2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 2010, Digium, Inc.
6 * Viagénie <asteriskv6@viagenie.ca>
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
20 * \brief Network socket handling
23 #ifndef _ASTERISK_NETSOCK2_H
24 #define _ASTERISK_NETSOCK2_H
26 #if defined(__cplusplus) || defined(c_plusplus)
30 #include <sys/socket.h>
32 #include <netinet/in.h>
35 * Values for address families that we support. This is reproduced from socket.h
36 * because we do not want users to include that file. Only netsock2.c should
37 * ever include socket.h.
46 * \brief Socket address structure.
49 * The first member is big enough to contain addresses of any
50 * family. The second member contains the length (in bytes) used
51 * in the first member.
54 * Some BSDs have the length embedded in sockaddr structs. We
55 * ignore them. (This is the right thing to do.)
58 * It is important to always initialize ast_sockaddr before use
59 * -- even if they are passed to ast_sockaddr_copy() as the
60 * underlying storage could be bigger than what ends up being
61 * copied -- leaving part of the data unitialized.
64 struct sockaddr_storage ss;
70 * Convert an IPv4-mapped IPv6 address into an IPv4 address.
72 * \warning You should rarely need this function. Only call this
73 * if you know what you're doing.
75 * \param addr The IPv4-mapped address to convert
76 * \param mapped_addr The resulting IPv4 address
77 * \retval 0 Unable to make the conversion
78 * \retval 1 Successful conversion
80 int ast_sockaddr_ipv4_mapped(const struct ast_sockaddr *addr, struct ast_sockaddr *ast_mapped);
86 * Checks if the ast_sockaddr is null. "null" in this sense essentially
87 * means uninitialized, or having a 0 length.
89 * \param addr Pointer to the ast_sockaddr we wish to check
90 * \retval 1 \a addr is null
91 * \retval 0 \a addr is non-null.
93 static inline int ast_sockaddr_isnull(const struct ast_sockaddr *addr)
95 return !addr || addr->len == 0;
102 * Sets address \a addr to null.
106 static inline void ast_sockaddr_setnull(struct ast_sockaddr *addr)
115 * Copies the data from one ast_sockaddr to another
117 * \param dst The destination ast_sockaddr
118 * \param src The source ast_sockaddr
121 static inline void ast_sockaddr_copy(struct ast_sockaddr *dst,
122 const struct ast_sockaddr *src)
124 memcpy(dst, src, src->len);
132 * Compares two ast_sockaddr structures
134 * \retval -1 \a a is lexicographically smaller than \a b
135 * \retval 0 \a a is equal to \a b
136 * \retval 1 \a b is lexicographically smaller than \a a
138 int ast_sockaddr_cmp(const struct ast_sockaddr *a, const struct ast_sockaddr *b);
144 * Compares the addresses of two ast_sockaddr structures.
146 * \retval -1 \a a is lexicographically smaller than \a b
147 * \retval 0 \a a is equal to \a b
148 * \retval 1 \a b is lexicographically smaller than \a a
150 int ast_sockaddr_cmp_addr(const struct ast_sockaddr *a, const struct ast_sockaddr *b);
152 #define AST_SOCKADDR_STR_ADDR (1 << 0)
153 #define AST_SOCKADDR_STR_PORT (1 << 1)
154 #define AST_SOCKADDR_STR_BRACKETS (1 << 2)
155 #define AST_SOCKADDR_STR_REMOTE (1 << 3)
156 #define AST_SOCKADDR_STR_HOST (AST_SOCKADDR_STR_ADDR | AST_SOCKADDR_STR_BRACKETS)
157 #define AST_SOCKADDR_STR_DEFAULT (AST_SOCKADDR_STR_ADDR | AST_SOCKADDR_STR_PORT)
158 #define AST_SOCKADDR_STR_ADDR_REMOTE (AST_SOCKADDR_STR_ADDR | AST_SOCKADDR_STR_REMOTE)
159 #define AST_SOCKADDR_STR_HOST_REMOTE (AST_SOCKADDR_STR_HOST | AST_SOCKADDR_STR_REMOTE)
160 #define AST_SOCKADDR_STR_DEFAULT_REMOTE (AST_SOCKADDR_STR_DEFAULT | AST_SOCKADDR_STR_REMOTE)
161 #define AST_SOCKADDR_STR_FORMAT_MASK (AST_SOCKADDR_STR_ADDR | AST_SOCKADDR_STR_PORT | AST_SOCKADDR_STR_BRACKETS)
167 * Convert a socket address to a string.
170 * This will be of the form a.b.c.d:xyz
171 * for IPv4 and [a:b:c:...:d]:xyz for IPv6.
173 * This function is thread-safe. The returned string is on static
174 * thread-specific storage.
176 * \param addr The input to be stringified
177 * \param format one of the following:
178 * AST_SOCKADDR_STR_DEFAULT:
179 * a.b.c.d:xyz for IPv4
180 * [a:b:c:...:d]:xyz for IPv6.
181 * AST_SOCKADDR_STR_ADDR: address only
183 * a:b:c:...:d for IPv6.
184 * AST_SOCKADDR_STR_HOST: address only, suitable for a URL
186 * [a:b:c:...:d] for IPv6.
187 * AST_SOCKADDR_STR_PORT: port only
189 * \note The string pointer returned by this function will point to a string that
190 * will be changed whenever any form of ast_sockaddr_stringify_fmt is called on that
191 * thread. Because of this, it is important that if you use this function, you use the
192 * string before another use of this function is made elsewhere in the same thread.
193 * The easiest way to accomplish this is by immediately copying the string to a buffer
194 * with something like ast_strdupa.
196 * \retval "(null)" \a addr is null
197 * \retval "" An error occurred during processing
198 * \retval string The stringified form of the address
200 char *ast_sockaddr_stringify_fmt(const struct ast_sockaddr *addr, int format);
206 * Wrapper around ast_sockaddr_stringify_fmt() with default format
208 * \return same as ast_sockaddr_stringify_fmt()
210 static inline char *ast_sockaddr_stringify(const struct ast_sockaddr *addr)
212 return ast_sockaddr_stringify_fmt(addr, AST_SOCKADDR_STR_DEFAULT);
219 * Wrapper around ast_sockaddr_stringify_fmt() with default format
221 * \note This address will be suitable for passing to a remote machine via the
222 * application layer. For example, the scope-id on a link-local IPv6 address
225 * \return same as ast_sockaddr_stringify_fmt()
227 static inline char *ast_sockaddr_stringify_remote(const struct ast_sockaddr *addr)
229 return ast_sockaddr_stringify_fmt(addr, AST_SOCKADDR_STR_DEFAULT_REMOTE);
236 * Wrapper around ast_sockaddr_stringify_fmt() to return an address only
238 * \return same as ast_sockaddr_stringify_fmt()
240 static inline char *ast_sockaddr_stringify_addr(const struct ast_sockaddr *addr)
242 return ast_sockaddr_stringify_fmt(addr, AST_SOCKADDR_STR_ADDR);
249 * Wrapper around ast_sockaddr_stringify_fmt() to return an address only
251 * \note This address will be suitable for passing to a remote machine via the
252 * application layer. For example, the scope-id on a link-local IPv6 address
255 * \return same as ast_sockaddr_stringify_fmt()
257 static inline char *ast_sockaddr_stringify_addr_remote(const struct ast_sockaddr *addr)
259 return ast_sockaddr_stringify_fmt(addr, AST_SOCKADDR_STR_ADDR_REMOTE);
266 * Wrapper around ast_sockaddr_stringify_fmt() to return an address only,
267 * suitable for a URL (with brackets for IPv6).
269 * \return same as ast_sockaddr_stringify_fmt()
271 static inline char *ast_sockaddr_stringify_host(const struct ast_sockaddr *addr)
273 return ast_sockaddr_stringify_fmt(addr, AST_SOCKADDR_STR_HOST);
280 * Wrapper around ast_sockaddr_stringify_fmt() to return an address only,
281 * suitable for a URL (with brackets for IPv6).
283 * \note This address will be suitable for passing to a remote machine via the
284 * application layer. For example, the scope-id on a link-local IPv6 address
287 * \return same as ast_sockaddr_stringify_fmt()
289 static inline char *ast_sockaddr_stringify_host_remote(const struct ast_sockaddr *addr)
291 return ast_sockaddr_stringify_fmt(addr, AST_SOCKADDR_STR_HOST_REMOTE);
298 * Wrapper around ast_sockaddr_stringify_fmt() to return a port only
300 * \return same as ast_sockaddr_stringify_fmt()
302 static inline char *ast_sockaddr_stringify_port(const struct ast_sockaddr *addr)
304 return ast_sockaddr_stringify_fmt(addr, AST_SOCKADDR_STR_PORT);
311 * Splits a string into its host and port components
313 * \param str[in] The string to parse. May be modified by writing a NUL at the end of
315 * \param host[out] Pointer to the host component within \a str.
316 * \param port[out] Pointer to the port component within \a str.
317 * \param flags If set to zero, a port MAY be present. If set to PARSE_PORT_IGNORE, a
318 * port MAY be present but will be ignored. If set to PARSE_PORT_REQUIRE,
319 * a port MUST be present. If set to PARSE_PORT_FORBID, a port MUST NOT
325 int ast_sockaddr_split_hostport(char *str, char **host, char **port, int flags);
331 * Parse an IPv4 or IPv6 address string.
334 * Parses a string containing an IPv4 or IPv6 address followed by an optional
335 * port (separated by a colon) into a struct ast_sockaddr. The allowed formats
344 * Host names are NOT allowed.
346 * \param[out] addr The resulting ast_sockaddr. This MAY be NULL from
347 * functions that are performing validity checks only, e.g. ast_parse_arg().
348 * \param str The string to parse
349 * \param flags If set to zero, a port MAY be present. If set to
350 * PARSE_PORT_IGNORE, a port MAY be present but will be ignored. If set to
351 * PARSE_PORT_REQUIRE, a port MUST be present. If set to PARSE_PORT_FORBID, a
352 * port MUST NOT be present.
357 int ast_sockaddr_parse(struct ast_sockaddr *addr, const char *str, int flags);
363 * Parses a string with an IPv4 or IPv6 address and place results into an array
366 * Parses a string containing a host name or an IPv4 or IPv6 address followed
367 * by an optional port (separated by a colon). The result is returned into a
368 * array of struct ast_sockaddr. Allowed formats for str are the following:
371 * host.example.com:port
378 * \param[out] addrs The resulting array of ast_sockaddrs
379 * \param str The string to parse
380 * \param flags If set to zero, a port MAY be present. If set to
381 * PARSE_PORT_IGNORE, a port MAY be present but will be ignored. If set to
382 * PARSE_PORT_REQUIRE, a port MUST be present. If set to PARSE_PORT_FORBID, a
383 * port MUST NOT be present.
385 * \param family Only addresses of the given family will be returned. Use 0 or
386 * AST_AF_UNSPEC to get addresses of all families.
389 * \retval non-zero The number of elements in addrs array.
391 int ast_sockaddr_resolve(struct ast_sockaddr **addrs, const char *str,
392 int flags, int family);
398 * Get the port number of a socket address.
400 * \warning Do not use this function unless you really know what you are doing.
401 * And "I want the port number" is not knowing what you are doing.
403 * \retval 0 Address is null
404 * \retval non-zero The port number of the ast_sockaddr
406 #define ast_sockaddr_port(addr) _ast_sockaddr_port(addr, __FILE__, __LINE__, __PRETTY_FUNCTION__)
407 uint16_t _ast_sockaddr_port(const struct ast_sockaddr *addr, const char *file, int line, const char *func);
413 * Sets the port number of a socket address.
415 * \warning Do not use this function unless you really know what you are doing.
416 * And "I want the port number" is not knowing what you are doing.
418 * \param addr Address on which to set the port
419 * \param port The port you wish to set the address to use
422 #define ast_sockaddr_set_port(addr,port) _ast_sockaddr_set_port(addr,port,__FILE__,__LINE__,__PRETTY_FUNCTION__)
423 void _ast_sockaddr_set_port(struct ast_sockaddr *addr, uint16_t port, const char *file, int line, const char *func);
429 * Get an IPv4 address of an ast_sockaddr
431 * \warning You should rarely need this function. Only use if you know what
433 * \return IPv4 address in network byte order
435 uint32_t ast_sockaddr_ipv4(const struct ast_sockaddr *addr);
441 * Determine if the address is an IPv4 address
443 * \warning You should rarely need this function. Only use if you know what
445 * \retval 1 This is an IPv4 address
446 * \retval 0 This is an IPv6 or IPv4-mapped IPv6 address
448 int ast_sockaddr_is_ipv4(const struct ast_sockaddr *addr);
454 * Determine if this is an IPv4-mapped IPv6 address
456 * \warning You should rarely need this function. Only use if you know what
459 * \retval 1 This is an IPv4-mapped IPv6 address.
460 * \retval 0 This is not an IPv4-mapped IPv6 address.
462 int ast_sockaddr_is_ipv4_mapped(const struct ast_sockaddr *addr);
468 * Determine if an IPv4 address is a multicast address
470 * \parm addr the address to check
472 * This function checks if an address is in the 224.0.0.0/4 network block.
474 * \return non-zero if this is a multicast address
476 int ast_sockaddr_is_ipv4_multicast(const struct ast_sockaddr *addr);
482 * Determine if this is a link-local IPv6 address
484 * \warning You should rarely need this function. Only use if you know what
487 * \retval 1 This is a link-local IPv6 address.
488 * \retval 0 This is link-local IPv6 address.
490 int ast_sockaddr_is_ipv6_link_local(const struct ast_sockaddr *addr);
496 * Determine if this is an IPv6 address
498 * \warning You should rarely need this function. Only use if you know what
501 * \retval 1 This is an IPv6 or IPv4-mapped IPv6 address.
502 * \retval 0 This is an IPv4 address.
504 int ast_sockaddr_is_ipv6(const struct ast_sockaddr *addr);
510 * Determine if the address type is unspecified, or "any" address.
513 * For IPv4, this would be the address 0.0.0.0, and for IPv6,
514 * this would be the address ::. The port number is ignored.
516 * \retval 1 This is an "any" address
517 * \retval 0 This is not an "any" address
519 int ast_sockaddr_is_any(const struct ast_sockaddr *addr);
525 * Computes a hash value from the address. The port is ignored.
527 * \retval 0 Unknown address family
528 * \retval other A 32-bit hash derived from the address
530 int ast_sockaddr_hash(const struct ast_sockaddr *addr);
536 * Wrapper around accept(2) that uses struct ast_sockaddr.
539 * For parameter and return information, see the man page for
542 int ast_accept(int sockfd, struct ast_sockaddr *addr);
548 * Wrapper around bind(2) that uses struct ast_sockaddr.
551 * For parameter and return information, see the man page for
554 int ast_bind(int sockfd, const struct ast_sockaddr *addr);
560 * Wrapper around connect(2) that uses struct ast_sockaddr.
563 * For parameter and return information, see the man page for
566 int ast_connect(int sockfd, const struct ast_sockaddr *addr);
572 * Wrapper around getsockname(2) that uses struct ast_sockaddr.
575 * For parameter and return information, see the man page for
578 int ast_getsockname(int sockfd, struct ast_sockaddr *addr);
584 * Wrapper around recvfrom(2) that uses struct ast_sockaddr.
587 * For parameter and return information, see the man page for
590 ssize_t ast_recvfrom(int sockfd, void *buf, size_t len, int flags,
591 struct ast_sockaddr *src_addr);
597 * Wrapper around sendto(2) that uses ast_sockaddr.
601 * return information, see the man page for sendto(2)
603 ssize_t ast_sendto(int sockfd, const void *buf, size_t len, int flags,
604 const struct ast_sockaddr *dest_addr);
610 * Set type of service
613 * Set ToS ("Type of Service for IPv4 and "Traffic Class for IPv6) and
614 * CoS (Linux's SO_PRIORITY)
616 * \param sockfd File descriptor for socket on which to set the parameters
617 * \param tos The type of service for the socket
618 * \param cos The cost of service for the socket
619 * \param desc A text description of the socket in question.
621 * \retval -1 Error, with errno set to an appropriate value
623 int ast_set_qos(int sockfd, int tos, int cos, const char *desc);
626 * These are backward compatibility functions that may be used by subsystems
627 * that have not yet been converted to IPv6. They will be removed when all
628 * subsystems are IPv6-ready.
636 * Converts a struct ast_sockaddr to a struct sockaddr_in.
638 * \param addr The ast_sockaddr to convert
639 * \param[out] sin The resulting sockaddr_in struct
640 * \retval nonzero Success
641 * \retval zero Failure
643 #define ast_sockaddr_to_sin(addr,sin) _ast_sockaddr_to_sin(addr,sin, __FILE__, __LINE__, __PRETTY_FUNCTION__)
644 int _ast_sockaddr_to_sin(const struct ast_sockaddr *addr,
645 struct sockaddr_in *sin, const char *file, int line, const char *func);
651 * Converts a struct sockaddr_in to a struct ast_sockaddr.
653 * \param sin The sockaddr_in to convert
654 * \return an ast_sockaddr structure
656 #define ast_sockaddr_from_sin(addr,sin) _ast_sockaddr_from_sin(addr,sin, __FILE__, __LINE__, __PRETTY_FUNCTION__)
657 void _ast_sockaddr_from_sin(struct ast_sockaddr *addr, const struct sockaddr_in *sin,
658 const char *file, int line, const char *func);
662 #if defined(__cplusplus) || defined(c_plusplus)
666 #endif /* _ASTERISK_NETSOCK2_H */