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 /* Destination type of lttng URI */
  16 enum lttng_dst_type {
  17         LTTNG_DST_IPV4                        = 1,
  18         LTTNG_DST_IPV6                        = 2,
  19         LTTNG_DST_PATH                        = 3,
  20 };
  21
  22 /* Type of lttng URI where it is a final destination or a hop */
  23 enum lttng_uri_type {
  24         LTTNG_URI_DST,  /* The URI is a final destination */
  25         /*
  26          * Hops are not supported yet but planned for a future release.
  27          *
  28          LTTNG_URI_HOP,
  29          */
  30 };
  31
  32 /* Communication stream type of a lttng URI */
  33 enum lttng_stream_type {
  34         LTTNG_STREAM_CONTROL,
  35         LTTNG_STREAM_DATA,
  36 };
  37
  38 /*
  39  * Protocol type of a lttng URI. The value 0 indicate that the proto_type field
  40  * should be ignored.
  41  */
  42 enum lttng_proto_type {
  43         LTTNG_PROTO_TYPE_NONE                 = 0,
  44         LTTNG_TCP                             = 1,
  45         /*
  46          * UDP protocol is not supported for now.
  47          *
  48          LTTNG_UDP                             = 2,
  49          */
  50 };
  51
  52 /*
  53  * Structure representing an URI supported by lttng.
  54  */
  55 struct lttng_uri {
  56         enum lttng_dst_type dtype;
  57         enum lttng_uri_type utype;
  58         enum lttng_stream_type stype;
  59         enum lttng_proto_type proto;
  60         uint16_t port;
  61         char subdir[LTTNG_PATH_MAX];
  62         union {
  63                 char ipv4[INET_ADDRSTRLEN];
  64                 char ipv6[INET6_ADDRSTRLEN];
  65                 char path[LTTNG_PATH_MAX];
  66         } dst;
  67 } LTTNG_PACKED;
  68
  69 int uri_compare(struct lttng_uri *uri1, struct lttng_uri *uri2);
  70 void uri_free(struct lttng_uri *uri);
  71 ssize_t uri_parse(const char *str_uri, struct lttng_uri **uris);
  72 ssize_t uri_parse_str_urls(const char *ctrl_url, const char *data_url,
  73                 struct lttng_uri **uris);
  74 int uri_to_str_url(struct lttng_uri *uri, char *dst, size_t size);
  75
  76 #endif /* _LTT_URI_H */