1/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20/*!
21 * \file runtime_base.h
22 * \brief Base of all C APIs
23 */
24#ifndef TVM_RUNTIME_RUNTIME_BASE_H_
25#define TVM_RUNTIME_RUNTIME_BASE_H_
26
27#include <tvm/runtime/c_runtime_api.h>
28
29#include <stdexcept>
30
31/*! \brief macro to guard beginning and end section of all functions */
32#define API_BEGIN() try {
33/*! \brief every function starts with API_BEGIN();
34 and finishes with API_END() or API_END_HANDLE_ERROR */
35#define API_END() \
36 } \
37 catch (::tvm::runtime::EnvErrorAlreadySet & _except_) { \
38 return -2; \
39 } \
40 catch (std::exception & _except_) { \
41 return TVMAPIHandleException(_except_); \
42 } \
43 return 0; // NOLINT(*)
44/*!
45 * \brief every function starts with API_BEGIN();
46 * and finishes with API_END() or API_END_HANDLE_ERROR
47 * The finally clause contains procedure to cleanup states when an error happens.
48 */
49#define API_END_HANDLE_ERROR(Finalize) \
50 } \
51 catch (::tvm::runtime::EnvErrorAlreadySet & _except_) { \
52 return -2; \
53 } \
54 catch (std::exception & _except_) { \
55 Finalize; \
56 return TVMAPIHandleException(_except_); \
57 } \
58 return 0; // NOLINT(*)
59
60/*!
61 * \brief handle exception throwed out
62 * \param e the exception
63 * \return the return value of API after exception is handled
64 */
65int TVMAPIHandleException(const std::exception& e);
66
67#endif // TVM_RUNTIME_RUNTIME_BASE_H_
68