2 * Copyright (c) 1995-1999, Index Data
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
6 * NT server based on threads by
7 * Chas Woodfield, Fretwell Downing Datasystems.
10 * Revision 1.59 1999-11-30 13:47:12 adam
11 * Improved installation. Moved header files to include/yaz.
13 * Revision 1.58 1999/08/27 09:40:32 adam
14 * Renamed logf function to yaz_log. Removed VC++ project files.
16 * Revision 1.57 1999/07/06 12:17:15 adam
17 * Added option -1 that runs server once (for profiling purposes).
19 * Revision 1.56 1999/06/10 11:45:30 adam
20 * Added bend_start, bend_stop handlers and removed pre_init.
21 * Handlers bend_start/bend_stop are called when service/daemon is
24 * Revision 1.55 1999/06/10 09:18:54 adam
25 * Modified so that pre_init is called when service/server is started.
27 * Revision 1.54 1999/04/16 14:45:55 adam
28 * Added interface for tcpd wrapper for access control.
30 * Revision 1.53 1999/02/02 13:57:39 adam
31 * Uses preprocessor define WIN32 instead of WINDOWS to build code
32 * for Microsoft WIN32.
34 * Revision 1.52 1998/08/21 14:13:34 adam
35 * Added GNU Configure script to build Makefiles.
37 * Revision 1.51 1998/07/07 15:51:03 adam
38 * Changed server so that it stops if bind fails - "address already in
39 * use" typically causes this.
41 * Revision 1.50 1998/06/22 11:32:39 adam
42 * Added 'conditional cs_listen' feature.
44 * Revision 1.49 1998/02/27 14:04:55 adam
45 * Fixed bug in statserv_remove.
47 * Revision 1.48 1998/02/11 11:53:36 adam
48 * Changed code so that it compiles as C++.
50 * Revision 1.47 1998/02/10 10:28:57 adam
51 * Added app_name, service_dependencies, service_display_name and
52 * options_func. options_func allows us to specify a different function
53 * to interogate the command line arguments. The other members allow us
54 * to pass the full service details accross to the service manager (CW).
57 * Revision 1.46 1998/01/30 15:24:57 adam
58 * Fixed bug in inetd code. The server listened on tcp:@:9999 even
59 * though it was started in inetd mode.
61 * Revision 1.45 1998/01/29 13:30:23 adam
62 * Better event handle system for NT/Unix.
64 * Revision 1.44 1997/11/07 13:31:52 adam
65 * Added NT Service name part of statserv_options_block. Moved NT
66 * service utility to server library.
68 * Revision 1.43 1997/10/31 12:20:09 adam
69 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
70 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
71 * Bug fix: missing fclose in data1_read_espec1.
73 * Revision 1.42 1997/10/27 14:03:02 adam
74 * Added new member to statserver_options_block, pre_init, which
75 * specifies a callback to be invoked after command line parsing and
76 * before the server listens for the first time.
78 * Revision 1.41 1997/09/29 07:19:32 adam
79 * Server library uses nmem_init/nmem_exit. The log prefix no longer
80 * includes leading path on NT.
82 * Revision 1.40 1997/09/17 12:10:41 adam
85 * Revision 1.39 1997/09/09 10:10:19 adam
86 * Another MSV5.0 port. Changed projects to include proper
87 * library/include paths.
88 * Server starts server in test-mode when no options are given.
90 * Revision 1.38 1997/09/04 14:19:14 adam
93 * Revision 1.37 1997/09/01 08:53:01 adam
94 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
95 * moved a separate directory. MSV5.0 project server.dsp created.
96 * As an option, the server can now operate as an NT service.
98 * Revision 1.36 1996/07/06 19:58:36 quinn
99 * System headerfiles gathered in yconfig
101 * Revision 1.35 1996/05/29 10:03:28 quinn
104 * Revision 1.34 1996/02/21 13:12:07 quinn
105 * *** empty log message ***
107 * Revision 1.33 1996/02/10 12:23:49 quinn
108 * Enable inetd operations fro TCP/IP stack
110 * Revision 1.32 1996/01/19 15:41:52 quinn
111 * *** empty log message ***
113 * Revision 1.31 1995/11/17 11:09:39 adam
114 * Added new option '-c' to specify configuration name in control block.
116 * Revision 1.30 1995/11/01 13:54:59 quinn
119 * Revision 1.29 1995/10/30 12:41:29 quinn
120 * Added hostname lookup for server.
122 * Revision 1.28 1995/09/29 17:12:30 quinn
125 * Revision 1.27 1995/09/27 15:03:02 quinn
126 * Modified function heads & prototypes.
128 * Revision 1.26 1995/08/29 14:44:51 quinn
131 * Revision 1.25 1995/08/29 11:18:02 quinn
132 * Added code to receive close
134 * Revision 1.24 1995/06/16 10:31:39 quinn
135 * Added session timeout.
137 * Revision 1.23 1995/06/15 12:30:48 quinn
140 * Revision 1.22 1995/06/15 07:45:17 quinn
143 * Revision 1.21 1995/06/06 08:15:40 quinn
146 * Revision 1.20 1995/05/29 08:12:09 quinn
149 * Revision 1.19 1995/05/16 09:37:27 quinn
152 * Revision 1.18 1995/05/16 08:51:09 quinn
153 * License, documentation, and memory fixes
155 * Revision 1.17 1995/05/15 11:56:42 quinn
156 * Asynchronous facilities. Restructuring of seshigh code.
158 * Revision 1.16 1995/04/10 10:23:40 quinn
159 * Some work to add scan and other things.
161 * Revision 1.15 1995/03/31 10:16:51 quinn
164 * Revision 1.14 1995/03/31 09:18:58 quinn
167 * Revision 1.13 1995/03/30 16:08:39 quinn
170 * Revision 1.12 1995/03/30 13:29:02 quinn
173 * Revision 1.11 1995/03/30 12:18:17 quinn
176 * Revision 1.10 1995/03/29 15:40:16 quinn
177 * Ongoing work. Statserv is now dynamic by default
179 * Revision 1.9 1995/03/27 08:34:30 quinn
180 * Added dynamic server functionality.
181 * Released bindings to session.c (is now redundant)
183 * Revision 1.8 1995/03/20 09:46:26 quinn
186 * Revision 1.7 1995/03/16 13:29:04 quinn
187 * Partitioned server.
189 * Revision 1.6 1995/03/15 15:18:52 quinn
190 * Little changes to better support nonblocking I/O
193 * Revision 1.5 1995/03/15 08:37:45 quinn
194 * Now we're pretty much set for nonblocking I/O.
196 * Revision 1.4 1995/03/14 16:59:48 quinn
199 * Revision 1.3 1995/03/14 11:30:15 quinn
202 * Revision 1.2 1995/03/14 10:28:03 quinn
203 * More work on demo server.
205 * Revision 1.1 1995/03/10 18:22:45 quinn
206 * The rudiments of an asynchronous server.
225 #include <yaz/comstack.h>
226 #include <yaz/tcpip.h>
227 #include <yaz/options.h>
229 #include <yaz/xmosi.h>
234 #include <yaz/statserv.h>
236 static IOCHAN pListener = NULL;
238 static char *me = "statserver";
242 int check_options(int argc, char **argv);
243 statserv_options_block control_block = {
244 1, /* dynamic mode */
245 0, /* one shot (single session) */
246 LOG_DEFAULT_LEVEL, /* log level */
248 "", /* diagnostic output to stderr */
249 "tcp:@:9999", /* default listener port */
250 PROTO_Z3950, /* default application protocol */
251 60, /* idle timeout (minutes) */
252 1024*1024, /* maximum PDU size (approx.) to allow */
253 "default-config", /* configuration name to pass to backend */
254 "", /* set user id */
255 0, /* bend_start handler */
256 0, /* bend_stop handler */
257 check_options, /* Default routine, for checking the run-time arguments */
260 0 /* default value for inet deamon */
263 ,"Z39.50 Server", /* NT Service Name */
264 "Server", /* NT application Name */
265 "", /* NT Service Dependencies */
266 "Z39.50 Server" /* NT Service Display Name */
271 * handle incoming connect requests.
272 * The dynamic mode is a bit tricky mostly because we want to avoid
273 * doing all of the listening and accepting in the parent - it's
278 typedef struct _ThreadList ThreadList;
287 static ThreadList *pFirstThread;
288 static CRITICAL_SECTION Thread_CritSect;
289 static BOOL bInitialized = FALSE;
291 static void ThreadList_Initialize()
293 /* Initialize the critical Sections */
294 InitializeCriticalSection(&Thread_CritSect);
296 /* Set the first thraed */
299 /* we have been initialized */
303 static void statserv_add(HANDLE hThread, IOCHAN pIOChannel)
305 /* Only one thread can go through this section at a time */
306 EnterCriticalSection(&Thread_CritSect);
309 /* Lets create our new object */
310 ThreadList *pNewThread = (ThreadList *)malloc(sizeof(ThreadList));
311 pNewThread->hThread = hThread;
312 pNewThread->pIOChannel = pIOChannel;
313 pNewThread->pNext = pFirstThread;
314 pFirstThread = pNewThread;
316 /* Lets let somebody else create a new object now */
317 LeaveCriticalSection(&Thread_CritSect);
321 void statserv_remove(IOCHAN pIOChannel)
323 /* Only one thread can go through this section at a time */
324 EnterCriticalSection(&Thread_CritSect);
327 ThreadList *pCurrentThread = pFirstThread;
328 ThreadList *pNextThread;
329 ThreadList *pPrevThread =NULL;
331 /* Step through alll the threads */
332 for (; pCurrentThread != NULL; pCurrentThread = pNextThread)
334 /* We only need to compare on the IO Channel */
335 if (pCurrentThread->pIOChannel == pIOChannel)
337 /* We have found the thread we want to delete */
338 /* First of all reset the next pointers */
339 if (pPrevThread == NULL)
340 pFirstThread = pCurrentThread->pNext;
342 pPrevThread->pNext = pCurrentThread->pNext;
344 /* All we need todo now is delete the memory */
345 free(pCurrentThread);
347 /* No need to look at any more threads */
352 /* We need to look at another thread */
353 pNextThread = pCurrentThread->pNext;
354 pPrevThread = pCurrentThread;
358 /* Lets let somebody else remove an object now */
359 LeaveCriticalSection(&Thread_CritSect);
363 void statserv_closedown()
365 /* Shouldn't do anything if we are not initialized */
369 HANDLE *pThreadHandles = NULL;
371 /* We need to stop threads adding and removing while we */
372 /* start the closedown process */
373 EnterCriticalSection(&Thread_CritSect);
376 /* We have exclusive access to the thread stuff now */
377 /* Y didn't i use a semaphore - Oh well never mind */
378 ThreadList *pCurrentThread = pFirstThread;
380 /* Before we do anything else, we need to shutdown the listener */
381 if (pListener != NULL)
382 iochan_destroy(pListener);
384 for (; pCurrentThread != NULL; pCurrentThread = pCurrentThread->pNext)
386 /* Just destroy the IOCHAN, that should do the trick */
387 iochan_destroy(pCurrentThread->pIOChannel);
389 /* Keep a running count of our handles */
395 HANDLE *pCurrentHandle ;
397 /* Allocate the thread handle array */
398 pThreadHandles = (HANDLE *)malloc(sizeof(HANDLE) * iHandles);
399 pCurrentHandle = pThreadHandles;
401 for (pCurrentThread = pFirstThread;
402 pCurrentThread != NULL;
403 pCurrentThread = pCurrentThread->pNext, pCurrentHandle++)
405 /* Just the handle */
406 *pCurrentHandle = pCurrentThread->hThread;
410 /* We can now leave the critical section */
411 LeaveCriticalSection(&Thread_CritSect);
414 /* Now we can really do something */
417 /* This will now wait, until all the threads close */
418 WaitForMultipleObjects(iHandles, pThreadHandles, TRUE, INFINITE);
420 /* Free the memory we allocated for the handle array */
421 free(pThreadHandles);
424 if (control_block.bend_stop)
425 (*control_block.bend_stop)(&control_block);
426 /* No longer require the critical section, since all threads are dead */
427 DeleteCriticalSection(&Thread_CritSect);
431 int __stdcall event_loop_thread (IOCHAN iochan)
433 return event_loop (&iochan);
436 static void listener(IOCHAN h, int event)
438 COMSTACK line = (COMSTACK) iochan_getdata(h);
443 if (event == EVENT_INPUT)
445 if ((res = cs_listen(line, 0, 0)) < 0)
447 yaz_log(LOG_FATAL, "cs_listen failed");
452 yaz_log(LOG_DEBUG, "listen ok");
453 iochan_setevent(h, EVENT_OUTPUT);
454 iochan_setflags(h, EVENT_OUTPUT | EVENT_EXCEPT); /* set up for acpt */
456 else if (event == EVENT_OUTPUT)
463 if (!(new_line = cs_accept(line)))
465 yaz_log(LOG_FATAL, "Accept failed.");
466 iochan_setflags(h, EVENT_INPUT | EVENT_EXCEPT); /* reset listener */
469 yaz_log(LOG_DEBUG, "Accept ok");
471 if (!(new_chan = iochan_create(cs_fileno(new_line), ir_session,
474 yaz_log(LOG_FATAL, "Failed to create iochan");
479 yaz_log(LOG_DEBUG, "Creating association");
480 if (!(newas = create_association(new_chan, new_line)))
482 yaz_log(LOG_FATAL, "Failed to create new assoc.");
486 yaz_log(LOG_DEBUG, "Setting timeout %d", control_block.idle_timeout);
487 iochan_setdata(new_chan, newas);
488 iochan_settimeout(new_chan, control_block.idle_timeout * 60);
490 yaz_log(LOG_DEBUG, "Determining client address");
491 a = cs_addrstr(new_line);
492 yaz_log(LOG_LOG, "Accepted connection from %s", a ? a : "[Unknown]");
494 /* Now what we need todo is create a new thread with this iochan as
496 /* if (CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)event_loop_thread,
497 new_chan, 0, &ThreadId) == NULL) */
498 /* Somehow, somewhere we need to store this thread id, otherwise we
499 won't be able to close cleanly */
500 NewHandle = (HANDLE)_beginthreadex(NULL, 0, event_loop_thread,
501 new_chan, 0, &ThreadId);
502 if (NewHandle == (HANDLE)-1)
505 yaz_log(LOG_FATAL|LOG_ERRNO, "Failed to create new thread.");
509 /* We successfully created the thread, so add it to the list */
510 statserv_add(NewHandle, new_chan);
512 yaz_log(LOG_DEBUG, "Created new thread, iochan %p", new_chan);
513 iochan_setflags(h, EVENT_INPUT | EVENT_EXCEPT); /* reset listener */
517 yaz_log(LOG_FATAL, "Bad event on listener.");
525 /* To save having an #ifdef in event_loop we need to define this empty function */
526 void statserv_remove(IOCHAN pIOChannel)
530 void statserv_closedown()
533 for (p = pListener; p; p = p->next)
537 static void listener(IOCHAN h, int event)
539 COMSTACK line = (COMSTACK) iochan_getdata(h);
542 static int child = 0;
545 if (event == EVENT_INPUT)
547 if (control_block.dynamic && !child)
553 yaz_log(LOG_FATAL|LOG_ERRNO, "pipe");
557 if ((res = fork()) < 0)
559 yaz_log(LOG_FATAL|LOG_ERRNO, "fork");
563 else if (res == 0) /* child */
570 for (pp = pListener; pp; pp = iochan_getnext(pp))
574 COMSTACK l = (COMSTACK)iochan_getdata(pp);
579 sprintf(nbuf, "%s(%d)", me, getpid());
580 log_init(control_block.loglevel, nbuf, 0);
585 /* wait for child to take the call */
591 if ((res = read(hand[0], dummy, 1)) < 0 && errno != EINTR)
593 yaz_log(LOG_FATAL|LOG_ERRNO, "handshake read");
599 yaz_log(LOG_DEBUG, "P: Child has taken the call");
604 if ((res = cs_listen_check(line, 0, 0, control_block.check_ip,
605 control_block.daemon_name)) < 0)
607 yaz_log(LOG_WARN, "cs_listen failed");
612 yaz_log(LOG_DEBUG, "listen ok");
613 iochan_setevent(h, EVENT_OUTPUT);
614 iochan_setflags(h, EVENT_OUTPUT | EVENT_EXCEPT); /* set up for acpt */
616 /* in dynamic mode, only the child ever comes down here */
617 else if (event == EVENT_OUTPUT)
623 if (!(new_line = cs_accept(line)))
625 yaz_log(LOG_FATAL, "Accept failed.");
626 iochan_setflags(h, EVENT_INPUT | EVENT_EXCEPT); /* reset listener */
629 yaz_log(LOG_DEBUG, "accept ok");
630 if (control_block.dynamic)
633 /* close our half of the listener socket */
634 for (pp = pListener; pp; pp = iochan_getnext(pp))
636 COMSTACK l = (COMSTACK)iochan_getdata(pp);
641 yaz_log(LOG_DEBUG, "Releasing parent");
645 iochan_setflags(h, EVENT_INPUT | EVENT_EXCEPT); /* reset listener */
647 if (!(new_chan = iochan_create(cs_fileno(new_line), ir_session,
650 yaz_log(LOG_FATAL, "Failed to create iochan");
654 new_chan->next = pListener;
655 pListener = new_chan;
656 if (!(newas = create_association(new_chan, new_line)))
658 yaz_log(LOG_FATAL, "Failed to create new assoc.");
662 iochan_setdata(new_chan, newas);
663 iochan_settimeout(new_chan, control_block.idle_timeout * 60);
664 a = cs_addrstr(new_line);
665 yaz_log(LOG_LOG, "Accepted connection from %s", a ? a : "[Unknown]");
669 yaz_log(LOG_FATAL, "Bad event on listener.");
677 static void inetd_connection(int what)
684 if ((line = cs_createbysocket(0, tcpip_type, 0, what)))
686 if ((chan = iochan_create(cs_fileno(line), ir_session, EVENT_INPUT)))
688 if ((assoc = create_association(chan, line)))
690 iochan_setdata(chan, assoc);
691 iochan_settimeout(chan, control_block.idle_timeout * 60);
692 addr = cs_addrstr(line);
693 yaz_log(LOG_LOG, "Inetd association from %s", addr ? addr : "[UNKNOWN]");
697 yaz_log(LOG_FATAL, "Failed to create association structure");
699 chan->next = pListener;
704 yaz_log(LOG_FATAL, "Failed to create iochan");
709 yaz_log(LOG_ERRNO|LOG_FATAL, "Failed to create comstack on socket 0");
714 * Set up a listening endpoint, and give it to the event-handler.
716 static void add_listener(char *where, int what)
720 char mode[100], addr[100];
724 if (!where || sscanf(where, "%[^:]:%s", mode, addr) != 2)
726 yaz_log (LOG_WARN, "%s: Address format: ('tcp'|'osi')':'<address>", me);
729 if (!strcmp(mode, "tcp"))
731 else if (!strcmp(mode, "osi"))
736 yaz_log (LOG_WARN, "OSI Transport not allowed by configuration.");
742 yaz_log (LOG_WARN, "You must specify either 'osi:' or 'tcp:'");
745 yaz_log(LOG_LOG, "Adding %s %s listener on %s",
746 control_block.dynamic ? "dynamic" : "static",
747 what == PROTO_SR ? "SR" : "Z3950", where);
748 if (!(l = cs_create(type, 0, what)))
750 yaz_log(LOG_FATAL|LOG_ERRNO, "Failed to create listener");
753 ap = cs_straddr (l, addr);
756 fprintf(stderr, "Address resolution failed.\n");
760 if (cs_bind(l, ap, CS_SERVER) < 0)
762 yaz_log(LOG_FATAL|LOG_ERRNO, "Failed to bind to %s", where);
766 if (!(lst = iochan_create(cs_fileno(l), listener, EVENT_INPUT |
769 yaz_log(LOG_FATAL|LOG_ERRNO, "Failed to create IOCHAN-type");
773 iochan_setdata(lst, l);
775 /* Ensure our listener chain is setup properly */
776 lst->next = pListener;
781 /* For windows we don't need to catch the signals */
782 static void catchchld(int num)
784 while (waitpid(-1, 0, WNOHANG) > 0)
786 signal(SIGCHLD, catchchld);
790 statserv_options_block *statserv_getcontrol(void)
792 static statserv_options_block cb;
794 memcpy(&cb, &control_block, sizeof(cb));
798 void statserv_setcontrol(statserv_options_block *block)
800 memcpy(&control_block, block, sizeof(*block));
803 int statserv_start(int argc, char **argv)
809 /* We need to initialize the thread list */
810 ThreadList_Initialize();
814 if ((me = strrchr (argv[0], '\\')))
821 if (control_block.options_func(argc, argv))
824 if (control_block.bend_start)
825 (*control_block.bend_start)(&control_block);
827 if (control_block.inetd)
828 inetd_connection(control_block.default_proto);
831 if (control_block.dynamic)
832 signal(SIGCHLD, catchchld);
834 if (*control_block.setuid)
838 if (!(pw = getpwnam(control_block.setuid)))
840 yaz_log(LOG_FATAL, "%s: Unknown user", control_block.setuid);
843 if (setuid(pw->pw_uid) < 0)
845 yaz_log(LOG_FATAL|LOG_ERRNO, "setuid");
851 if ((pListener == NULL) && *control_block.default_listen)
852 add_listener(control_block.default_listen,
853 control_block.default_proto);
855 if (pListener == NULL)
859 yaz_log(LOG_LOG, "Entering event loop.");
860 ret = event_loop(&pListener);
866 int check_options(int argc, char **argv)
871 while ((ret = options("1a:iszSl:v:u:c:w:t:k:d:", argv, argc, &arg)) != -2)
876 add_listener(arg, control_block.default_proto);
879 control_block.one_shot = 1;
880 control_block.dynamic = 0;
883 control_block.default_proto = PROTO_Z3950;
886 control_block.default_proto = PROTO_SR;
889 control_block.dynamic = 0;
892 strcpy(control_block.logfile, arg ? arg : "");
893 log_init(control_block.loglevel, me, control_block.logfile);
896 control_block.loglevel = log_mask_str(arg);
897 log_init(control_block.loglevel, me, control_block.logfile);
900 strcpy(control_block.apdufile, arg ? arg : "");
903 strcpy(control_block.setuid, arg ? arg : "");
906 strcpy(control_block.configname, arg ? arg : "");
909 strcpy(control_block.daemon_name, arg ? arg : "");
912 if (!arg || !(r = atoi(arg)))
914 fprintf(stderr, "%s: Specify positive timeout for -t.\n", me);
917 control_block.idle_timeout = r;
920 if (!arg || !(r = atoi(arg)))
922 fprintf(stderr, "%s: Specify positive size for -k.\n", me);
925 control_block.maxrecordsize = r * 1024;
928 control_block.inetd = 1;
938 fprintf(stderr, "Usage: %s [ -i -a <pdufile> -v <loglevel>"
939 " -l <logfile> -u <user> -c <config> -t <minutes>"
940 " -k <kilobytes> -d <daemon>"
941 " -zsS <listener-addr> -w <directory> ... ]\n", me);
955 static Args ArgDetails;
957 /* name of the executable */
958 #define SZAPPNAME "server"
960 /* list of service dependencies - "dep1\0dep2\0\0" */
961 #define SZDEPENDENCIES ""
963 int statserv_main(int argc, char **argv)
965 statserv_options_block *cb = statserv_getcontrol();
967 /* Lets setup the Arg structure */
968 ArgDetails.argc = argc;
969 ArgDetails.argv = argv;
971 /* Now setup the service with the service controller */
972 SetupService(argc, argv, &ArgDetails, SZAPPNAME,
973 cb->service_name, /* internal service name */
974 cb->service_name, /* displayed name of the service */
979 int StartAppService(void *pHandle, int argc, char **argv)
981 /* Initializes the App */
985 void RunAppService(void *pHandle)
987 Args *pArgs = (Args *)pHandle;
989 /* Starts the app running */
990 statserv_start(pArgs->argc, pArgs->argv);
993 void StopAppService(void *pHandle)
996 statserv_closedown();
999 int statserv_main(int argc, char **argv)
1001 int ret = statserv_start (argc, argv);
1002 statserv_closedown ();