include/babeltrace/graph/query-executor-const.h

   1 #ifndef BABELTRACE_GRAPH_QUERY_EXECUTOR_CONST_H
   2 #define BABELTRACE_GRAPH_QUERY_EXECUTOR_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 /* For bt_bool */
  27 #include <babeltrace/types.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 struct bt_query_executor;
  34
  35 enum bt_query_executor_status {
  36         BT_QUERY_EXECUTOR_STATUS_OK = 0,
  37         BT_QUERY_EXECUTOR_STATUS_AGAIN = 11,
  38         BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED = 95,
  39         BT_QUERY_EXECUTOR_STATUS_CANCELED = 125,
  40         BT_QUERY_EXECUTOR_STATUS_ERROR = -1,
  41         BT_QUERY_EXECUTOR_STATUS_NOMEM = -12,
  42         BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT = -23,
  43         BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS = -24,
  44 };
  45
  46 extern
  47 bt_bool bt_query_executor_is_canceled(
  48                 const struct bt_query_executor *query_executor);
  49
  50 extern void bt_query_executor_get_ref(
  51                 const struct bt_query_executor *query_executor);
  52
  53 extern void bt_query_executor_put_ref(
  54                 const struct bt_query_executor *query_executor);
  55
  56 #define BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(_var)               \
  57         do {                                                    \
  58                 bt_query_executor_put_ref(_var);                \
  59                 (_var) = NULL;                                  \
  60         } while (0)
  61
  62 #define BT_QUERY_EXECUTOR_MOVE_REF(_var_dst, _var_src)          \
  63         do {                                                    \
  64                 bt_query_executor_put_ref(_var_dst);            \
  65                 (_var_dst) = (_var_src);                        \
  66                 (_var_src) = NULL;                              \
  67         } while (0)
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif /* BABELTRACE_GRAPH_QUERY_EXECUTOR_CONST_H */