xref: /aosp_15_r20/external/tensorflow/tensorflow/compiler/xla/service/custom_call_status.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_H_
17 #define TENSORFLOW_COMPILER_XLA_SERVICE_CUSTOM_CALL_STATUS_H_
18 
19 #include <string.h>
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24 
25 // ABI-stable public interfaces for XlaCustomCallStatus.
26 
27 // Represents the result of a CustomCall: success or failure, with an associated
28 // error message in the failure case.
29 typedef struct XlaCustomCallStatus_ XlaCustomCallStatus;
30 
31 // Set the XlaCustomCallStatus to a success state. This is the default state.
32 void XlaCustomCallStatusSetSuccess(XlaCustomCallStatus* status);
33 
34 // Set the XlaCustomCallStatus to a failure state with the given error message.
35 // Does not take ownership of the supplied message string; instead copies the
36 // first 'message_len' bytes, or up to the null terminator, whichever comes
37 // first.
38 void XlaCustomCallStatusSetFailure(XlaCustomCallStatus* status,
39                                    const char* message, size_t message_len);
40 
41 #ifdef __cplusplus
42 }  // extern "C"
43 #endif
44 
45 #endif  // TENSORFLOW_COMPILER_XLA_SERVICE_CUSTOM_CALL_STATUS_H_
46