3 * $Id: bres.c,v 1.7 2004/04/08 01:36:11 mdw Exp $
5 * Background reverse name resolution
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
14 * mLib is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * mLib is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Header files ------------------------------------------------------*/
38 #include <sys/types.h>
43 #include <sys/socket.h>
44 #include <netinet/in.h>
45 #include <arpa/inet.h>
53 /*----- Magic numbers -----------------------------------------------------*/
55 #define BRES_MAX 15 /* Maximum number of resolvers */
56 #define BRES_IDLE 60 /* Lifetime of an idle resolver */
58 /*----- Static variables --------------------------------------------------*/
60 #ifndef BRES_STANDALONE
62 static bres_server servers
[BRES_MAX
]; /* Statically allocated servers */
64 #define FREE ((bres_server *)&freelist)
65 static struct { bres_server
*next
, *prev
; } freelist
= { FREE
, FREE
};
67 #define QUEUE ((bres_client *)&queue)
68 static struct { bres_client
*next
, *prev
; } queue
= { QUEUE
, QUEUE
};
70 static sel_state
*sel
;
72 static const char *server
= 0;
76 /*----- Background resolver protocol --------------------------------------*/
78 /* --- Requests and responses --- *
80 * There are two types of requests: name and addr, corresponding to the
81 * standard @gethostbyname@ and @gethostbyaddr@ calls. There are two types
82 * of responses too: a positive response consists of an encoded equivalent of
83 * a @struct hostent@ structure containing the requested information; a
84 * negative response consists of an @h_errno@ value explaining the problem.
87 #define BRES_BYNAME 0 /* Request: resolve given name */
88 #define BRES_BYADDR 1 /* Request: resolve given address */
90 #define BRES_HOSTENT 0 /* Response: resolved ok */
91 #define BRES_ERROR 1 /* Response: resolution failed */
93 /* --- Encodings --- *
95 * A string is encoded as a @size_t@ length followed by the actual data. The
96 * null terminator is not transmitted.
98 * Addresses for resolution are transmitted as raw @struct in_addr@
101 * A @hostent@ structure is transmitted as a header containing fixed-size
102 * information, followed by the official name, an array of aliases, and an
103 * array of addresses. The number of items in the arrays is specified in the
106 * The implementation assumes that a complete request or reply is always
107 * sent. Undesirable blocking will occur if this is not the case. Both ends
108 * are assumed to trust each other. A protocol failure results in the child
109 * in question being terminated.
112 typedef struct hostskel
{
119 /* --- @doread@, @dowrite@ --- *
121 * Arguments: @int fd@ = file descriptor
122 * @void *buf@ = buffer for data
123 * @size_t sz@ = size of data
125 * Returns: Zero if successful, nonzero otherwise.
127 * Use: Reads or writes a chunk of data. @EINTR@ errors are retried;
128 * incomplete reads and writes are continued from where they
129 * left off. End-of-file is considered an I/O error.
132 static int doread(int fd
, void *buf
, size_t sz
)
136 int r
= read(fd
, p
, sz
);
151 static int dowrite(int fd
, const void *buf
, size_t sz
)
155 int r
= write(fd
, p
, sz
);
170 /* --- @getstring@ --- *
172 * Arguments: @int fd@ = file descriptor to read
174 * Returns: String in heap-allocated block, or a null pointer.
176 * Use: Decodes a string.
179 static char *getstring(int fd
)
184 if (doread(fd
, &sz
, sizeof(sz
)) || (p
= malloc(sz
+ 1)) == 0)
186 if (doread(fd
, p
, sz
)) {
194 /* --- @putstring@ --- *
196 * Arguments: @int fd@ = file descriptor to write on
197 * @const char *p@ = pointer to string to write
199 * Returns: Zero if successful.
201 * Use: Encodes a string.
204 static int putstring(int fd
, const char *p
)
206 size_t sz
= strlen(p
);
207 if (dowrite(fd
, &sz
, sizeof(sz
)) || dowrite(fd
, p
, sz
))
212 /* --- @gethost@ --- *
214 * Arguments: @int fd@ = file descriptor to read
216 * Returns: Pointer to heap-allocated @struct hostent@, or null.
218 * Use: Decodes a host structure. The resulting structure is all in
219 * one big heap block.
222 #ifndef BRES_STANDALONE
224 static struct hostent
*gethost(int fd
)
231 /* --- Read the skeleton structure --- */
233 if (doread(fd
, &hsk
, sizeof(hsk
)))
236 /* --- Read the hostname and alias strings --- *
238 * Count the length of the strings as we go.
243 sizeof(struct hostent
) +
244 hsk
.naddr
* hsk
.addrsz
+
245 (hsk
.naddr
+ hsk
.nalias
+ 2) * sizeof(char *);
247 /* --- Read the primary host name --- */
249 if ((name
= getstring(fd
)) == 0)
251 sz
+= strlen(name
) + 1;
253 /* --- Read in the alias names --- */
257 if ((alias
= malloc(hsk
.nalias
* sizeof(char *))) == 0)
259 for (i
= 0; i
< hsk
.nalias
; i
++)
261 for (i
= 0; i
< hsk
.nalias
; i
++) {
262 if ((alias
[i
] = getstring(fd
)) == 0)
264 sz
+= strlen(alias
[i
]) + 1;
268 /* --- Allocate the output structure --- */
270 if ((h
= malloc(sz
)) == 0)
274 /* --- Fill in the base structure --- */
276 h
->h_addrtype
= hsk
.addrtype
;
277 h
->h_length
= hsk
.addrsz
;
279 /* --- Start putting everything else in --- */
282 char **p
= (char **)(h
+ 1);
283 char *a
= (char *)(p
+ hsk
.nalias
+ hsk
.naddr
+ 2);
286 /* --- Start with the address table --- */
289 if (doread(fd
, a
, hsk
.naddr
* hsk
.addrsz
))
291 for (i
= 0; i
< hsk
.naddr
; i
++) {
297 /* --- Finally copy the strings over --- */
299 #define PUT(_p) do { \
300 size_t _len = strlen(_p) + 1; \
301 memcpy(a, (_p), _len); \
309 for (i
= 0; i
< hsk
.nalias
; i
++) {
322 /* --- Tidy up after various types of failure --- */
327 for (i
= 0; i
< hsk
.nalias
&& alias
[i
]; i
++)
339 /* --- @puthost@ --- *
341 * Arguments: @int fd@ = file descriptor
342 * @struct hostent *h@ = pointer to host structure
344 * Returns: Zero if successful.
346 * Use: Encodes a host structure.
349 static int puthost(int fd
, struct hostent
*h
)
354 /* --- Fill in and send the skeleton structure --- */
356 for (i
= 0; h
->h_aliases
[i
]; i
++)
359 for (i
= 0; h
->h_addr_list
[i
]; i
++)
362 hsk
.addrtype
= h
->h_addrtype
;
363 hsk
.addrsz
= h
->h_length
;
364 if (dowrite(fd
, &hsk
, sizeof(hsk
)))
367 /* --- Send the name and alias strings --- */
369 if (putstring(fd
, h
->h_name
))
371 for (i
= 0; h
->h_aliases
[i
]; i
++) {
372 if (putstring(fd
, h
->h_aliases
[i
]))
376 /* --- Send the address data --- */
378 for (i
= 0; h
->h_addr_list
[i
]; i
++) {
379 if (dowrite(fd
, h
->h_addr_list
[i
], hsk
.addrsz
))
383 /* --- OK, done --- */
388 /*----- Resolver server ---------------------------------------------------*/
392 * Arguments: @int rfd@ = output file descriptor for resolved hostnames
393 * @int cfd@ = input file descriptor for raw addresses
397 * Use: Asynchronous name resolving process.
400 static void child(int rfd
, int cfd
)
402 /* --- Close other file descriptors --- */
406 #if defined(_SC_OPEN_MAX)
407 int maxfd
= sysconf(_SC_OPEN_MAX
);
408 #elif defined(OPEN_MAX)
409 int maxfd
= OPEN_MAX
;
415 maxfd
= 256; /* Fingers crossed... */
416 for (i
= 0; i
< maxfd
; i
++) {
417 if (i
!= rfd
&& i
!= cfd
&& i
!= 1)
422 signal(SIGTERM
, SIG_DFL
);
423 signal(SIGHUP
, SIG_DFL
);
424 signal(SIGQUIT
, SIG_DFL
);
425 signal(SIGALRM
, SIG_DFL
);
426 signal(SIGINT
, SIG_DFL
);
428 /* --- Main request/response loop --- */
434 /* --- Read the request --- */
436 if (doread(cfd
, &req
, sizeof(req
)))
439 /* --- Process it into a host structure --- */
443 /* --- Normal forward lookup --- */
446 char *name
= getstring(cfd
);
449 h
= gethostbyname(name
);
453 /* --- Reverse lookup --- */
458 if (doread(cfd
, &addr
, sizeof(addr
)))
460 if ((h
= gethostbyaddr((char *)&addr
, sizeof(addr
), AF_INET
)) == 0)
463 /* --- Do a forward lookup to confirm --- */
466 size_t sz
= strlen(h
->h_name
) + 1;
467 if ((p
= malloc(sz
)) == 0)
469 memcpy(p
, h
->h_name
, sz
);
472 h
= gethostbyname(p
);
479 for (pp
= h
->h_addr_list
; *pp
; pp
++) {
481 memcpy(&a
, *pp
, sizeof(a
));
482 if (a
.s_addr
== addr
.s_addr
) {
490 h_errno
= NO_RECOVERY
;
495 /* --- Unknown request -- may have lost sync --- */
501 /* --- Transmit the response --- */
505 if (dowrite(rfd
, &resp
, sizeof(resp
)) || puthost(rfd
, h
))
509 if (dowrite(rfd
, &resp
, sizeof(resp
)) ||
510 dowrite(rfd
, &h_errno
, sizeof(h_errno
)))
521 * Arguments: @int argc@ = number of command line arguments
522 * @char *argv[]@ = array of arguments
524 * Returns: Runs until killed or an error occurs.
526 * Use: A name resolver server process for mLib programs which need
527 * this sort of thing.
530 #ifdef BRES_STANDALONE
532 int main(int argc
, char *argv
[])
534 if (isatty(STDIN_FILENO
)) {
535 char *p
= strrchr(argv
[0], '/');
541 "%s: don't run this program unless you know what you're doing.\n",
545 child(STDOUT_FILENO
, STDIN_FILENO
);
551 /*----- Main code ---------------------------------------------------------*/
553 #ifndef BRES_STANDALONE
557 * Arguments: @bres_server *rs@ = pointer to server block
561 * Use: Kills a server process, reaps the losing child and makes
562 * things generally clean again.
565 static void zap(bres_server
*rs
)
567 /* --- Close the pipes, kill the child, and reap it --- */
572 kill(rs
->kid
, SIGTERM
);
573 waitpid(rs
->kid
, 0, 0);
577 /* --- Move the server to the back of the list --- */
579 rs
->next
->prev
= rs
->prev
;
580 rs
->prev
->next
= rs
->next
;
582 rs
->prev
= FREE
->prev
;
583 FREE
->prev
->next
= rs
;
587 /* --- @bres_abort@ --- *
589 * Arguments: @bres_client *rc@ = pointer to client block
593 * Use: Removes a queued job.
596 void bres_abort(bres_client
*rc
)
598 if (rc
->q
== BRES_BYNAME
)
601 sel_rmfile(&rc
->rs
->f
);
605 rc
->next
->prev
= rc
->prev
;
606 rc
->prev
->next
= rc
->next
;
612 * Arguments: @struct timeval *tv@ = pointer to the current time
613 * @void *vp@ = pointer to a server block
617 * Use: Kills off a child which has been idle for too long.
620 static void idle(struct timeval
*tv
, void *vp
)
622 bres_server
*rs
= vp
;
626 /* --- @answer@ --- *
628 * Arguments: @int fd@ = file descriptor which is ready
629 * @unsigned mode@ = what it's doing now
630 * @void *vp@ = pointer to server block
634 * Use: Retrieves an answer from a name resolver process.
637 static void attach(bres_client */
*rc*/
);
639 static void answer(int fd
, unsigned mode
, void *vp
)
641 bres_server
*rs
= vp
;
642 bres_client
*rc
= rs
->rc
;
643 struct hostent
*h
= 0;
647 /* --- Report the result to my client --- */
651 if (doread(fd
, &resp
, sizeof(resp
)) == 0) {
654 doread(fd
, &h_errno
, sizeof(h_errno
));
665 if (rc
->q
== BRES_BYNAME
)
675 /* --- Wrap up the various structures --- */
679 rs
->next
= FREE
->next
;
681 FREE
->next
->prev
= rs
;
684 /* --- Tie a timer onto the server block --- */
689 gettimeofday(&tv
, 0);
690 tv
.tv_sec
+= BRES_IDLE
;
691 sel_addtimer(sel
, &rs
->t
, &tv
, idle
, rs
);
694 /* --- If there are any clients waiting, attach one --- */
696 if (QUEUE
->next
!= QUEUE
) {
698 QUEUE
->next
= rc
->next
;
699 rc
->next
->prev
= QUEUE
;
706 * Arguments: @bres_server *rs@ = pointer to a server block
708 * Returns: Zero if OK, nonzero if something failed.
710 * Use: Starts up a child resolver process.
713 static int start(bres_server
*rs
)
718 /* --- Make the pipes --- */
725 /* --- Start up the child process --- */
727 if ((kid
= fork()) < 0)
734 dup2(cfd
[0], STDIN_FILENO
);
735 dup2(rfd
[1], STDOUT_FILENO
);
738 execlp(server
, server
, (char *)0);
739 child(STDOUT_FILENO
, STDIN_FILENO
);
741 child(rfd
[1], cfd
[0]);
745 /* --- Fix up everything in the server block --- */
750 sel_initfile(sel
, &rs
->f
, rfd
[0], SEL_READ
, answer
, rs
);
754 /* --- Fix up after errors --- */
766 /* --- @attach@ --- *
768 * Arguments: @bres_client *rc@ = pointer to a client block
772 * Use: Attaches a client to a spare server (which is assumed to
776 static void attach(bres_client
*rc
)
781 /* --- Fix up the server ready for the job --- *
783 * If the server has a process, remove its timer. Otherwise, fork off a
784 * new resolver process. This is also where I go if I find that the child
785 * resolver process has lost while I wasn't looking. Only one attempt at
786 * forking is performed.
794 if (lose
|| start(rs
))
799 /* --- Submit the job to the resolver --- */
802 struct sigaction sa
, osa
;
805 /* --- Ignore @SIGPIPE@ for now --- *
807 * This way I can trap @EPIPE@ and reap a losing child, if there was one.
810 sa
.sa_handler
= SIG_IGN
;
812 sigemptyset(&sa
.sa_mask
);
813 sigaction(SIGPIPE
, &sa
, &osa
);
815 /* --- Write the new job to the child --- */
818 if (dowrite(rs
->fd
, &rc
->q
, sizeof(rc
->q
)))
820 else switch (rc
->q
) {
822 if (dowrite(rs
->fd
, &rc
->u
.addr
, sizeof(rc
->u
.addr
)))
826 if (putstring(rs
->fd
, rc
->u
.name
))
830 sigaction(SIGPIPE
, &osa
, 0);
832 /* --- Sort out various errors --- *
834 * This was once more complicated, handling @EPIPE@ separately from other
835 * errors. Now everything's handled the same way.
844 /* --- Fiddle with lists so that everything's OK --- */
847 rs
->next
->prev
= FREE
;
848 FREE
->next
= rs
->next
;
849 rs
->next
= rs
->prev
= rs
;
856 if (rc
->q
== BRES_BYNAME
)
860 /* --- @resolve@ --- *
862 * Arguments: @bres_client *rc@ = pointer to filled-in client block
866 * Use: Dispatcher for incoming resolution jobs.
869 static void resolve(bres_client
*rc
)
871 /* --- If there's a free server, plug it in --- */
874 if (FREE
->next
== FREE
) {
876 rc
->prev
= QUEUE
->prev
;
877 QUEUE
->prev
->next
= rc
;
883 /* --- @bres_byaddr@ --- *
885 * Arguments: @bres_client *rc@ = pointer to client block
886 * @struct in_addr addr@ = address to resolve
887 * @void (*func)(struct hostent *h, void *p)@ = handler function
888 * @void *p@ = argument for handler function
892 * Use: Adds an address lookup job to the queue. The job will be
893 * processed when there's a spare resolver process to deal with
897 void bres_byaddr(bres_client
*rc
, struct in_addr addr
,
898 void (*func
)(struct hostent */
*h*/
, void */
*p*/
),
908 /* --- @bres_byname@ --- *
910 * Arguments: @bres_client *rc@ = pointer to client block
911 * @const char *name@ = name to resolve
912 * @void (*func)(struct hostent *h, void *p)@ = handler function
913 * @void *p@ = argument for handler function
917 * Use: Adds a name lookup job to the queue. The job will be
918 * processed when there's a spare resolver process to deal with
922 void bres_byname(bres_client
*rc
, const char *name
,
923 void (*func
)(struct hostent */
*h*/
, void */
*p*/
),
927 rc
->u
.name
= xstrdup(name
);
933 /* --- @bres_exec@ --- *
935 * Arguments: @const char *file@ = file containing server code or null
939 * Use: Makes `bres' use a standalone server rather than copies of
940 * the current process. This can reduce memory consumption for
941 * large processes, at the expense of startup time (which
942 * shouldn't be too bad anyway, because of the resolver design).
943 * If the filename is null, a default set up at install time is
944 * used. It's probably a good idea to leave it alone.
947 void bres_exec(const char *file
)
952 server
= BRES_SERVER
;
955 /* --- @bres_init@ --- *
957 * Arguments: @sel_state *s@ = pointer to select multiplexor
961 * Use: Initializes the background resolver for use.
964 void bres_init(sel_state
*s
)
969 for (i
= 0; i
< BRES_MAX
; i
++) {
970 servers
[i
].next
= FREE
;
971 servers
[i
].prev
= FREE
->prev
;
974 FREE
->prev
->next
= &servers
[i
];
975 FREE
->prev
= &servers
[i
];
981 /*----- That's all, folks -------------------------------------------------*/