2429893fc37d92705ec6e55125ec5b20ddf0fed9
1 /* Copyright (C) 1996,1997,1998,2000,2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include "libguile/_scm.h"
29 #include "libguile/unif.h"
30 #include "libguile/feature.h"
31 #include "libguile/fports.h"
32 #include "libguile/strings.h"
33 #include "libguile/vectors.h"
34 #include "libguile/dynwind.h"
36 #include "libguile/validate.h"
37 #include "libguile/socket.h"
40 #include "win32-socket.h"
52 #include <sys/types.h>
53 #ifdef HAVE_WINSOCK2_H
56 #include <sys/socket.h>
57 #ifdef HAVE_UNIX_DOMAIN_SOCKETS
60 #include <netinet/in.h>
62 #include <arpa/inet.h>
65 #if defined (HAVE_UNIX_DOMAIN_SOCKETS) && !defined (SUN_LEN)
66 #define SUN_LEN(ptr) ((size_t) (((struct sockaddr_un *) 0)->sun_path) \
67 + strlen ((ptr)->sun_path))
70 /* we are not currently using socklen_t. it's not defined on all systems,
71 so would need to be checked by configure. in the meantime, plain
72 int is the best alternative. */
76 SCM_DEFINE (scm_htons
, "htons", 1, 0, 0,
78 "Convert a 16 bit quantity from host to network byte ordering.\n"
79 "@var{value} is packed into 2 bytes, which are then converted\n"
80 "and returned as a new integer.")
81 #define FUNC_NAME s_scm_htons
83 return scm_from_ushort (htons (scm_to_ushort (value
)));
87 SCM_DEFINE (scm_ntohs
, "ntohs", 1, 0, 0,
89 "Convert a 16 bit quantity from network to host byte ordering.\n"
90 "@var{value} is packed into 2 bytes, which are then converted\n"
91 "and returned as a new integer.")
92 #define FUNC_NAME s_scm_ntohs
94 return scm_from_ushort (ntohs (scm_to_ushort (value
)));
98 SCM_DEFINE (scm_htonl
, "htonl", 1, 0, 0,
100 "Convert a 32 bit quantity from host to network byte ordering.\n"
101 "@var{value} is packed into 4 bytes, which are then converted\n"
102 "and returned as a new integer.")
103 #define FUNC_NAME s_scm_htonl
105 scm_t_uint32 c_in
= SCM_NUM2ULONG (1, value
);
107 return scm_from_ulong (htonl (c_in
));
111 SCM_DEFINE (scm_ntohl
, "ntohl", 1, 0, 0,
113 "Convert a 32 bit quantity from network to host byte ordering.\n"
114 "@var{value} is packed into 4 bytes, which are then converted\n"
115 "and returned as a new integer.")
116 #define FUNC_NAME s_scm_ntohl
118 scm_t_uint32 c_in
= SCM_NUM2ULONG (1, value
);
120 return scm_from_ulong (ntohl (c_in
));
124 #ifndef HAVE_INET_ATON
125 /* for our definition in inet_aton.c, not usually needed. */
126 extern int inet_aton ();
129 SCM_DEFINE (scm_inet_aton
, "inet-aton", 1, 0, 0,
131 "Convert an IPv4 Internet address from printable string\n"
132 "(dotted decimal notation) to an integer. E.g.,\n\n"
134 "(inet-aton \"127.0.0.1\") @result{} 2130706433\n"
136 #define FUNC_NAME s_scm_inet_aton
142 c_address
= scm_to_locale_string (address
);
143 rv
= inet_aton (c_address
, &soka
);
146 SCM_MISC_ERROR ("bad address", SCM_EOL
);
147 return scm_from_ulong (ntohl (soka
.s_addr
));
152 SCM_DEFINE (scm_inet_ntoa
, "inet-ntoa", 1, 0, 0,
154 "Convert an IPv4 Internet address to a printable\n"
155 "(dotted decimal notation) string. E.g.,\n\n"
157 "(inet-ntoa 2130706433) @result{} \"127.0.0.1\"\n"
159 #define FUNC_NAME s_scm_inet_ntoa
164 addr
.s_addr
= htonl (SCM_NUM2ULONG (1, inetid
));
165 s
= inet_ntoa (addr
);
166 answer
= scm_from_locale_string (s
);
171 #ifdef HAVE_INET_NETOF
172 SCM_DEFINE (scm_inet_netof
, "inet-netof", 1, 0, 0,
174 "Return the network number part of the given IPv4\n"
175 "Internet address. E.g.,\n\n"
177 "(inet-netof 2130706433) @result{} 127\n"
179 #define FUNC_NAME s_scm_inet_netof
182 addr
.s_addr
= htonl (SCM_NUM2ULONG (1, address
));
183 return scm_from_ulong (inet_netof (addr
));
188 #ifdef HAVE_INET_LNAOF
189 SCM_DEFINE (scm_lnaof
, "inet-lnaof", 1, 0, 0,
191 "Return the local-address-with-network part of the given\n"
192 "IPv4 Internet address, using the obsolete class A/B/C system.\n"
195 "(inet-lnaof 2130706433) @result{} 1\n"
197 #define FUNC_NAME s_scm_lnaof
200 addr
.s_addr
= htonl (SCM_NUM2ULONG (1, address
));
201 return scm_from_ulong (inet_lnaof (addr
));
206 #ifdef HAVE_INET_MAKEADDR
207 SCM_DEFINE (scm_inet_makeaddr
, "inet-makeaddr", 2, 0, 0,
209 "Make an IPv4 Internet address by combining the network number\n"
210 "@var{net} with the local-address-within-network number\n"
211 "@var{lna}. E.g.,\n\n"
213 "(inet-makeaddr 127 1) @result{} 2130706433\n"
215 #define FUNC_NAME s_scm_inet_makeaddr
218 unsigned long netnum
;
219 unsigned long lnanum
;
221 netnum
= SCM_NUM2ULONG (1, net
);
222 lnanum
= SCM_NUM2ULONG (2, lna
);
223 addr
= inet_makeaddr (netnum
, lnanum
);
224 return scm_from_ulong (ntohl (addr
.s_addr
));
231 /* flip a 128 bit IPv6 address between host and network order. */
232 #ifdef WORDS_BIGENDIAN
233 #define FLIP_NET_HOST_128(addr)
235 #define FLIP_NET_HOST_128(addr)\
239 for (i = 0; i < 8; i++)\
241 scm_t_uint8 c = (addr)[i];\
243 (addr)[i] = (addr)[15 - i];\
249 #ifdef WORDS_BIGENDIAN
250 #define FLIPCPY_NET_HOST_128(dest, src) memcpy (dest, src, 16)
252 #define FLIPCPY_NET_HOST_128(dest, src) \
254 const scm_t_uint8 *tmp_srcp = (src) + 15; \
255 scm_t_uint8 *tmp_destp = (dest); \
258 *tmp_destp++ = *tmp_srcp--; \
259 } while (tmp_srcp != (src)); \
264 #if (SIZEOF_SCM_T_BITS * SCM_CHAR_BIT) > 128
265 #error "Assumption that scm_t_bits <= 128 bits has been violated."
268 #if (SIZEOF_UNSIGNED_LONG * SCM_CHAR_BIT) > 128
269 #error "Assumption that unsigned long <= 128 bits has been violated."
272 #if (SIZEOF_UNSIGNED_LONG_LONG * SCM_CHAR_BIT) > 128
273 #error "Assumption that unsigned long long <= 128 bits has been violated."
276 /* convert a 128 bit IPv6 address in network order to a host ordered
279 scm_from_ipv6 (const scm_t_uint8
*src
)
281 SCM result
= scm_i_mkbig ();
282 mpz_import (SCM_I_BIG_MPZ (result
),
284 1, /* big-endian chunk ordering */
285 16, /* chunks are 16 bytes long */
286 1, /* big-endian byte ordering */
287 0, /* "nails" -- leading unused bits per chunk */
289 return scm_i_normbig (result
);
292 /* convert a host ordered SCM integer to a 128 bit IPv6 address in
295 scm_to_ipv6 (scm_t_uint8 dst
[16], SCM src
)
297 if (SCM_I_INUMP (src
))
299 scm_t_signed_bits n
= SCM_I_INUM (src
);
301 scm_out_of_range (NULL
, src
);
302 #ifdef WORDS_BIGENDIAN
303 memset (dst
, 0, 16 - sizeof (scm_t_signed_bits
));
304 memcpy (dst
+ (16 - sizeof (scm_t_signed_bits
)),
306 sizeof (scm_t_signed_bits
));
308 memset (dst
+ sizeof (scm_t_signed_bits
),
310 16 - sizeof (scm_t_signed_bits
));
311 /* FIXME: this pair of ops is kinda wasteful -- should rewrite as
312 a single loop perhaps, similar to the handling of bignums. */
313 memcpy (dst
, &n
, sizeof (scm_t_signed_bits
));
314 FLIP_NET_HOST_128 (dst
);
317 else if (SCM_BIGP (src
))
321 if ((mpz_sgn (SCM_I_BIG_MPZ (src
)) < 0)
322 || mpz_sizeinbase (SCM_I_BIG_MPZ (src
), 2) > 128)
323 scm_out_of_range (NULL
, src
);
328 1, /* big-endian chunk ordering */
329 16, /* chunks are 16 bytes long */
330 1, /* big-endian byte ordering */
331 0, /* "nails" -- leading unused bits per chunk */
332 SCM_I_BIG_MPZ (src
));
333 scm_remember_upto_here_1 (src
);
336 scm_wrong_type_arg (NULL
, 0, src
);
339 #ifdef HAVE_INET_PTON
340 SCM_DEFINE (scm_inet_pton
, "inet-pton", 2, 0, 0,
341 (SCM family
, SCM address
),
342 "Convert a string containing a printable network address to\n"
343 "an integer address. Note that unlike the C version of this\n"
345 "the result is an integer with normal host byte ordering.\n"
346 "@var{family} can be @code{AF_INET} or @code{AF_INET6}. E.g.,\n\n"
348 "(inet-pton AF_INET \"127.0.0.1\") @result{} 2130706433\n"
349 "(inet-pton AF_INET6 \"::1\") @result{} 1\n"
351 #define FUNC_NAME s_scm_inet_pton
358 af
= scm_to_int (family
);
359 SCM_ASSERT_RANGE (1, family
, af
== AF_INET
|| af
== AF_INET6
);
360 src
= scm_to_locale_string (address
);
361 rv
= inet_pton (af
, src
, dst
);
368 SCM_MISC_ERROR ("Bad address", SCM_EOL
);
370 return scm_from_ulong (ntohl (*(scm_t_uint32
*) dst
));
372 return scm_from_ipv6 ((char *) dst
);
377 #ifdef HAVE_INET_NTOP
378 SCM_DEFINE (scm_inet_ntop
, "inet-ntop", 2, 0, 0,
379 (SCM family
, SCM address
),
380 "Convert a network address into a printable string.\n"
381 "Note that unlike the C version of this function,\n"
382 "the input is an integer with normal host byte ordering.\n"
383 "@var{family} can be @code{AF_INET} or @code{AF_INET6}. E.g.,\n\n"
385 "(inet-ntop AF_INET 2130706433) @result{} \"127.0.0.1\"\n"
386 "(inet-ntop AF_INET6 (- (expt 2 128) 1)) @result{}\n"
387 "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff\n"
389 #define FUNC_NAME s_scm_inet_ntop
392 #ifdef INET6_ADDRSTRLEN
393 char dst
[INET6_ADDRSTRLEN
];
399 af
= scm_to_int (family
);
400 SCM_ASSERT_RANGE (1, family
, af
== AF_INET
|| af
== AF_INET6
);
402 *(scm_t_uint32
*) addr6
= htonl (SCM_NUM2ULONG (2, address
));
404 scm_to_ipv6 (addr6
, address
);
405 if (inet_ntop (af
, &addr6
, dst
, sizeof dst
) == NULL
)
407 return scm_from_locale_string (dst
);
412 #endif /* HAVE_IPV6 */
414 SCM_SYMBOL (sym_socket
, "socket");
416 #define SCM_SOCK_FD_TO_PORT(fd) scm_fdes_to_port (fd, "r+0", sym_socket)
418 SCM_DEFINE (scm_socket
, "socket", 3, 0, 0,
419 (SCM family
, SCM style
, SCM proto
),
420 "Return a new socket port of the type specified by @var{family},\n"
421 "@var{style} and @var{proto}. All three parameters are\n"
422 "integers. Supported values for @var{family} are\n"
423 "@code{AF_UNIX}, @code{AF_INET} and @code{AF_INET6}.\n"
424 "Typical values for @var{style} are @code{SOCK_STREAM},\n"
425 "@code{SOCK_DGRAM} and @code{SOCK_RAW}.\n\n"
426 "@var{proto} can be obtained from a protocol name using\n"
427 "@code{getprotobyname}. A value of zero specifies the default\n"
428 "protocol, which is usually right.\n\n"
429 "A single socket port cannot by used for communication until it\n"
430 "has been connected to another socket.")
431 #define FUNC_NAME s_scm_socket
435 fd
= socket (scm_to_int (family
),
440 return SCM_SOCK_FD_TO_PORT (fd
);
444 #ifdef HAVE_SOCKETPAIR
445 SCM_DEFINE (scm_socketpair
, "socketpair", 3, 0, 0,
446 (SCM family
, SCM style
, SCM proto
),
447 "Return a pair of connected (but unnamed) socket ports of the\n"
448 "type specified by @var{family}, @var{style} and @var{proto}.\n"
449 "Many systems support only socket pairs of the @code{AF_UNIX}\n"
450 "family. Zero is likely to be the only meaningful value for\n"
452 #define FUNC_NAME s_scm_socketpair
457 fam
= scm_to_int (family
);
459 if (socketpair (fam
, scm_to_int (style
), scm_to_int (proto
), fd
) == -1)
462 return scm_cons (SCM_SOCK_FD_TO_PORT (fd
[0]), SCM_SOCK_FD_TO_PORT (fd
[1]));
467 SCM_DEFINE (scm_getsockopt
, "getsockopt", 3, 0, 0,
468 (SCM sock
, SCM level
, SCM optname
),
469 "Return the value of a particular socket option for the socket\n"
470 "port @var{sock}. @var{level} is an integer code for type of\n"
471 "option being requested, e.g., @code{SOL_SOCKET} for\n"
472 "socket-level options. @var{optname} is an integer code for the\n"
473 "option required and should be specified using one of the\n"
474 "symbols @code{SO_DEBUG}, @code{SO_REUSEADDR} etc.\n\n"
475 "The returned value is typically an integer but @code{SO_LINGER}\n"
476 "returns a pair of integers.")
477 #define FUNC_NAME s_scm_getsockopt
480 /* size of optval is the largest supported option. */
481 #ifdef HAVE_STRUCT_LINGER
482 char optval
[sizeof (struct linger
)];
483 int optlen
= sizeof (struct linger
);
485 char optval
[sizeof (size_t)];
486 int optlen
= sizeof (size_t);
491 sock
= SCM_COERCE_OUTPORT (sock
);
492 SCM_VALIDATE_OPFPORT (1, sock
);
493 ilevel
= scm_to_int (level
);
494 ioptname
= scm_to_int (optname
);
496 fd
= SCM_FPORT_FDES (sock
);
497 if (getsockopt (fd
, ilevel
, ioptname
, (void *) optval
, &optlen
) == -1)
500 if (ilevel
== SOL_SOCKET
)
503 if (ioptname
== SO_LINGER
)
505 #ifdef HAVE_STRUCT_LINGER
506 struct linger
*ling
= (struct linger
*) optval
;
508 return scm_cons (scm_from_long (ling
->l_onoff
),
509 scm_from_long (ling
->l_linger
));
511 return scm_cons (scm_from_long (*(int *) optval
),
519 || ioptname
== SO_SNDBUF
522 || ioptname
== SO_RCVBUF
526 return scm_from_size_t (*(size_t *) optval
);
529 return scm_from_int (*(int *) optval
);
533 SCM_DEFINE (scm_setsockopt
, "setsockopt", 4, 0, 0,
534 (SCM sock
, SCM level
, SCM optname
, SCM value
),
535 "Set the value of a particular socket option for the socket\n"
536 "port @var{sock}. @var{level} is an integer code for type of option\n"
537 "being set, e.g., @code{SOL_SOCKET} for socket-level options.\n"
538 "@var{optname} is an\n"
539 "integer code for the option to set and should be specified using one of\n"
540 "the symbols @code{SO_DEBUG}, @code{SO_REUSEADDR} etc.\n"
541 "@var{value} is the value to which the option should be set. For\n"
542 "most options this must be an integer, but for @code{SO_LINGER} it must\n"
544 "The return value is unspecified.")
545 #define FUNC_NAME s_scm_setsockopt
549 /* size of optval is the largest supported option. */
550 #ifdef HAVE_STRUCT_LINGER
551 char optval
[sizeof (struct linger
)];
553 char optval
[sizeof (size_t)];
555 int ilevel
, ioptname
;
557 sock
= SCM_COERCE_OUTPORT (sock
);
559 SCM_VALIDATE_OPFPORT (1, sock
);
560 ilevel
= scm_to_int (level
);
561 ioptname
= scm_to_int (optname
);
563 fd
= SCM_FPORT_FDES (sock
);
565 if (ilevel
== SOL_SOCKET
)
568 if (ioptname
== SO_LINGER
)
570 #ifdef HAVE_STRUCT_LINGER
574 SCM_ASSERT (scm_is_pair (value
), value
, SCM_ARG4
, FUNC_NAME
);
575 lv
= SCM_NUM2LONG (4, SCM_CAR (value
));
576 ling
.l_onoff
= (int) lv
;
577 SCM_ASSERT_RANGE (SCM_ARG4
, value
, ling
.l_onoff
== lv
);
578 lv
= SCM_NUM2LONG (4, SCM_CDR (value
));
579 ling
.l_linger
= (int) lv
;
580 SCM_ASSERT_RANGE (SCM_ARG4
, value
, ling
.l_linger
== lv
);
581 optlen
= (int) sizeof (struct linger
);
582 memcpy (optval
, (void *) &ling
, optlen
);
587 SCM_ASSERT (scm_is_pair (value
), value
, SCM_ARG4
, FUNC_NAME
);
588 /* timeout is ignored, but may as well validate it. */
589 lv
= SCM_NUM2LONG (4, SCM_CDR (value
));
591 SCM_ASSERT_RANGE (SCM_ARG4
, value
, ling
== lv
);
592 lv
= SCM_NUM2LONG (4, SCM_CAR (value
));
594 SCM_ASSERT_RANGE (SCM_ARG4
, value
, ling
== lv
);
595 optlen
= (int) sizeof (int);
596 (*(int *) optval
) = ling
;
603 || ioptname
== SO_SNDBUF
606 || ioptname
== SO_RCVBUF
610 long lv
= SCM_NUM2LONG (4, value
);
612 optlen
= (int) sizeof (size_t);
613 (*(size_t *) optval
) = (size_t) lv
;
618 /* Most options take an int. */
619 long lv
= SCM_NUM2LONG (4, value
);
622 SCM_ASSERT_RANGE (SCM_ARG4
, value
, val
== lv
);
623 optlen
= (int) sizeof (int);
624 (*(int *) optval
) = val
;
626 if (setsockopt (fd
, ilevel
, ioptname
, (void *) optval
, optlen
) == -1)
628 return SCM_UNSPECIFIED
;
632 SCM_DEFINE (scm_shutdown
, "shutdown", 2, 0, 0,
634 "Sockets can be closed simply by using @code{close-port}. The\n"
635 "@code{shutdown} procedure allows reception or transmission on a\n"
636 "connection to be shut down individually, according to the parameter\n"
640 "Stop receiving data for this socket. If further data arrives, reject it.\n"
642 "Stop trying to transmit data from this socket. Discard any\n"
643 "data waiting to be sent. Stop looking for acknowledgement of\n"
644 "data already sent; don't retransmit it if it is lost.\n"
646 "Stop both reception and transmission.\n"
648 "The return value is unspecified.")
649 #define FUNC_NAME s_scm_shutdown
652 sock
= SCM_COERCE_OUTPORT (sock
);
653 SCM_VALIDATE_OPFPORT (1, sock
);
654 fd
= SCM_FPORT_FDES (sock
);
655 if (shutdown (fd
, scm_to_signed_integer (how
, 0, 2)) == -1)
657 return SCM_UNSPECIFIED
;
661 /* convert fam/address/args into a sockaddr of the appropriate type.
662 args is modified by removing the arguments actually used.
663 which_arg and proc are used when reporting errors:
664 which_arg is the position of address in the original argument list.
665 proc is the name of the original procedure.
666 size returns the size of the structure allocated. */
668 static struct sockaddr
*
669 scm_fill_sockaddr (int fam
, SCM address
, SCM
*args
, int which_arg
,
670 const char *proc
, int *size
)
671 #define FUNC_NAME proc
677 struct sockaddr_in
*soka
;
681 SCM_VALIDATE_ULONG_COPY (which_arg
, address
, addr
);
682 SCM_VALIDATE_CONS (which_arg
+ 1, *args
);
683 port
= scm_to_int (SCM_CAR (*args
));
684 *args
= SCM_CDR (*args
);
685 soka
= (struct sockaddr_in
*) scm_malloc (sizeof (struct sockaddr_in
));
687 scm_memory_error (proc
);
688 #if HAVE_STRUCT_SOCKADDR_SIN_LEN
689 soka
->sin_len
= sizeof (struct sockaddr_in
);
691 soka
->sin_family
= AF_INET
;
692 soka
->sin_addr
.s_addr
= htonl (addr
);
693 soka
->sin_port
= htons (port
);
694 *size
= sizeof (struct sockaddr_in
);
695 return (struct sockaddr
*) soka
;
702 struct sockaddr_in6
*soka
;
703 unsigned long flowinfo
= 0;
704 unsigned long scope_id
= 0;
706 SCM_VALIDATE_CONS (which_arg
+ 1, *args
);
707 port
= scm_to_int (SCM_CAR (*args
));
708 *args
= SCM_CDR (*args
);
709 if (scm_is_pair (*args
))
711 SCM_VALIDATE_ULONG_COPY (which_arg
+ 2, SCM_CAR (*args
), flowinfo
);
712 *args
= SCM_CDR (*args
);
713 if (scm_is_pair (*args
))
715 SCM_VALIDATE_ULONG_COPY (which_arg
+ 3, SCM_CAR (*args
),
717 *args
= SCM_CDR (*args
);
720 soka
= (struct sockaddr_in6
*) scm_malloc (sizeof (struct sockaddr_in6
));
722 scm_memory_error (proc
);
723 #if HAVE_STRUCT_SOCKADDR_IN6_SIN6_LEN
724 soka
->sin6_len
= sizeof (struct sockaddr_in6
);
726 soka
->sin6_family
= AF_INET6
;
727 scm_to_ipv6 (soka
->sin6_addr
.s6_addr
, address
);
728 soka
->sin6_port
= htons (port
);
729 soka
->sin6_flowinfo
= flowinfo
;
730 #ifdef HAVE_SIN6_SCOPE_ID
731 soka
->sin6_scope_id
= scope_id
;
733 *size
= sizeof (struct sockaddr_in6
);
734 return (struct sockaddr
*) soka
;
737 #ifdef HAVE_UNIX_DOMAIN_SOCKETS
740 struct sockaddr_un
*soka
;
746 c_address
= scm_to_locale_string (address
);
747 scm_frame_free (c_address
);
749 /* the static buffer size in sockaddr_un seems to be arbitrary
750 and not necessarily a hard limit. e.g., the glibc manual
751 suggests it may be possible to declare it size 0. let's
752 ignore it. if the O/S doesn't like the size it will cause
753 connect/bind etc., to fail. sun_path is always the last
754 member of the structure. */
755 addr_size
= sizeof (struct sockaddr_un
)
756 + max (0, strlen (c_address
) + 1 - (sizeof soka
->sun_path
));
757 soka
= (struct sockaddr_un
*) scm_malloc (addr_size
);
758 memset (soka
, 0, addr_size
); /* for sun_len: see sin_len above. */
759 soka
->sun_family
= AF_UNIX
;
760 strcpy (soka
->sun_path
, c_address
);
761 *size
= SUN_LEN (soka
);
764 return (struct sockaddr
*) soka
;
768 scm_out_of_range (proc
, scm_from_int (fam
));
773 SCM_DEFINE (scm_connect
, "connect", 3, 0, 1,
774 (SCM sock
, SCM fam
, SCM address
, SCM args
),
775 "Initiate a connection from a socket using a specified address\n"
776 "family to the address\n"
777 "specified by @var{address} and possibly @var{args}.\n"
778 "The format required for @var{address}\n"
779 "and @var{args} depends on the family of the socket.\n\n"
780 "For a socket of family @code{AF_UNIX},\n"
781 "only @var{address} is specified and must be a string with the\n"
782 "filename where the socket is to be created.\n\n"
783 "For a socket of family @code{AF_INET},\n"
784 "@var{address} must be an integer IPv4 host address and\n"
785 "@var{args} must be a single integer port number.\n\n"
786 "For a socket of family @code{AF_INET6},\n"
787 "@var{address} must be an integer IPv6 host address and\n"
788 "@var{args} may be up to three integers:\n"
789 "port [flowinfo] [scope_id],\n"
790 "where flowinfo and scope_id default to zero.\n\n"
791 "The return value is unspecified.")
792 #define FUNC_NAME s_scm_connect
795 struct sockaddr
*soka
;
798 sock
= SCM_COERCE_OUTPORT (sock
);
799 SCM_VALIDATE_OPFPORT (1, sock
);
800 fd
= SCM_FPORT_FDES (sock
);
801 soka
= scm_fill_sockaddr (scm_to_int (fam
), address
, &args
, 3, FUNC_NAME
,
803 if (connect (fd
, soka
, size
) == -1)
805 int save_errno
= errno
;
812 return SCM_UNSPECIFIED
;
816 SCM_DEFINE (scm_bind
, "bind", 3, 0, 1,
817 (SCM sock
, SCM fam
, SCM address
, SCM args
),
818 "Assign an address to the socket port @var{sock}.\n"
819 "Generally this only needs to be done for server sockets,\n"
820 "so they know where to look for incoming connections. A socket\n"
821 "without an address will be assigned one automatically when it\n"
822 "starts communicating.\n\n"
823 "The format of @var{address} and @var{args} depends\n"
824 "on the family of the socket.\n\n"
825 "For a socket of family @code{AF_UNIX}, only @var{address}\n"
826 "is specified and must be a string with the filename where\n"
827 "the socket is to be created.\n\n"
828 "For a socket of family @code{AF_INET}, @var{address}\n"
829 "must be an integer IPv4 address and @var{args}\n"
830 "must be a single integer port number.\n\n"
831 "The values of the following variables can also be used for\n"
833 "@defvar INADDR_ANY\n"
834 "Allow connections from any address.\n"
836 "@defvar INADDR_LOOPBACK\n"
837 "The address of the local host using the loopback device.\n"
839 "@defvar INADDR_BROADCAST\n"
840 "The broadcast address on the local network.\n"
842 "@defvar INADDR_NONE\n"
845 "For a socket of family @code{AF_INET6}, @var{address}\n"
846 "must be an integer IPv6 address and @var{args}\n"
847 "may be up to three integers:\n"
848 "port [flowinfo] [scope_id],\n"
849 "where flowinfo and scope_id default to zero.\n\n"
850 "The return value is unspecified.")
851 #define FUNC_NAME s_scm_bind
853 struct sockaddr
*soka
;
857 sock
= SCM_COERCE_OUTPORT (sock
);
858 SCM_VALIDATE_OPFPORT (1, sock
);
859 soka
= scm_fill_sockaddr (scm_to_int (fam
), address
, &args
, 3, FUNC_NAME
,
861 fd
= SCM_FPORT_FDES (sock
);
862 if (bind (fd
, soka
, size
) == -1)
864 int save_errno
= errno
;
871 return SCM_UNSPECIFIED
;
875 SCM_DEFINE (scm_listen
, "listen", 2, 0, 0,
876 (SCM sock
, SCM backlog
),
877 "Enable @var{sock} to accept connection\n"
878 "requests. @var{backlog} is an integer specifying\n"
879 "the maximum length of the queue for pending connections.\n"
880 "If the queue fills, new clients will fail to connect until\n"
881 "the server calls @code{accept} to accept a connection from\n"
883 "The return value is unspecified.")
884 #define FUNC_NAME s_scm_listen
887 sock
= SCM_COERCE_OUTPORT (sock
);
888 SCM_VALIDATE_OPFPORT (1, sock
);
889 fd
= SCM_FPORT_FDES (sock
);
890 if (listen (fd
, scm_to_int (backlog
)) == -1)
892 return SCM_UNSPECIFIED
;
896 /* Put the components of a sockaddr into a new SCM vector. */
898 scm_addr_vector (const struct sockaddr
*address
, int addr_size
,
901 short int fam
= address
->sa_family
;
909 const struct sockaddr_in
*nad
= (struct sockaddr_in
*) address
;
911 result
= scm_c_make_vector (3, SCM_UNSPECIFIED
);
913 SCM_SIMPLE_VECTOR_SET(result
, 0,
914 scm_from_short (fam
));
915 SCM_SIMPLE_VECTOR_SET(result
, 1,
916 scm_from_ulong (ntohl (nad
->sin_addr
.s_addr
)));
917 SCM_SIMPLE_VECTOR_SET(result
, 2,
918 scm_from_ushort (ntohs (nad
->sin_port
)));
924 const struct sockaddr_in6
*nad
= (struct sockaddr_in6
*) address
;
926 result
= scm_c_make_vector (5, SCM_UNSPECIFIED
);
927 SCM_SIMPLE_VECTOR_SET(result
, 0, scm_from_short (fam
));
928 SCM_SIMPLE_VECTOR_SET(result
, 1, scm_from_ipv6 (nad
->sin6_addr
.s6_addr
));
929 SCM_SIMPLE_VECTOR_SET(result
, 2, scm_from_ushort (ntohs (nad
->sin6_port
)));
930 SCM_SIMPLE_VECTOR_SET(result
, 3, scm_from_uint32 (nad
->sin6_flowinfo
));
931 #ifdef HAVE_SIN6_SCOPE_ID
932 SCM_SIMPLE_VECTOR_SET(result
, 4, scm_from_ulong (nad
->sin6_scope_id
));
934 SCM_SIMPLE_VECTOR_SET(result
, 4, SCM_INUM0
);
939 #ifdef HAVE_UNIX_DOMAIN_SOCKETS
942 const struct sockaddr_un
*nad
= (struct sockaddr_un
*) address
;
944 result
= scm_c_make_vector (2, SCM_UNSPECIFIED
);
946 SCM_SIMPLE_VECTOR_SET(result
, 0, scm_from_short (fam
));
947 /* When addr_size is not enough to cover sun_path, do not try
949 if (addr_size
<= offsetof (struct sockaddr_un
, sun_path
))
950 SCM_SIMPLE_VECTOR_SET(result
, 1, SCM_BOOL_F
);
952 SCM_SIMPLE_VECTOR_SET(result
, 1, scm_from_locale_string (nad
->sun_path
));
957 scm_misc_error (proc
, "Unrecognised address family: ~A",
958 scm_list_1 (scm_from_int (fam
)));
963 /* calculate the size of a buffer large enough to hold any supported
964 sockaddr type. if the buffer isn't large enough, certain system
965 calls will return a truncated address. */
967 #if defined (HAVE_UNIX_DOMAIN_SOCKETS)
968 #define MAX_SIZE_UN sizeof (struct sockaddr_un)
970 #define MAX_SIZE_UN 0
973 #if defined (HAVE_IPV6)
974 #define MAX_SIZE_IN6 sizeof (struct sockaddr_in6)
976 #define MAX_SIZE_IN6 0
979 #define MAX_ADDR_SIZE max (max (sizeof (struct sockaddr_in), MAX_SIZE_IN6),\
982 SCM_DEFINE (scm_accept
, "accept", 1, 0, 0,
984 "Accept a connection on a bound, listening socket.\n"
986 "are no pending connections in the queue, wait until\n"
987 "one is available unless the non-blocking option has been\n"
988 "set on the socket.\n\n"
989 "The return value is a\n"
990 "pair in which the @emph{car} is a new socket port for the\n"
992 "the @emph{cdr} is an object with address information about the\n"
993 "client which initiated the connection.\n\n"
994 "@var{sock} does not become part of the\n"
995 "connection and will continue to accept new requests.")
996 #define FUNC_NAME s_scm_accept
1002 int addr_size
= MAX_ADDR_SIZE
;
1003 char max_addr
[MAX_ADDR_SIZE
];
1004 struct sockaddr
*addr
= (struct sockaddr
*) max_addr
;
1006 sock
= SCM_COERCE_OUTPORT (sock
);
1007 SCM_VALIDATE_OPFPORT (1, sock
);
1008 fd
= SCM_FPORT_FDES (sock
);
1009 newfd
= accept (fd
, addr
, &addr_size
);
1012 newsock
= SCM_SOCK_FD_TO_PORT (newfd
);
1013 address
= scm_addr_vector (addr
, addr_size
, FUNC_NAME
);
1014 return scm_cons (newsock
, address
);
1018 SCM_DEFINE (scm_getsockname
, "getsockname", 1, 0, 0,
1020 "Return the address of @var{sock}, in the same form as the\n"
1021 "object returned by @code{accept}. On many systems the address\n"
1022 "of a socket in the @code{AF_FILE} namespace cannot be read.")
1023 #define FUNC_NAME s_scm_getsockname
1026 int addr_size
= MAX_ADDR_SIZE
;
1027 char max_addr
[MAX_ADDR_SIZE
];
1028 struct sockaddr
*addr
= (struct sockaddr
*) max_addr
;
1030 sock
= SCM_COERCE_OUTPORT (sock
);
1031 SCM_VALIDATE_OPFPORT (1, sock
);
1032 fd
= SCM_FPORT_FDES (sock
);
1033 if (getsockname (fd
, addr
, &addr_size
) == -1)
1035 return scm_addr_vector (addr
, addr_size
, FUNC_NAME
);
1039 SCM_DEFINE (scm_getpeername
, "getpeername", 1, 0, 0,
1041 "Return the address that @var{sock}\n"
1042 "is connected to, in the same form as the object returned by\n"
1043 "@code{accept}. On many systems the address of a socket in the\n"
1044 "@code{AF_FILE} namespace cannot be read.")
1045 #define FUNC_NAME s_scm_getpeername
1048 int addr_size
= MAX_ADDR_SIZE
;
1049 char max_addr
[MAX_ADDR_SIZE
];
1050 struct sockaddr
*addr
= (struct sockaddr
*) max_addr
;
1052 sock
= SCM_COERCE_OUTPORT (sock
);
1053 SCM_VALIDATE_OPFPORT (1, sock
);
1054 fd
= SCM_FPORT_FDES (sock
);
1055 if (getpeername (fd
, addr
, &addr_size
) == -1)
1057 return scm_addr_vector (addr
, addr_size
, FUNC_NAME
);
1061 SCM_DEFINE (scm_recv
, "recv!", 2, 1, 0,
1062 (SCM sock
, SCM buf
, SCM flags
),
1063 "Receive data from a socket port.\n"
1064 "@var{sock} must already\n"
1065 "be bound to the address from which data is to be received.\n"
1066 "@var{buf} is a string into which\n"
1067 "the data will be written. The size of @var{buf} limits\n"
1069 "data which can be received: in the case of packet\n"
1070 "protocols, if a packet larger than this limit is encountered\n"
1072 "will be irrevocably lost.\n\n"
1073 "The optional @var{flags} argument is a value or\n"
1074 "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
1075 "The value returned is the number of bytes read from the\n"
1077 "Note that the data is read directly from the socket file\n"
1079 "any unread buffered port data is ignored.")
1080 #define FUNC_NAME s_scm_recv
1088 SCM_VALIDATE_OPFPORT (1, sock
);
1089 SCM_VALIDATE_STRING (2, buf
);
1090 if (SCM_UNBNDP (flags
))
1093 flg
= scm_to_int (flags
);
1094 fd
= SCM_FPORT_FDES (sock
);
1096 len
= scm_i_string_length (buf
);
1097 dest
= scm_i_string_writable_chars (buf
);
1098 SCM_SYSCALL (rv
= recv (fd
, dest
, len
, flg
));
1099 scm_i_string_stop_writing ();
1104 scm_remember_upto_here_1 (buf
);
1105 return scm_from_int (rv
);
1109 SCM_DEFINE (scm_send
, "send", 2, 1, 0,
1110 (SCM sock
, SCM message
, SCM flags
),
1111 "Transmit the string @var{message} on a socket port @var{sock}.\n"
1112 "@var{sock} must already be bound to a destination address. The\n"
1113 "value returned is the number of bytes transmitted --\n"
1114 "it's possible for\n"
1115 "this to be less than the length of @var{message}\n"
1116 "if the socket is\n"
1117 "set to be non-blocking. The optional @var{flags} argument\n"
1119 "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
1120 "Note that the data is written directly to the socket\n"
1121 "file descriptor:\n"
1122 "any unflushed buffered port data is ignored.")
1123 #define FUNC_NAME s_scm_send
1131 sock
= SCM_COERCE_OUTPORT (sock
);
1132 SCM_VALIDATE_OPFPORT (1, sock
);
1133 SCM_VALIDATE_STRING (2, message
);
1134 if (SCM_UNBNDP (flags
))
1137 flg
= scm_to_int (flags
);
1138 fd
= SCM_FPORT_FDES (sock
);
1140 len
= scm_i_string_length (message
);
1141 src
= scm_i_string_writable_chars (message
);
1142 SCM_SYSCALL (rv
= send (fd
, src
, len
, flg
));
1143 scm_i_string_stop_writing ();
1148 scm_remember_upto_here_1 (message
);
1149 return scm_from_int (rv
);
1153 SCM_DEFINE (scm_recvfrom
, "recvfrom!", 2, 3, 0,
1154 (SCM sock
, SCM str
, SCM flags
, SCM start
, SCM end
),
1155 "Return data from the socket port @var{sock} and also\n"
1156 "information about where the data was received from.\n"
1157 "@var{sock} must already be bound to the address from which\n"
1158 "data is to be received. @code{str}, is a string into which the\n"
1159 "data will be written. The size of @var{str} limits the amount\n"
1160 "of data which can be received: in the case of packet protocols,\n"
1161 "if a packet larger than this limit is encountered then some\n"
1162 "data will be irrevocably lost.\n\n"
1163 "The optional @var{flags} argument is a value or bitwise OR of\n"
1164 "@code{MSG_OOB}, @code{MSG_PEEK}, @code{MSG_DONTROUTE} etc.\n\n"
1165 "The value returned is a pair: the @emph{car} is the number of\n"
1166 "bytes read from the socket and the @emph{cdr} an address object\n"
1167 "in the same form as returned by @code{accept}. The address\n"
1168 "will given as @code{#f} if not available, as is usually the\n"
1169 "case for stream sockets.\n\n"
1170 "The @var{start} and @var{end} arguments specify a substring of\n"
1171 "@var{str} to which the data should be written.\n\n"
1172 "Note that the data is read directly from the socket file\n"
1173 "descriptor: any unread buffered port data is ignored.")
1174 #define FUNC_NAME s_scm_recvfrom
1183 int addr_size
= MAX_ADDR_SIZE
;
1184 char max_addr
[MAX_ADDR_SIZE
];
1185 struct sockaddr
*addr
= (struct sockaddr
*) max_addr
;
1187 SCM_VALIDATE_OPFPORT (1, sock
);
1188 fd
= SCM_FPORT_FDES (sock
);
1190 SCM_VALIDATE_STRING (2, str
);
1191 scm_i_get_substring_spec (scm_i_string_length (str
),
1192 start
, &offset
, end
, &cend
);
1194 if (SCM_UNBNDP (flags
))
1197 SCM_VALIDATE_ULONG_COPY (3, flags
, flg
);
1199 /* recvfrom will not necessarily return an address. usually nothing
1200 is returned for stream sockets. */
1201 buf
= scm_i_string_writable_chars (str
);
1202 addr
->sa_family
= AF_UNSPEC
;
1203 SCM_SYSCALL (rv
= recvfrom (fd
, buf
+ offset
,
1206 scm_i_string_stop_writing ();
1210 if (addr
->sa_family
!= AF_UNSPEC
)
1211 address
= scm_addr_vector (addr
, addr_size
, FUNC_NAME
);
1213 address
= SCM_BOOL_F
;
1215 scm_remember_upto_here_1 (str
);
1216 return scm_cons (scm_from_int (rv
), address
);
1220 SCM_DEFINE (scm_sendto
, "sendto", 4, 0, 1,
1221 (SCM sock
, SCM message
, SCM fam
, SCM address
, SCM args_and_flags
),
1222 "Transmit the string @var{message} on the socket port\n"
1224 "destination address is specified using the @var{fam},\n"
1225 "@var{address} and\n"
1226 "@var{args_and_flags} arguments, in a similar way to the\n"
1227 "@code{connect} procedure. @var{args_and_flags} contains\n"
1228 "the usual connection arguments optionally followed by\n"
1229 "a flags argument, which is a value or\n"
1230 "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
1231 "The value returned is the number of bytes transmitted --\n"
1232 "it's possible for\n"
1233 "this to be less than the length of @var{message} if the\n"
1235 "set to be non-blocking.\n"
1236 "Note that the data is written directly to the socket\n"
1237 "file descriptor:\n"
1238 "any unflushed buffered port data is ignored.")
1239 #define FUNC_NAME s_scm_sendto
1244 struct sockaddr
*soka
;
1247 sock
= SCM_COERCE_OUTPORT (sock
);
1248 SCM_VALIDATE_FPORT (1, sock
);
1249 SCM_VALIDATE_STRING (2, message
);
1250 fd
= SCM_FPORT_FDES (sock
);
1251 soka
= scm_fill_sockaddr (scm_to_int (fam
), address
, &args_and_flags
, 4,
1253 if (scm_is_null (args_and_flags
))
1257 SCM_VALIDATE_CONS (5, args_and_flags
);
1258 flg
= SCM_NUM2ULONG (5, SCM_CAR (args_and_flags
));
1260 SCM_SYSCALL (rv
= sendto (fd
,
1261 scm_i_string_chars (message
),
1262 scm_i_string_length (message
),
1266 int save_errno
= errno
;
1273 scm_remember_upto_here_1 (message
);
1274 return scm_from_int (rv
);
1283 /* protocol families. */
1285 scm_c_define ("AF_UNSPEC", scm_from_int (AF_UNSPEC
));
1288 scm_c_define ("AF_UNIX", scm_from_int (AF_UNIX
));
1291 scm_c_define ("AF_INET", scm_from_int (AF_INET
));
1294 scm_c_define ("AF_INET6", scm_from_int (AF_INET6
));
1298 scm_c_define ("PF_UNSPEC", scm_from_int (PF_UNSPEC
));
1301 scm_c_define ("PF_UNIX", scm_from_int (PF_UNIX
));
1304 scm_c_define ("PF_INET", scm_from_int (PF_INET
));
1307 scm_c_define ("PF_INET6", scm_from_int (PF_INET6
));
1310 /* standard addresses. */
1312 scm_c_define ("INADDR_ANY", scm_from_ulong (INADDR_ANY
));
1314 #ifdef INADDR_BROADCAST
1315 scm_c_define ("INADDR_BROADCAST", scm_from_ulong (INADDR_BROADCAST
));
1318 scm_c_define ("INADDR_NONE", scm_from_ulong (INADDR_NONE
));
1320 #ifdef INADDR_LOOPBACK
1321 scm_c_define ("INADDR_LOOPBACK", scm_from_ulong (INADDR_LOOPBACK
));
1326 SOCK_PACKET is deliberately omitted, the GNU/Linux socket(2) and
1327 packet(7) advise that it's obsolete and strongly deprecated. */
1330 scm_c_define ("SOCK_STREAM", scm_from_int (SOCK_STREAM
));
1333 scm_c_define ("SOCK_DGRAM", scm_from_int (SOCK_DGRAM
));
1335 #ifdef SOCK_SEQPACKET
1336 scm_c_define ("SOCK_SEQPACKET", scm_from_int (SOCK_SEQPACKET
));
1339 scm_c_define ("SOCK_RAW", scm_from_int (SOCK_RAW
));
1342 scm_c_define ("SOCK_RDM", scm_from_int (SOCK_RDM
));
1345 /* setsockopt level. */
1347 scm_c_define ("SOL_SOCKET", scm_from_int (SOL_SOCKET
));
1350 scm_c_define ("SOL_IP", scm_from_int (SOL_IP
));
1353 scm_c_define ("SOL_TCP", scm_from_int (SOL_TCP
));
1356 scm_c_define ("SOL_UDP", scm_from_int (SOL_UDP
));
1359 /* setsockopt names. */
1361 scm_c_define ("SO_DEBUG", scm_from_int (SO_DEBUG
));
1364 scm_c_define ("SO_REUSEADDR", scm_from_int (SO_REUSEADDR
));
1367 scm_c_define ("SO_STYLE", scm_from_int (SO_STYLE
));
1370 scm_c_define ("SO_TYPE", scm_from_int (SO_TYPE
));
1373 scm_c_define ("SO_ERROR", scm_from_int (SO_ERROR
));
1376 scm_c_define ("SO_DONTROUTE", scm_from_int (SO_DONTROUTE
));
1379 scm_c_define ("SO_BROADCAST", scm_from_int (SO_BROADCAST
));
1382 scm_c_define ("SO_SNDBUF", scm_from_int (SO_SNDBUF
));
1385 scm_c_define ("SO_RCVBUF", scm_from_int (SO_RCVBUF
));
1388 scm_c_define ("SO_KEEPALIVE", scm_from_int (SO_KEEPALIVE
));
1391 scm_c_define ("SO_OOBINLINE", scm_from_int (SO_OOBINLINE
));
1394 scm_c_define ("SO_NO_CHECK", scm_from_int (SO_NO_CHECK
));
1397 scm_c_define ("SO_PRIORITY", scm_from_int (SO_PRIORITY
));
1400 scm_c_define ("SO_LINGER", scm_from_int (SO_LINGER
));
1403 /* recv/send options. */
1405 scm_c_define ("MSG_OOB", scm_from_int (MSG_OOB
));
1408 scm_c_define ("MSG_PEEK", scm_from_int (MSG_PEEK
));
1410 #ifdef MSG_DONTROUTE
1411 scm_c_define ("MSG_DONTROUTE", scm_from_int (MSG_DONTROUTE
));
1415 scm_i_init_socket_Win32 ();
1418 scm_add_feature ("socket");
1420 #include "libguile/socket.x"