src/common/uri.h

   1 /*
   2  * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #ifndef URI_H
   9 #define URI_H
  10
  11 #include <netinet/in.h>
  12 #include <lttng/lttng.h>
  13 #include <common/macros.h>
  14
  15 #if defined(__cplusplus)
  16 extern "C" {
  17 #endif
  18
  19 /* Destination type of lttng URI */
  20 enum lttng_dst_type {
  21         LTTNG_DST_IPV4                        = 1,
  22         LTTNG_DST_IPV6                        = 2,
  23         LTTNG_DST_PATH                        = 3,
  24 };
  25
  26 /* Type of lttng URI where it is a final destination or a hop */
  27 enum lttng_uri_type {
  28         LTTNG_URI_DST,  /* The URI is a final destination */
  29         /*
  30          * Hops are not supported yet but planned for a future release.
  31          *
  32          LTTNG_URI_HOP,
  33          */
  34 };
  35
  36 /* Communication stream type of a lttng URI */
  37 enum lttng_stream_type {
  38         LTTNG_STREAM_CONTROL,
  39         LTTNG_STREAM_DATA,
  40 };
  41
  42 /*
  43  * Protocol type of a lttng URI. The value 0 indicate that the proto_type field
  44  * should be ignored.
  45  */
  46 enum lttng_proto_type {
  47         LTTNG_TCP                             = 1,
  48         /*
  49          * UDP protocol is not supported for now.
  50          *
  51          LTTNG_UDP                             = 2,
  52          */
  53 };
  54
  55 /*
  56  * Structure representing an URI supported by lttng.
  57  */
  58 struct lttng_uri {
  59         enum lttng_dst_type dtype;
  60         enum lttng_uri_type utype;
  61         enum lttng_stream_type stype;
  62         enum lttng_proto_type proto;
  63         uint16_t port;
  64         char subdir[LTTNG_PATH_MAX];
  65         union {
  66                 char ipv4[INET_ADDRSTRLEN];
  67                 char ipv6[INET6_ADDRSTRLEN];
  68                 char path[LTTNG_PATH_MAX];
  69         } dst;
  70 } LTTNG_PACKED;
  71
  72 int uri_compare(struct lttng_uri *uri1, struct lttng_uri *uri2);
  73 void uri_free(struct lttng_uri *uri);
  74 ssize_t uri_parse(const char *str_uri, struct lttng_uri **uris);
  75 ssize_t uri_parse_str_urls(const char *ctrl_url, const char *data_url,
  76                 struct lttng_uri **uris);
  77 int uri_to_str_url(struct lttng_uri *uri, char *dst, size_t size);
  78
  79 #if defined(__cplusplus)
  80 }
  81 #endif
  82
  83 #endif /* _LTT_URI_H */