include/babeltrace2/graph/port-const.h

   1 #ifndef BABELTRACE2_GRAPH_PORT_CONST_H
   2 #define BABELTRACE2_GRAPH_PORT_CONST_H
   3
   4 /*
   5  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   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 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  30 #include <stdint.h>
  31
  32 #include <babeltrace2/types.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 typedef enum bt_port_type {
  39         BT_PORT_TYPE_INPUT      = 1 << 0,
  40         BT_PORT_TYPE_OUTPUT     = 1 << 1,
  41 } bt_port_type;
  42
  43 extern const char *bt_port_get_name(const bt_port *port);
  44
  45 extern bt_port_type bt_port_get_type(const bt_port *port);
  46
  47 extern const bt_connection *bt_port_borrow_connection_const(
  48                 const bt_port *port);
  49
  50 extern const bt_component *bt_port_borrow_component_const(
  51                 const bt_port *port);
  52
  53 extern bt_bool bt_port_is_connected(const bt_port *port);
  54
  55 static inline
  56 bt_bool bt_port_is_input(const bt_port *port)
  57 {
  58         return bt_port_get_type(port) == BT_PORT_TYPE_INPUT;
  59 }
  60
  61 static inline
  62 bt_bool bt_port_is_output(const bt_port *port)
  63 {
  64         return bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT;
  65 }
  66
  67 extern void bt_port_get_ref(const bt_port *port);
  68
  69 extern void bt_port_put_ref(const bt_port *port);
  70
  71 #define BT_PORT_PUT_REF_AND_RESET(_var)         \
  72         do {                                    \
  73                 bt_port_put_ref(_var);          \
  74                 (_var) = NULL;                  \
  75         } while (0)
  76
  77 #define BT_PORT_MOVE_REF(_var_dst, _var_src)    \
  78         do {                                    \
  79                 bt_port_put_ref(_var_dst);      \
  80                 (_var_dst) = (_var_src);        \
  81                 (_var_src) = NULL;              \
  82         } while (0)
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #endif /* BABELTRACE2_GRAPH_PORT_CONST_H */