2 * Copyright (c) 1995-2003, Index Data
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
6 * NT threaded server code by
7 * Chas Woodfield, Fretwell Downing Informatics.
9 * $Id: statserv.c,v 1.90 2003-01-14 08:21:14 adam Exp $
34 #include <yaz/comstack.h>
35 #include <yaz/tcpip.h>
36 #include <yaz/options.h>
38 #include <yaz/xmosi.h>
43 #include <yaz/statserv.h>
45 static IOCHAN pListener = NULL;
47 static char *me = "statserver";
51 int check_options(int argc, char **argv);
52 statserv_options_block control_block = {
54 0, /* threaded mode */
55 0, /* one shot (single session) */
56 LOG_DEFAULT_LEVEL, /* log level */
58 "", /* diagnostic output to stderr */
59 "tcp:@:9999", /* default listener port */
60 PROTO_Z3950, /* default application protocol */
61 60, /* idle timeout (minutes) */
62 1024*1024, /* maximum PDU size (approx.) to allow */
63 "default-config", /* configuration name to pass to backend */
65 0, /* bend_start handler */
66 0, /* bend_stop handler */
67 check_options, /* Default routine, for checking the run-time arguments */
70 0, /* default value for inet deamon */
71 0, /* handle (for service, etc) */
72 0, /* bend_init handle */
73 0 /* bend_close handle */
75 ,"Z39.50 Server", /* NT Service Name */
76 "Server", /* NT application Name */
77 "", /* NT Service Dependencies */
78 "Z39.50 Server" /* NT Service Display Name */
83 * handle incoming connect requests.
84 * The dynamic mode is a bit tricky mostly because we want to avoid
85 * doing all of the listening and accepting in the parent - it's
90 typedef struct _ThreadList ThreadList;
99 static ThreadList *pFirstThread;
100 static CRITICAL_SECTION Thread_CritSect;
101 static BOOL bInitialized = FALSE;
103 static void ThreadList_Initialize()
105 /* Initialize the critical Sections */
106 InitializeCriticalSection(&Thread_CritSect);
108 /* Set the first thraed */
111 /* we have been initialized */
115 static void statserv_add(HANDLE hThread, IOCHAN pIOChannel)
117 /* Only one thread can go through this section at a time */
118 EnterCriticalSection(&Thread_CritSect);
121 /* Lets create our new object */
122 ThreadList *pNewThread = (ThreadList *)malloc(sizeof(ThreadList));
123 pNewThread->hThread = hThread;
124 pNewThread->pIOChannel = pIOChannel;
125 pNewThread->pNext = pFirstThread;
126 pFirstThread = pNewThread;
128 /* Lets let somebody else create a new object now */
129 LeaveCriticalSection(&Thread_CritSect);
133 void statserv_remove(IOCHAN pIOChannel)
135 /* Only one thread can go through this section at a time */
136 EnterCriticalSection(&Thread_CritSect);
139 ThreadList *pCurrentThread = pFirstThread;
140 ThreadList *pNextThread;
141 ThreadList *pPrevThread =NULL;
143 /* Step through alll the threads */
144 for (; pCurrentThread != NULL; pCurrentThread = pNextThread)
146 /* We only need to compare on the IO Channel */
147 if (pCurrentThread->pIOChannel == pIOChannel)
149 /* We have found the thread we want to delete */
150 /* First of all reset the next pointers */
151 if (pPrevThread == NULL)
152 pFirstThread = pCurrentThread->pNext;
154 pPrevThread->pNext = pCurrentThread->pNext;
156 /* All we need todo now is delete the memory */
157 free(pCurrentThread);
159 /* No need to look at any more threads */
164 /* We need to look at another thread */
165 pNextThread = pCurrentThread->pNext;
166 pPrevThread = pCurrentThread;
170 /* Lets let somebody else remove an object now */
171 LeaveCriticalSection(&Thread_CritSect);
175 /* WIN32 statserv_closedown */
176 void statserv_closedown()
178 /* Shouldn't do anything if we are not initialized */
182 HANDLE *pThreadHandles = NULL;
184 /* We need to stop threads adding and removing while we */
185 /* start the closedown process */
186 EnterCriticalSection(&Thread_CritSect);
189 /* We have exclusive access to the thread stuff now */
190 /* Y didn't i use a semaphore - Oh well never mind */
191 ThreadList *pCurrentThread = pFirstThread;
193 /* Before we do anything else, we need to shutdown the listener */
194 if (pListener != NULL)
195 iochan_destroy(pListener);
197 for (; pCurrentThread != NULL; pCurrentThread = pCurrentThread->pNext)
199 /* Just destroy the IOCHAN, that should do the trick */
200 iochan_destroy(pCurrentThread->pIOChannel);
201 closesocket(pCurrentThread->pIOChannel->fd);
203 /* Keep a running count of our handles */
209 HANDLE *pCurrentHandle ;
211 /* Allocate the thread handle array */
212 pThreadHandles = (HANDLE *)malloc(sizeof(HANDLE) * iHandles);
213 pCurrentHandle = pThreadHandles;
215 for (pCurrentThread = pFirstThread;
216 pCurrentThread != NULL;
217 pCurrentThread = pCurrentThread->pNext, pCurrentHandle++)
219 /* Just the handle */
220 *pCurrentHandle = pCurrentThread->hThread;
224 /* We can now leave the critical section */
225 LeaveCriticalSection(&Thread_CritSect);
228 /* Now we can really do something */
231 logf (LOG_LOG, "waiting for %d to die", iHandles);
232 /* This will now wait, until all the threads close */
233 WaitForMultipleObjects(iHandles, pThreadHandles, TRUE, INFINITE);
235 /* Free the memory we allocated for the handle array */
236 free(pThreadHandles);
239 if (control_block.bend_stop)
240 (*control_block.bend_stop)(&control_block);
241 /* No longer require the critical section, since all threads are dead */
242 DeleteCriticalSection(&Thread_CritSect);
246 void __cdecl event_loop_thread (IOCHAN iochan)
248 event_loop (&iochan);
252 static void listener(IOCHAN h, int event)
254 COMSTACK line = (COMSTACK) iochan_getdata(h);
259 if (event == EVENT_INPUT)
261 if ((res = cs_listen(line, 0, 0)) < 0)
263 yaz_log(LOG_FATAL, "cs_listen failed");
268 yaz_log(LOG_DEBUG, "listen ok");
269 iochan_setevent(h, EVENT_OUTPUT);
270 iochan_setflags(h, EVENT_OUTPUT | EVENT_EXCEPT); /* set up for acpt */
272 else if (event == EVENT_OUTPUT)
274 COMSTACK new_line = cs_accept(line);
280 yaz_log(LOG_FATAL, "Accept failed.");
281 iochan_setflags(h, EVENT_INPUT | EVENT_EXCEPT);
284 yaz_log(LOG_DEBUG, "Accept ok");
286 if (!(new_chan = iochan_create(cs_fileno(new_line), ir_session,
289 yaz_log(LOG_FATAL, "Failed to create iochan");
294 yaz_log(LOG_DEBUG, "Creating association");
295 if (!(newas = create_association(new_chan, new_line)))
297 yaz_log(LOG_FATAL, "Failed to create new assoc.");
301 newas->cs_get_mask = EVENT_INPUT;
302 newas->cs_put_mask = 0;
303 newas->cs_accept_mask = 0;
305 yaz_log(LOG_DEBUG, "Setting timeout %d", control_block.idle_timeout);
306 iochan_setdata(new_chan, newas);
307 iochan_settimeout(new_chan, control_block.idle_timeout * 60);
309 /* Now what we need todo is create a new thread with this iochan as
311 newHandle = (HANDLE) _beginthread(event_loop_thread, 0, new_chan);
312 if (newHandle == (HANDLE) -1)
315 yaz_log(LOG_FATAL|LOG_ERRNO, "Failed to create new thread.");
319 /* We successfully created the thread, so add it to the list */
320 statserv_add(newHandle, new_chan);
322 yaz_log(LOG_DEBUG, "Created new thread, id = %ld iochan %p",(long) newHandle, new_chan);
323 iochan_setflags(h, EVENT_INPUT | EVENT_EXCEPT); /* reset listener */
327 yaz_log(LOG_FATAL, "Bad event on listener.");
333 int statserv_must_terminate(void)
340 static int term_flag = 0;
341 /* To save having an #ifdef in event_loop we need to
342 define this empty function
344 int statserv_must_terminate(void)
349 void statserv_remove(IOCHAN pIOChannel)
353 void statserv_closedown()
357 if (control_block.bend_stop)
358 (*control_block.bend_stop)(&control_block);
359 for (p = pListener; p; p = p->next)
365 void sigterm(int sig)
370 static void *new_session (void *vp);
371 static int no_sessions = 0;
374 static void listener(IOCHAN h, int event)
376 COMSTACK line = (COMSTACK) iochan_getdata(h);
378 static int child = 0;
381 if (event == EVENT_INPUT)
383 if (control_block.dynamic && !child)
390 yaz_log(LOG_FATAL|LOG_ERRNO, "pipe");
394 if ((res = fork()) < 0)
396 yaz_log(LOG_FATAL|LOG_ERRNO, "fork");
400 else if (res == 0) /* child */
407 for (pp = pListener; pp; pp = iochan_getnext(pp))
411 COMSTACK l = (COMSTACK)iochan_getdata(pp);
416 sprintf(nbuf, "%s(%d)", me, getpid());
417 yaz_log_init(control_block.loglevel, nbuf, 0);
418 /* ensure that bend_stop is not called when each child exits -
419 only for the main process ..
421 control_block.bend_stop = 0;
426 /* wait for child to take the call */
432 if ((res = read(hand[0], dummy, 1)) < 0 &&
433 yaz_errno() != EINTR)
435 yaz_log(LOG_FATAL|LOG_ERRNO, "handshake read");
441 yaz_log(LOG_DEBUG, "P: Child has taken the call");
446 if ((res = cs_listen_check(line, 0, 0, control_block.check_ip,
447 control_block.daemon_name)) < 0)
449 yaz_log(LOG_WARN, "cs_listen failed");
454 yaz_log(LOG_DEBUG, "listen ok");
455 iochan_setevent(h, EVENT_OUTPUT);
456 iochan_setflags(h, EVENT_OUTPUT | EVENT_EXCEPT); /* set up for acpt */
458 /* in dynamic mode, only the child ever comes down here */
459 else if (event == EVENT_OUTPUT)
461 COMSTACK 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");
470 if (control_block.dynamic)
473 /* close our half of the listener socket */
474 for (pp = pListener; pp; pp = iochan_getnext(pp))
476 COMSTACK l = (COMSTACK)iochan_getdata(pp);
481 yaz_log(LOG_DEBUG, "Releasing parent");
486 iochan_setflags(h, EVENT_INPUT | EVENT_EXCEPT); /* reset listener */
489 #if YAZ_POSIX_THREADS
490 if (control_block.threads)
492 pthread_t child_thread;
493 pthread_create (&child_thread, 0, new_session, new_line);
494 pthread_detach (child_thread);
497 new_session(new_line);
498 #elif YAZ_GNU_THREADS
499 if (control_block.threads)
504 attr = pth_attr_new ();
505 pth_attr_set (attr, PTH_ATTR_JOINABLE, FALSE);
506 pth_attr_set (attr, PTH_ATTR_STACK_SIZE, 32*1024);
507 pth_attr_set (attr, PTH_ATTR_NAME, "session");
508 yaz_log (LOG_LOG, "pth_spawn begin");
509 child_thread = pth_spawn (attr, new_session, new_line);
510 yaz_log (LOG_LOG, "pth_spawn finish");
511 pth_attr_destroy (attr);
514 new_session(new_line);
516 new_session(new_line);
519 else if (event == EVENT_TIMEOUT)
521 yaz_log(LOG_LOG, "Shutting down listener.");
526 yaz_log(LOG_FATAL, "Bad event on listener.");
531 static void *new_session (void *vp)
536 COMSTACK new_line = (COMSTACK) vp;
538 unsigned cs_get_mask, cs_accept_mask, mask =
539 ((new_line->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
540 ((new_line->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
544 cs_accept_mask = mask; /* accept didn't complete */
549 cs_accept_mask = 0; /* accept completed. */
550 cs_get_mask = mask = EVENT_INPUT;
553 if (!(new_chan = iochan_create(cs_fileno(new_line), ir_session, mask)))
555 yaz_log(LOG_FATAL, "Failed to create iochan");
558 if (!(newas = create_association(new_chan, new_line)))
560 yaz_log(LOG_FATAL, "Failed to create new assoc.");
563 newas->cs_accept_mask = cs_accept_mask;
564 newas->cs_get_mask = cs_get_mask;
566 iochan_setdata(new_chan, newas);
567 iochan_settimeout(new_chan, control_block.idle_timeout * 60);
568 a = cs_addrstr(new_line);
569 yaz_log(LOG_LOG, "Starting session %d from %s",
570 no_sessions, a ? a : "[Unknown]");
571 if (control_block.threads)
573 event_loop(&new_chan);
577 new_chan->next = pListener;
578 pListener = new_chan;
586 static void inetd_connection(int what)
593 if ((line = cs_createbysocket(0, tcpip_type, 0, what)))
595 if ((chan = iochan_create(cs_fileno(line), ir_session, EVENT_INPUT)))
597 if ((assoc = create_association(chan, line)))
599 iochan_setdata(chan, assoc);
600 iochan_settimeout(chan, control_block.idle_timeout * 60);
601 addr = cs_addrstr(line);
602 yaz_log(LOG_LOG, "Inetd association from %s",
603 addr ? addr : "[UNKNOWN]");
604 assoc->cs_get_mask = EVENT_INPUT;
608 yaz_log(LOG_FATAL, "Failed to create association structure");
610 chan->next = pListener;
615 yaz_log(LOG_FATAL, "Failed to create iochan");
620 yaz_log(LOG_ERRNO|LOG_FATAL, "Failed to create comstack on socket 0");
625 * Set up a listening endpoint, and give it to the event-handler.
627 static int add_listener(char *where, int what)
634 if (control_block.dynamic)
636 else if (control_block.threads)
641 yaz_log(LOG_LOG, "Adding %s %s listener on %s", mode,
642 what == PROTO_SR ? "SR" : "Z3950", where);
644 l = cs_create_host(where, 0, &ap);
647 yaz_log(LOG_FATAL|LOG_ERRNO, "Failed to listen on %s", where);
650 if (cs_bind(l, ap, CS_SERVER) < 0)
652 yaz_log(LOG_FATAL|LOG_ERRNO, "Failed to bind to %s", where);
656 if (!(lst = iochan_create(cs_fileno(l), listener, EVENT_INPUT |
659 yaz_log(LOG_FATAL|LOG_ERRNO, "Failed to create IOCHAN-type");
663 iochan_setdata(lst, l);
665 /* Ensure our listener chain is setup properly */
666 lst->next = pListener;
672 /* UNIX only (for windows we don't need to catch the signals) */
673 static void catchchld(int num)
675 while (waitpid(-1, 0, WNOHANG) > 0)
677 signal(SIGCHLD, catchchld);
681 statserv_options_block *statserv_getcontrol(void)
683 static statserv_options_block cb;
685 memcpy(&cb, &control_block, sizeof(cb));
689 void statserv_setcontrol(statserv_options_block *block)
691 memcpy(&control_block, block, sizeof(*block));
694 int statserv_start(int argc, char **argv)
699 /* We need to initialize the thread list */
700 ThreadList_Initialize();
705 if ((me = strrchr (argv[0], '\\')))
712 if (control_block.options_func(argc, argv))
715 if (control_block.bend_start)
716 (*control_block.bend_start)(&control_block);
718 yaz_log (LOG_LOG, "Starting server %s", me);
721 if (control_block.inetd)
722 inetd_connection(control_block.default_proto);
725 yaz_log (LOG_LOG, "Starting server %s pid=%d", me, getpid());
727 sigset_t sigs_to_block;
729 sigemptyset(&sigs_to_block);
730 sigaddset (&sigs_to_block, SIGTERM);
731 pthread_sigmask (SIG_BLOCK, &sigs_to_block, 0);
734 if (control_block.dynamic)
735 signal(SIGCHLD, catchchld);
737 signal (SIGPIPE, SIG_IGN);
738 signal (SIGTERM, sigterm);
739 if (*control_block.setuid)
743 if (!(pw = getpwnam(control_block.setuid)))
745 yaz_log(LOG_FATAL, "%s: Unknown user", control_block.setuid);
748 if (setuid(pw->pw_uid) < 0)
750 yaz_log(LOG_FATAL|LOG_ERRNO, "setuid");
758 if ((pListener == NULL) && *control_block.default_listen)
759 add_listener(control_block.default_listen,
760 control_block.default_proto);
762 if (pListener == NULL)
766 yaz_log(LOG_LOG, "Entering event loop.");
767 ret = event_loop(&pListener);
772 int check_options(int argc, char **argv)
777 while ((ret = options("1a:iszSTl:v:u:c:w:t:k:d:", argv, argc, &arg)) != -2)
782 if (add_listener(arg, control_block.default_proto))
783 return 1; /* failed to create listener */
786 control_block.one_shot = 1;
787 control_block.dynamic = 0;
790 control_block.default_proto = PROTO_Z3950;
793 fprintf (stderr, "%s: SR protocol no longer supported\n", me);
797 control_block.dynamic = 0;
800 #if YAZ_POSIX_THREADS
801 control_block.dynamic = 0;
802 control_block.threads = 1;
803 #elif YAZ_GNU_THREADS
804 control_block.dynamic = 0;
805 control_block.threads = 1;
807 fprintf(stderr, "%s: Threaded mode not available.\n", me);
812 strcpy(control_block.logfile, arg ? arg : "");
813 yaz_log_init(control_block.loglevel, me, control_block.logfile);
816 control_block.loglevel = yaz_log_mask_str(arg);
817 yaz_log_init(control_block.loglevel, me, control_block.logfile);
820 strcpy(control_block.apdufile, arg ? arg : "");
823 strcpy(control_block.setuid, arg ? arg : "");
826 strcpy(control_block.configname, arg ? arg : "");
829 strcpy(control_block.daemon_name, arg ? arg : "");
832 if (!arg || !(r = atoi(arg)))
834 fprintf(stderr, "%s: Specify positive timeout for -t.\n", me);
837 control_block.idle_timeout = r;
840 if (!arg || !(r = atoi(arg)))
842 fprintf(stderr, "%s: Specify positive size for -k.\n", me);
845 control_block.maxrecordsize = r * 1024;
848 control_block.inetd = 1;
858 fprintf(stderr, "Usage: %s [ -a <pdufile> -v <loglevel>"
859 " -l <logfile> -u <user> -c <config> -t <minutes>"
860 " -k <kilobytes> -d <daemon>"
861 " -ziST1 -w <directory> <listender-addr>... ]\n", me);
875 static Args ArgDetails;
877 /* name of the executable */
878 #define SZAPPNAME "server"
880 /* list of service dependencies - "dep1\0dep2\0\0" */
881 #define SZDEPENDENCIES ""
883 int statserv_main(int argc, char **argv,
884 bend_initresult *(*bend_init)(bend_initrequest *r),
885 void (*bend_close)(void *handle))
887 statserv_options_block *cb = statserv_getcontrol();
889 cb->bend_init = bend_init;
890 cb->bend_close = bend_close;
892 statserv_setcontrol(cb);
894 /* Lets setup the Arg structure */
895 ArgDetails.argc = argc;
896 ArgDetails.argv = argv;
898 /* Now setup the service with the service controller */
899 SetupService(argc, argv, &ArgDetails, SZAPPNAME,
900 cb->service_name, /* internal service name */
901 cb->service_display_name, /* displayed name */
906 int StartAppService(void *pHandle, int argc, char **argv)
908 /* Initializes the App */
912 void RunAppService(void *pHandle)
914 Args *pArgs = (Args *)pHandle;
916 /* Starts the app running */
917 statserv_start(pArgs->argc, pArgs->argv);
920 void StopAppService(void *pHandle)
923 statserv_closedown();
928 int statserv_main(int argc, char **argv,
929 bend_initresult *(*bend_init)(bend_initrequest *r),
930 void (*bend_close)(void *handle))
933 statserv_options_block *cb = statserv_getcontrol();
935 cb->bend_init = bend_init;
936 cb->bend_close = bend_close;
938 statserv_setcontrol(cb);
939 ret = statserv_start (argc, argv);
940 statserv_closedown ();