su  1.12.11devel
 All Data Structures Files Functions Variables Typedefs Enumerator Macros Groups Pages
su.h
Go to the documentation of this file.
1 /*
2  * This file is part of the Sofia-SIP package
3  *
4  * Copyright (C) 2005,2006,2007 Nokia Corporation.
5  *
6  * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation; either version 2.1 of
11  * the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21  * 02110-1301 USA
22  *
23  */
24 
25 #ifndef SU_H
26 
27 #define SU_H
28 
36 /* ---------------------------------------------------------------------- */
37 /* Includes */
38 
39 #ifndef SU_CONFIG_H
40 #include <sofia-sip/su_config.h>
41 #endif
42 #ifndef SU_TYPES_H
43 #include <sofia-sip/su_types.h>
44 #endif
45 #ifndef SU_ERRNO_H
46 #include <sofia-sip/su_errno.h>
47 #endif
48 
49 #include <stdio.h>
50 #include <limits.h>
51 
52 #if SU_HAVE_BSDSOCK /* Unix-compatible includes */
53 #include <errno.h>
54 #include <unistd.h>
55 
56 #include <fcntl.h>
57 #include <sys/types.h>
58 #include <sys/socket.h>
59 #include <sys/ioctl.h>
60 
61 #include <netinet/in.h>
62 #include <arpa/inet.h>
63 #include <netdb.h>
64 #endif
65 
66 #if SU_HAVE_WINSOCK /* Windows includes */
67 # include <winsock2.h>
68 # include <ws2tcpip.h>
69 # if SU_HAVE_IN6
70 # if defined(IPPROTO_IPV6) || (_WIN32_WINNT >= 0x0501)
71 /* case 1: IPv6 defined in winsock2.h/ws2tcpip.h */
72 # else
73 /* case 2: try to use "IPv6 Tech Preview" */
74 # include <tpipv6.h>
75 # endif
76 # endif
77 #endif
78 
79 SOFIA_BEGIN_DECLS
80 
81 /* ---------------------------------------------------------------------- */
82 /* Constant definitions */
83 
84 #if SU_HAVE_BSDSOCK || DOCUMENTATION_ONLY
85 enum {
87  INVALID_SOCKET = -1,
88 #define INVALID_SOCKET ((su_socket_t)INVALID_SOCKET)
89 
90  SOCKET_ERROR = -1,
91 #define SOCKET_ERROR SOCKET_ERROR
92 
93  su_success = 0,
95  su_failure = -1
96 };
97 #if SYMBIAN && !defined(MSG_NOSIGNAL)
98 #define MSG_NOSIGNAL (0)
99 #endif
100 #elif SU_HAVE_WINSOCK
101 enum {
102  su_success = 0,
103  su_failure = 0xffffffffUL
104 };
105 
106 #define MSG_NOSIGNAL (0)
107 
108 #endif
109 
111 #define SU_MAXHOST (1025)
112 
113 #define SU_MAXSERV (25)
114 
116 #define SU_ADDRSIZE (48)
117 
118 #define SU_SERVSIZE (16)
119 
120 #define SU_SUCCESS su_success
121 #define SU_FAILURE su_failure
122 
123 /* ---------------------------------------------------------------------- */
124 /* Type definitions */
125 
127 #if SU_HAVE_BSDSOCK || DOCUMENTATION_ONLY
128 typedef int su_socket_t;
129 #elif SU_HAVE_WINSOCK
130 typedef SOCKET su_socket_t;
131 #endif
132 
133 #if !SU_HAVE_SOCKADDR_STORAGE
134 /*
135  * RFC 2553: protocol-independent placeholder for socket addresses
136  */
137 #define _SS_MAXSIZE 128
138 #define _SS_ALIGNSIZE (sizeof(int64_t))
139 #define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(u_char) * 2)
140 #define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(u_char) * 2 - \
141  _SS_PAD1SIZE - _SS_ALIGNSIZE)
142 
143 struct sockaddr_storage {
144 #if SU_HAVE_SOCKADDR_SA_LEN
145  unsigned char ss_len; /* address length */
146  unsigned char ss_family; /* address family */
147 #else
148  unsigned short ss_family; /* address family */
149 #endif
150  char __ss_pad1[_SS_PAD1SIZE];
151  int64_t __ss_align; /* force desired structure storage alignment */
152  char __ss_pad2[_SS_PAD2SIZE];
153 };
154 #endif
155 
157 union su_sockaddr_u {
158 #ifdef DOCUMENTATION_ONLY
159  uint8_t su_len;
160  uint8_t su_family;
161  uint16_t su_port;
162 #else
163  short su_dummy;
164 #if SU_HAVE_SOCKADDR_SA_LEN
165 #define su_len su_sa.sa_len
166 #else
167 #define su_len su_array[0]
168 #endif
169 #define su_family su_sa.sa_family
170 #define su_port su_sin.sin_port
171 #endif
172 
173  char su_array[32];
174  uint16_t su_array16[16];
175  uint32_t su_array32[8];
176  struct sockaddr su_sa;
177  struct sockaddr_in su_sin;
178 #if SU_HAVE_IN6
179  struct sockaddr_in6 su_sin6;
180 #endif
181 #ifdef DOCUMENTATION_ONLY
182  uint32_t su_scope_id;
183 #else
184 #define su_scope_id su_array32[6]
185 #endif
186 };
187 
188 typedef union su_sockaddr_u su_sockaddr_t;
189 
190 #if SU_HAVE_BSDSOCK || DOCUMENTATION_ONLY
191 
201 typedef size_t su_ioveclen_t;
202 
239 typedef struct su_iovec_s {
240  void *siv_base;
241  su_ioveclen_t siv_len;
242 } su_iovec_t;
243 
250 #define SU_IOVECLEN_MAX SIZE_MAX
251 #endif
252 
253 #if SU_HAVE_WINSOCK
254 typedef u_long su_ioveclen_t;
255 
256 /* This is same as WSABUF */
257 typedef struct su_iovec_s {
258  su_ioveclen_t siv_len;
259  void *siv_base;
260 } su_iovec_t;
261 
262 #define SU_IOVECLEN_MAX ULONG_MAX
263 #endif
264 
265 /* ---------------------------------------------------------------------- */
266 /* Socket compatibility functions */
267 
268 SOFIAPUBFUN int su_init(void);
269 SOFIAPUBFUN void su_deinit(void);
270 
272 SOFIAPUBFUN su_socket_t su_socket(int af, int sock, int proto);
274 SOFIAPUBFUN int su_close(su_socket_t s);
276 SOFIAPUBFUN int su_ioctl(su_socket_t s, int request, ...);
277 
287 SOFIAPUBFUN int su_is_blocking(int errcode);
288 
290 SOFIAPUBFUN int su_setblocking(su_socket_t s, int blocking);
292 SOFIAPUBFUN int su_setreuseaddr(su_socket_t s, int reuse);
294 SOFIAPUBFUN int su_soerror(su_socket_t s);
296 SOFIAPUBFUN int su_getsocktype(su_socket_t s);
297 
299 SOFIAPUBFUN issize_t su_getmsgsize(su_socket_t s);
300 
302 SOFIAPUBFUN
303 issize_t su_vsend(su_socket_t, su_iovec_t const iov[], isize_t len, int flags,
304  su_sockaddr_t const *su, socklen_t sulen);
306 SOFIAPUBFUN
307 issize_t su_vrecv(su_socket_t, su_iovec_t iov[], isize_t len, int flags,
308  su_sockaddr_t *su, socklen_t *sulen);
310 SOFIAPUBFUN int su_getlocalip(su_sockaddr_t *sin);
311 
312 #if SU_HAVE_BSDSOCK
313 #define su_ioctl ioctl
314 /*
315  * Note: before 1.12.2, there was su_isblocking() which did not take argument
316  * and which was missing from WINSOCK
317  */
318 #define su_is_blocking(e) \
319  ((e) == EINPROGRESS || (e) == EAGAIN || (e) == EWOULDBLOCK)
320 #endif
321 
322 #if SU_HAVE_WINSOCK
323 SOFIAPUBFUN int su_inet_pton(int af, char const *src, void *dst);
324 SOFIAPUBFUN const char *su_inet_ntop(int af, void const *src,
325  char *dst, size_t size);
326 SOFIAPUBFUN ssize_t
327  su_send(su_socket_t s, void *buffer, size_t length, int flags),
328  su_sendto(su_socket_t s, void *buffer, size_t length, int flags,
329  su_sockaddr_t const *to, socklen_t tolen),
330  su_recv(su_socket_t s, void *buffer, size_t length, int flags),
331  su_recvfrom(su_socket_t s, void *buffer, size_t length, int flags,
332  su_sockaddr_t *from, socklen_t *fromlen);
333 
334 static __inline
335 uint16_t su_ntohs(uint16_t s)
336 {
337  return (uint16_t)(((s & 255) << 8) | ((s & 0xff00) >> 8));
338 }
339 
340 static __inline
341 uint32_t su_ntohl(uint32_t l)
342 {
343  return ((l & 0xff) << 24) | ((l & 0xff00) << 8)
344  | ((l & 0xff0000) >> 8) | ((l & 0xff000000U) >> 24);
345 }
346 
347 #define ntohs su_ntohs
348 #define htons su_ntohs
349 #define ntohl su_ntohl
350 #define htonl su_ntohl
351 
352 #else
353 #define su_inet_pton inet_pton
354 #define su_inet_ntop inet_ntop
355 #define su_send(s,b,l,f) send((s),(b),(l),(f))
356 #define su_sendto(s,b,l,f,a,L) sendto((s),(b),(l),(f),(void const*)(a),(L))
357 #define su_recv(s,b,l,f) recv((s),(b),(l),(f))
358 #define su_recvfrom(s,b,l,f,a,L) recvfrom((s),(b),(l),(f),(void *)(a),(L))
359 #endif
360 
361 /* ---------------------------------------------------------------------- */
362 /* Other compatibility stuff */
363 
364 #if SU_HAVE_WINSOCK
365 #define getuid() (0x505)
366 #endif
367 
368 #ifndef IPPROTO_SCTP
369 #define IPPROTO_SCTP (132)
370 #endif
371 
372 /* ---------------------------------------------------------------------- */
373 /* Address manipulation macros */
374 
380 #if SU_HAVE_IN6
381 #define SU_ADDR(su) \
382  ((su)->su_family == AF_INET ? (void *)&(su)->su_sin.sin_addr : \
383  ((su)->su_family == AF_INET6 ? (void *)&(su)->su_sin6.sin6_addr : \
384  (void *)&(su)->su_sa.sa_data))
385 #else
386 #define SU_ADDR(su) \
387  ((su)->su_family == AF_INET ? (void *)&(su)->su_sin.sin_addr : \
388  (void *)&(su)->su_sa.sa_data)
389 #endif
390 
396 #if SU_HAVE_IN6
397 #define SU_ADDRLEN(su) \
398  ((su)->su_family == AF_INET \
399  ? (socklen_t)sizeof((su)->su_sin.sin_addr) : \
400  ((su)->su_family == AF_INET6 \
401  ? (socklen_t)sizeof((su)->su_sin6.sin6_addr) \
402  : (socklen_t)sizeof((su)->su_sa.sa_data)))
403 #else
404 #define SU_ADDRLEN(su) \
405  ((su)->su_family == AF_INET \
406  ? (socklen_t)sizeof((su)->su_sin.sin_addr) \
407  : (socklen_t)sizeof((su)->su_sa.sa_data))