1 /* $NetBSD: getnetconfig.c,v 1.18 2010/12/08 02:06:38 joerg Exp $ */
4 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
5 * unrestricted use provided that this legend is included on all tape
6 * media and as a part of the software program in whole or part. Users
7 * may copy or modify Sun RPC without charge, but are not authorized
8 * to license or distribute it to anyone else except as part of a product or
9 * program developed by the user or with the express written consent of
10 * Sun Microsystems, Inc.
12 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
13 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
14 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
16 * Sun RPC is provided with no support and without any obligation on the
17 * part of Sun Microsystems, Inc. to assist in its use, correction,
18 * modification or enhancement.
20 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
21 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
22 * OR ANY PART THEREOF.
24 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
25 * or profits or other special, indirect and consequential damages, even if
26 * Sun has been advised of the possibility of such damages.
28 * Sun Microsystems, Inc.
30 * Mountain View, California 94043
33 #include <sys/cdefs.h>
34 #if defined(LIBC_SCCS) && !defined(lint)
36 static char sccsid
[] = "@(#)getnetconfig.c 1.12 91/12/19 SMI";
38 __RCSID("$NetBSD: getnetconfig.c,v 1.18 2010/12/08 02:06:38 joerg Exp $");
43 * Copyright (c) 1989 by Sun Microsystems, Inc.
46 #include "namespace.h"
47 #include "reentrant.h"
51 #include <netconfig.h>
56 #include "rpc_internal.h"
59 __weak_alias(getnetconfig
,_getnetconfig
)
60 __weak_alias(setnetconfig
,_setnetconfig
)
61 __weak_alias(endnetconfig
,_endnetconfig
)
62 __weak_alias(getnetconfigent
,_getnetconfigent
)
63 __weak_alias(freenetconfigent
,_freenetconfigent
)
64 __weak_alias(nc_perror
,_nc_perror
)
65 __weak_alias(nc_sperror
,_nc_sperror
)
69 * The five library routines in this file provide application access to the
70 * system network configuration database, /etc/netconfig. In addition to the
71 * netconfig database and the routines for accessing it, the environment
72 * variable NETPATH and its corresponding routines in getnetpath.c may also be
73 * used to specify the network transport to be used.
81 #define NC_NONETCONFIG ENOENT
82 #define NC_NOMEM ENOMEM
83 #define NC_NOTINIT EINVAL /* setnetconfig was not called first */
84 #define NC_BADFILE EBADF /* format for netconfig file is bad */
87 * semantics as strings (should be in netconfig.h)
89 #define NC_TPI_CLTS_S "tpi_clts"
90 #define NC_TPI_COTS_S "tpi_cots"
91 #define NC_TPI_COTS_ORD_S "tpi_cots_ord"
92 #define NC_TPI_RAW_S "tpi_raw"
95 * flags as characters (also should be in netconfig.h)
97 #define NC_NOFLAG_C '-'
98 #define NC_VISIBLE_C 'v'
99 #define NC_BROADCAST_C 'b'
102 * Character used to indicate there is no name-to-address lookup library
104 #define NC_NOLOOKUP "-"
106 static const char * const _nc_errors
[] = {
107 "Netconfig database not found",
110 "Netconfig database has invalid format"
113 struct netconfig_info
{
114 int eof
; /* all entries has been read */
115 int ref
; /* # of times setnetconfig() has been called */
116 struct netconfig_list
*head
; /* head of the list */
117 struct netconfig_list
*tail
; /* last of the list */
120 struct netconfig_list
{
121 char *linep
; /* hold line read from netconfig */
122 struct netconfig
*ncp
;
123 struct netconfig_list
*next
;
126 struct netconfig_vars
{
127 int valid
; /* token that indicates valid netconfig_vars */
128 int flag
; /* first time flag */
129 struct netconfig_list
*nc_configs
;
130 /* pointer to the current netconfig entry */
133 #define NC_VALID 0xfeed
134 #define NC_STORAGE 0xf00d
138 static int *__nc_error
__P((void));
139 static int parse_ncp
__P((char *, struct netconfig
*));
140 static struct netconfig
*dup_ncp
__P((struct netconfig
*));
143 static FILE *nc_file
; /* for netconfig db */
144 static struct netconfig_info ni
= { 0, 0, NULL
, NULL
};
146 #define MAXNETCONFIGLINE 1000
149 static thread_key_t nc_key
;
150 static once_t nc_once
= ONCE_INITIALIZER
;
153 __nc_error_setup(void)
155 thr_keycreate(&nc_key
, free
);
165 static int nc_error
= 0;
168 if (__isthreaded
== 0)
170 thr_once(&nc_once
, __nc_error_setup
);
171 nc_addr
= thr_getspecific(nc_key
) ;
172 if (nc_addr
== NULL
) {
173 nc_addr
= malloc(sizeof (int));
176 if (thr_setspecific(nc_key
, (void *) nc_addr
) != 0) {
189 #define nc_error (*(__nc_error()))
191 * A call to setnetconfig() establishes a /etc/netconfig "session". A session
192 * "handle" is returned on a successful call. At the start of a session (after
193 * a call to setnetconfig()) searches through the /etc/netconfig database will
194 * proceed from the start of the file. The session handle must be passed to
195 * getnetconfig() to parse the file. Each call to getnetconfig() using the
196 * current handle will process one subsequent entry in /etc/netconfig.
197 * setnetconfig() must be called before the first call to getnetconfig().
198 * (Handles are used to allow for nested calls to setnetpath()).
200 * A new session is established with each call to setnetconfig(), with a new
201 * handle being returned on each call. Previously established sessions remain
202 * active until endnetconfig() is called with that session's handle as an
205 * setnetconfig() need *not* be called before a call to getnetconfigent().
206 * setnetconfig() returns a NULL pointer on failure (for example, if
207 * the netconfig database is not present).
212 struct netconfig_vars
*nc_vars
;
214 if ((nc_vars
= malloc(sizeof(*nc_vars
))) == NULL
) {
219 * For multiple calls, i.e. nc_file is not NULL, we just return the
220 * handle without reopening the netconfig db.
223 if ((nc_file
!= NULL
) || (nc_file
= fopen(NETCONFIG
, "r")) != NULL
) {
224 nc_vars
->valid
= NC_VALID
;
226 nc_vars
->nc_configs
= ni
.head
;
227 return ((void *)nc_vars
);
230 nc_error
= NC_NONETCONFIG
;
237 * When first called, getnetconfig() returns a pointer to the first entry in
238 * the netconfig database, formatted as a struct netconfig. On each subsequent
239 * call, getnetconfig() returns a pointer to the next entry in the database.
240 * getnetconfig() can thus be used to search the entire netconfig file.
241 * getnetconfig() returns NULL at end of file.
245 getnetconfig(handlep
)
248 struct netconfig_vars
*ncp
= (struct netconfig_vars
*)handlep
;
249 char *stringp
; /* tmp string pointer */
250 struct netconfig_list
*list
;
251 struct netconfig
*np
;
254 * Verify that handle is valid
256 if (ncp
== NULL
|| nc_file
== NULL
) {
257 nc_error
= NC_NOTINIT
;
261 switch (ncp
->valid
) {
264 * If entry has already been read into the list,
265 * we return the entry in the linked list.
266 * If this is the first time call, check if there are any
267 * entries in linked list. If no entries, we need to read the
269 * If we have been here and the next entry is there, we just
272 if (ncp
->flag
== 0) { /* first time */
274 ncp
->nc_configs
= ni
.head
;
275 if (ncp
->nc_configs
!= NULL
) /* entry already exist */
276 return(ncp
->nc_configs
->ncp
);
278 else if (ncp
->nc_configs
!= NULL
&&
279 ncp
->nc_configs
->next
!= NULL
) {
280 ncp
->nc_configs
= ncp
->nc_configs
->next
;
281 return(ncp
->nc_configs
->ncp
);
285 * If we cannot find the entry in the list and is end of file,
292 nc_error
= NC_NOTINIT
;
296 stringp
= malloc(MAXNETCONFIGLINE
);
301 if (malloc_verify() == 0) {
302 fprintf(stderr
, "memory heap corrupted in getnetconfig\n");
308 * Read a line from netconfig file.
311 if (fgets(stringp
, MAXNETCONFIGLINE
, nc_file
) == NULL
) {
316 } while (*stringp
== '#');
318 list
= malloc(sizeof(*list
));
323 np
= malloc(sizeof(*np
));
331 list
->ncp
->nc_lookups
= NULL
;
332 list
->linep
= stringp
;
333 if (parse_ncp(stringp
, list
->ncp
) == -1) {
340 * If this is the first entry that's been read, it is the
341 * head of the list. If not, put the entry at the end of
342 * the list. Reposition the current pointer of the handle to
343 * the last entry in the list.
345 if (ni
.head
== NULL
) /* first entry */
346 ni
.head
= ni
.tail
= list
;
348 ni
.tail
->next
= list
;
349 ni
.tail
= ni
.tail
->next
;
351 ncp
->nc_configs
= ni
.tail
;
352 return(ni
.tail
->ncp
);
357 * endnetconfig() may be called to "unbind" or "close" the netconfig database
358 * when processing is complete, releasing resources for reuse. endnetconfig()
359 * may not be called before setnetconfig(). endnetconfig() returns 0 on
360 * success and -1 on failure (for example, if setnetconfig() was not called
364 endnetconfig(handlep
)
367 struct netconfig_vars
*nc_handlep
= (struct netconfig_vars
*)handlep
;
369 struct netconfig_list
*q
, *p
;
372 * Verify that handle is valid
374 if (nc_handlep
== NULL
|| (nc_handlep
->valid
!= NC_VALID
&&
375 nc_handlep
->valid
!= NC_STORAGE
)) {
376 nc_error
= NC_NOTINIT
;
381 * Return 0 if anyone still needs it.
383 nc_handlep
->valid
= NC_INVALID
;
384 nc_handlep
->flag
= 0;
385 nc_handlep
->nc_configs
= NULL
;
392 * Noone needs these entries anymore, then frees them.
393 * Make sure all info in netconfig_info structure has been
402 if (q
->ncp
->nc_lookups
!= NULL
) free(q
->ncp
->nc_lookups
);
416 * getnetconfigent(netid) returns a pointer to the struct netconfig structure
417 * corresponding to netid. It returns NULL if netid is invalid (that is, does
418 * not name an entry in the netconfig database). It returns NULL and sets
419 * errno in case of failure (for example, if the netconfig database cannot be
424 getnetconfigent(netid
)
427 FILE *file
; /* NETCONFIG db's file pointer */
428 char *linep
; /* holds current netconfig line */
429 char *stringp
; /* temporary string pointer */
430 struct netconfig
*ncp
= NULL
; /* returned value */
431 struct netconfig_list
*list
; /* pointer to cache list */
433 if (netid
== NULL
|| strlen(netid
) == 0)
437 * Look up table if the entries have already been read and parsed in
438 * getnetconfig(), then copy this entry into a buffer and return it.
439 * If we cannot find the entry in the current list and there are more
440 * entries in the netconfig db that has not been read, we then read the
441 * db and try find the match netid.
442 * If all the netconfig db has been read and placed into the list and
443 * there is no match for the netid, return NULL.
445 if (ni
.head
!= NULL
) {
446 for (list
= ni
.head
; list
; list
= list
->next
) {
447 if (strcmp(list
->ncp
->nc_netid
, netid
) == 0)
448 return(dup_ncp(list
->ncp
));
450 if (ni
.eof
== 1) /* that's all the entries */
454 if ((file
= fopen(NETCONFIG
, "r")) == NULL
)
457 if ((linep
= malloc(MAXNETCONFIGLINE
)) == NULL
) {
463 char *tmpp
; /* tmp string pointer */
466 if ((stringp
= fgets(linep
, MAXNETCONFIGLINE
, file
))
469 } while (*stringp
== '#');
470 if (stringp
== NULL
) /* eof */
472 if ((tmpp
= strpbrk(stringp
, "\t ")) == NULL
) {
473 /* can't parse file */
474 nc_error
= NC_BADFILE
;
477 if (strlen(netid
) == (size_t) (len
= tmpp
- stringp
) && /* a match */
478 strncmp(stringp
, netid
, (size_t)len
) == 0) {
479 if ((ncp
= malloc(sizeof(*ncp
))) == NULL
)
481 ncp
->nc_lookups
= NULL
;
482 if (parse_ncp(linep
, ncp
) == -1) {
488 } while (stringp
!= NULL
);
496 * freenetconfigent(netconfigp) frees the netconfig structure pointed to by
497 * netconfigp (previously returned by getnetconfigent()).
501 freenetconfigent(netconfigp
)
502 struct netconfig
*netconfigp
;
504 if (netconfigp
!= NULL
) {
505 /* holds all netconfigp's strings */
506 free(netconfigp
->nc_netid
);
507 if (netconfigp
->nc_lookups
!= NULL
)
508 free(netconfigp
->nc_lookups
);
514 * Parse line and stuff it in a struct netconfig
515 * Typical line might look like:
516 * udp tpi_cots vb inet udp /dev/udp /usr/lib/ip.so,/usr/local/ip.so
518 * We return -1 if any of the tokens don't parse, or malloc fails.
520 * Note that we modify stringp (putting NULLs after tokens) and
521 * we set the ncp's string field pointers to point to these tokens within
526 parse_ncp(stringp
, ncp
)
527 char *stringp
; /* string to parse */
528 struct netconfig
*ncp
; /* where to put results */
530 char *tokenp
; /* for processing tokens */
533 _DIAGASSERT(stringp
!= NULL
);
534 _DIAGASSERT(ncp
!= NULL
);
536 nc_error
= NC_BADFILE
;
537 /* nearly anything that breaks is for this reason */
538 stringp
[strlen(stringp
)-1] = '\0'; /* get rid of newline */
540 if ((ncp
->nc_netid
= strtok_r(stringp
, "\t ", &lasts
)) == NULL
)
544 if ((tokenp
= strtok_r(NULL
, "\t ", &lasts
)) == NULL
)
546 if (strcmp(tokenp
, NC_TPI_COTS_ORD_S
) == 0)
547 ncp
->nc_semantics
= NC_TPI_COTS_ORD
;
548 else if (strcmp(tokenp
, NC_TPI_COTS_S
) == 0)
549 ncp
->nc_semantics
= NC_TPI_COTS
;
550 else if (strcmp(tokenp
, NC_TPI_CLTS_S
) == 0)
551 ncp
->nc_semantics
= NC_TPI_CLTS
;
552 else if (strcmp(tokenp
, NC_TPI_RAW_S
) == 0)
553 ncp
->nc_semantics
= NC_TPI_RAW
;
558 if ((tokenp
= strtok_r(NULL
, "\t ", &lasts
)) == NULL
)
560 for (ncp
->nc_flag
= NC_NOFLAG
; *tokenp
!= '\0'; tokenp
++) {
565 ncp
->nc_flag
|= NC_VISIBLE
;
568 ncp
->nc_flag
|= NC_BROADCAST
;
574 /* protocol family */
575 if ((ncp
->nc_protofmly
= strtok_r(NULL
, "\t ", &lasts
)) == NULL
)
578 if ((ncp
->nc_proto
= strtok_r(NULL
, "\t ", &lasts
)) == NULL
)
581 if ((ncp
->nc_device
= strtok_r(NULL
, "\t ", &lasts
)) == NULL
)
583 if ((tokenp
= strtok_r(NULL
, "\t ", &lasts
)) == NULL
)
585 if (strcmp(tokenp
, NC_NOLOOKUP
) == 0) {
586 ncp
->nc_nlookups
= 0;
587 ncp
->nc_lookups
= NULL
;
589 char *cp
; /* tmp string */
591 if (ncp
->nc_lookups
!= NULL
) /* from last visit */
592 free(ncp
->nc_lookups
);
593 /* preallocate one string pointer */
594 ncp
->nc_lookups
= malloc(sizeof(*ncp
->nc_lookups
));
595 ncp
->nc_nlookups
= 0;
596 while ((cp
= tokenp
) != NULL
) {
597 tokenp
= _get_next_token(cp
, ',');
598 ncp
->nc_lookups
[(size_t)ncp
->nc_nlookups
++] = cp
;
599 ncp
->nc_lookups
= (char **)
600 realloc(ncp
->nc_lookups
,
601 (size_t)(ncp
->nc_nlookups
+1) *sizeof(char *));
609 * Returns a string describing the reason for failure.
618 message
= _nc_errors
[0];
621 message
= _nc_errors
[1];
624 message
= _nc_errors
[2];
627 message
= _nc_errors
[3];
630 message
= "Unknown network selection error";
632 return __UNCONST(message
);
636 * Prints a message onto standard error describing the reason for failure.
643 _DIAGASSERT(s
!= NULL
);
645 fprintf(stderr
, "%s: %s", s
, nc_sperror());
649 * Duplicates the matched netconfig buffer.
651 static struct netconfig
*
653 struct netconfig
*ncp
;
659 _DIAGASSERT(ncp
!= NULL
);
661 if ((tmp
= malloc(MAXNETCONFIGLINE
)) == NULL
)
663 if ((p
= malloc(sizeof(*p
))) == NULL
) {
668 * First we dup all the data from matched netconfig buffer. Then we
669 * adjust some of the member pointer to a pre-allocated buffer where
670 * contains part of the data.
671 * To follow the convention used in parse_ncp(), we store all the
672 * necessary information in the pre-allocated buffer and let each
673 * of the netconfig char pointer member point to the right address
677 p
->nc_netid
= (char *)strcpy(tmp
,ncp
->nc_netid
);
678 tmp
= strchr(tmp
, '\0') + 1;
679 p
->nc_protofmly
= (char *)strcpy(tmp
,ncp
->nc_protofmly
);
680 tmp
= strchr(tmp
, '\0') + 1;
681 p
->nc_proto
= (char *)strcpy(tmp
,ncp
->nc_proto
);
682 tmp
= strchr(tmp
, '\0') + 1;
683 p
->nc_device
= (char *)strcpy(tmp
,ncp
->nc_device
);
684 p
->nc_lookups
= malloc((size_t)(p
->nc_nlookups
+1) * sizeof(char *));
685 if (p
->nc_lookups
== NULL
) {
690 for (i
=0; i
< p
->nc_nlookups
; i
++) {
691 tmp
= strchr(tmp
, '\0') + 1;
692 p
->nc_lookups
[i
] = strcpy(tmp
,ncp
->nc_lookups
[i
]);