1 #include <opensrf/osrf_prefork.h>
2 #include <opensrf/osrf_app_session.h>
3 #include <opensrf/osrf_application.h>
6 //#define READ_BUFSIZE 4096
7 #define READ_BUFSIZE 1024
8 //#define MAX_BUFSIZE 10485760 /* 10M enough? ;) */
9 #define ABS_MAX_CHILDREN 256
11 struct prefork_simple_struct {
18 int current_num_children;
19 int keepalive; /* keepalive time for stateful sessions */
21 struct prefork_child_struct* first_child;
22 transport_client* connection;
24 typedef struct prefork_simple_struct prefork_simple;
26 struct prefork_child_struct {
37 struct prefork_child_struct* next;
40 typedef struct prefork_child_struct prefork_child;
42 static prefork_simple* prefork_simple_init( transport_client* client,
43 int max_requests, int min_children, int max_children );
44 static prefork_child* launch_child( prefork_simple* forker );
45 static void prefork_launch_children( prefork_simple* forker );
46 static void prefork_run(prefork_simple* forker);
47 static void add_prefork_child( prefork_simple* forker, prefork_child* child );
49 //static prefork_child* find_prefork_child( prefork_simple* forker, pid_t pid );
51 static void del_prefork_child( prefork_simple* forker, pid_t pid );
52 static void check_children( prefork_simple* forker, int forever );
53 static void prefork_child_process_request(prefork_child*, char* data);
54 static int prefork_child_init_hook(prefork_child*);
55 static prefork_child* prefork_child_init(
56 int max_requests, int read_data_fd, int write_data_fd,
57 int read_status_fd, int write_status_fd );
59 /* listens on the 'data_to_child' fd and wait for incoming data */
60 static void prefork_child_wait( prefork_child* child );
61 static int prefork_free( prefork_simple* );
62 static int prefork_child_free( prefork_child* );
63 static void osrf_prefork_register_routers( const char* appname );
64 static void osrf_prefork_child_exit( prefork_child* );
67 /* true if we just deleted a child. This will allow us to make sure we're
68 not trying to use freed memory */
69 static sig_atomic_t child_dead;
71 static void sigchld_handler( int sig );
73 int osrf_prefork_run(const char* appname) {
76 osrfLogError( OSRF_LOG_MARK, "osrf_prefork_run requires an appname to run!");
80 set_proc_title( "OpenSRF Listener [%s]", appname );
87 osrfLogInfo( OSRF_LOG_MARK, "Loading config in osrf_forker for app %s", appname);
89 char* max_req = osrf_settings_host_value("/apps/%s/unix_config/max_requests", appname);
90 char* min_children = osrf_settings_host_value("/apps/%s/unix_config/min_children", appname);
91 char* max_children = osrf_settings_host_value("/apps/%s/unix_config/max_children", appname);
92 char* keepalive = osrf_settings_host_value("/apps/%s/keepalive", appname);
94 if(!keepalive) osrfLogWarning( OSRF_LOG_MARK, "Keepalive is not defined, assuming %d", kalive);
95 else kalive = atoi(keepalive);
97 if(!max_req) osrfLogWarning( OSRF_LOG_MARK, "Max requests not defined, assuming %d", maxr);
98 else maxr = atoi(max_req);
100 if(!min_children) osrfLogWarning( OSRF_LOG_MARK, "Min children not defined, assuming %d", minc);
101 else minc = atoi(min_children);
103 if(!max_children) osrfLogWarning( OSRF_LOG_MARK, "Max children not defined, assuming %d", maxc);
104 else maxc = atoi(max_children);
110 /* --------------------------------------------------- */
112 char* resc = va_list_to_string("%s_listener", appname);
114 if(!osrfSystemBootstrapClientResc( NULL, NULL, resc )) {
115 osrfLogError( OSRF_LOG_MARK, "Unable to bootstrap client for osrf_prefork_run()");
122 prefork_simple* forker = prefork_simple_init(
123 osrfSystemGetTransportClient(), maxr, minc, maxc);
126 osrfLogError( OSRF_LOG_MARK, "osrf_prefork_run() failed to create prefork_simple object");
130 forker->appname = strdup(appname);
131 forker->keepalive = kalive;
133 prefork_launch_children(forker);
135 osrf_prefork_register_routers(appname);
137 osrfLogInfo( OSRF_LOG_MARK, "Launching osrf_forker for app %s", appname);
140 osrfLogWarning( OSRF_LOG_MARK, "prefork_run() retuned - how??");
141 prefork_free(forker);
146 /* sends the "register" packet to the specified router */
147 static void osrf_prefork_send_router_registration(const char* appname, const char* routerName, const char* routerDomain) {
148 transport_client* client = osrfSystemGetTransportClient();
149 char* jid = va_list_to_string( "%s@%s/router", routerName, routerDomain );
150 osrfLogInfo( OSRF_LOG_MARK, "%s registering with router %s", appname, jid );
151 transport_message* msg = message_init("registering", NULL, NULL, jid, NULL );
152 message_set_router_info( msg, NULL, NULL, appname, "register", 0 );
153 client_send_message( client, msg );
158 /** parses a single "complex" router configuration chunk */
159 static void osrf_prefork_parse_router_chunk(const char* appname, jsonObject* routerChunk) {
161 char* routerName = jsonObjectGetString(jsonObjectGetKey(routerChunk, "name"));
162 char* domain = jsonObjectGetString(jsonObjectGetKey(routerChunk, "domain"));
163 jsonObject* services = jsonObjectGetKey(routerChunk, "services");
164 osrfLogDebug(OSRF_LOG_MARK, "found router config with domain %s and name %s", routerName, domain);
166 if(services && services->type == JSON_HASH) {
167 osrfLogDebug(OSRF_LOG_MARK, "investigating router information...");
168 services = jsonObjectGetKey(services, "service");
170 for(j = 0; j < services->size; j++ ) {
171 char* service = jsonObjectGetString(jsonObjectGetIndex(services, j));
172 if(!strcmp(appname, service))
173 osrf_prefork_send_router_registration(appname, routerName, domain);
176 osrf_prefork_send_router_registration(appname, routerName, domain);
180 static void osrf_prefork_register_routers( const char* appname ) {
182 jsonObject* routerInfo = osrfConfigGetValueObject(NULL, "/routers/router");
185 for(i = 0; i < routerInfo->size; i++) {
186 jsonObject* routerChunk = jsonObjectGetIndex(routerInfo, i);
188 if(routerChunk->type == JSON_STRING) {
189 /* this accomodates simple router configs */
190 char* routerName = osrfConfigGetValue( NULL, "/router_name" );
191 char* domain = osrfConfigGetValue(NULL, "/routers/router");
192 osrfLogDebug(OSRF_LOG_MARK, "found simple router settings with router name %s", routerName);
193 osrf_prefork_send_router_registration(appname, routerName, domain);
196 osrf_prefork_parse_router_chunk(appname, routerChunk);
201 static int prefork_child_init_hook(prefork_child* child) {
203 if(!child) return -1;
204 osrfLogDebug( OSRF_LOG_MARK, "Child init hook for child %d", child->pid);
206 osrfSystemInitCache();
207 char* resc = va_list_to_string("%s_drone",child->appname);
209 /* if we're a source-client, tell the logger now that we're a new process*/
210 char* isclient = osrfConfigGetValue(NULL, "/client");
211 if( isclient && !strcasecmp(isclient,"true") )
212 osrfLogSetIsClient(1);
216 /* we want to remove traces of our parents socket connection
217 * so we can have our own */
218 osrfSystemIgnoreTransportClient();
220 if(!osrfSystemBootstrapClientResc( NULL, NULL, resc)) {
221 osrfLogError( OSRF_LOG_MARK, "Unable to bootstrap client for osrf_prefork_run()");
228 if( ! osrfAppRunChildInit(child->appname) ) {
229 osrfLogDebug(OSRF_LOG_MARK, "Prefork child_init succeeded\n");
231 osrfLogError(OSRF_LOG_MARK, "Prefork child_init failed\n");
235 set_proc_title( "OpenSRF Drone [%s]", child->appname );
239 static void prefork_child_process_request(prefork_child* child, char* data) {
242 transport_client* client = osrfSystemGetTransportClient();
244 if(!client_connected(client)) {
245 osrfSystemIgnoreTransportClient();
246 osrfLogWarning(OSRF_LOG_MARK, "Reconnecting child to opensrf after disconnect...");
247 if(!osrf_system_bootstrap_client(NULL, NULL)) {
248 osrfLogError( OSRF_LOG_MARK,
249 "Unable to bootstrap client in prefork_child_process_request()");
251 osrf_prefork_child_exit(child);
255 /* construct the message from the xml */
256 transport_message* msg = new_message_from_xml( data );
258 osrfAppSession* session = osrf_stack_transport_handler(msg, child->appname);
261 if( session->stateless && session->state != OSRF_SESSION_CONNECTED ) {
262 osrfAppSessionFree( session );
266 osrfLogDebug( OSRF_LOG_MARK, "Entering keepalive loop for session %s", session->session_id );
267 int keepalive = child->keepalive;
275 osrfLogDebug(OSRF_LOG_MARK,
276 "osrf_prefork calling queue_wait [%d] in keepalive loop", keepalive);
278 retval = osrf_app_session_queue_wait(session, keepalive, &recvd);
281 osrfLogDebug(OSRF_LOG_MARK, "Data received == %d", recvd);
284 osrfLogError(OSRF_LOG_MARK, "queue-wait returned non-success %d", retval);
288 /* see if the client disconnected from us */
289 if(session->state != OSRF_SESSION_CONNECTED) break;
291 /* if no data was reveived within the timeout interval */
292 if( !recvd && (end - start) >= keepalive ) {
293 osrfLogInfo(OSRF_LOG_MARK, "No request was received in %d seconds, exiting stateful session", keepalive);
294 osrfAppSessionStatus(
298 0, "Disconnected on timeout" );
304 osrfLogDebug( OSRF_LOG_MARK, "Exiting keepalive loop for session %s", session->session_id );
305 osrfAppSessionFree( session );
310 static prefork_simple* prefork_simple_init( transport_client* client,
311 int max_requests, int min_children, int max_children ) {
313 if( min_children > max_children ) {
314 osrfLogError( OSRF_LOG_MARK, "min_children (%d) is greater "
315 "than max_children (%d)", min_children, max_children );
319 if( max_children > ABS_MAX_CHILDREN ) {
320 osrfLogError( OSRF_LOG_MARK, "max_children (%d) is greater than ABS_MAX_CHILDREN (%d)",
321 max_children, ABS_MAX_CHILDREN );
325 osrfLogInfo(OSRF_LOG_MARK, "Prefork launching child with max_request=%d,"
326 "min_children=%d, max_children=%d", max_requests, min_children, max_children );
328 /* flesh out the struct */
329 prefork_simple* prefork = (prefork_simple*) safe_malloc(sizeof(prefork_simple));
330 prefork->max_requests = max_requests;
331 prefork->min_children = min_children;
332 prefork->max_children = max_children;
334 prefork->data_to_child = 0;
335 prefork->data_to_parent = 0;
336 prefork->current_num_children = 0;
337 prefork->keepalive = 0;
338 prefork->appname = NULL;
339 prefork->first_child = NULL;
340 prefork->connection = client;
345 static prefork_child* launch_child( prefork_simple* forker ) {
351 /* Set up the data pipes and add the child struct to the parent */
352 if( pipe(data_fd) < 0 ) { /* build the data pipe*/
353 osrfLogError( OSRF_LOG_MARK, "Pipe making error" );
357 if( pipe(status_fd) < 0 ) {/* build the status pipe */
358 osrfLogError( OSRF_LOG_MARK, "Pipe making error" );
362 osrfLogInternal( OSRF_LOG_MARK, "Pipes: %d %d %d %d", data_fd[0], data_fd[1], status_fd[0], status_fd[1] );
363 prefork_child* child = prefork_child_init( forker->max_requests, data_fd[0],
364 data_fd[1], status_fd[0], status_fd[1] );
366 child->appname = strdup(forker->appname);
367 child->keepalive = forker->keepalive;
370 add_prefork_child( forker, child );
372 if( (pid=fork()) < 0 ) {
373 osrfLogError( OSRF_LOG_MARK, "Forking Error" );
377 if( pid > 0 ) { /* parent */
379 signal(SIGCHLD, sigchld_handler);
380 (forker->current_num_children)++;
383 osrfLogDebug( OSRF_LOG_MARK, "Parent launched %d", pid );
384 /* *no* child pipe FD's can be closed or the parent will re-use fd's that
385 the children are currently using */
391 osrfLogInternal( OSRF_LOG_MARK, "I am new child with read_data_fd = %d and write_status_fd = %d",
392 child->read_data_fd, child->write_status_fd );
394 child->pid = getpid();
395 close( child->write_data_fd );
396 close( child->read_status_fd );
399 if( prefork_child_init_hook(child) == -1 ) {
400 osrfLogError(OSRF_LOG_MARK,
401 "Forker child going away because we could not connect to OpenSRF...");
402 osrf_prefork_child_exit(child);
405 prefork_child_wait( child );
406 osrf_prefork_child_exit(child); /* just to be sure */
411 static void osrf_prefork_child_exit(prefork_child* child) {
412 osrfAppRunExitCode();
416 static void prefork_launch_children( prefork_simple* forker ) {
419 while( c++ < forker->min_children )
420 launch_child( forker );
424 static void sigchld_handler( int sig ) {
425 signal(SIGCHLD, sigchld_handler);
430 void reap_children( prefork_simple* forker ) {
435 while( (child_pid=waitpid(-1,&status,WNOHANG)) > 0)
436 del_prefork_child( forker, child_pid );
439 while( forker->current_num_children < forker->min_children )
440 launch_child( forker );
445 static void prefork_run(prefork_simple* forker) {
447 if( forker->first_child == NULL )
450 transport_message* cur_msg = NULL;
455 if( forker->first_child == NULL ) {/* no more children */
456 osrfLogWarning( OSRF_LOG_MARK, "No more children..." );
460 osrfLogDebug( OSRF_LOG_MARK, "Forker going into wait for data...");
461 cur_msg = client_recv( forker->connection, -1 );
463 //fprintf(stderr, "Got Data %f\n", get_timestamp_millis() );
465 if( cur_msg == NULL ) continue;
467 int honored = 0; /* true if we've serviced the request */
472 if(!no_recheck) check_children( forker, 0 );
475 osrfLogDebug( OSRF_LOG_MARK, "Server received inbound data" );
477 prefork_child* cur_child = forker->first_child;
479 /* Look for an available child */
480 for( k = 0; k < forker->current_num_children; k++ ) {
482 osrfLogInternal( OSRF_LOG_MARK, "Searching for available child. cur_child->pid = %d", cur_child->pid );
483 osrfLogInternal( OSRF_LOG_MARK, "Current num children %d and loop %d", forker->current_num_children, k);
485 if( cur_child->available ) {
486 osrfLogDebug( OSRF_LOG_MARK, "forker sending data to %d", cur_child->pid );
488 message_prepare_xml( cur_msg );
489 char* data = cur_msg->msg_xml;
490 if( ! data || strlen(data) < 1 ) break;
492 cur_child->available = 0;
493 osrfLogInternal( OSRF_LOG_MARK, "Writing to child fd %d", cur_child->write_data_fd );
496 //fprintf(stderr, "Writing Data %f\n", get_timestamp_millis() );
497 if( (written = write( cur_child->write_data_fd, data, strlen(data) + 1 )) < 0 ) {
498 osrfLogWarning( OSRF_LOG_MARK, "Write returned error %d", errno);
499 cur_child = cur_child->next;
503 //fprintf(stderr, "Wrote %d bytes to child\n", written);
505 forker->first_child = cur_child->next;
509 cur_child = cur_child->next;
512 /* if none available, add a new child if we can */
514 osrfLogDebug( OSRF_LOG_MARK, "Not enough children, attempting to add...");
516 if( forker->current_num_children < forker->max_children ) {
517 osrfLogDebug( OSRF_LOG_MARK, "Launching new child with current_num = %d",
518 forker->current_num_children );
520 prefork_child* new_child = launch_child( forker );
523 message_prepare_xml( cur_msg );
524 char* data = cur_msg->msg_xml;
527 int len = strlen(data);
530 new_child->available = 0;
531 osrfLogDebug( OSRF_LOG_MARK, "Writing to new child fd %d : pid %d",
532 new_child->write_data_fd, new_child->pid );
534 if( write( new_child->write_data_fd, data, len + 1 ) >= 0 ) {
535 forker->first_child = new_child->next;
546 osrfLogWarning( OSRF_LOG_MARK, "No children available, waiting...");
548 check_children( forker, 1 ); /* non-poll version */
549 /* tell the loop no to call check_children again, since we're calling it now */
554 reap_children(forker);
557 //fprintf(stderr, "Parent done with request %f\n", get_timestamp_millis() );
561 message_free( cur_msg );
563 } /* top level listen loop */
568 /** XXX Add a flag which tells select() to wait forever on children
569 * in the best case, this will be faster than calling usleep(x), and
570 * in the worst case it won't be slower and will do less logging...
573 static void check_children( prefork_simple* forker, int forever ) {
585 reap_children(forker);
587 prefork_child* cur_child = forker->first_child;
590 for( i = 0; i!= forker->current_num_children; i++ ) {
592 if( cur_child->read_status_fd > max_fd )
593 max_fd = cur_child->read_status_fd;
594 FD_SET( cur_child->read_status_fd, &read_set );
595 cur_child = cur_child->next;
598 FD_CLR(0,&read_set);/* just to be sure */
601 osrfLogWarning(OSRF_LOG_MARK, "We have no children available - waiting for one to show up...");
603 if( (select_ret=select( max_fd + 1 , &read_set, NULL, NULL, NULL)) == -1 ) {
604 osrfLogWarning( OSRF_LOG_MARK, "Select returned error %d on check_children", errno );
606 osrfLogInfo(OSRF_LOG_MARK, "select() completed after waiting on children to become available");
614 if( (select_ret=select( max_fd + 1 , &read_set, NULL, NULL, &tv)) == -1 ) {
615 osrfLogWarning( OSRF_LOG_MARK, "Select returned error %d on check_children", errno );
619 if( select_ret == 0 )
622 /* see if one of a child has told us it's done */
623 cur_child = forker->first_child;
626 for( j = 0; j!= forker->current_num_children && num_handled < select_ret ; j++ ) {
628 if( FD_ISSET( cur_child->read_status_fd, &read_set ) ) {
629 //printf( "Server received status from a child %d\n", cur_child->pid );
630 osrfLogDebug( OSRF_LOG_MARK, "Server received status from a child %d", cur_child->pid );
634 /* now suck off the data */
636 osrf_clearbuf( buf, sizeof(buf) );
637 if( (n=read(cur_child->read_status_fd, buf, sizeof(buf) - 1)) < 0 ) {
638 osrfLogWarning( OSRF_LOG_MARK, "Read error after select in child status read with errno %d", errno);
642 osrfLogDebug( OSRF_LOG_MARK, "Read %d bytes from status buffer: %s", n, buf );
644 cur_child->available = 1;
646 cur_child = cur_child->next;
652 static void prefork_child_wait( prefork_child* child ) {
655 growing_buffer* gbuf = buffer_init( READ_BUFSIZE );
656 char buf[READ_BUFSIZE];
657 osrf_clearbuf( buf, sizeof(buf) );
659 for( i = 0; i < child->max_requests; i++ ) {
663 clr_fl(child->read_data_fd, O_NONBLOCK );
665 while( (n=read(child->read_data_fd, buf, READ_BUFSIZE-1)) > 0 ) {
667 osrfLogDebug(OSRF_LOG_MARK, "Prefork child read %d bytes of data", n);
669 set_fl(child->read_data_fd, O_NONBLOCK );
670 buffer_add( gbuf, buf );
671 osrf_clearbuf( buf, sizeof(buf) );
675 if( errno == EAGAIN ) n = 0;
677 if( errno == EPIPE ) {
678 osrfLogDebug(OSRF_LOG_MARK, "C child attempted read on broken pipe, exiting...");
683 osrfLogWarning( OSRF_LOG_MARK, "Prefork child read returned error with errno %d", errno );
686 } else if( gotdata ) {
687 osrfLogDebug(OSRF_LOG_MARK, "Prefork child got a request.. processing..");
688 prefork_child_process_request(child, gbuf->buf);
689 buffer_reset( gbuf );
692 if( i < child->max_requests - 1 )
693 write( child->write_status_fd, "available" /*less than 64 bytes*/, 9 );
698 osrfLogDebug( OSRF_LOG_MARK, "Child with max-requests=%d, num-served=%d exiting...[%ld]",
699 child->max_requests, i, (long) getpid() );
701 osrf_prefork_child_exit(child); /* just to be sure */
705 static void add_prefork_child( prefork_simple* forker, prefork_child* child ) {
707 if( forker->first_child == NULL ) {
708 forker->first_child = child;
713 /* we put the child in as the last because, regardless,
714 we have to do the DLL splice dance, and this is the
717 prefork_child* start_child = forker->first_child;
719 if( forker->first_child->next == start_child )
721 forker->first_child = forker->first_child->next;
724 /* here we know that forker->first_child is the last element
725 in the list and start_child is the first. Insert the
726 new child between them*/
728 forker->first_child->next = child;
729 child->next = start_child;
733 //static prefork_child* find_prefork_child( prefork_simple* forker, pid_t pid ) {
735 // if( forker->first_child == NULL ) { return NULL; }
736 // prefork_child* start_child = forker->first_child;
738 // if( forker->first_child->pid == pid )
739 // return forker->first_child;
740 // } while( (forker->first_child = forker->first_child->next) != start_child );
746 static void del_prefork_child( prefork_simple* forker, pid_t pid ) {
748 if( forker->first_child == NULL ) { return; }
750 (forker->current_num_children)--;
751 osrfLogDebug( OSRF_LOG_MARK, "Deleting Child: %d", pid );
753 prefork_child* start_child = forker->first_child; /* starting point */
754 prefork_child* cur_child = start_child; /* current pointer */
755 prefork_child* prev_child = start_child; /* the trailing pointer */
757 /* special case where there is only one in the list */
758 if( start_child == start_child->next ) {
759 if( start_child->pid == pid ) {
760 forker->first_child = NULL;
762 close( start_child->read_data_fd );
763 close( start_child->write_data_fd );
764 close( start_child->read_status_fd );
765 close( start_child->write_status_fd );
767 prefork_child_free( start_child );
773 /* special case where the first item in the list needs to be removed */
774 if( start_child->pid == pid ) {
776 /* find the last one so we can remove the start_child */
778 prev_child = cur_child;
779 cur_child = cur_child->next;
780 }while( cur_child != start_child );
782 /* now cur_child == start_child */
783 prev_child->next = cur_child->next;
784 forker->first_child = prev_child;
786 close( cur_child->read_data_fd );
787 close( cur_child->write_data_fd );
788 close( cur_child->read_status_fd );
789 close( cur_child->write_status_fd );
791 prefork_child_free( cur_child );
796 prev_child = cur_child;
797 cur_child = cur_child->next;
799 if( cur_child->pid == pid ) {
800 prev_child->next = cur_child->next;
802 close( cur_child->read_data_fd );
803 close( cur_child->write_data_fd );
804 close( cur_child->read_status_fd );
805 close( cur_child->write_status_fd );
807 prefork_child_free( cur_child );
811 } while(cur_child != start_child);
817 static prefork_child* prefork_child_init(
818 int max_requests, int read_data_fd, int write_data_fd,
819 int read_status_fd, int write_status_fd ) {
821 prefork_child* child = (prefork_child*) safe_malloc(sizeof(prefork_child));
823 child->max_requests = max_requests;
824 child->read_data_fd = read_data_fd;
825 child->write_data_fd = write_data_fd;
826 child->read_status_fd = read_status_fd;
827 child->write_status_fd = write_status_fd;
828 child->min_children = 0;
829 child->available = 1;
830 child->appname = NULL;
831 child->keepalive = 0;
838 static int prefork_free( prefork_simple* prefork ) {
840 while( prefork->first_child != NULL ) {
841 osrfLogInfo( OSRF_LOG_MARK, "Killing children and sleeping 1 to reap..." );
846 client_free(prefork->connection);
847 free(prefork->appname);
852 static int prefork_child_free( prefork_child* child ) {
853 free(child->appname);
854 close(child->read_data_fd);
855 close(child->write_status_fd);