1 /* Copyright (C) 1996,1997,1998,2000,2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 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 License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * 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., 51 Franklin Street, Fifth Floor, Boston, MA
29 #include "libguile/_scm.h"
30 #include "libguile/arrays.h"
31 #include "libguile/feature.h"
32 #include "libguile/fports.h"
33 #include "libguile/strings.h"
34 #include "libguile/vectors.h"
35 #include "libguile/dynwind.h"
36 #include "libguile/srfi-13.h"
38 #include "libguile/validate.h"
39 #include "libguile/socket.h"
41 #include "libguile/iselect.h"
44 #include "win32-socket.h"
56 #include <sys/types.h>
57 #ifdef HAVE_WINSOCK2_H
60 #include <sys/socket.h>
61 #ifdef HAVE_UNIX_DOMAIN_SOCKETS
64 #include <netinet/in.h>
66 #include <arpa/inet.h>
69 #if defined (HAVE_UNIX_DOMAIN_SOCKETS) && !defined (SUN_LEN)
70 #define SUN_LEN(ptr) ((size_t) (((struct sockaddr_un *) 0)->sun_path) \
71 + strlen ((ptr)->sun_path))
74 /* The largest possible socket address. Wrapping it in a union guarantees
75 that the compiler will make it suitably aligned. */
78 struct sockaddr sockaddr
;
79 struct sockaddr_in sockaddr_in
;
81 #ifdef HAVE_UNIX_DOMAIN_SOCKETS
82 struct sockaddr_un sockaddr_un
;
85 struct sockaddr_in6 sockaddr_in6
;
90 /* Maximum size of a socket address. */
91 #define MAX_ADDR_SIZE (sizeof (scm_t_max_sockaddr))
96 SCM_DEFINE (scm_htons
, "htons", 1, 0, 0,
98 "Convert a 16 bit quantity from host to network byte ordering.\n"
99 "@var{value} is packed into 2 bytes, which are then converted\n"
100 "and returned as a new integer.")
101 #define FUNC_NAME s_scm_htons
103 return scm_from_ushort (htons (scm_to_ushort (value
)));
107 SCM_DEFINE (scm_ntohs
, "ntohs", 1, 0, 0,
109 "Convert a 16 bit quantity from network to host byte ordering.\n"
110 "@var{value} is packed into 2 bytes, which are then converted\n"
111 "and returned as a new integer.")
112 #define FUNC_NAME s_scm_ntohs
114 return scm_from_ushort (ntohs (scm_to_ushort (value
)));
118 SCM_DEFINE (scm_htonl
, "htonl", 1, 0, 0,
120 "Convert a 32 bit quantity from host to network byte ordering.\n"
121 "@var{value} is packed into 4 bytes, which are then converted\n"
122 "and returned as a new integer.")
123 #define FUNC_NAME s_scm_htonl
125 return scm_from_ulong (htonl (scm_to_uint32 (value
)));
129 SCM_DEFINE (scm_ntohl
, "ntohl", 1, 0, 0,
131 "Convert a 32 bit quantity from network to host byte ordering.\n"
132 "@var{value} is packed into 4 bytes, which are then converted\n"
133 "and returned as a new integer.")
134 #define FUNC_NAME s_scm_ntohl
136 return scm_from_ulong (ntohl (scm_to_uint32 (value
)));
140 #ifdef HAVE_INET_NETOF
141 SCM_DEFINE (scm_inet_netof
, "inet-netof", 1, 0, 0,
143 "Return the network number part of the given IPv4\n"
144 "Internet address. E.g.,\n\n"
146 "(inet-netof 2130706433) @result{} 127\n"
148 #define FUNC_NAME s_scm_inet_netof
151 addr
.s_addr
= htonl (SCM_NUM2ULONG (1, address
));
152 return scm_from_ulong (inet_netof (addr
));
157 #ifdef HAVE_INET_LNAOF
158 SCM_DEFINE (scm_lnaof
, "inet-lnaof", 1, 0, 0,
160 "Return the local-address-with-network part of the given\n"
161 "IPv4 Internet address, using the obsolete class A/B/C system.\n"
164 "(inet-lnaof 2130706433) @result{} 1\n"
166 #define FUNC_NAME s_scm_lnaof
169 addr
.s_addr
= htonl (SCM_NUM2ULONG (1, address
));
170 return scm_from_ulong (inet_lnaof (addr
));
175 #ifdef HAVE_INET_MAKEADDR
176 SCM_DEFINE (scm_inet_makeaddr
, "inet-makeaddr", 2, 0, 0,
178 "Make an IPv4 Internet address by combining the network number\n"
179 "@var{net} with the local-address-within-network number\n"
180 "@var{lna}. E.g.,\n\n"
182 "(inet-makeaddr 127 1) @result{} 2130706433\n"
184 #define FUNC_NAME s_scm_inet_makeaddr
187 unsigned long netnum
;
188 unsigned long lnanum
;
190 netnum
= SCM_NUM2ULONG (1, net
);
191 lnanum
= SCM_NUM2ULONG (2, lna
);
192 addr
= inet_makeaddr (netnum
, lnanum
);
193 return scm_from_ulong (ntohl (addr
.s_addr
));
200 /* flip a 128 bit IPv6 address between host and network order. */
201 #ifdef WORDS_BIGENDIAN
202 #define FLIP_NET_HOST_128(addr)
204 #define FLIP_NET_HOST_128(addr)\
208 for (i = 0; i < 8; i++)\
210 scm_t_uint8 c = (addr)[i];\
212 (addr)[i] = (addr)[15 - i];\
218 #ifdef WORDS_BIGENDIAN
219 #define FLIPCPY_NET_HOST_128(dest, src) memcpy (dest, src, 16)
221 #define FLIPCPY_NET_HOST_128(dest, src) \
223 const scm_t_uint8 *tmp_srcp = (src) + 15; \
224 scm_t_uint8 *tmp_destp = (dest); \
227 *tmp_destp++ = *tmp_srcp--; \
228 } while (tmp_srcp != (src)); \
233 #if (SIZEOF_SCM_T_BITS * SCM_CHAR_BIT) > 128
234 #error "Assumption that scm_t_bits <= 128 bits has been violated."
237 #if (SIZEOF_UNSIGNED_LONG * SCM_CHAR_BIT) > 128
238 #error "Assumption that unsigned long <= 128 bits has been violated."
241 #if (SIZEOF_UNSIGNED_LONG_LONG * SCM_CHAR_BIT) > 128
242 #error "Assumption that unsigned long long <= 128 bits has been violated."
245 /* convert a 128 bit IPv6 address in network order to a host ordered
248 scm_from_ipv6 (const scm_t_uint8
*src
)
250 SCM result
= scm_i_mkbig ();
251 mpz_import (SCM_I_BIG_MPZ (result
),
253 1, /* big-endian chunk ordering */
254 16, /* chunks are 16 bytes long */
255 1, /* big-endian byte ordering */
256 0, /* "nails" -- leading unused bits per chunk */
258 return scm_i_normbig (result
);
261 /* convert a host ordered SCM integer to a 128 bit IPv6 address in
264 scm_to_ipv6 (scm_t_uint8 dst
[16], SCM src
)
266 if (SCM_I_INUMP (src
))
268 scm_t_signed_bits n
= SCM_I_INUM (src
);
270 scm_out_of_range (NULL
, src
);
271 #ifdef WORDS_BIGENDIAN
272 memset (dst
, 0, 16 - sizeof (scm_t_signed_bits
));
273 memcpy (dst
+ (16 - sizeof (scm_t_signed_bits
)),
275 sizeof (scm_t_signed_bits
));
277 memset (dst
+ sizeof (scm_t_signed_bits
),
279 16 - sizeof (scm_t_signed_bits
));
280 /* FIXME: this pair of ops is kinda wasteful -- should rewrite as
281 a single loop perhaps, similar to the handling of bignums. */
282 memcpy (dst
, &n
, sizeof (scm_t_signed_bits
));
283 FLIP_NET_HOST_128 (dst
);
286 else if (SCM_BIGP (src
))
290 if ((mpz_sgn (SCM_I_BIG_MPZ (src
)) < 0)
291 || mpz_sizeinbase (SCM_I_BIG_MPZ (src
), 2) > 128)
292 scm_out_of_range (NULL
, src
);
297 1, /* big-endian chunk ordering */
298 16, /* chunks are 16 bytes long */
299 1, /* big-endian byte ordering */
300 0, /* "nails" -- leading unused bits per chunk */
301 SCM_I_BIG_MPZ (src
));
302 scm_remember_upto_here_1 (src
);
305 scm_wrong_type_arg_msg ("scm_to_ipv6", 0, src
, "integer");
308 SCM_DEFINE (scm_inet_pton
, "inet-pton", 2, 0, 0,
309 (SCM family
, SCM address
),
310 "Convert a string containing a printable network address to\n"
311 "an integer address. Note that unlike the C version of this\n"
313 "the result is an integer with normal host byte ordering.\n"
314 "@var{family} can be @code{AF_INET} or @code{AF_INET6}. E.g.,\n\n"
316 "(inet-pton AF_INET \"127.0.0.1\") @result{} 2130706433\n"
317 "(inet-pton AF_INET6 \"::1\") @result{} 1\n"
319 #define FUNC_NAME s_scm_inet_pton
326 af
= scm_to_int (family
);
327 SCM_ASSERT_RANGE (1, family
, af
== AF_INET
|| af
== AF_INET6
);
328 src
= scm_to_locale_string (address
);
329 rv
= inet_pton (af
, src
, dst
);
336 SCM_MISC_ERROR ("Bad address", SCM_EOL
);
338 return scm_from_ulong (ntohl (*dst
));
340 return scm_from_ipv6 ((scm_t_uint8
*) dst
);
344 SCM_DEFINE (scm_inet_ntop
, "inet-ntop", 2, 0, 0,
345 (SCM family
, SCM address
),
346 "Convert a network address into a printable string.\n"
347 "Note that unlike the C version of this function,\n"
348 "the input is an integer with normal host byte ordering.\n"
349 "@var{family} can be @code{AF_INET} or @code{AF_INET6}. E.g.,\n\n"
351 "(inet-ntop AF_INET 2130706433) @result{} \"127.0.0.1\"\n"
352 "(inet-ntop AF_INET6 (- (expt 2 128) 1))\n"
353 " @result{} \"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff\"\n"
355 #define FUNC_NAME s_scm_inet_ntop
358 #ifdef INET6_ADDRSTRLEN
359 char dst
[INET6_ADDRSTRLEN
];
365 af
= scm_to_int (family
);
366 SCM_ASSERT_RANGE (1, family
, af
== AF_INET
|| af
== AF_INET6
);
371 addr4
= htonl (SCM_NUM2ULONG (2, address
));
372 result
= inet_ntop (af
, &addr4
, dst
, sizeof (dst
));
378 scm_to_ipv6 ((scm_t_uint8
*) addr6
, address
);
379 result
= inet_ntop (af
, &addr6
, dst
, sizeof (dst
));
385 return scm_from_locale_string (dst
);
389 #endif /* HAVE_IPV6 */
391 SCM_SYMBOL (sym_socket
, "socket");
393 #define SCM_SOCK_FD_TO_PORT(fd) scm_fdes_to_port (fd, "r+0", sym_socket)
395 SCM_DEFINE (scm_socket
, "socket", 3, 0, 0,
396 (SCM family
, SCM style
, SCM proto
),
397 "Return a new socket port of the type specified by @var{family},\n"
398 "@var{style} and @var{proto}. All three parameters are\n"
399 "integers. Supported values for @var{family} are\n"
400 "@code{AF_UNIX}, @code{AF_INET} and @code{AF_INET6}.\n"
401 "Typical values for @var{style} are @code{SOCK_STREAM},\n"
402 "@code{SOCK_DGRAM} and @code{SOCK_RAW}.\n\n"
403 "@var{proto} can be obtained from a protocol name using\n"
404 "@code{getprotobyname}. A value of zero specifies the default\n"
405 "protocol, which is usually right.\n\n"
406 "A single socket port cannot by used for communication until it\n"
407 "has been connected to another socket.")
408 #define FUNC_NAME s_scm_socket
412 fd
= socket (scm_to_int (family
),
417 return SCM_SOCK_FD_TO_PORT (fd
);
421 #ifdef HAVE_SOCKETPAIR
422 SCM_DEFINE (scm_socketpair
, "socketpair", 3, 0, 0,
423 (SCM family
, SCM style
, SCM proto
),
424 "Return a pair of connected (but unnamed) socket ports of the\n"
425 "type specified by @var{family}, @var{style} and @var{proto}.\n"
426 "Many systems support only socket pairs of the @code{AF_UNIX}\n"
427 "family. Zero is likely to be the only meaningful value for\n"
429 #define FUNC_NAME s_scm_socketpair
434 fam
= scm_to_int (family
);
436 if (socketpair (fam
, scm_to_int (style
), scm_to_int (proto
), fd
) == -1)
439 return scm_cons (SCM_SOCK_FD_TO_PORT (fd
[0]), SCM_SOCK_FD_TO_PORT (fd
[1]));
444 /* Possible results for `getsockopt ()'. Wrapping it into a union guarantees
445 suitable alignment. */
448 #ifdef HAVE_STRUCT_LINGER
449 struct linger linger
;
453 } scm_t_getsockopt_result
;
455 SCM_DEFINE (scm_getsockopt
, "getsockopt", 3, 0, 0,
456 (SCM sock
, SCM level
, SCM optname
),
457 "Return an option value from socket port @var{sock}.\n"
459 "@var{level} is an integer specifying a protocol layer, either\n"
460 "@code{SOL_SOCKET} for socket level options, or a protocol\n"
461 "number from the @code{IPPROTO} constants or @code{getprotoent}\n"
462 "(@pxref{Network Databases}).\n"
464 "@defvar SOL_SOCKET\n"
465 "@defvarx IPPROTO_IP\n"
466 "@defvarx IPPROTO_TCP\n"
467 "@defvarx IPPROTO_UDP\n"
470 "@var{optname} is an integer specifying an option within the\n"
473 "For @code{SOL_SOCKET} level the following @var{optname}s are\n"
474 "defined (when provided by the system). For their meaning see\n"
475 "@ref{Socket-Level Options,,, libc, The GNU C Library Reference\n"
476 "Manual}, or @command{man 7 socket}.\n"
479 "@defvarx SO_REUSEADDR\n"
480 "@defvarx SO_STYLE\n"
482 "@defvarx SO_ERROR\n"
483 "@defvarx SO_DONTROUTE\n"
484 "@defvarx SO_BROADCAST\n"
485 "@defvarx SO_SNDBUF\n"
486 "@defvarx SO_RCVBUF\n"
487 "@defvarx SO_KEEPALIVE\n"
488 "@defvarx SO_OOBINLINE\n"
489 "@defvarx SO_NO_CHECK\n"
490 "@defvarx SO_PRIORITY\n"
491 "The value returned is an integer.\n"
494 "@defvar SO_LINGER\n"
495 "The @var{value} returned is a pair of integers\n"
496 "@code{(@var{ENABLE} . @var{TIMEOUT})}. On old systems without\n"
497 "timeout support (ie.@: without @code{struct linger}), only\n"
498 "@var{ENABLE} has an effect but the value in Guile is always a\n"
501 #define FUNC_NAME s_scm_getsockopt
504 /* size of optval is the largest supported option. */
505 scm_t_getsockopt_result optval
;
506 socklen_t optlen
= sizeof (optval
);
510 sock
= SCM_COERCE_OUTPORT (sock
);
511 SCM_VALIDATE_OPFPORT (1, sock
);
512 ilevel
= scm_to_int (level
);
513 ioptname
= scm_to_int (optname
);
515 fd
= SCM_FPORT_FDES (sock
);
516 if (getsockopt (fd
, ilevel
, ioptname
, (void *) &optval
, &optlen
) == -1)
519 if (ilevel
== SOL_SOCKET
)
522 if (ioptname
== SO_LINGER
)
524 #ifdef HAVE_STRUCT_LINGER
525 struct linger
*ling
= (struct linger
*) &optval
;
527 return scm_cons (scm_from_long (ling
->l_onoff
),
528 scm_from_long (ling
->l_linger
));
530 return scm_cons (scm_from_long (*(int *) &optval
),
538 || ioptname
== SO_SNDBUF
541 || ioptname
== SO_RCVBUF
545 return scm_from_size_t (*(size_t *) &optval
);
548 return scm_from_int (*(int *) &optval
);
552 SCM_DEFINE (scm_setsockopt
, "setsockopt", 4, 0, 0,
553 (SCM sock
, SCM level
, SCM optname
, SCM value
),
554 "Set an option on socket port @var{sock}. The return value is\n"
557 "@var{level} is an integer specifying a protocol layer, either\n"
558 "@code{SOL_SOCKET} for socket level options, or a protocol\n"
559 "number from the @code{IPPROTO} constants or @code{getprotoent}\n"
560 "(@pxref{Network Databases}).\n"
562 "@defvar SOL_SOCKET\n"
563 "@defvarx IPPROTO_IP\n"
564 "@defvarx IPPROTO_TCP\n"
565 "@defvarx IPPROTO_UDP\n"
568 "@var{optname} is an integer specifying an option within the\n"
571 "For @code{SOL_SOCKET} level the following @var{optname}s are\n"
572 "defined (when provided by the system). For their meaning see\n"
573 "@ref{Socket-Level Options,,, libc, The GNU C Library Reference\n"
574 "Manual}, or @command{man 7 socket}.\n"
577 "@defvarx SO_REUSEADDR\n"
578 "@defvarx SO_STYLE\n"
580 "@defvarx SO_ERROR\n"
581 "@defvarx SO_DONTROUTE\n"
582 "@defvarx SO_BROADCAST\n"
583 "@defvarx SO_SNDBUF\n"
584 "@defvarx SO_RCVBUF\n"
585 "@defvarx SO_KEEPALIVE\n"
586 "@defvarx SO_OOBINLINE\n"
587 "@defvarx SO_NO_CHECK\n"
588 "@defvarx SO_PRIORITY\n"
589 "@var{value} is an integer.\n"
592 "@defvar SO_LINGER\n"
593 "@var{value} is a pair of integers @code{(@var{ENABLE}\n"
594 ". @var{TIMEOUT})}. On old systems without timeout support\n"
595 "(ie.@: without @code{struct linger}), only @var{ENABLE} has an\n"
596 "effect but the value in Guile is always a pair.\n"
599 "@c Note that we refer only to ``man ip'' here. On GNU/Linux it's\n"
600 "@c ``man 7 ip'' but on NetBSD it's ``man 4 ip''.\n"
602 "For IP level (@code{IPPROTO_IP}) the following @var{optname}s\n"
603 "are defined (when provided by the system). See @command{man\n"
604 "ip} for what they mean.\n"
606 "@defvar IP_MULTICAST_IF\n"
607 "This sets the source interface used by multicast traffic.\n"
610 "@defvar IP_MULTICAST_TTL\n"
611 "This sets the default TTL for multicast traffic. This defaults \n"
612 "to 1 and should be increased to allow traffic to pass beyond the\n"
616 "@defvar IP_ADD_MEMBERSHIP\n"
617 "@defvarx IP_DROP_MEMBERSHIP\n"
618 "These can be used only with @code{setsockopt}, not\n"
619 "@code{getsockopt}. @var{value} is a pair\n"
620 "@code{(@var{MULTIADDR} . @var{INTERFACEADDR})} of IPv4\n"
621 "addresses (@pxref{Network Address Conversion}).\n"
622 "@var{MULTIADDR} is a multicast address to be added to or\n"
623 "dropped from the interface @var{INTERFACEADDR}.\n"
624 "@var{INTERFACEADDR} can be @code{INADDR_ANY} to have the system\n"
625 "select the interface. @var{INTERFACEADDR} can also be an\n"
626 "interface index number, on systems supporting that.\n"
628 #define FUNC_NAME s_scm_setsockopt
633 #ifdef HAVE_STRUCT_LINGER
634 struct linger opt_linger
;
637 #ifdef HAVE_STRUCT_IP_MREQ
638 struct ip_mreq opt_mreq
;
641 const void *optval
= NULL
;
642 socklen_t optlen
= 0;
644 int ilevel
, ioptname
;
646 sock
= SCM_COERCE_OUTPORT (sock
);
648 SCM_VALIDATE_OPFPORT (1, sock
);
649 ilevel
= scm_to_int (level
);
650 ioptname
= scm_to_int (optname
);
652 fd
= SCM_FPORT_FDES (sock
);
654 if (ilevel
== SOL_SOCKET
)
657 if (ioptname
== SO_LINGER
)
659 #ifdef HAVE_STRUCT_LINGER
660 SCM_ASSERT (scm_is_pair (value
), value
, SCM_ARG4
, FUNC_NAME
);
661 opt_linger
.l_onoff
= scm_to_int (SCM_CAR (value
));
662 opt_linger
.l_linger
= scm_to_int (SCM_CDR (value
));
663 optlen
= sizeof (struct linger
);
664 optval
= &opt_linger
;
666 SCM_ASSERT (scm_is_pair (value
), value
, SCM_ARG4
, FUNC_NAME
);
667 opt_int
= scm_to_int (SCM_CAR (value
));
668 /* timeout is ignored, but may as well validate it. */
669 scm_to_int (SCM_CDR (value
));
670 optlen
= sizeof (int);
678 || ioptname
== SO_SNDBUF
681 || ioptname
== SO_RCVBUF
685 opt_int
= scm_to_int (value
);
686 optlen
= sizeof (size_t);
691 #ifdef HAVE_STRUCT_IP_MREQ
692 if (ilevel
== IPPROTO_IP
&&
693 (ioptname
== IP_ADD_MEMBERSHIP
|| ioptname
== IP_DROP_MEMBERSHIP
))
695 /* Fourth argument must be a pair of addresses. */
696 SCM_ASSERT (scm_is_pair (value
), value
, SCM_ARG4
, FUNC_NAME
);
697 opt_mreq
.imr_multiaddr
.s_addr
= htonl (scm_to_ulong (SCM_CAR (value
)));
698 opt_mreq
.imr_interface
.s_addr
= htonl (scm_to_ulong (SCM_CDR (value
)));
699 optlen
= sizeof (opt_mreq
);
706 /* Most options take an int. */
707 opt_int
= scm_to_int (value
);
708 optlen
= sizeof (int);
712 if (setsockopt (fd
, ilevel
, ioptname
, optval
, optlen
) == -1)
714 return SCM_UNSPECIFIED
;
718 SCM_DEFINE (scm_shutdown
, "shutdown", 2, 0, 0,
720 "Sockets can be closed simply by using @code{close-port}. The\n"
721 "@code{shutdown} procedure allows reception or transmission on a\n"
722 "connection to be shut down individually, according to the parameter\n"
726 "Stop receiving data for this socket. If further data arrives, reject it.\n"
728 "Stop trying to transmit data from this socket. Discard any\n"
729 "data waiting to be sent. Stop looking for acknowledgement of\n"
730 "data already sent; don't retransmit it if it is lost.\n"
732 "Stop both reception and transmission.\n"
734 "The return value is unspecified.")
735 #define FUNC_NAME s_scm_shutdown
738 sock
= SCM_COERCE_OUTPORT (sock
);
739 SCM_VALIDATE_OPFPORT (1, sock
);
740 fd
= SCM_FPORT_FDES (sock
);
741 if (shutdown (fd
, scm_to_signed_integer (how
, 0, 2)) == -1)
743 return SCM_UNSPECIFIED
;
747 /* convert fam/address/args into a sockaddr of the appropriate type.
748 args is modified by removing the arguments actually used.
749 which_arg and proc are used when reporting errors:
750 which_arg is the position of address in the original argument list.
751 proc is the name of the original procedure.
752 size returns the size of the structure allocated. */
754 static struct sockaddr
*
755 scm_fill_sockaddr (int fam
, SCM address
, SCM
*args
, int which_arg
,
756 const char *proc
, size_t *size
)
757 #define FUNC_NAME proc
763 struct sockaddr_in
*soka
;
767 SCM_VALIDATE_ULONG_COPY (which_arg
, address
, addr
);
768 SCM_VALIDATE_CONS (which_arg
+ 1, *args
);
769 port
= scm_to_int (SCM_CAR (*args
));
770 *args
= SCM_CDR (*args
);
771 soka
= (struct sockaddr_in
*) scm_malloc (sizeof (struct sockaddr_in
));
773 #ifdef HAVE_STRUCT_SOCKADDR_SIN_LEN
774 soka
->sin_len
= sizeof (struct sockaddr_in
);
776 soka
->sin_family
= AF_INET
;
777 soka
->sin_addr
.s_addr
= htonl (addr
);
778 soka
->sin_port
= htons (port
);
779 *size
= sizeof (struct sockaddr_in
);
780 return (struct sockaddr
*) soka
;
787 struct sockaddr_in6
*soka
;
788 unsigned long flowinfo
= 0;
789 unsigned long scope_id
= 0;
791 SCM_VALIDATE_CONS (which_arg
+ 1, *args
);
792 port
= scm_to_int (SCM_CAR (*args
));
793 *args
= SCM_CDR (*args
);
794 if (scm_is_pair (*args
))
796 SCM_VALIDATE_ULONG_COPY (which_arg
+ 2, SCM_CAR (*args
), flowinfo
);
797 *args
= SCM_CDR (*args
);
798 if (scm_is_pair (*args
))
800 SCM_VALIDATE_ULONG_COPY (which_arg
+ 3, SCM_CAR (*args
),
802 *args
= SCM_CDR (*args
);
805 soka
= (struct sockaddr_in6
*) scm_malloc (sizeof (struct sockaddr_in6
));
807 #ifdef HAVE_STRUCT_SOCKADDR_IN6_SIN6_LEN
808 soka
->sin6_len
= sizeof (struct sockaddr_in6
);
810 soka
->sin6_family
= AF_INET6
;
811 scm_to_ipv6 (soka
->sin6_addr
.s6_addr
, address
);
812 soka
->sin6_port
= htons (port
);
813 soka
->sin6_flowinfo
= flowinfo
;
814 #ifdef HAVE_SIN6_SCOPE_ID
815 soka
->sin6_scope_id
= scope_id
;
817 *size
= sizeof (struct sockaddr_in6
);
818 return (struct sockaddr
*) soka
;
821 #ifdef HAVE_UNIX_DOMAIN_SOCKETS
824 struct sockaddr_un
*soka
;
828 scm_dynwind_begin (0);
830 c_address
= scm_to_locale_string (address
);
831 scm_dynwind_free (c_address
);
833 /* the static buffer size in sockaddr_un seems to be arbitrary
834 and not necessarily a hard limit. e.g., the glibc manual
835 suggests it may be possible to declare it size 0. let's
836 ignore it. if the O/S doesn't like the size it will cause
837 connect/bind etc., to fail. sun_path is always the last
838 member of the structure. */
839 addr_size
= sizeof (struct sockaddr_un
)
840 + max (0, strlen (c_address
) + 1 - (sizeof soka
->sun_path
));
841 soka
= (struct sockaddr_un
*) scm_malloc (addr_size
);
842 memset (soka
, 0, addr_size
); /* for sun_len: see sin_len above. */
843 soka
->sun_family
= AF_UNIX
;
844 strcpy (soka
->sun_path
, c_address
);
845 *size
= SUN_LEN (soka
);
848 return (struct sockaddr
*) soka
;
852 scm_out_of_range (proc
, scm_from_int (fam
));
857 SCM_DEFINE (scm_connect
, "connect", 2, 1, 1,
858 (SCM sock
, SCM fam_or_sockaddr
, SCM address
, SCM args
),
859 "Initiate a connection from a socket using a specified address\n"
860 "family to the address\n"
861 "specified by @var{address} and possibly @var{args}.\n"
862 "The format required for @var{address}\n"
863 "and @var{args} depends on the family of the socket.\n\n"
864 "For a socket of family @code{AF_UNIX},\n"
865 "only @var{address} is specified and must be a string with the\n"
866 "filename where the socket is to be created.\n\n"
867 "For a socket of family @code{AF_INET},\n"
868 "@var{address} must be an integer IPv4 host address and\n"
869 "@var{args} must be a single integer port number.\n\n"
870 "For a socket of family @code{AF_INET6},\n"
871 "@var{address} must be an integer IPv6 host address and\n"
872 "@var{args} may be up to three integers:\n"
873 "port [flowinfo] [scope_id],\n"
874 "where flowinfo and scope_id default to zero.\n\n"
875 "Alternatively, the second argument can be a socket address object "
876 "as returned by @code{make-socket-address}, in which case the "
877 "no additional arguments should be passed.\n\n"
878 "The return value is unspecified.")
879 #define FUNC_NAME s_scm_connect
882 struct sockaddr
*soka
;
885 sock
= SCM_COERCE_OUTPORT (sock
);
886 SCM_VALIDATE_OPFPORT (1, sock
);
887 fd
= SCM_FPORT_FDES (sock
);
889 if (address
== SCM_UNDEFINED
)
890 /* No third argument was passed to FAM_OR_SOCKADDR must actually be a
891 `socket address' object. */
892 soka
= scm_to_sockaddr (fam_or_sockaddr
, &size
);
894 soka
= scm_fill_sockaddr (scm_to_int (fam_or_sockaddr
), address
,
895 &args
, 3, FUNC_NAME
, &size
);
897 if (connect (fd
, soka
, size
) == -1)
899 int save_errno
= errno
;
906 return SCM_UNSPECIFIED
;
910 SCM_DEFINE (scm_bind
, "bind", 2, 1, 1,
911 (SCM sock
, SCM fam_or_sockaddr
, SCM address
, SCM args
),
912 "Assign an address to the socket port @var{sock}.\n"
913 "Generally this only needs to be done for server sockets,\n"
914 "so they know where to look for incoming connections. A socket\n"
915 "without an address will be assigned one automatically when it\n"
916 "starts communicating.\n\n"
917 "The format of @var{address} and @var{args} depends\n"
918 "on the family of the socket.\n\n"
919 "For a socket of family @code{AF_UNIX}, only @var{address}\n"
920 "is specified and must be a string with the filename where\n"
921 "the socket is to be created.\n\n"
922 "For a socket of family @code{AF_INET}, @var{address}\n"
923 "must be an integer IPv4 address and @var{args}\n"
924 "must be a single integer port number.\n\n"
925 "The values of the following variables can also be used for\n"
927 "@defvar INADDR_ANY\n"
928 "Allow connections from any address.\n"
930 "@defvar INADDR_LOOPBACK\n"
931 "The address of the local host using the loopback device.\n"
933 "@defvar INADDR_BROADCAST\n"
934 "The broadcast address on the local network.\n"
936 "@defvar INADDR_NONE\n"
939 "For a socket of family @code{AF_INET6}, @var{address}\n"
940 "must be an integer IPv6 address and @var{args}\n"
941 "may be up to three integers:\n"
942 "port [flowinfo] [scope_id],\n"
943 "where flowinfo and scope_id default to zero.\n\n"
944 "Alternatively, the second argument can be a socket address object "
945 "as returned by @code{make-socket-address}, in which case the "
946 "no additional arguments should be passed.\n\n"
947 "The return value is unspecified.")
948 #define FUNC_NAME s_scm_bind
950 struct sockaddr
*soka
;
954 sock
= SCM_COERCE_OUTPORT (sock
);
955 SCM_VALIDATE_OPFPORT (1, sock
);
956 fd
= SCM_FPORT_FDES (sock
);
958 if (address
== SCM_UNDEFINED
)
959 /* No third argument was passed to FAM_OR_SOCKADDR must actually be a
960 `socket address' object. */
961 soka
= scm_to_sockaddr (fam_or_sockaddr
, &size
);
963 soka
= scm_fill_sockaddr (scm_to_int (fam_or_sockaddr
), address
,
964 &args
, 3, FUNC_NAME
, &size
);
967 if (bind (fd
, soka
, size
) == -1)
969 int save_errno
= errno
;
976 return SCM_UNSPECIFIED
;
980 SCM_DEFINE (scm_listen
, "listen", 2, 0, 0,
981 (SCM sock
, SCM backlog
),
982 "Enable @var{sock} to accept connection\n"
983 "requests. @var{backlog} is an integer specifying\n"
984 "the maximum length of the queue for pending connections.\n"
985 "If the queue fills, new clients will fail to connect until\n"
986 "the server calls @code{accept} to accept a connection from\n"
988 "The return value is unspecified.")
989 #define FUNC_NAME s_scm_listen
992 sock
= SCM_COERCE_OUTPORT (sock
);
993 SCM_VALIDATE_OPFPORT (1, sock
);
994 fd
= SCM_FPORT_FDES (sock
);
995 if (listen (fd
, scm_to_int (backlog
)) == -1)
997 return SCM_UNSPECIFIED
;
1001 /* Put the components of a sockaddr into a new SCM vector. */
1002 static SCM_C_INLINE_KEYWORD SCM
1003 _scm_from_sockaddr (const scm_t_max_sockaddr
*address
, unsigned addr_size
,
1006 SCM result
= SCM_EOL
;
1007 short int fam
= ((struct sockaddr
*) address
)->sa_family
;
1013 const struct sockaddr_in
*nad
= (struct sockaddr_in
*) address
;
1015 result
= scm_c_make_vector (3, SCM_UNSPECIFIED
);
1017 SCM_SIMPLE_VECTOR_SET(result
, 0,
1018 scm_from_short (fam
));
1019 SCM_SIMPLE_VECTOR_SET(result
, 1,
1020 scm_from_ulong (ntohl (nad
->sin_addr
.s_addr
)));
1021 SCM_SIMPLE_VECTOR_SET(result
, 2,
1022 scm_from_ushort (ntohs (nad
->sin_port
)));
1028 const struct sockaddr_in6
*nad
= (struct sockaddr_in6
*) address
;
1030 result
= scm_c_make_vector (5, SCM_UNSPECIFIED
);
1031 SCM_SIMPLE_VECTOR_SET(result
, 0, scm_from_short (fam
));
1032 SCM_SIMPLE_VECTOR_SET(result
, 1, scm_from_ipv6 (nad
->sin6_addr
.s6_addr
));
1033 SCM_SIMPLE_VECTOR_SET(result
, 2, scm_from_ushort (ntohs (nad
->sin6_port
)));
1034 SCM_SIMPLE_VECTOR_SET(result
, 3, scm_from_uint32 (nad
->sin6_flowinfo
));
1035 #ifdef HAVE_SIN6_SCOPE_ID
1036 SCM_SIMPLE_VECTOR_SET(result
, 4, scm_from_ulong (nad
->sin6_scope_id
));
1038 SCM_SIMPLE_VECTOR_SET(result
, 4, SCM_INUM0
);
1043 #ifdef HAVE_UNIX_DOMAIN_SOCKETS
1046 const struct sockaddr_un
*nad
= (struct sockaddr_un
*) address
;
1048 result
= scm_c_make_vector (2, SCM_UNSPECIFIED
);
1050 SCM_SIMPLE_VECTOR_SET(result
, 0, scm_from_short (fam
));
1051 /* When addr_size is not enough to cover sun_path, do not try
1053 if (addr_size
<= offsetof (struct sockaddr_un
, sun_path
))
1054 SCM_SIMPLE_VECTOR_SET(result
, 1, SCM_BOOL_F
);
1056 SCM_SIMPLE_VECTOR_SET(result
, 1, scm_from_locale_string (nad
->sun_path
));
1061 result
= SCM_UNSPECIFIED
;
1062 scm_misc_error (proc
, "unrecognised address family: ~A",
1063 scm_list_1 (scm_from_int (fam
)));
1069 /* The publicly-visible function. Return a Scheme object representing
1070 ADDRESS, an address of ADDR_SIZE bytes. */
1072 scm_from_sockaddr (const struct sockaddr
*address
, unsigned addr_size
)
1074 return (_scm_from_sockaddr ((scm_t_max_sockaddr
*) address
,
1075 addr_size
, "scm_from_sockaddr"));
1078 /* Convert ADDRESS, an address object returned by either
1079 `scm_from_sockaddr ()' or `scm_make_socket_address ()', into its C
1080 representation. On success, a non-NULL pointer is returned and
1081 ADDRESS_SIZE is updated to the actual size (in bytes) of the returned
1082 address. The result must eventually be freed using `free ()'. */
1084 scm_to_sockaddr (SCM address
, size_t *address_size
)
1085 #define FUNC_NAME "scm_to_sockaddr"
1088 struct sockaddr
*c_address
= NULL
;
1090 SCM_VALIDATE_VECTOR (1, address
);
1093 family
= scm_to_short (SCM_SIMPLE_VECTOR_REF (address
, 0));
1099 if (SCM_SIMPLE_VECTOR_LENGTH (address
) != 3)
1100 scm_misc_error (FUNC_NAME
,
1101 "invalid inet address representation: ~A",
1102 scm_list_1 (address
));
1105 struct sockaddr_in c_inet
;
1107 c_inet
.sin_addr
.s_addr
=
1108 htonl (scm_to_ulong (SCM_SIMPLE_VECTOR_REF (address
, 1)));
1110 htons (scm_to_ushort (SCM_SIMPLE_VECTOR_REF (address
, 2)));
1111 c_inet
.sin_family
= AF_INET
;
1113 *address_size
= sizeof (c_inet
);
1114 c_address
= scm_malloc (sizeof (c_inet
));
1115 memcpy (c_address
, &c_inet
, sizeof (c_inet
));
1124 if (SCM_SIMPLE_VECTOR_LENGTH (address
) != 5)
1125 scm_misc_error (FUNC_NAME
, "invalid inet6 address representation: ~A",
1126 scm_list_1 (address
));
1129 struct sockaddr_in6 c_inet6
;
1131 scm_to_ipv6 (c_inet6
.sin6_addr
.s6_addr
,
1132 SCM_SIMPLE_VECTOR_REF (address
, 1));
1134 htons (scm_to_ushort (SCM_SIMPLE_VECTOR_REF (address
, 2)));
1135 c_inet6
.sin6_flowinfo
=
1136 scm_to_uint32 (SCM_SIMPLE_VECTOR_REF (address
, 3));
1137 #ifdef HAVE_SIN6_SCOPE_ID
1138 c_inet6
.sin6_scope_id
=
1139 scm_to_ulong (SCM_SIMPLE_VECTOR_REF (address
, 4));
1142 c_inet6
.sin6_family
= AF_INET6
;
1144 *address_size
= sizeof (c_inet6
);
1145 c_address
= scm_malloc (sizeof (c_inet6
));
1146 memcpy (c_address
, &c_inet6
, sizeof (c_inet6
));
1153 #ifdef HAVE_UNIX_DOMAIN_SOCKETS
1156 if (SCM_SIMPLE_VECTOR_LENGTH (address
) != 2)
1157 scm_misc_error (FUNC_NAME
, "invalid unix address representation: ~A",
1158 scm_list_1 (address
));
1162 size_t path_len
= 0;
1164 path
= SCM_SIMPLE_VECTOR_REF (address
, 1);
1165 if ((!scm_is_string (path
)) && (path
!= SCM_BOOL_F
))
1166 scm_misc_error (FUNC_NAME
, "invalid unix address "
1167 "path: ~A", scm_list_1 (path
));
1170 struct sockaddr_un c_unix
;
1172 if (path
== SCM_BOOL_F
)
1175 path_len
= scm_c_string_length (path
);
1177 #ifdef UNIX_PATH_MAX
1178 if (path_len
>= UNIX_PATH_MAX
)
1180 /* We can hope that this limit will eventually vanish, at least on GNU.
1181 However, currently, while glibc doesn't define `UNIX_PATH_MAX', it
1182 documents it has being limited to 108 bytes. */
1183 if (path_len
>= sizeof (c_unix
.sun_path
))
1185 scm_misc_error (FUNC_NAME
, "unix address path "
1186 "too long: ~A", scm_list_1 (path
));
1191 scm_to_locale_stringbuf (path
, c_unix
.sun_path
,
1192 #ifdef UNIX_PATH_MAX
1195 sizeof (c_unix
.sun_path
));
1197 c_unix
.sun_path
[path_len
] = '\0';
1200 if (strlen (c_unix
.sun_path
) != path_len
)
1201 scm_misc_error (FUNC_NAME
, "unix address path "
1202 "contains nul characters: ~A",
1206 c_unix
.sun_path
[0] = '\0';
1208 c_unix
.sun_family
= AF_UNIX
;
1210 *address_size
= SUN_LEN (&c_unix
);
1211 c_address
= scm_malloc (sizeof (c_unix
));
1212 memcpy (c_address
, &c_unix
, sizeof (c_unix
));
1222 scm_misc_error (FUNC_NAME
, "unrecognised address family: ~A",
1223 scm_list_1 (scm_from_ushort (family
)));
1231 /* Return a newly-allocated `sockaddr' structure that reflects ADDRESS, being
1232 an address of family FAMILY, with the family-specific parameters ARGS (see
1233 the description of `connect' for details). The returned structure may be
1234 freed using `free ()'. */
1236 scm_c_make_socket_address (SCM family
, SCM address
, SCM args
,
1237 size_t *address_size
)
1239 struct sockaddr
*soka
;
1241 soka
= scm_fill_sockaddr (scm_to_ushort (family
), address
, &args
, 1,
1242 "scm_c_make_socket_address", address_size
);
1247 SCM_DEFINE (scm_make_socket_address
, "make-socket-address", 2, 0, 1,
1248 (SCM family
, SCM address
, SCM args
),
1249 "Return a Scheme address object that reflects @var{address}, "
1250 "being an address of family @var{family}, with the "
1251 "family-specific parameters @var{args} (see the description of "
1252 "@code{connect} for details).")
1253 #define FUNC_NAME s_scm_make_socket_address
1255 SCM result
= SCM_BOOL_F
;
1256 struct sockaddr
*c_address
;
1257 size_t c_address_size
;
1259 c_address
= scm_c_make_socket_address (family
, address
, args
,
1261 if (c_address
!= NULL
)
1263 result
= scm_from_sockaddr (c_address
, c_address_size
);
1272 SCM_DEFINE (scm_accept
, "accept", 1, 0, 0,
1274 "Accept a connection on a bound, listening socket.\n"
1276 "are no pending connections in the queue, wait until\n"
1277 "one is available unless the non-blocking option has been\n"
1278 "set on the socket.\n\n"
1279 "The return value is a\n"
1280 "pair in which the @emph{car} is a new socket port for the\n"
1282 "the @emph{cdr} is an object with address information about the\n"
1283 "client which initiated the connection.\n\n"
1284 "@var{sock} does not become part of the\n"
1285 "connection and will continue to accept new requests.")
1286 #define FUNC_NAME s_scm_accept
1292 SELECT_TYPE readfds
, exceptfds
;
1293 socklen_t addr_size
= MAX_ADDR_SIZE
;
1294 scm_t_max_sockaddr addr
;
1296 sock
= SCM_COERCE_OUTPORT (sock
);
1297 SCM_VALIDATE_OPFPORT (1, sock
);
1298 fd
= SCM_FPORT_FDES (sock
);
1301 FD_ZERO (&exceptfds
);
1302 FD_SET (fd
, &readfds
);
1303 FD_SET (fd
, &exceptfds
);
1305 /* Block until something happens on FD, leaving guile mode while
1307 selected
= scm_std_select (fd
+ 1, &readfds
, NULL
, &exceptfds
,
1312 newfd
= accept (fd
, (struct sockaddr
*) &addr
, &addr_size
);
1315 newsock
= SCM_SOCK_FD_TO_PORT (newfd
);
1316 address
= _scm_from_sockaddr (&addr
, addr_size
,
1319 return scm_cons (newsock
, address
);
1323 SCM_DEFINE (scm_getsockname
, "getsockname", 1, 0, 0,
1325 "Return the address of @var{sock}, in the same form as the\n"
1326 "object returned by @code{accept}. On many systems the address\n"
1327 "of a socket in the @code{AF_FILE} namespace cannot be read.")
1328 #define FUNC_NAME s_scm_getsockname
1331 socklen_t addr_size
= MAX_ADDR_SIZE
;
1332 scm_t_max_sockaddr addr
;
1334 sock
= SCM_COERCE_OUTPORT (sock
);
1335 SCM_VALIDATE_OPFPORT (1, sock
);
1336 fd
= SCM_FPORT_FDES (sock
);
1337 if (getsockname (fd
, (struct sockaddr
*) &addr
, &addr_size
) == -1)
1340 return _scm_from_sockaddr (&addr
, addr_size
, FUNC_NAME
);
1344 SCM_DEFINE (scm_getpeername
, "getpeername", 1, 0, 0,
1346 "Return the address that @var{sock}\n"
1347 "is connected to, in the same form as the object returned by\n"
1348 "@code{accept}. On many systems the address of a socket in the\n"
1349 "@code{AF_FILE} namespace cannot be read.")
1350 #define FUNC_NAME s_scm_getpeername
1353 socklen_t addr_size
= MAX_ADDR_SIZE
;
1354 scm_t_max_sockaddr addr
;
1356 sock
= SCM_COERCE_OUTPORT (sock
);
1357 SCM_VALIDATE_OPFPORT (1, sock
);
1358 fd
= SCM_FPORT_FDES (sock
);
1359 if (getpeername (fd
, (struct sockaddr
*) &addr
, &addr_size
) == -1)
1362 return _scm_from_sockaddr (&addr
, addr_size
, FUNC_NAME
);
1366 SCM_DEFINE (scm_recv
, "recv!", 2, 1, 0,
1367 (SCM sock
, SCM buf
, SCM flags
),
1368 "Receive data from a socket port.\n"
1369 "@var{sock} must already\n"
1370 "be bound to the address from which data is to be received.\n"
1371 "@var{buf} is a string into which\n"
1372 "the data will be written. The size of @var{buf} limits\n"
1374 "data which can be received: in the case of packet\n"
1375 "protocols, if a packet larger than this limit is encountered\n"
1377 "will be irrevocably lost.\n\n"
1378 "The data is assumed to be binary, and there is no decoding of\n"
1379 "of locale-encoded strings.\n\n"
1380 "The optional @var{flags} argument is a value or\n"
1381 "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
1382 "The value returned is the number of bytes read from the\n"
1384 "Note that the data is read directly from the socket file\n"
1386 "any unread buffered port data is ignored.")
1387 #define FUNC_NAME s_scm_recv
1396 SCM_VALIDATE_OPFPORT (1, sock
);
1397 SCM_VALIDATE_STRING (2, buf
);
1398 if (SCM_UNBNDP (flags
))
1401 flg
= scm_to_int (flags
);
1402 fd
= SCM_FPORT_FDES (sock
);
1404 len
= scm_i_string_length (buf
);
1405 msg
= scm_i_make_string (len
, &dest
);
1406 SCM_SYSCALL (rv
= recv (fd
, dest
, len
, flg
));
1407 scm_string_copy_x (buf
, scm_from_int (0),
1408 msg
, scm_from_int (0), scm_from_size_t (len
));
1413 scm_remember_upto_here_2 (buf
, msg
);
1414 return scm_from_int (rv
);
1418 SCM_DEFINE (scm_send
, "send", 2, 1, 0,
1419 (SCM sock
, SCM message
, SCM flags
),
1420 "Transmit the string @var{message} on a socket port @var{sock}.\n"
1421 "@var{sock} must already be bound to a destination address. The\n"
1422 "value returned is the number of bytes transmitted --\n"
1423 "it's possible for\n"
1424 "this to be less than the length of @var{message}\n"
1425 "if the socket is\n"
1426 "set to be non-blocking. The optional @var{flags} argument\n"
1428 "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
1429 "Note that the data is written directly to the socket\n"
1430 "file descriptor:\n"
1431 "any unflushed buffered port data is ignored.\n\n"
1432 "This operation is defined only for strings containing codepoints\n"
1434 #define FUNC_NAME s_scm_send
1442 sock
= SCM_COERCE_OUTPORT (sock
);
1443 SCM_VALIDATE_OPFPORT (1, sock
);
1444 SCM_VALIDATE_STRING (2, message
);
1446 /* If the string is wide, see if it can be coerced into
1448 if (!scm_i_is_narrow_string (message
)
1449 || scm_i_try_narrow_string (message
))
1450 SCM_MISC_ERROR ("the message string is not 8-bit: ~s",
1451 scm_list_1 (message
));
1453 if (SCM_UNBNDP (flags
))
1456 flg
= scm_to_int (flags
);
1457 fd
= SCM_FPORT_FDES (sock
);
1459 len
= scm_i_string_length (message
);
1460 message
= scm_i_string_start_writing (message
);
1461 src
= scm_i_string_writable_chars (message
);
1462 SCM_SYSCALL (rv
= send (fd
, src
, len
, flg
));
1463 scm_i_string_stop_writing ();
1468 scm_remember_upto_here_1 (message
);
1469 return scm_from_int (rv
);
1473 SCM_DEFINE (scm_recvfrom
, "recvfrom!", 2, 3, 0,
1474 (SCM sock
, SCM str
, SCM flags
, SCM start
, SCM end
),
1475 "Receive data from socket port @var{sock} (which must be already\n"
1476 "bound), returning the originating address as well as the data.\n"
1477 "This is usually for use on datagram sockets, but can be used on\n"
1478 "stream-oriented sockets too.\n"
1480 "The data received is stored in the given @var{str}, using\n"
1481 "either the whole string or just the region between the optional\n"
1482 "@var{start} and @var{end} positions. The size of @var{str}\n"
1483 "limits the amount of data which can be received. For datagram\n"
1484 "protocols, if a packet larger than this is received then excess\n"
1485 "bytes are irrevocably lost.\n"
1487 "The return value is a pair. The @code{car} is the number of\n"
1488 "bytes read. The @code{cdr} is a socket address object which is\n"
1489 "where the data come from, or @code{#f} if the origin is\n"
1492 "The optional @var{flags} argument is a or bitwise OR\n"
1493 "(@code{logior}) of @code{MSG_OOB}, @code{MSG_PEEK},\n"
1494 "@code{MSG_DONTROUTE} etc.\n"
1496 "Data is read directly from the socket file descriptor, any\n"
1497 "buffered port data is ignored.\n"
1499 "On a GNU/Linux system @code{recvfrom!} is not multi-threading,\n"
1500 "all threads stop while a @code{recvfrom!} call is in progress.\n"
1501 "An application may need to use @code{select}, @code{O_NONBLOCK}\n"
1502 "or @code{MSG_DONTWAIT} to avoid this.")
1503 #define FUNC_NAME s_scm_recvfrom
1512 socklen_t addr_size
= MAX_ADDR_SIZE
;
1513 scm_t_max_sockaddr addr
;
1515 SCM_VALIDATE_OPFPORT (1, sock
);
1516 fd
= SCM_FPORT_FDES (sock
);
1518 SCM_VALIDATE_STRING (2, str
);
1519 scm_i_get_substring_spec (scm_i_string_length (str
),
1520 start
, &offset
, end
, &cend
);
1522 if (SCM_UNBNDP (flags
))
1525 SCM_VALIDATE_ULONG_COPY (3, flags
, flg
);
1527 /* recvfrom will not necessarily return an address. usually nothing
1528 is returned for stream sockets. */
1529 str
= scm_i_string_start_writing (str
);
1530 buf
= scm_i_string_writable_chars (str
);
1531 ((struct sockaddr
*) &addr
)->sa_family
= AF_UNSPEC
;
1532 SCM_SYSCALL (rv
= recvfrom (fd
, buf
+ offset
,
1534 (struct sockaddr
*) &addr
, &addr_size
));
1535 scm_i_string_stop_writing ();
1539 if (((struct sockaddr
*) &addr
)->sa_family
!= AF_UNSPEC
)
1540 address
= _scm_from_sockaddr (&addr
, addr_size
, FUNC_NAME
);
1542 address
= SCM_BOOL_F
;
1544 scm_remember_upto_here_1 (str
);
1546 return scm_cons (scm_from_int (rv
), address
);
1550 SCM_DEFINE (scm_sendto
, "sendto", 3, 1, 1,
1551 (SCM sock
, SCM message
, SCM fam_or_sockaddr
, SCM address
, SCM args_and_flags
),
1552 "Transmit the string @var{message} on the socket port\n"
1554 "destination address is specified using the @var{fam},\n"
1555 "@var{address} and\n"
1556 "@var{args_and_flags} arguments, or just a socket address object "
1557 "returned by @code{make-socket-address}, in a similar way to the\n"
1558 "@code{connect} procedure. @var{args_and_flags} contains\n"
1559 "the usual connection arguments optionally followed by\n"
1560 "a flags argument, which is a value or\n"
1561 "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
1562 "The value returned is the number of bytes transmitted --\n"
1563 "it's possible for\n"
1564 "this to be less than the length of @var{message} if the\n"
1566 "set to be non-blocking.\n"
1567 "Note that the data is written directly to the socket\n"
1568 "file descriptor:\n"
1569 "any unflushed buffered port data is ignored.\n"
1570 "This operation is defined only for strings containing codepoints\n"
1572 #define FUNC_NAME s_scm_sendto
1577 struct sockaddr
*soka
;
1580 sock
= SCM_COERCE_OUTPORT (sock
);
1581 SCM_VALIDATE_FPORT (1, sock
);
1582 SCM_VALIDATE_STRING (2, message
);
1583 fd
= SCM_FPORT_FDES (sock
);
1585 if (!scm_is_number (fam_or_sockaddr
))
1587 /* FAM_OR_SOCKADDR must actually be a `socket address' object. This
1588 means that the following arguments, i.e. ADDRESS and those listed in
1589 ARGS_AND_FLAGS, are the `MSG_' flags. */
1590 soka
= scm_to_sockaddr (fam_or_sockaddr
, &size
);
1591 if (address
!= SCM_UNDEFINED
)
1592 args_and_flags
= scm_cons (address
, args_and_flags
);
1595 soka
= scm_fill_sockaddr (scm_to_int (fam_or_sockaddr
), address
,
1596 &args_and_flags
, 3, FUNC_NAME
, &size
);
1598 if (scm_is_null (args_and_flags
))
1602 SCM_VALIDATE_CONS (5, args_and_flags
);
1603 flg
= SCM_NUM2ULONG (5, SCM_CAR (args_and_flags
));
1605 SCM_SYSCALL (rv
= sendto (fd
,
1606 scm_i_string_chars (message
),
1607 scm_i_string_length (message
),
1611 int save_errno
= errno
;
1618 scm_remember_upto_here_1 (message
);
1619 return scm_from_int (rv
);
1628 /* protocol families. */
1630 scm_c_define ("AF_UNSPEC", scm_from_int (AF_UNSPEC
));
1633 scm_c_define ("AF_UNIX", scm_from_int (AF_UNIX
));
1636 scm_c_define ("AF_INET", scm_from_int (AF_INET
));
1639 scm_c_define ("AF_INET6", scm_from_int (AF_INET6
));
1643 scm_c_define ("PF_UNSPEC", scm_from_int (PF_UNSPEC
));
1646 scm_c_define ("PF_UNIX", scm_from_int (PF_UNIX
));
1649 scm_c_define ("PF_INET", scm_from_int (PF_INET
));
1652 scm_c_define ("PF_INET6", scm_from_int (PF_INET6
));
1655 /* standard addresses. */
1657 scm_c_define ("INADDR_ANY", scm_from_ulong (INADDR_ANY
));
1659 #ifdef INADDR_BROADCAST
1660 scm_c_define ("INADDR_BROADCAST", scm_from_ulong (INADDR_BROADCAST
));
1663 scm_c_define ("INADDR_NONE", scm_from_ulong (INADDR_NONE
));
1665 #ifdef INADDR_LOOPBACK
1666 scm_c_define ("INADDR_LOOPBACK", scm_from_ulong (INADDR_LOOPBACK
));
1671 SOCK_PACKET is deliberately omitted, the GNU/Linux socket(2) and
1672 packet(7) advise that it's obsolete and strongly deprecated. */
1675 scm_c_define ("SOCK_STREAM", scm_from_int (SOCK_STREAM
));
1678 scm_c_define ("SOCK_DGRAM", scm_from_int (SOCK_DGRAM
));
1680 #ifdef SOCK_SEQPACKET
1681 scm_c_define ("SOCK_SEQPACKET", scm_from_int (SOCK_SEQPACKET
));
1684 scm_c_define ("SOCK_RAW", scm_from_int (SOCK_RAW
));
1687 scm_c_define ("SOCK_RDM", scm_from_int (SOCK_RDM
));
1690 /* setsockopt level.
1692 SOL_IP, SOL_TCP and SOL_UDP are defined on gnu/linux, but not on for
1693 instance NetBSD. We define IPPROTOs because that's what the posix spec
1694 shows in its example at
1696 http://www.opengroup.org/onlinepubs/007904975/functions/getsockopt.html
1699 scm_c_define ("SOL_SOCKET", scm_from_int (SOL_SOCKET
));
1702 scm_c_define ("IPPROTO_IP", scm_from_int (IPPROTO_IP
));
1705 scm_c_define ("IPPROTO_TCP", scm_from_int (IPPROTO_TCP
));
1708 scm_c_define ("IPPROTO_UDP", scm_from_int (IPPROTO_UDP
));
1711 /* setsockopt names. */
1713 scm_c_define ("SO_DEBUG", scm_from_int (SO_DEBUG
));
1716 scm_c_define ("SO_REUSEADDR", scm_from_int (SO_REUSEADDR
));
1719 scm_c_define ("SO_STYLE", scm_from_int (SO_STYLE
));
1722 scm_c_define ("SO_TYPE", scm_from_int (SO_TYPE
));
1725 scm_c_define ("SO_ERROR", scm_from_int (SO_ERROR
));
1728 scm_c_define ("SO_DONTROUTE", scm_from_int (SO_DONTROUTE
));
1731 scm_c_define ("SO_BROADCAST", scm_from_int (SO_BROADCAST
));
1734 scm_c_define ("SO_SNDBUF", scm_from_int (SO_SNDBUF
));
1737 scm_c_define ("SO_RCVBUF", scm_from_int (SO_RCVBUF
));
1740 scm_c_define ("SO_KEEPALIVE", scm_from_int (SO_KEEPALIVE
));
1743 scm_c_define ("SO_OOBINLINE", scm_from_int (SO_OOBINLINE
));
1746 scm_c_define ("SO_NO_CHECK", scm_from_int (SO_NO_CHECK
));
1749 scm_c_define ("SO_PRIORITY", scm_from_int (SO_PRIORITY
));
1752 scm_c_define ("SO_LINGER", scm_from_int (SO_LINGER
));
1755 /* recv/send options. */
1757 scm_c_define ("MSG_DONTWAIT", scm_from_int (MSG_DONTWAIT
));
1760 scm_c_define ("MSG_OOB", scm_from_int (MSG_OOB
));
1763 scm_c_define ("MSG_PEEK", scm_from_int (MSG_PEEK
));
1765 #ifdef MSG_DONTROUTE
1766 scm_c_define ("MSG_DONTROUTE", scm_from_int (MSG_DONTROUTE
));
1770 scm_i_init_socket_Win32 ();
1773 #ifdef IP_ADD_MEMBERSHIP
1774 scm_c_define ("IP_ADD_MEMBERSHIP", scm_from_int (IP_ADD_MEMBERSHIP
));
1775 scm_c_define ("IP_DROP_MEMBERSHIP", scm_from_int (IP_DROP_MEMBERSHIP
));
1778 #ifdef IP_MULTICAST_TTL
1779 scm_c_define ("IP_MULTICAST_TTL", scm_from_int ( IP_MULTICAST_TTL
));
1782 #ifdef IP_MULTICAST_IF
1783 scm_c_define ("IP_MULTICAST_IF", scm_from_int ( IP_MULTICAST_IF
));
1786 scm_add_feature ("socket");
1788 #include "libguile/socket.x"