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>
33 P_NET
, P_NET6
, P_FILE
, P_TCP
, P_TCP6
,
38 const char *leading_string
;
39 enum uri_proto_code code
;
40 enum lttng_proto_type type
;
41 enum lttng_dst_type dtype
;
44 /* Supported protocols */
45 static const struct uri_proto proto_uri
[] = {
46 { .name
= "file", .leading_string
= "file://", .code
= P_FILE
, .type
= 0, .dtype
= LTTNG_DST_PATH
},
47 { .name
= "net", .leading_string
= "net://", .code
= P_NET
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV4
},
48 { .name
= "net6", .leading_string
= "net6://", .code
= P_NET6
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV6
},
49 { .name
= "tcp", .leading_string
= "tcp://", .code
= P_TCP
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV4
},
50 { .name
= "tcp6", .leading_string
= "tcp6://", .code
= P_TCP6
, .type
= LTTNG_TCP
, .dtype
= LTTNG_DST_IPV6
},
51 /* Invalid proto marking the end of the array. */
52 { NULL
, NULL
, 0, 0, 0 }
56 * Return pointer to the character in s matching one of the characters in
57 * accept. If nothing is found, return pointer to the end of string (eos).
59 static const inline char *strpbrk_or_eos(const char *s
, const char *accept
)
61 char *p
= strpbrk(s
, accept
);
71 * Validate if proto is a supported protocol from proto_uri array.
73 static const struct uri_proto
*get_uri_proto(const char *uri_str
)
75 const struct uri_proto
*supported
= NULL
;
78 if (uri_str
== NULL
) {
82 for (supported
= &proto_uri
[0];
83 supported
->leading_string
!= NULL
; ++supported
) {
84 if (strncasecmp(uri_str
, supported
->leading_string
,
85 strlen(supported
->leading_string
)) == 0) {
98 * Set network address from string into dst. Supports both IP string and
101 static int set_ip_address(const char *addr
, int af
, char *dst
, size_t size
)
104 unsigned char buf
[sizeof(struct in6_addr
)];
105 struct hostent
*record
;
110 memset(dst
, 0, size
);
112 /* Network protocol */
113 ret
= inet_pton(af
, addr
, buf
);
115 /* We consider the dst to be an hostname or an invalid IP char */
116 record
= gethostbyname2(addr
, af
);
117 if (record
== NULL
) {
118 /* At this point, the IP or the hostname is bad */
119 ERR("URI parse bad hostname %s for af %d", addr
, af
);
123 /* Translate IP to string */
124 (void) inet_ntop(af
, record
->h_addr_list
[0], dst
, size
);
127 strncpy(dst
, addr
, size
);
128 dst
[size
- 1] = '\0';
132 DBG2("IP address resolved to %s", dst
);
141 * Set default URI attribute which is basically the given stream type and the
142 * default port if none is set in the URI.
144 static void set_default_uri_attr(struct lttng_uri
*uri
,
145 enum lttng_stream_type stype
)
148 if (uri
->dtype
!= LTTNG_DST_PATH
&& uri
->port
== 0) {
149 uri
->port
= (stype
== LTTNG_STREAM_CONTROL
) ?
150 DEFAULT_NETWORK_CONTROL_PORT
: DEFAULT_NETWORK_DATA_PORT
;
155 * Compare two URL destination.
157 * Return 0 is equal else is not equal.
159 static int compare_destination(struct lttng_uri
*ctrl
, struct lttng_uri
*data
)
166 switch (ctrl
->dtype
) {
168 ret
= strncmp(ctrl
->dst
.ipv4
, data
->dst
.ipv4
, sizeof(ctrl
->dst
.ipv4
));
171 ret
= strncmp(ctrl
->dst
.ipv6
, data
->dst
.ipv6
, sizeof(ctrl
->dst
.ipv6
));
182 * Build a string URL from a lttng_uri object.
185 int uri_to_str_url(struct lttng_uri
*uri
, char *dst
, size_t size
)
189 char proto
[4], port
[7];
194 if (uri
->dtype
== LTTNG_DST_PATH
) {
196 addr
= uri
->dst
.path
;
197 (void) snprintf(proto
, sizeof(proto
), "file");
198 (void) snprintf(port
, sizeof(port
), "%s", "");
200 ipver
= (uri
->dtype
== LTTNG_DST_IPV4
) ? 4 : 6;
201 addr
= (ipver
== 4) ? uri
->dst
.ipv4
: uri
->dst
.ipv6
;
202 (void) snprintf(proto
, sizeof(proto
), "net%d", ipver
);
203 (void) snprintf(port
, sizeof(port
), ":%d", uri
->port
);
206 ret
= snprintf(dst
, size
, "%s://%s%s%s%s/%s", proto
,
207 (ipver
== 6) ? "[" : "", addr
, (ipver
== 6) ? "]" : "",
210 PERROR("snprintf uri to url");
219 * Return 0 if equal else 1.
222 int uri_compare(struct lttng_uri
*uri1
, struct lttng_uri
*uri2
)
224 return memcmp(uri1
, uri2
, sizeof(struct lttng_uri
));
231 void uri_free(struct lttng_uri
*uri
)
237 * Return an allocated URI.
240 struct lttng_uri
*uri_create(void)
242 struct lttng_uri
*uri
;
244 uri
= zmalloc(sizeof(struct lttng_uri
));
246 PERROR("zmalloc uri");
253 * Parses a string URI to a lttng_uri. This function can potentially return
254 * more than one URI in uris so the size of the array is returned and uris is
255 * allocated and populated. Caller must free(3) the array.
257 * This function can not detect the stream type of the URI so the caller has to
258 * make sure the correct type (stype) is set on the return URI(s). The default
259 * port must also be set by the caller if the returned URI has its port set to
262 * NOTE: A good part of the following code was inspired from the "wget" source
263 * tree from the src/url.c file and url_parse() function. Also, the
264 * strpbrk_or_eos() function found above is also inspired by the same code.
265 * This code was originally licensed GPLv2 so we acknolwedge the Free Software
266 * Foundation here for the work and to make sure we are compliant with it.
269 ssize_t
uri_parse(const char *str_uri
, struct lttng_uri
**uris
)
272 /* Size of the uris array. Default is 1 */
274 char subdir
[PATH_MAX
];
275 unsigned int ctrl_port
= 0;
276 unsigned int data_port
= 0;
277 struct lttng_uri
*tmp_uris
;
279 const struct uri_proto
*proto
;
280 const char *purl
, *addr_e
, *addr_b
, *subdir_b
= NULL
;
281 const char *seps
= ":/\0";
284 * The first part is the protocol portion of a maximum of 5 bytes for now.
285 * The second part is the hostname or IP address. The 255 bytes size is the
286 * limit found in the RFC 1035 for the total length of a domain name
287 * (https://www.ietf.org/rfc/rfc1035.txt). Finally, for the net://
288 * protocol, two ports CAN be specified.
291 DBG3("URI string: %s", str_uri
);
293 proto
= get_uri_proto(str_uri
);
295 ERR("URI parse unknown protocol %s", str_uri
);
301 if (proto
->code
== P_NET
|| proto
->code
== P_NET6
) {
302 /* Special case for net:// which requires two URI objects */
306 /* Allocate URI array */
307 tmp_uris
= zmalloc(sizeof(struct lttng_uri
) * size
);
308 if (tmp_uris
== NULL
) {
309 PERROR("zmalloc uri");
313 memset(subdir
, 0, sizeof(subdir
));
314 purl
+= strlen(proto
->leading_string
);
316 /* Copy known value to the first URI. */
317 tmp_uris
[0].dtype
= proto
->dtype
;
318 tmp_uris
[0].proto
= proto
->type
;
320 if (proto
->code
== P_FILE
) {
322 ERR("Missing destination full path.");
326 strncpy(tmp_uris
[0].dst
.path
, purl
, sizeof(tmp_uris
[0].dst
.path
));
327 tmp_uris
[0].dst
.path
[sizeof(tmp_uris
[0].dst
.path
) - 1] = '\0';
328 DBG3("URI file destination: %s", purl
);
332 /* Assume we are at the beginning of an address or host of some sort. */
336 * Handle IPv6 address inside square brackets as mention by RFC 2732. IPv6
337 * address that does not start AND end with brackets will be rejected even
340 * proto://[<addr>]...
344 /* Address begins after '[' */
346 addr_e
= strchr(addr_b
, ']');
347 if (addr_e
== NULL
|| addr_b
== addr_e
) {
348 ERR("Broken IPv6 address %s", addr_b
);
352 /* Moving parsed URL pointer after the final bracket ']' */
356 * The closing bracket must be followed by a seperator or NULL char.
358 if (strchr(seps
, *purl
) == NULL
) {
359 ERR("Unknown symbol after IPv6 address: %s", purl
);
363 purl
= strpbrk_or_eos(purl
, seps
);
367 /* Check if we at least have a char for the addr or hostname. */
368 if (addr_b
== addr_e
) {
369 ERR("No address or hostname detected.");
373 addr_f
= utils_strdupdelim(addr_b
, addr_e
);
374 if (addr_f
== NULL
) {
379 * Detect PORT after address. The net/net6 protocol allows up to two port
380 * so we can define the control and data port.
382 while (*purl
== ':') {
383 const char *port_b
, *port_e
;
386 /* Update pass counter */
390 * Maximum of two ports is possible if P_NET/NET6. Bigger than that,
393 if ((i
== 2 && (proto
->code
!= P_NET
&& proto
->code
!= P_NET6
))
399 * Move parsed URL to port value.
400 * proto://addr_host:PORT1:PORT2/foo/bar
405 purl
= strpbrk_or_eos(purl
, seps
);
408 if (port_b
!= port_e
) {
411 port_f
= utils_strdupdelim(port_b
, port_e
);
412 if (port_f
== NULL
) {
417 if (port
> 0xffff || port
<= 0x0) {
418 ERR("Invalid port number %d", port
);
432 /* Check for a valid subdir or trailing garbage */
435 * Move to subdir value.
436 * proto://addr_host:PORT1:PORT2/foo/bar
441 } else if (*purl
!= '\0') {
442 ERR("Trailing characters not recognized: %s", purl
);
446 /* We have enough valid information to create URI(s) object */
448 /* Copy generic information */
449 tmp_uris
[0].port
= ctrl_port
;
451 /* Copy subdirectory if one. */
453 strncpy(tmp_uris
[0].subdir
, subdir_b
, sizeof(tmp_uris
[0].subdir
));
454 tmp_uris
[0].subdir
[sizeof(tmp_uris
[0].subdir
) - 1] = '\0';
457 switch (proto
->code
) {
459 ret
= set_ip_address(addr_f
, AF_INET
, tmp_uris
[0].dst
.ipv4
,
460 sizeof(tmp_uris
[0].dst
.ipv4
));
465 memcpy(tmp_uris
[1].dst
.ipv4
, tmp_uris
[0].dst
.ipv4
, sizeof(tmp_uris
[1].dst
.ipv4
));
467 tmp_uris
[1].dtype
= proto
->dtype
;
468 tmp_uris
[1].proto
= proto
->type
;
469 tmp_uris
[1].port
= data_port
;
472 ret
= set_ip_address(addr_f
, AF_INET6
, tmp_uris
[0].dst
.ipv6
,
473 sizeof(tmp_uris
[0].dst
.ipv6
));
478 memcpy(tmp_uris
[1].dst
.ipv6
, tmp_uris
[0].dst
.ipv6
, sizeof(tmp_uris
[1].dst
.ipv6
));
480 tmp_uris
[1].dtype
= proto
->dtype
;
481 tmp_uris
[1].proto
= proto
->type
;
482 tmp_uris
[1].port
= data_port
;
485 ret
= set_ip_address(addr_f
, AF_INET
, tmp_uris
[0].dst
.ipv4
,
486 sizeof(tmp_uris
[0].dst
.ipv4
));
492 ret
= set_ip_address(addr_f
, AF_INET6
, tmp_uris
[0].dst
.ipv6
,
493 sizeof(tmp_uris
[0].dst
.ipv6
));
503 DBG3("URI dtype: %d, proto: %d, host: %s, subdir: %s, ctrl: %d, data: %d",
504 proto
->dtype
, proto
->type
, (addr_f
== NULL
) ? "" : addr_f
,
505 (subdir_b
== NULL
) ? "" : subdir_b
, ctrl_port
, data_port
);
520 * Parse a string URL and creates URI(s) returning the size of the populated
524 ssize_t
uri_parse_str_urls(const char *ctrl_url
, const char *data_url
,
525 struct lttng_uri
**uris
)
527 unsigned int equal
= 1, idx
= 0;
528 /* Add the "file://" size to the URL maximum size */
529 char url
[PATH_MAX
+ 7];
530 ssize_t size_ctrl
= 0, size_data
= 0, size
;
531 struct lttng_uri
*ctrl_uris
= NULL
, *data_uris
= NULL
;
532 struct lttng_uri
*tmp_uris
= NULL
;
534 /* No URL(s) is allowed. This means that the consumer will be disabled. */
535 if (ctrl_url
== NULL
&& data_url
== NULL
) {
539 /* Check if URLs are equal and if so, only use the control URL */
540 if ((ctrl_url
&& *ctrl_url
!= '\0') && (data_url
&& *data_url
!= '\0')) {
541 equal
= !strcmp(ctrl_url
, data_url
);
545 * Since we allow the str_url to be a full local filesystem path, we are
546 * going to create a valid file:// URL if it's the case.
548 * Check if first character is a '/' or else reject the URL.
550 if (ctrl_url
&& ctrl_url
[0] == '/') {
553 ret
= snprintf(url
, sizeof(url
), "file://%s", ctrl_url
);
555 PERROR("snprintf file url");
561 /* Parse the control URL if there is one */
562 if (ctrl_url
&& *ctrl_url
!= '\0') {
563 size_ctrl
= uri_parse(ctrl_url
, &ctrl_uris
);
565 ERR("Unable to parse the URL %s", ctrl_url
);
569 /* At this point, we know there is at least one URI in the array */
570 set_default_uri_attr(&ctrl_uris
[0], LTTNG_STREAM_CONTROL
);
572 if (ctrl_uris
[0].dtype
== LTTNG_DST_PATH
&&
573 (data_url
&& *data_url
!= '\0')) {
574 ERR("Can not have a data URL when destination is file://");
578 /* URL are not equal but the control URL uses a net:// protocol */
579 if (size_ctrl
== 2) {
581 ERR("Control URL uses the net:// protocol and the data URL is "
582 "different. Not allowed.");
585 set_default_uri_attr(&ctrl_uris
[1], LTTNG_STREAM_DATA
);
587 * The data_url and ctrl_url are equal and the ctrl_url
588 * contains a net:// protocol so we just skip the data part.
595 if (data_url
&& *data_url
!= '\0') {
598 /* We have to parse the data URL in this case */
599 size_data
= uri_parse(data_url
, &data_uris
);
601 ERR("Unable to parse the URL %s", data_url
);
603 } else if (size_data
== 2) {
604 ERR("Data URL can not be set with the net[4|6]:// protocol");
608 set_default_uri_attr(&data_uris
[0], LTTNG_STREAM_DATA
);
610 ret
= compare_destination(&ctrl_uris
[0], &data_uris
[0]);
612 ERR("Control and data destination mismatch");
617 /* Compute total size */
618 size
= size_ctrl
+ size_data
;
620 tmp_uris
= zmalloc(sizeof(struct lttng_uri
) * size
);
621 if (tmp_uris
== NULL
) {
622 PERROR("zmalloc uris");
627 /* It's possible the control URIs array contains more than one URI */
628 memcpy(tmp_uris
, ctrl_uris
, sizeof(struct lttng_uri
) * size_ctrl
);
634 memcpy(&tmp_uris
[idx
], data_uris
, sizeof(struct lttng_uri
));