1 /* "net_db.c" network database support
2 * Copyright (C) 1995,1996,1997,1998,1999,2000,2001 Free Software Foundation, Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2, or (at your option)
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this software; see the file COPYING. If not, write to
16 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307 USA
19 * As a special exception, the Free Software Foundation gives permission
20 * for additional uses of the text contained in its release of GUILE.
22 * The exception is that, if you link the GUILE library with other files
23 * to produce an executable, this does not by itself cause the
24 * resulting executable to be covered by the GNU General Public License.
25 * Your use of that executable is in no way restricted on account of
26 * linking the GUILE library code into it.
28 * This exception does not however invalidate any other reasons why
29 * the executable file might be covered by the GNU General Public License.
31 * This exception applies only to the code released by the
32 * Free Software Foundation under the name GUILE. If you copy
33 * code from other Free Software Foundation releases into a copy of
34 * GUILE, as the General Public License permits, the exception does
35 * not apply to the code that you add in this way. To avoid misleading
36 * anyone as to the status of such modified files, you must delete
37 * this exception notice from them.
39 * If you write modifications of your own for GUILE, it is your choice
40 * whether to permit this exception to apply to your modifications.
41 * If you do not wish that, delete this exception notice. */
43 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
44 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
47 /* Written in 1994 by Aubrey Jaffer.
48 * Thanks to Hallvard.Tretteberg@si.sintef.no for inspiration and discussion.
49 * Rewritten by Gary Houston to be a closer interface to the C socket library.
50 * Split into net_db.c and socket.c.
56 #include "libguile/_scm.h"
57 #include "libguile/feature.h"
58 #include "libguile/strings.h"
59 #include "libguile/vectors.h"
61 #include "libguile/validate.h"
62 #include "libguile/net_db.h"
68 #include <sys/types.h>
69 #include <sys/socket.h>
71 #include <netinet/in.h>
72 #include <arpa/inet.h>
78 #endif /* STDC_HEADERS */
80 #ifndef HAVE_INET_ATON
81 /* for our definition in inet_aton.c, not usually needed. */
82 extern int inet_aton ();
86 /* h_errno not found in netdb.h, maybe this will help. */
90 SCM_DEFINE (scm_inet_aton
, "inet-aton", 1, 0, 0,
92 "Converts a string containing an Internet host address in the\n"
93 "traditional dotted decimal notation into an integer.\n"
95 "(inet-aton \"127.0.0.1\") @result{} 2130706433\n"
97 #define FUNC_NAME s_scm_inet_aton
101 SCM_VALIDATE_STRING (1, address
);
102 SCM_STRING_COERCE_0TERMINATION_X (address
);
103 if (inet_aton (SCM_STRING_CHARS (address
), &soka
) == 0)
104 SCM_MISC_ERROR ("bad address", SCM_EOL
);
105 return scm_ulong2num (ntohl (soka
.s_addr
));
110 SCM_DEFINE (scm_inet_ntoa
, "inet-ntoa", 1, 0, 0,
112 "Converts an integer Internet host address into a string with\n"
113 "the traditional dotted decimal representation.\n"
115 "(inet-ntoa 2130706433) @result{} \"127.0.0.1\"\n"
117 #define FUNC_NAME s_scm_inet_ntoa
122 addr
.s_addr
= htonl (SCM_NUM2ULONG (1, inetid
));
123 s
= inet_ntoa (addr
);
124 answer
= scm_makfromstr (s
, strlen (s
), 0);
129 #ifdef HAVE_INET_NETOF
130 SCM_DEFINE (scm_inet_netof
, "inet-netof", 1, 0, 0,
132 "Return the network number part of the given integer Internet\n"
135 "(inet-netof 2130706433) @result{} 127\n"
137 #define FUNC_NAME s_scm_inet_netof
140 addr
.s_addr
= htonl (SCM_NUM2ULONG (1, address
));
141 return scm_ulong2num ((unsigned long) inet_netof (addr
));
146 #ifdef HAVE_INET_LNAOF
147 SCM_DEFINE (scm_lnaof
, "inet-lnaof", 1, 0, 0,
149 "Return the local-address-with-network part of the given\n"
150 "Internet address.\n"
152 "(inet-lnaof 2130706433) @result{} 1\n"
154 #define FUNC_NAME s_scm_lnaof
157 addr
.s_addr
= htonl (SCM_NUM2ULONG (1, address
));
158 return scm_ulong2num ((unsigned long) inet_lnaof (addr
));
163 #ifdef HAVE_INET_MAKEADDR
164 SCM_DEFINE (scm_inet_makeaddr
, "inet-makeaddr", 2, 0, 0,
166 "Makes an Internet host address by combining the network number\n"
167 "@var{net} with the local-address-within-network number\n"
170 "(inet-makeaddr 127 1) @result{} 2130706433\n"
172 #define FUNC_NAME s_scm_inet_makeaddr
175 unsigned long netnum
;
176 unsigned long lnanum
;
178 #if 0 /* GJB:FIXME:: */
179 SCM_VALIDATE_INUM_COPY (1,net
,netnum
);
180 SCM_VALIDATE_INUM_COPY (2,lna
,lnanum
);
182 netnum
= SCM_NUM2ULONG (1, net
);
183 lnanum
= SCM_NUM2ULONG (2, lna
);
185 addr
= inet_makeaddr (netnum
, lnanum
);
186 return scm_ulong2num (ntohl (addr
.s_addr
));
191 SCM_SYMBOL (scm_host_not_found_key
, "host-not-found");
192 SCM_SYMBOL (scm_try_again_key
, "try-again");
193 SCM_SYMBOL (scm_no_recovery_key
, "no-recovery");
194 SCM_SYMBOL (scm_no_data_key
, "no-data");
196 static void scm_resolv_error (const char *subr
, SCM bad_value
)
198 #ifdef NETDB_INTERNAL
199 if (h_errno
== NETDB_INTERNAL
)
201 /* errno supposedly contains a useful value. */
213 key
= scm_host_not_found_key
;
214 errmsg
= "Unknown host";
217 key
= scm_try_again_key
;
218 errmsg
= "Host name lookup failure";
221 key
= scm_no_recovery_key
;
222 errmsg
= "Unknown server error";
225 key
= scm_no_data_key
;
226 errmsg
= "No address associated with name";
229 scm_misc_error (subr
, "Unknown resolver error", SCM_EOL
);
233 #ifdef HAVE_HSTRERROR
234 errmsg
= (const char *) hstrerror (h_errno
);
236 scm_error (key
, subr
, errmsg
, scm_cons (bad_value
, SCM_EOL
), SCM_EOL
);
240 /* Should take an extra arg for address format (will be needed for IPv6).
241 Should use reentrant facilities if available.
244 SCM_DEFINE (scm_gethost
, "gethost", 0, 1, 0,
246 "@deffnx procedure gethostbyname hostname\n"
247 "@deffnx procedure gethostbyaddr address\n"
248 "Look up a host by name or address, returning a host object. The\n"
249 "@code{gethost} procedure will accept either a string name or an integer\n"
250 "address; if given no arguments, it behaves like @code{gethostent} (see\n"
251 "below). If a name or address is supplied but the address can not be\n"
252 "found, an error will be thrown to one of the keys:\n"
253 "@code{host-not-found}, @code{try-again}, @code{no-recovery} or\n"
254 "@code{no-data}, corresponding to the equivalent @code{h_error} values.\n"
255 "Unusual conditions may result in errors thrown to the\n"
256 "@code{system-error} or @code{misc_error} keys.")
257 #define FUNC_NAME s_scm_gethost
259 SCM ans
= scm_c_make_vector (5, SCM_UNSPECIFIED
);
260 SCM
*ve
= SCM_VELTS (ans
);
262 struct hostent
*entry
;
266 if (SCM_UNBNDP (host
))
268 #ifdef HAVE_GETHOSTENT
269 entry
= gethostent ();
275 /* As far as I can tell, there's no good way to tell whether
276 zero means an error or end-of-file. The trick of
277 clearing errno before calling gethostent and checking it
278 afterwards doesn't cut it, because, on Linux, it seems to
279 try to contact some other server (YP?) and fails, which
280 is a benign failure. */
284 else if (SCM_STRINGP (host
))
286 SCM_STRING_COERCE_0TERMINATION_X (host
);
287 entry
= gethostbyname (SCM_STRING_CHARS (host
));
291 inad
.s_addr
= htonl (SCM_NUM2ULONG (1, host
));
292 entry
= gethostbyaddr ((char *) &inad
, sizeof (inad
), AF_INET
);
295 scm_resolv_error (FUNC_NAME
, host
);
297 ve
[0] = scm_makfromstr (entry
->h_name
,
298 (scm_sizet
) strlen (entry
->h_name
), 0);
299 ve
[1] = scm_makfromstrs (-1, entry
->h_aliases
);
300 ve
[2] = SCM_MAKINUM (entry
->h_addrtype
+ 0L);
301 ve
[3] = SCM_MAKINUM (entry
->h_length
+ 0L);
302 if (sizeof (struct in_addr
) != entry
->h_length
)
307 for (argv
= entry
->h_addr_list
; argv
[i
]; i
++);
310 inad
= *(struct in_addr
*) argv
[i
];
311 lst
= scm_cons (scm_ulong2num (ntohl (inad
.s_addr
)), lst
);
319 /* In all subsequent getMUMBLE functions, when we're called with no
320 arguments, we're supposed to traverse the tables entry by entry.
321 However, there doesn't seem to be any documented way to distinguish
322 between end-of-table and an error; in both cases the functions
323 return zero. Gotta love Unix. For the time being, we clear errno,
324 and if we get a zero and errno is set, we signal an error. This
325 doesn't seem quite right (what if errno gets set as part of healthy
326 operation?), but it seems to work okay. We'll see. */
328 #if defined(HAVE_GETNETENT) && defined(HAVE_GETNETBYNAME) && defined(HAVE_GETNETBYADDR)
329 SCM_DEFINE (scm_getnet
, "getnet", 0, 1, 0,
331 "@deffnx procedure getnetbyname net-name\n"
332 "@deffnx procedure getnetbyaddr net-number\n"
333 "Look up a network by name or net number in the network database. The\n"
334 "@var{net-name} argument must be a string, and the @var{net-number}\n"
335 "argument must be an integer. @code{getnet} will accept either type of\n"
336 "argument, behaving like @code{getnetent} (see below) if no arguments are\n"
338 #define FUNC_NAME s_scm_getnet
342 struct netent
*entry
;
344 ans
= scm_c_make_vector (4, SCM_UNSPECIFIED
);
345 ve
= SCM_VELTS (ans
);
346 if (SCM_UNBNDP (net
))
348 entry
= getnetent ();
351 /* There's no good way to tell whether zero means an error
352 or end-of-file, so we always return #f. See `gethost'
357 else if (SCM_STRINGP (net
))
359 SCM_STRING_COERCE_0TERMINATION_X (net
);
360 entry
= getnetbyname (SCM_STRING_CHARS (net
));
364 unsigned long netnum
;
365 netnum
= SCM_NUM2ULONG (1, net
);
366 entry
= getnetbyaddr (netnum
, AF_INET
);
369 SCM_SYSERROR_MSG ("no such network ~A", SCM_LIST1 (net
), errno
);
370 ve
[0] = scm_makfromstr (entry
->n_name
, (scm_sizet
) strlen (entry
->n_name
), 0);
371 ve
[1] = scm_makfromstrs (-1, entry
->n_aliases
);
372 ve
[2] = SCM_MAKINUM (entry
->n_addrtype
+ 0L);
373 ve
[3] = scm_ulong2num (entry
->n_net
+ 0L);
379 #ifdef HAVE_GETPROTOENT
380 SCM_DEFINE (scm_getproto
, "getproto", 0, 1, 0,
382 "@deffnx procedure getprotobyname name\n"
383 "@deffnx procedure getprotobynumber number\n"
384 "Look up a network protocol by name or by number. @code{getprotobyname}\n"
385 "takes a string argument, and @code{getprotobynumber} takes an integer\n"
386 "argument. @code{getproto} will accept either type, behaving like\n"
387 "@code{getprotoent} (see below) if no arguments are supplied.")
388 #define FUNC_NAME s_scm_getproto
392 struct protoent
*entry
;
394 ans
= scm_c_make_vector (3, SCM_UNSPECIFIED
);
395 ve
= SCM_VELTS (ans
);
396 if (SCM_UNBNDP (protocol
))
398 entry
= getprotoent ();
401 /* There's no good way to tell whether zero means an error
402 or end-of-file, so we always return #f. See `gethost'
407 else if (SCM_STRINGP (protocol
))
409 SCM_STRING_COERCE_0TERMINATION_X (protocol
);
410 entry
= getprotobyname (SCM_STRING_CHARS (protocol
));
414 unsigned long protonum
;
415 protonum
= SCM_NUM2ULONG (1, protocol
);
416 entry
= getprotobynumber (protonum
);
419 SCM_SYSERROR_MSG ("no such protocol ~A", SCM_LIST1 (protocol
), errno
);
420 ve
[0] = scm_makfromstr (entry
->p_name
, (scm_sizet
) strlen (entry
->p_name
), 0);
421 ve
[1] = scm_makfromstrs (-1, entry
->p_aliases
);
422 ve
[2] = SCM_MAKINUM (entry
->p_proto
+ 0L);
429 scm_return_entry (struct servent
*entry
)
434 ans
= scm_c_make_vector (4, SCM_UNSPECIFIED
);
435 ve
= SCM_VELTS (ans
);
436 ve
[0] = scm_makfromstr (entry
->s_name
, (scm_sizet
) strlen (entry
->s_name
), 0);
437 ve
[1] = scm_makfromstrs (-1, entry
->s_aliases
);
438 ve
[2] = SCM_MAKINUM (ntohs (entry
->s_port
) + 0L);
439 ve
[3] = scm_makfromstr (entry
->s_proto
, (scm_sizet
) strlen (entry
->s_proto
), 0);
443 #ifdef HAVE_GETSERVENT
444 SCM_DEFINE (scm_getserv
, "getserv", 0, 2, 0,
445 (SCM name
, SCM protocol
),
446 "@deffnx procedure getservbyname name protocol\n"
447 "@deffnx procedure getservbyport port protocol\n"
448 "Look up a network service by name or by service number, and return a\n"
449 "network service object. The @var{protocol} argument specifies the name\n"
450 "of the desired protocol; if the protocol found in the network service\n"
451 "database does not match this name, a system error is signalled.\n\n"
452 "The @code{getserv} procedure will take either a service name or number\n"
453 "as its first argument; if given no arguments, it behaves like\n"
454 "@code{getservent} (see below).")
455 #define FUNC_NAME s_scm_getserv
457 struct servent
*entry
;
458 if (SCM_UNBNDP (name
))
460 entry
= getservent ();
463 /* There's no good way to tell whether zero means an error
464 or end-of-file, so we always return #f. See `gethost'
468 return scm_return_entry (entry
);
470 SCM_VALIDATE_STRING (2, protocol
);
471 SCM_STRING_COERCE_0TERMINATION_X (protocol
);
472 if (SCM_STRINGP (name
))
474 SCM_STRING_COERCE_0TERMINATION_X (name
);
475 entry
= getservbyname (SCM_STRING_CHARS (name
), SCM_STRING_CHARS (protocol
));
479 SCM_VALIDATE_INUM (1,name
);
480 entry
= getservbyport (htons (SCM_INUM (name
)), SCM_STRING_CHARS (protocol
));
483 SCM_SYSERROR_MSG("no such service ~A", SCM_LIST1 (name
), errno
);
484 return scm_return_entry (entry
);
489 #if defined(HAVE_SETHOSTENT) && defined(HAVE_ENDHOSTENT)
490 SCM_DEFINE (scm_sethost
, "sethost", 0, 1, 0,
492 "If @var{stayopen} is omitted, this is equivalent to @code{endhostent}.\n"
493 "Otherwise it is equivalent to @code{sethostent stayopen}.")
494 #define FUNC_NAME s_scm_sethost
496 if (SCM_UNBNDP (stayopen
))
499 sethostent (SCM_NFALSEP (stayopen
));
500 return SCM_UNSPECIFIED
;
505 #if defined(HAVE_SETNETENT) && defined(HAVE_ENDNETENT)
506 SCM_DEFINE (scm_setnet
, "setnet", 0, 1, 0,
508 "If @var{stayopen} is omitted, this is equivalent to @code{endnetent}.\n"
509 "Otherwise it is equivalent to @code{setnetent stayopen}.")
510 #define FUNC_NAME s_scm_setnet
512 if (SCM_UNBNDP (stayopen
))
515 setnetent (SCM_NFALSEP (stayopen
));
516 return SCM_UNSPECIFIED
;
521 #if defined(HAVE_SETPROTOENT) && defined(HAVE_ENDPROTOENT)
522 SCM_DEFINE (scm_setproto
, "setproto", 0, 1, 0,
524 "If @var{stayopen} is omitted, this is equivalent to @code{endprotoent}.\n"
525 "Otherwise it is equivalent to @code{setprotoent stayopen}.")
526 #define FUNC_NAME s_scm_setproto
528 if (SCM_UNBNDP (stayopen
))
531 setprotoent (SCM_NFALSEP (stayopen
));
532 return SCM_UNSPECIFIED
;
537 #if defined(HAVE_SETSERVENT) && defined(HAVE_ENDSERVENT)
538 SCM_DEFINE (scm_setserv
, "setserv", 0, 1, 0,
540 "If @var{stayopen} is omitted, this is equivalent to @code{endservent}.\n"
541 "Otherwise it is equivalent to @code{setservent stayopen}.")
542 #define FUNC_NAME s_scm_setserv
544 if (SCM_UNBNDP (stayopen
))
547 setservent (SCM_NFALSEP (stayopen
));
548 return SCM_UNSPECIFIED
;
558 scm_sysintern ("INADDR_ANY", scm_ulong2num (INADDR_ANY
));
560 #ifdef INADDR_BROADCAST
561 scm_sysintern ("INADDR_BROADCAST", scm_ulong2num (INADDR_BROADCAST
));
564 scm_sysintern ("INADDR_NONE", scm_ulong2num (INADDR_NONE
));
566 #ifdef INADDR_LOOPBACK
567 scm_sysintern ("INADDR_LOOPBACK", scm_ulong2num (INADDR_LOOPBACK
));
570 scm_add_feature ("net-db");
571 #ifndef SCM_MAGIC_SNARFER
572 #include "libguile/net_db.x"