xref: /aosp_15_r20/external/tensorflow/tensorflow/compiler/xla/service/custom_call_status_internal.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2021 The TensorFlow Authors. All Rights Reserved.
2 
3 Licensed under the Apache License, Version 2.0 (the "License");
4 you may not use this file except in compliance with the License.
5 You may obtain a copy of the License at
6 
7     http://www.apache.org/licenses/LICENSE-2.0
8 
9 Unless required by applicable law or agreed to in writing, software
10 distributed under the License is distributed on an "AS IS" BASIS,
11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 See the License for the specific language governing permissions and
13 limitations under the License.
14 ==============================================================================*/
15 
16 #ifndef TENSORFLOW_COMPILER_XLA_SERVICE_CUSTOM_CALL_STATUS_INTERNAL_H_
17 #define TENSORFLOW_COMPILER_XLA_SERVICE_CUSTOM_CALL_STATUS_INTERNAL_H_
18 
19 #include <optional>
20 
21 #include "absl/strings/string_view.h"
22 #include "tensorflow/compiler/xla/service/custom_call_status.h"
23 
24 struct XlaCustomCallStatus_ {
25   // The message being present means "failure". Otherwise means "success".
26   std::optional<std::string> message;
27 };
28 
29 namespace xla {
30 
31 // Get a view of the internal error message of the XlaCustomCallStatus. Only
32 // lives as long as the XlaCustomCallStatus. Returns an empty optional if the
33 // result was "success".
34 std::optional<absl::string_view> CustomCallStatusGetMessage(
35     const XlaCustomCallStatus* status);
36 
37 }  // namespace xla
38 
39 #endif  // TENSORFLOW_COMPILER_XLA_SERVICE_CUSTOM_CALL_INTERNAL_STATUS_H_
40