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 int 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 static void osrf_prefork_register_routers( const char* appname ) {
148 osrfStringArray* arr = osrfNewStringArray(4);
150 int c = osrfConfigGetValueList( NULL, arr, "/routers/router" );
151 char* routerName = osrfConfigGetValue( NULL, "/router_name" );
152 transport_client* client = osrfSystemGetTransportClient();
154 osrfLogInfo( OSRF_LOG_MARK, "router name is %s and we have %d routers to connect to", routerName, c );
157 char* domain = osrfStringArrayGetString(arr, --c);
160 char* jid = va_list_to_string( "%s@%s/router", routerName, domain );
161 osrfLogInfo( OSRF_LOG_MARK, "Registering with router %s", jid );
163 transport_message* msg = message_init("registering", NULL, NULL, jid, NULL );
164 message_set_router_info( msg, NULL, NULL, appname, "register", 0 );
166 client_send_message( client, msg );
173 osrfStringArrayFree(arr);
176 static int prefork_child_init_hook(prefork_child* child) {
178 if(!child) return -1;
179 osrfLogDebug( OSRF_LOG_MARK, "Child init hook for child %d", child->pid);
180 char* resc = va_list_to_string("%s_drone",child->appname);
182 /* if we're a source-client, tell the logger now that we're a new process*/
183 char* isclient = osrfConfigGetValue(NULL, "/client");
184 if( isclient && !strcasecmp(isclient,"true") )
185 osrfLogSetIsClient(1);
189 /* we want to remove traces of our parents socket connection
190 * so we can have our own */
191 osrfSystemIgnoreTransportClient();
193 if(!osrfSystemBootstrapClientResc( NULL, NULL, resc)) {
194 osrfLogError( OSRF_LOG_MARK, "Unable to bootstrap client for osrf_prefork_run()");
201 if( ! osrfAppRunChildInit(child->appname) ) {
202 osrfLogDebug(OSRF_LOG_MARK, "Prefork child_init succeeded\n");
204 osrfLogError(OSRF_LOG_MARK, "Prefork child_init failed\n");
208 set_proc_title( "OpenSRF Drone [%s]", child->appname );
212 static void prefork_child_process_request(prefork_child* child, char* data) {
215 transport_client* client = osrfSystemGetTransportClient();
217 if(!client_connected(client)) {
218 osrfSystemIgnoreTransportClient();
219 osrfLogWarning(OSRF_LOG_MARK, "Reconnecting child to opensrf after disconnect...");
220 if(!osrf_system_bootstrap_client(NULL, NULL)) {
221 osrfLogError( OSRF_LOG_MARK,
222 "Unable to bootstrap client in prefork_child_process_request()");
224 osrf_prefork_child_exit(child);
228 /* construct the message from the xml */
229 transport_message* msg = new_message_from_xml( data );
231 osrfAppSession* session = osrf_stack_transport_handler(msg, child->appname);
234 if( session->stateless && session->state != OSRF_SESSION_CONNECTED ) {
235 osrfAppSessionFree( session );
239 osrfLogDebug( OSRF_LOG_MARK, "Entering keepalive loop for session %s", session->session_id );
240 int keepalive = child->keepalive;
248 osrfLogDebug(OSRF_LOG_MARK,
249 "osrf_prefork calling queue_wait [%d] in keepalive loop", keepalive);
251 retval = osrf_app_session_queue_wait(session, keepalive, &recvd);
254 osrfLogDebug(OSRF_LOG_MARK, "Data received == %d", recvd);
257 osrfLogError(OSRF_LOG_MARK, "queue-wait returned non-success %d", retval);
261 /* see if the client disconnected from us */
262 if(session->state != OSRF_SESSION_CONNECTED) break;
264 /* if no data was reveived within the timeout interval */
265 if( !recvd && (end - start) >= keepalive ) {
266 osrfLogInfo(OSRF_LOG_MARK, "No request was received in %d seconds, exiting stateful session", keepalive);
267 osrfAppSessionStatus(
271 0, "Disconnected on timeout" );
277 osrfLogDebug( OSRF_LOG_MARK, "Exiting keepalive loop for session %s", session->session_id );
278 osrfAppSessionFree( session );
283 static prefork_simple* prefork_simple_init( transport_client* client,
284 int max_requests, int min_children, int max_children ) {
286 if( min_children > max_children ) {
287 osrfLogError( OSRF_LOG_MARK, "min_children (%d) is greater "
288 "than max_children (%d)", min_children, max_children );
292 if( max_children > ABS_MAX_CHILDREN ) {
293 osrfLogError( OSRF_LOG_MARK, "max_children (%d) is greater than ABS_MAX_CHILDREN (%d)",
294 max_children, ABS_MAX_CHILDREN );
298 osrfLogInfo(OSRF_LOG_MARK, "Prefork launching child with max_request=%d,"
299 "min_children=%d, max_children=%d", max_requests, min_children, max_children );
301 /* flesh out the struct */
302 prefork_simple* prefork = (prefork_simple*) safe_malloc(sizeof(prefork_simple));
303 prefork->max_requests = max_requests;
304 prefork->min_children = min_children;
305 prefork->max_children = max_children;
307 prefork->data_to_child = 0;
308 prefork->data_to_parent = 0;
309 prefork->current_num_children = 0;
310 prefork->keepalive = 0;
311 prefork->appname = NULL;
312 prefork->first_child = NULL;
313 prefork->connection = client;
318 static prefork_child* launch_child( prefork_simple* forker ) {
324 /* Set up the data pipes and add the child struct to the parent */
325 if( pipe(data_fd) < 0 ) { /* build the data pipe*/
326 osrfLogError( OSRF_LOG_MARK, "Pipe making error" );
330 if( pipe(status_fd) < 0 ) {/* build the status pipe */
331 osrfLogError( OSRF_LOG_MARK, "Pipe making error" );
335 osrfLogInternal( OSRF_LOG_MARK, "Pipes: %d %d %d %d", data_fd[0], data_fd[1], status_fd[0], status_fd[1] );
336 prefork_child* child = prefork_child_init( forker->max_requests, data_fd[0],
337 data_fd[1], status_fd[0], status_fd[1] );
339 child->appname = strdup(forker->appname);
340 child->keepalive = forker->keepalive;
343 add_prefork_child( forker, child );
345 if( (pid=fork()) < 0 ) {
346 osrfLogError( OSRF_LOG_MARK, "Forking Error" );
350 if( pid > 0 ) { /* parent */
352 signal(SIGCHLD, sigchld_handler);
353 (forker->current_num_children)++;
356 osrfLogDebug( OSRF_LOG_MARK, "Parent launched %d", pid );
357 /* *no* child pipe FD's can be closed or the parent will re-use fd's that
358 the children are currently using */
364 osrfLogInternal( OSRF_LOG_MARK, "I am new child with read_data_fd = %d and write_status_fd = %d",
365 child->read_data_fd, child->write_status_fd );
367 child->pid = getpid();
368 close( child->write_data_fd );
369 close( child->read_status_fd );
372 if( prefork_child_init_hook(child) == -1 ) {
373 osrfLogError(OSRF_LOG_MARK,
374 "Forker child going away because we could not connect to OpenSRF...");
375 osrf_prefork_child_exit(child);
378 prefork_child_wait( child );
379 osrf_prefork_child_exit(child); /* just to be sure */
384 static void osrf_prefork_child_exit(prefork_child* child) {
385 osrfAppRunExitCode();
389 static void prefork_launch_children( prefork_simple* forker ) {
392 while( c++ < forker->min_children )
393 launch_child( forker );
397 static void sigchld_handler( int sig ) {
398 signal(SIGCHLD, sigchld_handler);
403 void reap_children( prefork_simple* forker ) {
408 while( (child_pid=waitpid(-1,&status,WNOHANG)) > 0)
409 del_prefork_child( forker, child_pid );
412 while( forker->current_num_children < forker->min_children )
413 launch_child( forker );
418 static void prefork_run(prefork_simple* forker) {
420 if( forker->first_child == NULL )
423 transport_message* cur_msg = NULL;
428 if( forker->first_child == NULL ) {/* no more children */
429 osrfLogWarning( OSRF_LOG_MARK, "No more children..." );
433 osrfLogDebug( OSRF_LOG_MARK, "Forker going into wait for data...");
434 cur_msg = client_recv( forker->connection, -1 );
436 //fprintf(stderr, "Got Data %f\n", get_timestamp_millis() );
438 if( cur_msg == NULL ) continue;
440 int honored = 0; /* true if we've serviced the request */
445 if(!no_recheck) check_children( forker, 0 );
448 osrfLogDebug( OSRF_LOG_MARK, "Server received inbound data" );
450 prefork_child* cur_child = forker->first_child;
452 /* Look for an available child */
453 for( k = 0; k < forker->current_num_children; k++ ) {
455 osrfLogInternal( OSRF_LOG_MARK, "Searching for available child. cur_child->pid = %d", cur_child->pid );
456 osrfLogInternal( OSRF_LOG_MARK, "Current num children %d and loop %d", forker->current_num_children, k);
458 if( cur_child->available ) {
459 osrfLogDebug( OSRF_LOG_MARK, "forker sending data to %d", cur_child->pid );
461 message_prepare_xml( cur_msg );
462 char* data = cur_msg->msg_xml;
463 if( ! data || strlen(data) < 1 ) break;
465 cur_child->available = 0;
466 osrfLogInternal( OSRF_LOG_MARK, "Writing to child fd %d", cur_child->write_data_fd );
469 //fprintf(stderr, "Writing Data %f\n", get_timestamp_millis() );
470 if( (written = write( cur_child->write_data_fd, data, strlen(data) + 1 )) < 0 ) {
471 osrfLogWarning( OSRF_LOG_MARK, "Write returned error %d", errno);
472 cur_child = cur_child->next;
476 //fprintf(stderr, "Wrote %d bytes to child\n", written);
478 forker->first_child = cur_child->next;
482 cur_child = cur_child->next;
485 /* if none available, add a new child if we can */
487 osrfLogDebug( OSRF_LOG_MARK, "Not enough children, attempting to add...");
489 if( forker->current_num_children < forker->max_children ) {
490 osrfLogDebug( OSRF_LOG_MARK, "Launching new child with current_num = %d",
491 forker->current_num_children );
493 prefork_child* new_child = launch_child( forker );
496 message_prepare_xml( cur_msg );
497 char* data = cur_msg->msg_xml;
500 int len = strlen(data);
503 new_child->available = 0;
504 osrfLogDebug( OSRF_LOG_MARK, "Writing to new child fd %d : pid %d",
505 new_child->write_data_fd, new_child->pid );
507 if( write( new_child->write_data_fd, data, len + 1 ) >= 0 ) {
508 forker->first_child = new_child->next;
519 osrfLogWarning( OSRF_LOG_MARK, "No children available, waiting...");
521 check_children( forker, 1 ); /* non-poll version */
522 /* tell the loop no to call check_children again, since we're calling it now */
527 reap_children(forker);
530 //fprintf(stderr, "Parent done with request %f\n", get_timestamp_millis() );
534 message_free( cur_msg );
536 } /* top level listen loop */
541 /** XXX Add a flag which tells select() to wait forever on children
542 * in the best case, this will be faster than calling usleep(x), and
543 * in the worst case it won't be slower and will do less logging...
546 static void check_children( prefork_simple* forker, int forever ) {
558 reap_children(forker);
560 prefork_child* cur_child = forker->first_child;
563 for( i = 0; i!= forker->current_num_children; i++ ) {
565 if( cur_child->read_status_fd > max_fd )
566 max_fd = cur_child->read_status_fd;
567 FD_SET( cur_child->read_status_fd, &read_set );
568 cur_child = cur_child->next;
571 FD_CLR(0,&read_set);/* just to be sure */
574 osrfLogWarning(OSRF_LOG_MARK, "We have no children available - waiting for one to show up...");
576 if( (select_ret=select( max_fd + 1 , &read_set, NULL, NULL, NULL)) == -1 ) {
577 osrfLogWarning( OSRF_LOG_MARK, "Select returned error %d on check_children", errno );
579 osrfLogInfo(OSRF_LOG_MARK, "select() completed after waiting on children to become available");
587 if( (select_ret=select( max_fd + 1 , &read_set, NULL, NULL, &tv)) == -1 ) {
588 osrfLogWarning( OSRF_LOG_MARK, "Select returned error %d on check_children", errno );
592 if( select_ret == 0 )
595 /* see if one of a child has told us it's done */
596 cur_child = forker->first_child;
599 for( j = 0; j!= forker->current_num_children && num_handled < select_ret ; j++ ) {
601 if( FD_ISSET( cur_child->read_status_fd, &read_set ) ) {
602 //printf( "Server received status from a child %d\n", cur_child->pid );
603 osrfLogDebug( OSRF_LOG_MARK, "Server received status from a child %d", cur_child->pid );
607 /* now suck off the data */
609 osrf_clearbuf( buf, sizeof(buf) );
610 if( (n=read(cur_child->read_status_fd, buf, 63)) < 0 ) {
611 osrfLogWarning( OSRF_LOG_MARK, "Read error after select in child status read with errno %d", errno);
614 osrfLogDebug( OSRF_LOG_MARK, "Read %d bytes from status buffer: %s", n, buf );
615 cur_child->available = 1;
617 cur_child = cur_child->next;
623 static void prefork_child_wait( prefork_child* child ) {
626 growing_buffer* gbuf = buffer_init( READ_BUFSIZE );
627 char buf[READ_BUFSIZE];
628 osrf_clearbuf( buf, sizeof(buf) );
630 for( i = 0; i < child->max_requests; i++ ) {
634 clr_fl(child->read_data_fd, O_NONBLOCK );
636 while( (n=read(child->read_data_fd, buf, READ_BUFSIZE-1)) > 0 ) {
637 osrfLogDebug(OSRF_LOG_MARK, "Prefork child read %d bytes of data", n);
639 set_fl(child->read_data_fd, O_NONBLOCK );
640 buffer_add( gbuf, buf );
641 osrf_clearbuf( buf, sizeof(buf) );
645 if( errno == EAGAIN ) n = 0;
647 if( errno == EPIPE ) {
648 osrfLogDebug(OSRF_LOG_MARK, "C child attempted read on broken pipe, exiting...");
653 osrfLogWarning( OSRF_LOG_MARK, "Prefork child read returned error with errno %d", errno );
656 } else if( gotdata ) {
657 osrfLogDebug(OSRF_LOG_MARK, "Prefork child got a request.. processing..");
658 prefork_child_process_request(child, gbuf->buf);
659 buffer_reset( gbuf );
662 if( i < child->max_requests - 1 )
663 write( child->write_status_fd, "available" /*less than 64 bytes*/, 9 );
668 osrfLogDebug( OSRF_LOG_MARK, "Child with max-requests=%d, num-served=%d exiting...[%ld]",
669 child->max_requests, i, (long) getpid() );
671 osrf_prefork_child_exit(child); /* just to be sure */
675 static void add_prefork_child( prefork_simple* forker, prefork_child* child ) {
677 if( forker->first_child == NULL ) {
678 forker->first_child = child;
683 /* we put the child in as the last because, regardless,
684 we have to do the DLL splice dance, and this is the
687 prefork_child* start_child = forker->first_child;
689 if( forker->first_child->next == start_child )
691 forker->first_child = forker->first_child->next;
694 /* here we know that forker->first_child is the last element
695 in the list and start_child is the first. Insert the
696 new child between them*/
698 forker->first_child->next = child;
699 child->next = start_child;
703 //static prefork_child* find_prefork_child( prefork_simple* forker, pid_t pid ) {
705 // if( forker->first_child == NULL ) { return NULL; }
706 // prefork_child* start_child = forker->first_child;
708 // if( forker->first_child->pid == pid )
709 // return forker->first_child;
710 // } while( (forker->first_child = forker->first_child->next) != start_child );
716 static void del_prefork_child( prefork_simple* forker, pid_t pid ) {
718 if( forker->first_child == NULL ) { return; }
720 (forker->current_num_children)--;
721 osrfLogDebug( OSRF_LOG_MARK, "Deleting Child: %d", pid );
723 prefork_child* start_child = forker->first_child; /* starting point */
724 prefork_child* cur_child = start_child; /* current pointer */
725 prefork_child* prev_child = start_child; /* the trailing pointer */
727 /* special case where there is only one in the list */
728 if( start_child == start_child->next ) {
729 if( start_child->pid == pid ) {
730 forker->first_child = NULL;
732 close( start_child->read_data_fd );
733 close( start_child->write_data_fd );
734 close( start_child->read_status_fd );
735 close( start_child->write_status_fd );
737 prefork_child_free( start_child );
743 /* special case where the first item in the list needs to be removed */
744 if( start_child->pid == pid ) {
746 /* find the last one so we can remove the start_child */
748 prev_child = cur_child;
749 cur_child = cur_child->next;
750 }while( cur_child != start_child );
752 /* now cur_child == start_child */
753 prev_child->next = cur_child->next;
754 forker->first_child = prev_child;
756 close( cur_child->read_data_fd );
757 close( cur_child->write_data_fd );
758 close( cur_child->read_status_fd );
759 close( cur_child->write_status_fd );
761 prefork_child_free( cur_child );
766 prev_child = cur_child;
767 cur_child = cur_child->next;
769 if( cur_child->pid == pid ) {
770 prev_child->next = cur_child->next;
772 close( cur_child->read_data_fd );
773 close( cur_child->write_data_fd );
774 close( cur_child->read_status_fd );
775 close( cur_child->write_status_fd );
777 prefork_child_free( cur_child );
781 } while(cur_child != start_child);
787 static prefork_child* prefork_child_init(
788 int max_requests, int read_data_fd, int write_data_fd,
789 int read_status_fd, int write_status_fd ) {
791 prefork_child* child = (prefork_child*) safe_malloc(sizeof(prefork_child));
793 child->max_requests = max_requests;
794 child->read_data_fd = read_data_fd;
795 child->write_data_fd = write_data_fd;
796 child->read_status_fd = read_status_fd;
797 child->write_status_fd = write_status_fd;
798 child->min_children = 0;
799 child->available = 1;
800 child->appname = NULL;
801 child->keepalive = 0;
808 static int prefork_free( prefork_simple* prefork ) {
810 while( prefork->first_child != NULL ) {
811 osrfLogInfo( OSRF_LOG_MARK, "Killing children and sleeping 1 to reap..." );
816 client_free(prefork->connection);
817 free(prefork->appname);
822 static int prefork_child_free( prefork_child* child ) {
823 free(child->appname);
824 close(child->read_data_fd);
825 close(child->write_status_fd);