2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include <arpa/inet.h>
24 #include <sys/socket.h>
26 #include <common/common.h>
27 #include <common/defaults.h>
28 #include <common/utils.h>
32 #define LOOPBACK_ADDR_IPV4 "127.0.0.1"
33 #define LOOPBACK_ADDR_IPV6 "::1"
36 P_NET
, P_NET6
, P_FILE
, P_TCP
, P_TCP6
,
41 const char *leading_string
;
42 enum uri_proto_code code
;
43 enum lttng_proto_type type
;
44 enum lttng_dst_type dtype
;
47 /* Supported protocols */
48 static const struct uri_proto proto_uri
[] = {
49 { .name
= "file", .leading_string
= "file://", .code
= P_FILE
, .type
= 0, .dtype
= LTTNG_DST_PATH
},
50 { .name
= "net", .leading_string
= "net://", .code
= P_NET
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV4
},
51 { .name
= "net4", .leading_string
= "net4://", .code
= P_NET
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV4
},
52 { .name
= "net6", .leading_string
= "net6://", .code
= P_NET6
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV6
},
53 { .name
= "tcp", .leading_string
= "tcp://", .code
= P_TCP
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV4
},
54 { .name
= "tcp4", .leading_string
= "tcp4://", .code
= P_TCP
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV4
},
55 { .name
= "tcp6", .leading_string
= "tcp6://", .code
= P_TCP6
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV6
},
56 /* Invalid proto marking the end of the array. */
57 { NULL
, NULL
, 0, 0, 0 }
61 * Return pointer to the character in s matching one of the characters in
62 * accept. If nothing is found, return pointer to the end of string (eos).
64 static const inline char *strpbrk_or_eos(const char *s
, const char *accept
)
66 char *p
= strpbrk(s
, accept
);
76 * Validate if proto is a supported protocol from proto_uri array.
78 static const struct uri_proto
*get_uri_proto(const char *uri_str
)
80 const struct uri_proto
*supported
= NULL
;
83 if (uri_str
== NULL
) {
87 for (supported
= &proto_uri
[0];
88 supported
->leading_string
!= NULL
; ++supported
) {
89 if (strncasecmp(uri_str
, supported
->leading_string
,
90 strlen(supported
->leading_string
)) == 0) {
103 * Set network address from string into dst. Supports both IP string and
106 static int set_ip_address(const char *addr
, int af
, char *dst
, size_t size
)
109 unsigned char buf
[sizeof(struct in6_addr
)];
110 struct hostent
*record
;
115 memset(dst
, 0, size
);
117 /* Network protocol */
118 ret
= inet_pton(af
, addr
, buf
);
120 /* We consider the dst to be an hostname or an invalid IP char */
121 record
= gethostbyname2(addr
, af
);
123 /* Translate IP to string */
124 if (!inet_ntop(af
, record
->h_addr_list
[0], dst
, size
)) {
128 } else if (!strcmp(addr
, "localhost") &&
129 (af
== AF_INET
|| af
== AF_INET6
)) {
131 * Some systems may not have "localhost" defined in
132 * accordance with IETF RFC 6761. According to this RFC,
133 * applications may recognize "localhost" names as
134 * special and resolve to the appropriate loopback
137 * We choose to use the system name resolution API first
138 * to honor its network configuration. If this fails, we
139 * resolve to the appropriate loopback address. This is
140 * done to accomodate systems which may want to start
141 * tracing before their network configured.
143 const char *loopback_addr
= af
== AF_INET
?
144 LOOPBACK_ADDR_IPV4
: LOOPBACK_ADDR_IPV6
;
145 const size_t loopback_addr_len
= af
== AF_INET
?
146 sizeof(LOOPBACK_ADDR_IPV4
) :
147 sizeof(LOOPBACK_ADDR_IPV6
);
149 DBG2("Could not resolve localhost address, using fallback");
150 if (loopback_addr_len
> size
) {
151 ERR("Could not resolve localhost address; destination string is too short");
154 strcpy(dst
, loopback_addr
);
156 /* At this point, the IP or the hostname is bad */
161 strncpy(dst
, addr
, size
);
162 dst
[size
- 1] = '\0';
166 DBG2("IP address resolved to %s", dst
);
170 ERR("URI parse bad hostname %s for af %d", addr
, af
);
175 * Set default URI attribute which is basically the given stream type and the
176 * default port if none is set in the URI.
178 static void set_default_uri_attr(struct lttng_uri
*uri
,
179 enum lttng_stream_type stype
)
182 if (uri
->dtype
!= LTTNG_DST_PATH
&& uri
->port
== 0) {
183 uri
->port
= (stype
== LTTNG_STREAM_CONTROL
) ?
184 DEFAULT_NETWORK_CONTROL_PORT
: DEFAULT_NETWORK_DATA_PORT
;
189 * Compare two URL destination.
191 * Return 0 is equal else is not equal.
193 static int compare_destination(struct lttng_uri
*ctrl
, struct lttng_uri
*data
)
200 switch (ctrl
->dtype
) {
202 ret
= strncmp(ctrl
->dst
.ipv4
, data
->dst
.ipv4
, sizeof(ctrl
->dst
.ipv4
));
205 ret
= strncmp(ctrl
->dst
.ipv6
, data
->dst
.ipv6
, sizeof(ctrl
->dst
.ipv6
));
216 * Build a string URL from a lttng_uri object.
219 int uri_to_str_url(struct lttng_uri
*uri
, char *dst
, size_t size
)
223 char proto
[5], port
[7];
228 if (uri
->dtype
== LTTNG_DST_PATH
) {
230 addr
= uri
->dst
.path
;
231 (void) snprintf(proto
, sizeof(proto
), "file");
232 (void) snprintf(port
, sizeof(port
), "%s", "");
234 ipver
= (uri
->dtype
== LTTNG_DST_IPV4
) ? 4 : 6;
235 addr
= (ipver
== 4) ? uri
->dst
.ipv4
: uri
->dst
.ipv6
;
236 (void) snprintf(proto
, sizeof(proto
), "tcp%d", ipver
);
237 (void) snprintf(port
, sizeof(port
), ":%d", uri
->port
);
240 ret
= snprintf(dst
, size
, "%s://%s%s%s%s/%s", proto
,
241 (ipver
== 6) ? "[" : "", addr
, (ipver
== 6) ? "]" : "",
244 PERROR("snprintf uri to url");
253 * Return 0 if equal else 1.
256 int uri_compare(struct lttng_uri
*uri1
, struct lttng_uri
*uri2
)
258 return memcmp(uri1
, uri2
, sizeof(struct lttng_uri
));
265 void uri_free(struct lttng_uri
*uri
)
271 * Return an allocated URI.
274 struct lttng_uri
*uri_create(void)
276 struct lttng_uri
*uri
;
278 uri
= zmalloc(sizeof(struct lttng_uri
));
280 PERROR("zmalloc uri");
287 * Parses a string URI to a lttng_uri. This function can potentially return
288 * more than one URI in uris so the size of the array is returned and uris is
289 * allocated and populated. Caller must free(3) the array.
291 * This function can not detect the stream type of the URI so the caller has to
292 * make sure the correct type (stype) is set on the return URI(s). The default
293 * port must also be set by the caller if the returned URI has its port set to
296 * NOTE: A good part of the following code was inspired from the "wget" source
297 * tree from the src/url.c file and url_parse() function. Also, the
298 * strpbrk_or_eos() function found above is also inspired by the same code.
299 * This code was originally licensed GPLv2 so we acknolwedge the Free Software
300 * Foundation here for the work and to make sure we are compliant with it.
303 ssize_t
uri_parse(const char *str_uri
, struct lttng_uri
**uris
)
306 /* Size of the uris array. Default is 1 */
308 char subdir
[PATH_MAX
];
309 unsigned int ctrl_port
= 0;
310 unsigned int data_port
= 0;
311 struct lttng_uri
*tmp_uris
;
313 const struct uri_proto
*proto
;
314 const char *purl
, *addr_e
, *addr_b
, *subdir_b
= NULL
;
315 const char *seps
= ":/\0";
318 * The first part is the protocol portion of a maximum of 5 bytes for now.
319 * The second part is the hostname or IP address. The 255 bytes size is the
320 * limit found in the RFC 1035 for the total length of a domain name
321 * (https://www.ietf.org/rfc/rfc1035.txt). Finally, for the net://
322 * protocol, two ports CAN be specified.
325 DBG3("URI string: %s", str_uri
);
327 proto
= get_uri_proto(str_uri
);
329 ERR("URI parse unknown protocol %s", str_uri
);
335 if (proto
->code
== P_NET
|| proto
->code
== P_NET6
) {
336 /* Special case for net:// which requires two URI objects */
340 /* Allocate URI array */
341 tmp_uris
= zmalloc(sizeof(struct lttng_uri
) * size
);
342 if (tmp_uris
== NULL
) {
343 PERROR("zmalloc uri");
347 memset(subdir
, 0, sizeof(subdir
));
348 purl
+= strlen(proto
->leading_string
);
350 /* Copy known value to the first URI. */
351 tmp_uris
[0].dtype
= proto
->dtype
;
352 tmp_uris
[0].proto
= proto
->type
;
354 if (proto
->code
== P_FILE
) {
356 ERR("Missing destination full path.");
360 strncpy(tmp_uris
[0].dst
.path
, purl
, sizeof(tmp_uris
[0].dst
.path
));
361 tmp_uris
[0].dst
.path
[sizeof(tmp_uris
[0].dst
.path
) - 1] = '\0';
362 DBG3("URI file destination: %s", purl
);
366 /* Assume we are at the beginning of an address or host of some sort. */
370 * Handle IPv6 address inside square brackets as mention by RFC 2732. IPv6
371 * address that does not start AND end with brackets will be rejected even
374 * proto://[<addr>]...
378 /* Address begins after '[' */
380 addr_e
= strchr(addr_b
, ']');
381 if (addr_e
== NULL
|| addr_b
== addr_e
) {
382 ERR("Broken IPv6 address %s", addr_b
);
386 /* Moving parsed URL pointer after the final bracket ']' */
390 * The closing bracket must be followed by a seperator or NULL char.
392 if (strchr(seps
, *purl
) == NULL
) {
393 ERR("Unknown symbol after IPv6 address: %s", purl
);
397 purl
= strpbrk_or_eos(purl
, seps
);
401 /* Check if we at least have a char for the addr or hostname. */
402 if (addr_b
== addr_e
) {
403 ERR("No address or hostname detected.");
407 addr_f
= utils_strdupdelim(addr_b
, addr_e
);
408 if (addr_f
== NULL
) {
413 * Detect PORT after address. The net/net6 protocol allows up to two port
414 * so we can define the control and data port.
416 while (*purl
== ':') {
417 const char *port_b
, *port_e
;
420 /* Update pass counter */
424 * Maximum of two ports is possible if P_NET/NET6. Bigger than that,
427 if ((i
== 2 && (proto
->code
!= P_NET
&& proto
->code
!= P_NET6
))
433 * Move parsed URL to port value.
434 * proto://addr_host:PORT1:PORT2/foo/bar
439 purl
= strpbrk_or_eos(purl
, seps
);
442 if (port_b
!= port_e
) {
445 port_f
= utils_strdupdelim(port_b
, port_e
);
446 if (port_f
== NULL
) {
451 if (port
> 0xffff || port
<= 0x0) {
452 ERR("Invalid port number %d", port
);
466 /* Check for a valid subdir or trailing garbage */
469 * Move to subdir value.
470 * proto://addr_host:PORT1:PORT2/foo/bar
475 } else if (*purl
!= '\0') {
476 ERR("Trailing characters not recognized: %s", purl
);
480 /* We have enough valid information to create URI(s) object */
482 /* Copy generic information */
483 tmp_uris
[0].port
= ctrl_port
;
485 /* Copy subdirectory if one. */
487 strncpy(tmp_uris
[0].subdir
, subdir_b
, sizeof(tmp_uris
[0].subdir
));
488 tmp_uris
[0].subdir
[sizeof(tmp_uris
[0].subdir
) - 1] = '\0';
491 switch (proto
->code
) {
493 ret
= set_ip_address(addr_f
, AF_INET
, tmp_uris
[0].dst
.ipv4
,
494 sizeof(tmp_uris
[0].dst
.ipv4
));
499 memcpy(tmp_uris
[1].dst
.ipv4
, tmp_uris
[0].dst
.ipv4
, sizeof(tmp_uris
[1].dst
.ipv4
));
501 tmp_uris
[1].dtype
= proto
->dtype
;
502 tmp_uris
[1].proto
= proto
->type
;
503 tmp_uris
[1].port
= data_port
;
506 ret
= set_ip_address(addr_f
, AF_INET6
, tmp_uris
[0].dst
.ipv6
,
507 sizeof(tmp_uris
[0].dst
.ipv6
));
512 memcpy(tmp_uris
[1].dst
.ipv6
, tmp_uris
[0].dst
.ipv6
, sizeof(tmp_uris
[1].dst
.ipv6
));
514 tmp_uris
[1].dtype
= proto
->dtype
;
515 tmp_uris
[1].proto
= proto
->type
;
516 tmp_uris
[1].port
= data_port
;
519 ret
= set_ip_address(addr_f
, AF_INET
, tmp_uris
[0].dst
.ipv4
,
520 sizeof(tmp_uris
[0].dst
.ipv4
));
526 ret
= set_ip_address(addr_f
, AF_INET6
, tmp_uris
[0].dst
.ipv6
,
527 sizeof(tmp_uris
[0].dst
.ipv6
));
537 DBG3("URI dtype: %d, proto: %d, host: %s, subdir: %s, ctrl: %d, data: %d",
538 proto
->dtype
, proto
->type
, (addr_f
== NULL
) ? "" : addr_f
,
539 (subdir_b
== NULL
) ? "" : subdir_b
, ctrl_port
, data_port
);
554 * Parse a string URL and creates URI(s) returning the size of the populated
558 ssize_t
uri_parse_str_urls(const char *ctrl_url
, const char *data_url
,
559 struct lttng_uri
**uris
)
561 unsigned int equal
= 1, idx
= 0;
562 /* Add the "file://" size to the URL maximum size */
563 char url
[PATH_MAX
+ 7];
564 ssize_t size_ctrl
= 0, size_data
= 0, size
;
565 struct lttng_uri
*ctrl_uris
= NULL
, *data_uris
= NULL
;
566 struct lttng_uri
*tmp_uris
= NULL
;
568 /* No URL(s) is allowed. This means that the consumer will be disabled. */
569 if (ctrl_url
== NULL
&& data_url
== NULL
) {
573 /* Check if URLs are equal and if so, only use the control URL */
574 if ((ctrl_url
&& *ctrl_url
!= '\0') && (data_url
&& *data_url
!= '\0')) {
575 equal
= !strcmp(ctrl_url
, data_url
);
579 * Since we allow the str_url to be a full local filesystem path, we are
580 * going to create a valid file:// URL if it's the case.
582 * Check if first character is a '/' or else reject the URL.
584 if (ctrl_url
&& ctrl_url
[0] == '/') {
587 ret
= snprintf(url
, sizeof(url
), "file://%s", ctrl_url
);
589 PERROR("snprintf file url");
595 /* Parse the control URL if there is one */
596 if (ctrl_url
&& *ctrl_url
!= '\0') {
597 size_ctrl
= uri_parse(ctrl_url
, &ctrl_uris
);
599 ERR("Unable to parse the URL %s", ctrl_url
);
603 /* At this point, we know there is at least one URI in the array */
604 set_default_uri_attr(&ctrl_uris
[0], LTTNG_STREAM_CONTROL
);
606 if (ctrl_uris
[0].dtype
== LTTNG_DST_PATH
&&
607 (data_url
&& *data_url
!= '\0')) {
608 ERR("Can not have a data URL when destination is file://");
612 /* URL are not equal but the control URL uses a net:// protocol */
613 if (size_ctrl
== 2) {
615 ERR("Control URL uses the net:// protocol and the data URL is "
616 "different. Not allowed.");
619 set_default_uri_attr(&ctrl_uris
[1], LTTNG_STREAM_DATA
);
621 * The data_url and ctrl_url are equal and the ctrl_url
622 * contains a net:// protocol so we just skip the data part.
629 if (data_url
&& *data_url
!= '\0') {
632 /* We have to parse the data URL in this case */
633 size_data
= uri_parse(data_url
, &data_uris
);
635 ERR("Unable to parse the URL %s", data_url
);
637 } else if (size_data
== 2) {
638 ERR("Data URL can not be set with the net[4|6]:// protocol");
642 set_default_uri_attr(&data_uris
[0], LTTNG_STREAM_DATA
);
644 ret
= compare_destination(&ctrl_uris
[0], &data_uris
[0]);
646 ERR("Control and data destination mismatch");
651 /* Compute total size */
652 size
= size_ctrl
+ size_data
;
654 tmp_uris
= zmalloc(sizeof(struct lttng_uri
) * size
);
655 if (tmp_uris
== NULL
) {
656 PERROR("zmalloc uris");
661 /* It's possible the control URIs array contains more than one URI */
662 memcpy(tmp_uris
, ctrl_uris
, sizeof(struct lttng_uri
) * size_ctrl
);
668 memcpy(&tmp_uris
[idx
], data_uris
, sizeof(struct lttng_uri
));