include/babeltrace/graph/graph-const.h

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