Clear up a documentation confusion noticed by Xiaoyun Wu
[p5sagit/p5-mst-13.2.git] / ext / Socket / Socket.xs
1 #define PERL_NO_GET_CONTEXT
2 #include "EXTERN.h"
3 #include "perl.h"
4 #include "XSUB.h"
5
6 #ifndef VMS
7 # ifdef I_SYS_TYPES
8 #  include <sys/types.h>
9 # endif
10 # include <sys/socket.h>
11 # if defined(USE_SOCKS) && defined(I_SOCKS)
12 #   include <socks.h>
13 # endif
14 # ifdef MPE
15 #  define PF_INET AF_INET
16 #  define PF_UNIX AF_UNIX
17 #  define SOCK_RAW 3
18 # endif
19 # ifdef I_SYS_UN
20 #  include <sys/un.h>
21 # endif
22 /* XXX Configure test for <netinet/in_systm.h needed XXX */
23 # if defined(NeXT) || defined(__NeXT__)
24 #  include <netinet/in_systm.h>
25 # endif
26 # ifdef I_NETINET_IN
27 #  include <netinet/in.h>
28 # endif
29 # ifdef I_NETDB
30 #  include <netdb.h>
31 # endif
32 # ifdef I_ARPA_INET
33 #  include <arpa/inet.h>
34 # endif
35 # ifdef I_NETINET_TCP
36 #  include <netinet/tcp.h>
37 # endif
38 #else
39 # include "sockadapt.h"
40 #endif
41
42 #ifdef NETWARE
43 NETDB_DEFINE_CONTEXT
44 NETINET_DEFINE_CONTEXT
45 #endif
46
47 #ifdef I_SYSUIO
48 # include <sys/uio.h>
49 #endif
50
51 #ifndef AF_NBS
52 # undef PF_NBS
53 #endif
54
55 #ifndef AF_X25
56 # undef PF_X25
57 #endif
58
59 #ifndef INADDR_NONE
60 # define INADDR_NONE    0xffffffff
61 #endif /* INADDR_NONE */
62 #ifndef INADDR_BROADCAST
63 # define INADDR_BROADCAST       0xffffffff
64 #endif /* INADDR_BROADCAST */
65 #ifndef INADDR_LOOPBACK
66 # define INADDR_LOOPBACK         0x7F000001
67 #endif /* INADDR_LOOPBACK */
68
69 #ifndef HAS_INET_ATON
70
71 /*
72  * Check whether "cp" is a valid ascii representation
73  * of an Internet address and convert to a binary address.
74  * Returns 1 if the address is valid, 0 if not.
75  * This replaces inet_addr, the return value from which
76  * cannot distinguish between failure and a local broadcast address.
77  */
78 static int
79 my_inet_aton(register const char *cp, struct in_addr *addr)
80 {
81         dTHX;
82         register U32 val;
83         register int base;
84         register char c;
85         int nparts;
86         const char *s;
87         unsigned int parts[4];
88         register unsigned int *pp = parts;
89
90         if (!cp)
91                 return 0;
92         for (;;) {
93                 /*
94                  * Collect number up to ``.''.
95                  * Values are specified as for C:
96                  * 0x=hex, 0=octal, other=decimal.
97                  */
98                 val = 0; base = 10;
99                 if (*cp == '0') {
100                         if (*++cp == 'x' || *cp == 'X')
101                                 base = 16, cp++;
102                         else
103                                 base = 8;
104                 }
105                 while ((c = *cp) != '\0') {
106                         if (isDIGIT(c)) {
107                                 val = (val * base) + (c - '0');
108                                 cp++;
109                                 continue;
110                         }
111                         if (base == 16 && (s=strchr(PL_hexdigit,c))) {
112                                 val = (val << 4) +
113                                         ((s - PL_hexdigit) & 15);
114                                 cp++;
115                                 continue;
116                         }
117                         break;
118                 }
119                 if (*cp == '.') {
120                         /*
121                          * Internet format:
122                          *      a.b.c.d
123                          *      a.b.c   (with c treated as 16-bits)
124                          *      a.b     (with b treated as 24 bits)
125                          */
126                         if (pp >= parts + 3 || val > 0xff)
127                                 return 0;
128                         *pp++ = val, cp++;
129                 } else
130                         break;
131         }
132         /*
133          * Check for trailing characters.
134          */
135         if (*cp && !isSPACE(*cp))
136                 return 0;
137         /*
138          * Concoct the address according to
139          * the number of parts specified.
140          */
141         nparts = pp - parts + 1;        /* force to an int for switch() */
142         switch (nparts) {
143
144         case 1:                         /* a -- 32 bits */
145                 break;
146
147         case 2:                         /* a.b -- 8.24 bits */
148                 if (val > 0xffffff)
149                         return 0;
150                 val |= parts[0] << 24;
151                 break;
152
153         case 3:                         /* a.b.c -- 8.8.16 bits */
154                 if (val > 0xffff)
155                         return 0;
156                 val |= (parts[0] << 24) | (parts[1] << 16);
157                 break;
158
159         case 4:                         /* a.b.c.d -- 8.8.8.8 bits */
160                 if (val > 0xff)
161                         return 0;
162                 val |= (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8);
163                 break;
164         }
165         addr->s_addr = htonl(val);
166         return 1;
167 }
168
169 #undef inet_aton
170 #define inet_aton my_inet_aton
171
172 #endif /* ! HAS_INET_ATON */
173
174
175 static int
176 not_here(char *s)
177 {
178     croak("Socket::%s not implemented on this architecture", s);
179     return -1;
180 }
181
182 #include "constants.c"
183
184 MODULE = Socket         PACKAGE = Socket
185
186 INCLUDE: constants.xs
187
188 void
189 inet_aton(host)
190         char *  host
191         CODE:
192         {
193         struct in_addr ip_address;
194         struct hostent * phe;
195         int ok = inet_aton(host, &ip_address);
196
197         if (!ok && (phe = gethostbyname(host))) {
198                 Copy( phe->h_addr, &ip_address, phe->h_length, char );
199                 ok = 1;
200         }
201
202         ST(0) = sv_newmortal();
203         if (ok) {
204                 sv_setpvn( ST(0), (char *)&ip_address, sizeof ip_address );
205         }
206         }
207
208 void
209 inet_ntoa(ip_address_sv)
210         SV *    ip_address_sv
211         CODE:
212         {
213         STRLEN addrlen;
214         struct in_addr addr;
215         char * addr_str;
216         char * ip_address = SvPV(ip_address_sv,addrlen);
217         if (addrlen != sizeof(addr)) {
218             croak("Bad arg length for %s, length is %d, should be %d",
219                         "Socket::inet_ntoa",
220                         addrlen, sizeof(addr));
221         }
222
223         Copy( ip_address, &addr, sizeof addr, char );
224 #if defined(__hpux) && defined(__GNUC__) && defined(USE_64_BIT_INT)
225         /* GCC on HP_UX breaks the call to inet_ntoa, // sky*/
226         addr_str = (char *) malloc(16);
227         sprintf(addr_str, "%d.%d.%d.%d", ((addr.s_addr >> 24) & 0xFF) , ((addr.s_addr >> 16) & 0xFF), ((addr.s_addr >> 8) & 0xFF), (addr.s_addr  & 0xFF));
228 #else
229         addr_str = inet_ntoa(addr);
230 #endif
231         ST(0) = sv_2mortal(newSVpvn(addr_str, strlen(addr_str)));
232         }
233
234 void
235 pack_sockaddr_un(pathname)
236         char *  pathname
237         CODE:
238         {
239 #ifdef I_SYS_UN
240         struct sockaddr_un sun_ad; /* fear using sun */
241         STRLEN len;
242
243         Zero( &sun_ad, sizeof sun_ad, char );
244         sun_ad.sun_family = AF_UNIX;
245         len = strlen(pathname);
246         if (len > sizeof(sun_ad.sun_path))
247             len = sizeof(sun_ad.sun_path);
248 #  ifdef OS2    /* Name should start with \socket\ and contain backslashes! */
249         {
250             int off;
251             char *s, *e;
252
253             if (pathname[0] != '/' && pathname[0] != '\\')
254                 croak("Relative UNIX domain socket name '%s' unsupported", pathname);
255             else if (len < 8
256                      || pathname[7] != '/' && pathname[7] != '\\'
257                      || !strnicmp(pathname + 1, "socket", 6))
258                 off = 7;
259             else
260                 off = 0;                /* Preserve names starting with \socket\ */
261             Copy( "\\socket", sun_ad.sun_path, off, char);
262             Copy( pathname, sun_ad.sun_path + off, len, char );
263
264             s = sun_ad.sun_path + off - 1;
265             e = s + len + 1;
266             while (++s < e)
267                 if (*s = '/')
268                     *s = '\\';
269         }
270 #  else /* !( defined OS2 ) */
271         Copy( pathname, sun_ad.sun_path, len, char );
272 #  endif
273         if (0) not_here("dummy");
274         ST(0) = sv_2mortal(newSVpvn((char *)&sun_ad, sizeof sun_ad));
275 #else
276         ST(0) = (SV *) not_here("pack_sockaddr_un");
277 #endif
278         
279         }
280
281 void
282 unpack_sockaddr_un(sun_sv)
283         SV *    sun_sv
284         CODE:
285         {
286 #ifdef I_SYS_UN
287         struct sockaddr_un addr;
288         STRLEN sockaddrlen;
289         char * sun_ad = SvPV(sun_sv,sockaddrlen);
290         char * e;
291 #   ifndef __linux__
292         /* On Linux sockaddrlen on sockets returned by accept, recvfrom,
293            getpeername and getsockname is not equal to sizeof(addr). */
294         if (sockaddrlen != sizeof(addr)) {
295             croak("Bad arg length for %s, length is %d, should be %d",
296                         "Socket::unpack_sockaddr_un",
297                         sockaddrlen, sizeof(addr));
298         }
299 #   endif
300
301         Copy( sun_ad, &addr, sizeof addr, char );
302
303         if ( addr.sun_family != AF_UNIX ) {
304             croak("Bad address family for %s, got %d, should be %d",
305                         "Socket::unpack_sockaddr_un",
306                         addr.sun_family,
307                         AF_UNIX);
308         }
309         e = addr.sun_path;
310         while (*e && e < addr.sun_path + sizeof addr.sun_path)
311             ++e;
312         ST(0) = sv_2mortal(newSVpvn(addr.sun_path, e - addr.sun_path));
313 #else
314         ST(0) = (SV *) not_here("unpack_sockaddr_un");
315 #endif
316         }
317
318 void
319 pack_sockaddr_in(port,ip_address)
320         unsigned short  port
321         char *  ip_address
322         CODE:
323         {
324         struct sockaddr_in sin;
325
326         Zero( &sin, sizeof sin, char );
327         sin.sin_family = AF_INET;
328         sin.sin_port = htons(port);
329         Copy( ip_address, &sin.sin_addr, sizeof sin.sin_addr, char );
330
331         ST(0) = sv_2mortal(newSVpvn((char *)&sin, sizeof sin));
332         }
333
334 void
335 unpack_sockaddr_in(sin_sv)
336         SV *    sin_sv
337         PPCODE:
338         {
339         STRLEN sockaddrlen;
340         struct sockaddr_in addr;
341         unsigned short  port;
342         struct in_addr  ip_address;
343         char *  sin = SvPV(sin_sv,sockaddrlen);
344         if (sockaddrlen != sizeof(addr)) {
345             croak("Bad arg length for %s, length is %d, should be %d",
346                         "Socket::unpack_sockaddr_in",
347                         sockaddrlen, sizeof(addr));
348         }
349         Copy( sin, &addr,sizeof addr, char );
350         if ( addr.sin_family != AF_INET ) {
351             croak("Bad address family for %s, got %d, should be %d",
352                         "Socket::unpack_sockaddr_in",
353                         addr.sin_family,
354                         AF_INET);
355         }
356         port = ntohs(addr.sin_port);
357         ip_address = addr.sin_addr;
358
359         EXTEND(SP, 2);
360         PUSHs(sv_2mortal(newSViv((IV) port)));
361         PUSHs(sv_2mortal(newSVpvn((char *)&ip_address,sizeof ip_address)));
362         }