1 #include "osrf_prefork.h"
3 #include "osrf_app_session.h"
4 #include "osrf_application.h"
6 /* true if we just deleted a child. This will allow us to make sure we're
7 not trying to use freed memory */
11 void sigchld_handler( int sig );
13 int osrf_prefork_run(char* appname) {
16 osrfLogError( OSRF_LOG_MARK, "osrf_prefork_run requires an appname to run!");
20 set_proc_title( "OpenSRF Listener [%s]", appname );
26 osrfLogInfo( OSRF_LOG_MARK, "Loading config in osrf_forker for app %s", appname);
28 jsonObject* max_req = osrf_settings_host_value_object("/apps/%s/unix_config/max_requests", appname);
29 jsonObject* min_children = osrf_settings_host_value_object("/apps/%s/unix_config/min_children", appname);
30 jsonObject* max_children = osrf_settings_host_value_object("/apps/%s/unix_config/max_children", appname);
32 char* keepalive = osrf_settings_host_value("/apps/%s/keepalive", appname);
35 kalive = atoi(keepalive);
38 kalive = 5; /* give it a default */
41 osrfLogInfo(OSRF_LOG_MARK, "keepalive setting = %d seconds", kalive);
45 if(!max_req) osrfLogWarning( OSRF_LOG_MARK, "Max requests not defined, assuming 1000");
46 else maxr = (int) jsonObjectGetNumber(max_req);
48 if(!min_children) osrfLogWarning( OSRF_LOG_MARK, "Min children not defined, assuming 3");
49 else minc = (int) jsonObjectGetNumber(min_children);
51 if(!max_children) osrfLogWarning( OSRF_LOG_MARK, "Max children not defined, assuming 10");
52 else maxc = (int) jsonObjectGetNumber(max_children);
54 jsonObjectFree(max_req);
55 jsonObjectFree(min_children);
56 jsonObjectFree(max_children);
57 /* --------------------------------------------------- */
59 char* resc = va_list_to_string("%s_listener", appname);
61 if(!osrf_system_bootstrap_client_resc( NULL, NULL, resc )) {
62 osrfLogError( OSRF_LOG_MARK, "Unable to bootstrap client for osrf_prefork_run()");
69 prefork_simple* forker = prefork_simple_init(
70 osrfSystemGetTransportClient(), maxr, minc, maxc);
72 forker->appname = strdup(appname);
73 forker->keepalive = kalive;
76 osrfLogError( OSRF_LOG_MARK, "osrf_prefork_run() failed to create prefork_simple object");
80 prefork_launch_children(forker);
82 osrf_prefork_register_routers(appname);
84 osrfLogInfo( OSRF_LOG_MARK, "Launching osrf_forker for app %s", appname);
87 osrfLogWarning( OSRF_LOG_MARK, "prefork_run() retuned - how??");
93 void osrf_prefork_register_routers( char* appname ) {
95 osrfStringArray* arr = osrfNewStringArray(4);
97 int c = osrfConfigGetValueList( NULL, arr, "/routers/router" );
98 char* routerName = osrfConfigGetValue( NULL, "/router_name" );
99 transport_client* client = osrfSystemGetTransportClient();
101 osrfLogInfo( OSRF_LOG_MARK, "router name is %s and we have %d routers to connect to", routerName, c );
104 char* domain = osrfStringArrayGetString(arr, --c);
107 char* jid = va_list_to_string( "%s@%s/router", routerName, domain );
108 osrfLogInfo( OSRF_LOG_MARK, "Registering with router %s", jid );
110 transport_message* msg = message_init("registering", NULL, NULL, jid, NULL );
111 message_set_router_info( msg, NULL, NULL, appname, "register", 0 );
113 client_send_message( client, msg );
120 osrfStringArrayFree(arr);
123 int prefork_child_init_hook(prefork_child* child) {
125 if(!child) return -1;
126 osrfLogDebug( OSRF_LOG_MARK, "Child init hook for child %d", child->pid);
127 char* resc = va_list_to_string("%s_drone",child->appname);
129 /* we want to remove traces of our parents socket connection
130 * so we can have our own */
131 osrfSystemIgnoreTransportClient();
133 if(!osrf_system_bootstrap_client_resc( NULL, NULL, resc)) {
134 osrfLogError( OSRF_LOG_MARK, "Unable to bootstrap client for osrf_prefork_run()");
141 if( ! osrfAppRunChildInit(child->appname) ) {
142 osrfLogDebug(OSRF_LOG_MARK, "Prefork child_init succeeded\n");
144 osrfLogError(OSRF_LOG_MARK, "Prefork child_init failed\n");
148 set_proc_title( "OpenSRF Drone [%s]", child->appname );
152 void prefork_child_process_request(prefork_child* child, char* data) {
155 transport_client* client = osrfSystemGetTransportClient();
157 if(!client_connected(client)) {
158 osrfSystemIgnoreTransportClient();
159 osrfLogWarning(OSRF_LOG_MARK, "Reconnecting child to opensrf after disconnect...");
160 if(!osrf_system_bootstrap_client(NULL, NULL)) {
161 osrfLogError( OSRF_LOG_MARK,
162 "Unable to bootstrap client in prefork_child_process_request()");
168 /* construct the message from the xml */
169 transport_message* msg = new_message_from_xml( data );
171 osrfAppSession* session = osrf_stack_transport_handler(msg, child->appname);
174 if( session->stateless && session->state != OSRF_SESSION_CONNECTED ) {
175 osrfAppSessionFree( session );
179 osrfLogDebug( OSRF_LOG_MARK, "Entering keepalive loop for session %s", session->session_id );
180 int keepalive = child->keepalive;
188 osrfLogDebug(OSRF_LOG_MARK,
189 "osrf_prefork calling queue_wait [%d] in keepalive loop", keepalive);
191 retval = osrf_app_session_queue_wait(session, keepalive, &recvd);
194 osrfLogDebug(OSRF_LOG_MARK, "Data received == %d", recvd);
197 osrfLogError(OSRF_LOG_MARK, "queue-wait returned non-success %d", retval);
201 /* see if the client disconnected from us */
202 if(session->state != OSRF_SESSION_CONNECTED) break;
204 /* if no data was reveived within the timeout interval */
205 if( !recvd && (end - start) >= keepalive ) {
206 osrfLogInfo(OSRF_LOG_MARK, "No data was reveived in %d seconds, exiting stateful session", keepalive);
207 osrfAppSessionStatus(
211 0, "Disconnected on timeout" );
217 osrfLogDebug( OSRF_LOG_MARK, "Exiting keepalive loop for session %s", session->session_id );
218 osrfAppSessionFree( session );
223 prefork_simple* prefork_simple_init( transport_client* client,
224 int max_requests, int min_children, int max_children ) {
226 if( min_children > max_children ) {
227 osrfLogError( OSRF_LOG_MARK, "min_children (%d) is greater "
228 "than max_children (%d)", min_children, max_children );
232 if( max_children > ABS_MAX_CHILDREN ) {
233 osrfLogError( OSRF_LOG_MARK, "max_children (%d) is greater than ABS_MAX_CHILDREN (%d)",
234 max_children, ABS_MAX_CHILDREN );
238 osrfLogInfo(OSRF_LOG_MARK, "Prefork launching child with max_request=%d,"
239 "min_children=%d, max_children=%d", max_requests, min_children, max_children );
241 /* flesh out the struct */
242 prefork_simple* prefork = (prefork_simple*) safe_malloc(sizeof(prefork_simple));
243 prefork->max_requests = max_requests;
244 prefork->min_children = min_children;
245 prefork->max_children = max_children;
246 prefork->first_child = NULL;
247 prefork->connection = client;
252 prefork_child* launch_child( prefork_simple* forker ) {
258 /* Set up the data pipes and add the child struct to the parent */
259 if( pipe(data_fd) < 0 ) { /* build the data pipe*/
260 osrfLogError( OSRF_LOG_MARK, "Pipe making error" );
264 if( pipe(status_fd) < 0 ) {/* build the status pipe */
265 osrfLogError( OSRF_LOG_MARK, "Pipe making error" );
269 osrfLogInternal( OSRF_LOG_MARK, "Pipes: %d %d %d %d", data_fd[0], data_fd[1], status_fd[0], status_fd[1] );
270 prefork_child* child = prefork_child_init( forker->max_requests, data_fd[0],
271 data_fd[1], status_fd[0], status_fd[1] );
273 child->appname = strdup(forker->appname);
274 child->keepalive = forker->keepalive;
277 add_prefork_child( forker, child );
279 if( (pid=fork()) < 0 ) {
280 osrfLogError( OSRF_LOG_MARK, "Forking Error" );
284 if( pid > 0 ) { /* parent */
286 signal(SIGCHLD, sigchld_handler);
287 (forker->current_num_children)++;
290 osrfLogDebug( OSRF_LOG_MARK, "Parent launched %d", pid );
291 /* *no* child pipe FD's can be closed or the parent will re-use fd's that
292 the children are currently using */
298 osrfLogInternal( OSRF_LOG_MARK, "I am new child with read_data_fd = %d and write_status_fd = %d",
299 child->read_data_fd, child->write_status_fd );
301 child->pid = getpid();
302 close( child->write_data_fd );
303 close( child->read_status_fd );
306 if( prefork_child_init_hook(child) == -1 ) {
307 osrfLogError(OSRF_LOG_MARK,
308 "Forker child going away because we could not connect to OpenSRF...");
312 prefork_child_wait( child );
313 exit(0); /* just to be sure */
319 void prefork_launch_children( prefork_simple* forker ) {
322 while( c++ < forker->min_children )
323 launch_child( forker );
327 void sigchld_handler( int sig ) {
328 signal(SIGCHLD, sigchld_handler);
333 void reap_children( prefork_simple* forker ) {
338 while( (child_pid=waitpid(-1,&status,WNOHANG)) > 0)
339 del_prefork_child( forker, child_pid );
342 while( forker->current_num_children < forker->min_children )
343 launch_child( forker );
348 void prefork_run(prefork_simple* forker) {
350 if( forker->first_child == NULL )
353 transport_message* cur_msg = NULL;
358 if( forker->first_child == NULL ) {/* no more children */
359 osrfLogWarning( OSRF_LOG_MARK, "No more children..." );
363 osrfLogDebug( OSRF_LOG_MARK, "Forker going into wait for data...");
364 cur_msg = client_recv( forker->connection, -1 );
366 //fprintf(stderr, "Got Data %f\n", get_timestamp_millis() );
368 if( cur_msg == NULL ) continue;
370 int honored = 0; /* true if we've serviced the request */
375 if(!no_recheck) check_children( forker, 0 );
378 osrfLogDebug( OSRF_LOG_MARK, "Server received inbound data" );
380 prefork_child* cur_child = forker->first_child;
382 /* Look for an available child */
383 for( k = 0; k < forker->current_num_children; k++ ) {
385 osrfLogInternal( OSRF_LOG_MARK, "Searching for available child. cur_child->pid = %d", cur_child->pid );
386 osrfLogInternal( OSRF_LOG_MARK, "Current num children %d and loop %d", forker->current_num_children, k);
388 if( cur_child->available ) {
389 osrfLogDebug( OSRF_LOG_MARK, "forker sending data to %d", cur_child->pid );
391 message_prepare_xml( cur_msg );
392 char* data = cur_msg->msg_xml;
393 if( ! data || strlen(data) < 1 ) break;
395 cur_child->available = 0;
396 osrfLogInternal( OSRF_LOG_MARK, "Writing to child fd %d", cur_child->write_data_fd );
399 //fprintf(stderr, "Writing Data %f\n", get_timestamp_millis() );
400 if( (written = write( cur_child->write_data_fd, data, strlen(data) + 1 )) < 0 ) {
401 osrfLogWarning( OSRF_LOG_MARK, "Write returned error %d", errno);
402 cur_child = cur_child->next;
406 //fprintf(stderr, "Wrote %d bytes to child\n", written);
408 forker->first_child = cur_child->next;
412 cur_child = cur_child->next;
415 /* if none available, add a new child if we can */
417 osrfLogDebug( OSRF_LOG_MARK, "Not enough children, attempting to add...");
418 if( forker->current_num_children < forker->max_children ) {
419 osrfLogDebug( OSRF_LOG_MARK, "Launching new child with current_num = %d",
420 forker->current_num_children );
422 prefork_child* new_child = launch_child( forker );
423 message_prepare_xml( cur_msg );
424 char* data = cur_msg->msg_xml;
425 if( ! data || strlen(data) < 1 ) break;
426 new_child->available = 0;
427 osrfLogDebug( OSRF_LOG_MARK, "Writing to new child fd %d : pid %d",
428 new_child->write_data_fd, new_child->pid );
429 write( new_child->write_data_fd, data, strlen(data) + 1 );
430 forker->first_child = new_child->next;
436 osrfLogWarning( OSRF_LOG_MARK, "No children available, waiting...");
438 check_children( forker, 1 ); /* non-poll version */
439 /* tell the loop no to call check_children again, since we're calling it now */
445 reap_children(forker);
448 //fprintf(stderr, "Parent done with request %f\n", get_timestamp_millis() );
452 message_free( cur_msg );
454 } /* top level listen loop */
459 /** XXX Add a flag which tells select() to wait forever on children
460 * in the best case, this will be faster than calling usleep(x), and
461 * in the worst case it won't be slower and will do less logging...
464 void check_children( prefork_simple* forker, int forever ) {
476 reap_children(forker);
478 prefork_child* cur_child = forker->first_child;
481 for( i = 0; i!= forker->current_num_children; i++ ) {
483 if( cur_child->read_status_fd > max_fd )
484 max_fd = cur_child->read_status_fd;
485 FD_SET( cur_child->read_status_fd, &read_set );
486 cur_child = cur_child->next;
489 FD_CLR(0,&read_set);/* just to be sure */
492 osrfLogWarning(OSRF_LOG_MARK, "We have no children available - waiting for one to show up...");
494 if( (select_ret=select( max_fd + 1 , &read_set, NULL, NULL, NULL)) == -1 ) {
495 osrfLogWarning( OSRF_LOG_MARK, "Select returned error %d on check_children", errno );
497 osrfLogInfo(OSRF_LOG_MARK, "select() completed after waiting on children to become available");
505 if( (select_ret=select( max_fd + 1 , &read_set, NULL, NULL, &tv)) == -1 ) {
506 osrfLogWarning( OSRF_LOG_MARK, "Select returned error %d on check_children", errno );
510 if( select_ret == 0 )
513 /* see if one of a child has told us it's done */
514 cur_child = forker->first_child;
517 for( j = 0; j!= forker->current_num_children && num_handled < select_ret ; j++ ) {
519 if( FD_ISSET( cur_child->read_status_fd, &read_set ) ) {
520 //printf( "Server received status from a child %d\n", cur_child->pid );
521 osrfLogDebug( OSRF_LOG_MARK, "Server received status from a child %d", cur_child->pid );
525 /* now suck off the data */
528 if( (n=read(cur_child->read_status_fd, buf, 63)) < 0 ) {
529 osrfLogWarning( OSRF_LOG_MARK, "Read error afer select in child status read with errno %d", errno);
532 osrfLogDebug( OSRF_LOG_MARK, "Read %d bytes from status buffer: %s", n, buf );
533 cur_child->available = 1;
535 cur_child = cur_child->next;
541 void prefork_child_wait( prefork_child* child ) {
544 growing_buffer* gbuf = buffer_init( READ_BUFSIZE );
545 char buf[READ_BUFSIZE];
546 memset( buf, 0, READ_BUFSIZE );
548 for( i = 0; i < child->max_requests; i++ ) {
552 clr_fl(child->read_data_fd, O_NONBLOCK );
554 while( (n=read(child->read_data_fd, buf, READ_BUFSIZE-1)) > 0 ) {
555 osrfLogDebug(OSRF_LOG_MARK, "Prefork child read %d bytes of data", n);
557 set_fl(child->read_data_fd, O_NONBLOCK );
558 buffer_add( gbuf, buf );
559 memset( buf, 0, READ_BUFSIZE );
563 if( errno == EAGAIN ) n = 0;
566 osrfLogWarning( OSRF_LOG_MARK, "Prefork child read returned error with errno %d", errno );
569 } else if( gotdata ) {
570 osrfLogDebug(OSRF_LOG_MARK, "Prefork child got a request.. processing..");
571 prefork_child_process_request(child, gbuf->buf);
572 buffer_reset( gbuf );
575 if( i < child->max_requests - 1 )
576 write( child->write_status_fd, "available" /*less than 64 bytes*/, 9 );
581 osrfLogDebug( OSRF_LOG_MARK, "Child with max-requests=%d, num-served=%d exiting...[%d]",
582 child->max_requests, i, getpid() );
588 void add_prefork_child( prefork_simple* forker, prefork_child* child ) {
590 if( forker->first_child == NULL ) {
591 forker->first_child = child;
596 /* we put the child in as the last because, regardless,
597 we have to do the DLL splice dance, and this is the
600 prefork_child* start_child = forker->first_child;
602 if( forker->first_child->next == start_child )
604 forker->first_child = forker->first_child->next;
607 /* here we know that forker->first_child is the last element
608 in the list and start_child is the first. Insert the
609 new child between them*/
611 forker->first_child->next = child;
612 child->next = start_child;
616 prefork_child* find_prefork_child( prefork_simple* forker, pid_t pid ) {
618 if( forker->first_child == NULL ) { return NULL; }
619 prefork_child* start_child = forker->first_child;
621 if( forker->first_child->pid == pid )
622 return forker->first_child;
623 } while( (forker->first_child = forker->first_child->next) != start_child );
629 void del_prefork_child( prefork_simple* forker, pid_t pid ) {
631 if( forker->first_child == NULL ) { return; }
633 (forker->current_num_children)--;
634 osrfLogDebug( OSRF_LOG_MARK, "Deleting Child: %d", pid );
636 prefork_child* start_child = forker->first_child; /* starting point */
637 prefork_child* cur_child = start_child; /* current pointer */
638 prefork_child* prev_child = start_child; /* the trailing pointer */
640 /* special case where there is only one in the list */
641 if( start_child == start_child->next ) {
642 if( start_child->pid == pid ) {
643 forker->first_child = NULL;
645 close( start_child->read_data_fd );
646 close( start_child->write_data_fd );
647 close( start_child->read_status_fd );
648 close( start_child->write_status_fd );
650 prefork_child_free( start_child );
656 /* special case where the first item in the list needs to be removed */
657 if( start_child->pid == pid ) {
659 /* find the last one so we can remove the start_child */
661 prev_child = cur_child;
662 cur_child = cur_child->next;
663 }while( cur_child != start_child );
665 /* now cur_child == start_child */
666 prev_child->next = cur_child->next;
667 forker->first_child = prev_child;
669 close( cur_child->read_data_fd );
670 close( cur_child->write_data_fd );
671 close( cur_child->read_status_fd );
672 close( cur_child->write_status_fd );
674 prefork_child_free( cur_child );
679 prev_child = cur_child;
680 cur_child = cur_child->next;
682 if( cur_child->pid == pid ) {
683 prev_child->next = cur_child->next;
685 close( cur_child->read_data_fd );
686 close( cur_child->write_data_fd );
687 close( cur_child->read_status_fd );
688 close( cur_child->write_status_fd );
690 prefork_child_free( cur_child );
694 } while(cur_child != start_child);
700 prefork_child* prefork_child_init(
701 int max_requests, int read_data_fd, int write_data_fd,
702 int read_status_fd, int write_status_fd ) {
704 prefork_child* child = (prefork_child*) safe_malloc(sizeof(prefork_child));
705 child->max_requests = max_requests;
706 child->read_data_fd = read_data_fd;
707 child->write_data_fd = write_data_fd;
708 child->read_status_fd = read_status_fd;
709 child->write_status_fd = write_status_fd;
710 child->available = 1;
716 int prefork_free( prefork_simple* prefork ) {
718 while( prefork->first_child != NULL ) {
719 osrfLogInfo( OSRF_LOG_MARK, "Killing children and sleeping 1 to reap..." );
724 client_free(prefork->connection);
725 free(prefork->appname);
730 int prefork_child_free( prefork_child* child ) {
731 free(child->appname);
732 close(child->read_data_fd);
733 close(child->write_status_fd);