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 /* construct the message from the xml */
156 transport_message* msg = new_message_from_xml( data );
158 osrfAppSession* session = osrf_stack_transport_handler(msg, child->appname);
161 if( session->stateless && session->state != OSRF_SESSION_CONNECTED ) {
162 osrfAppSessionFree( session );
166 osrfLogDebug( OSRF_LOG_MARK, "Entering keepalive loop for session %s", session->session_id );
167 int keepalive = child->keepalive;
174 osrfLogDebug(OSRF_LOG_MARK,
175 "osrf_prefork calling queue_wait [%d] in keepalive loop", keepalive);
177 retval = osrf_app_session_queue_wait(session, keepalive);
181 osrfLogError(OSRF_LOG_MARK, "queue-wait returned non-success %d", retval);
185 /* see if the client disconnected from us */
186 if(session->state != OSRF_SESSION_CONNECTED) break;
188 /* see if the used up the timeout */
189 if( (end - start) >= keepalive ) {
191 osrfLogDebug(OSRF_LOG_MARK, "Keepalive timed out, exiting connected session");
193 osrfAppSessionStatus(
197 0, "Disconnected on timeout" );
203 osrfLogDebug( OSRF_LOG_MARK, "Exiting keepalive loop for session %s", session->session_id );
204 osrfAppSessionFree( session );
209 prefork_simple* prefork_simple_init( transport_client* client,
210 int max_requests, int min_children, int max_children ) {
212 if( min_children > max_children ) {
213 osrfLogError( OSRF_LOG_MARK, "min_children (%d) is greater "
214 "than max_children (%d)", min_children, max_children );
218 if( max_children > ABS_MAX_CHILDREN ) {
219 osrfLogError( OSRF_LOG_MARK, "max_children (%d) is greater than ABS_MAX_CHILDREN (%d)",
220 max_children, ABS_MAX_CHILDREN );
224 osrfLogInfo(OSRF_LOG_MARK, "Prefork launching child with max_request=%d,"
225 "min_children=%d, max_children=%d", max_requests, min_children, max_children );
227 /* flesh out the struct */
228 prefork_simple* prefork = (prefork_simple*) safe_malloc(sizeof(prefork_simple));
229 prefork->max_requests = max_requests;
230 prefork->min_children = min_children;
231 prefork->max_children = max_children;
232 prefork->first_child = NULL;
233 prefork->connection = client;
238 prefork_child* launch_child( prefork_simple* forker ) {
244 /* Set up the data pipes and add the child struct to the parent */
245 if( pipe(data_fd) < 0 ) { /* build the data pipe*/
246 osrfLogError( OSRF_LOG_MARK, "Pipe making error" );
250 if( pipe(status_fd) < 0 ) {/* build the status pipe */
251 osrfLogError( OSRF_LOG_MARK, "Pipe making error" );
255 osrfLogInternal( OSRF_LOG_MARK, "Pipes: %d %d %d %d", data_fd[0], data_fd[1], status_fd[0], status_fd[1] );
256 prefork_child* child = prefork_child_init( forker->max_requests, data_fd[0],
257 data_fd[1], status_fd[0], status_fd[1] );
259 child->appname = strdup(forker->appname);
260 child->keepalive = forker->keepalive;
263 add_prefork_child( forker, child );
265 if( (pid=fork()) < 0 ) {
266 osrfLogError( OSRF_LOG_MARK, "Forking Error" );
270 if( pid > 0 ) { /* parent */
272 signal(SIGCHLD, sigchld_handler);
273 (forker->current_num_children)++;
276 osrfLogDebug( OSRF_LOG_MARK, "Parent launched %d", pid );
277 /* *no* child pipe FD's can be closed or the parent will re-use fd's that
278 the children are currently using */
284 osrfLogInternal( OSRF_LOG_MARK, "I am new child with read_data_fd = %d and write_status_fd = %d",
285 child->read_data_fd, child->write_status_fd );
287 child->pid = getpid();
288 close( child->write_data_fd );
289 close( child->read_status_fd );
292 if( prefork_child_init_hook(child) == -1 ) {
293 osrfLogError(OSRF_LOG_MARK,
294 "Forker child going away because we could not connect to OpenSRF...");
298 prefork_child_wait( child );
299 exit(0); /* just to be sure */
305 void prefork_launch_children( prefork_simple* forker ) {
308 while( c++ < forker->min_children )
309 launch_child( forker );
313 void sigchld_handler( int sig ) {
314 signal(SIGCHLD, sigchld_handler);
319 void reap_children( prefork_simple* forker ) {
324 while( (child_pid=waitpid(-1,&status,WNOHANG)) > 0)
325 del_prefork_child( forker, child_pid );
328 while( forker->current_num_children < forker->min_children )
329 launch_child( forker );
334 void prefork_run(prefork_simple* forker) {
336 if( forker->first_child == NULL )
339 transport_message* cur_msg = NULL;
344 if( forker->first_child == NULL ) {/* no more children */
345 osrfLogWarning( OSRF_LOG_MARK, "No more children..." );
349 osrfLogDebug( OSRF_LOG_MARK, "Forker going into wait for data...");
350 cur_msg = client_recv( forker->connection, -1 );
352 //fprintf(stderr, "Got Data %f\n", get_timestamp_millis() );
354 if( cur_msg == NULL ) continue;
356 int honored = 0; /* true if we've serviced the request */
360 check_children( forker );
362 osrfLogDebug( OSRF_LOG_MARK, "Server received inbound data" );
364 prefork_child* cur_child = forker->first_child;
366 /* Look for an available child */
367 for( k = 0; k < forker->current_num_children; k++ ) {
369 osrfLogInternal( OSRF_LOG_MARK, "Searching for available child. cur_child->pid = %d", cur_child->pid );
370 osrfLogInternal( OSRF_LOG_MARK, "Current num children %d and loop %d", forker->current_num_children, k);
372 if( cur_child->available ) {
373 osrfLogDebug( OSRF_LOG_MARK, "forker sending data to %d", cur_child->pid );
375 message_prepare_xml( cur_msg );
376 char* data = cur_msg->msg_xml;
377 if( ! data || strlen(data) < 1 ) break;
379 cur_child->available = 0;
380 osrfLogInternal( OSRF_LOG_MARK, "Writing to child fd %d", cur_child->write_data_fd );
383 //fprintf(stderr, "Writing Data %f\n", get_timestamp_millis() );
384 if( (written = write( cur_child->write_data_fd, data, strlen(data) + 1 )) < 0 ) {
385 osrfLogWarning( OSRF_LOG_MARK, "Write returned error %d", errno);
386 cur_child = cur_child->next;
390 //fprintf(stderr, "Wrote %d bytes to child\n", written);
392 forker->first_child = cur_child->next;
396 cur_child = cur_child->next;
399 /* if none available, add a new child if we can */
401 osrfLogDebug( OSRF_LOG_MARK, "Not enough children, attempting to add...");
402 if( forker->current_num_children < forker->max_children ) {
403 osrfLogDebug( OSRF_LOG_MARK, "Launching new child with current_num = %d",
404 forker->current_num_children );
406 prefork_child* new_child = launch_child( forker );
407 message_prepare_xml( cur_msg );
408 char* data = cur_msg->msg_xml;
409 if( ! data || strlen(data) < 1 ) break;
410 new_child->available = 0;
411 osrfLogDebug( OSRF_LOG_MARK, "Writing to new child fd %d : pid %d",
412 new_child->write_data_fd, new_child->pid );
413 write( new_child->write_data_fd, data, strlen(data) + 1 );
414 forker->first_child = new_child->next;
420 osrfLogWarning( OSRF_LOG_MARK, "No children available, sleeping and looping..." );
421 usleep( 50000 ); /* 50 milliseconds */
425 reap_children(forker);
428 //fprintf(stderr, "Parent done with request %f\n", get_timestamp_millis() );
432 message_free( cur_msg );
434 } /* top level listen loop */
439 void check_children( prefork_simple* forker ) {
454 reap_children(forker);
456 prefork_child* cur_child = forker->first_child;
459 for( i = 0; i!= forker->current_num_children; i++ ) {
461 if( cur_child->read_status_fd > max_fd )
462 max_fd = cur_child->read_status_fd;
463 FD_SET( cur_child->read_status_fd, &read_set );
464 cur_child = cur_child->next;
467 FD_CLR(0,&read_set);/* just to be sure */
469 if( (select_ret=select( max_fd + 1 , &read_set, NULL, NULL, &tv)) == -1 ) {
470 osrfLogWarning( OSRF_LOG_MARK, "Select returned error %d on check_children", errno );
473 if( select_ret == 0 )
476 /* see if one of a child has told us it's done */
477 cur_child = forker->first_child;
480 for( j = 0; j!= forker->current_num_children && num_handled < select_ret ; j++ ) {
482 if( FD_ISSET( cur_child->read_status_fd, &read_set ) ) {
483 //printf( "Server received status from a child %d\n", cur_child->pid );
484 osrfLogDebug( OSRF_LOG_MARK, "Server received status from a child %d", cur_child->pid );
488 /* now suck off the data */
491 if( (n=read(cur_child->read_status_fd, buf, 63)) < 0 ) {
492 osrfLogWarning( OSRF_LOG_MARK, "Read error afer select in child status read with errno %d", errno);
495 osrfLogDebug( OSRF_LOG_MARK, "Read %d bytes from status buffer: %s", n, buf );
496 cur_child->available = 1;
498 cur_child = cur_child->next;
504 void prefork_child_wait( prefork_child* child ) {
507 growing_buffer* gbuf = buffer_init( READ_BUFSIZE );
508 char buf[READ_BUFSIZE];
509 memset( buf, 0, READ_BUFSIZE );
511 for( i = 0; i < child->max_requests; i++ ) {
515 clr_fl(child->read_data_fd, O_NONBLOCK );
517 while( (n=read(child->read_data_fd, buf, READ_BUFSIZE-1)) > 0 ) {
518 osrfLogDebug(OSRF_LOG_MARK, "Prefork child read %d bytes of data", n);
520 set_fl(child->read_data_fd, O_NONBLOCK );
521 buffer_add( gbuf, buf );
522 memset( buf, 0, READ_BUFSIZE );
526 if( errno == EAGAIN ) n = 0;
529 osrfLogWarning( OSRF_LOG_MARK, "Prefork child read returned error with errno %d", errno );
532 } else if( gotdata ) {
533 osrfLogDebug(OSRF_LOG_MARK, "Prefork child got a request.. processing..");
534 prefork_child_process_request(child, gbuf->buf);
535 buffer_reset( gbuf );
538 if( i < child->max_requests - 1 )
539 write( child->write_status_fd, "available" /*less than 64 bytes*/, 9 );
544 osrfLogDebug( OSRF_LOG_MARK, "Child with max-requests=%d, num-served=%d exiting...[%d]",
545 child->max_requests, i, getpid() );
551 void add_prefork_child( prefork_simple* forker, prefork_child* child ) {
553 if( forker->first_child == NULL ) {
554 forker->first_child = child;
559 /* we put the child in as the last because, regardless,
560 we have to do the DLL splice dance, and this is the
563 prefork_child* start_child = forker->first_child;
565 if( forker->first_child->next == start_child )
567 forker->first_child = forker->first_child->next;
570 /* here we know that forker->first_child is the last element
571 in the list and start_child is the first. Insert the
572 new child between them*/
574 forker->first_child->next = child;
575 child->next = start_child;
579 prefork_child* find_prefork_child( prefork_simple* forker, pid_t pid ) {
581 if( forker->first_child == NULL ) { return NULL; }
582 prefork_child* start_child = forker->first_child;
584 if( forker->first_child->pid == pid )
585 return forker->first_child;
586 } while( (forker->first_child = forker->first_child->next) != start_child );
592 void del_prefork_child( prefork_simple* forker, pid_t pid ) {
594 if( forker->first_child == NULL ) { return; }
596 (forker->current_num_children)--;
597 osrfLogDebug( OSRF_LOG_MARK, "Deleting Child: %d", pid );
599 prefork_child* start_child = forker->first_child; /* starting point */
600 prefork_child* cur_child = start_child; /* current pointer */
601 prefork_child* prev_child = start_child; /* the trailing pointer */
603 /* special case where there is only one in the list */
604 if( start_child == start_child->next ) {
605 if( start_child->pid == pid ) {
606 forker->first_child = NULL;
608 close( start_child->read_data_fd );
609 close( start_child->write_data_fd );
610 close( start_child->read_status_fd );
611 close( start_child->write_status_fd );
613 prefork_child_free( start_child );
619 /* special case where the first item in the list needs to be removed */
620 if( start_child->pid == pid ) {
622 /* find the last one so we can remove the start_child */
624 prev_child = cur_child;
625 cur_child = cur_child->next;
626 }while( cur_child != start_child );
628 /* now cur_child == start_child */
629 prev_child->next = cur_child->next;
630 forker->first_child = prev_child;
632 close( cur_child->read_data_fd );
633 close( cur_child->write_data_fd );
634 close( cur_child->read_status_fd );
635 close( cur_child->write_status_fd );
637 prefork_child_free( cur_child );
642 prev_child = cur_child;
643 cur_child = cur_child->next;
645 if( cur_child->pid == pid ) {
646 prev_child->next = cur_child->next;
648 close( cur_child->read_data_fd );
649 close( cur_child->write_data_fd );
650 close( cur_child->read_status_fd );
651 close( cur_child->write_status_fd );
653 prefork_child_free( cur_child );
657 } while(cur_child != start_child);
663 prefork_child* prefork_child_init(
664 int max_requests, int read_data_fd, int write_data_fd,
665 int read_status_fd, int write_status_fd ) {
667 prefork_child* child = (prefork_child*) safe_malloc(sizeof(prefork_child));
668 child->max_requests = max_requests;
669 child->read_data_fd = read_data_fd;
670 child->write_data_fd = write_data_fd;
671 child->read_status_fd = read_status_fd;
672 child->write_status_fd = write_status_fd;
673 child->available = 1;
679 int prefork_free( prefork_simple* prefork ) {
681 while( prefork->first_child != NULL ) {
682 osrfLogInfo( OSRF_LOG_MARK, "Killing children and sleeping 1 to reap..." );
687 client_free(prefork->connection);
688 free(prefork->appname);
693 int prefork_child_free( prefork_child* child ) {
694 free(child->appname);
695 close(child->read_data_fd);
696 close(child->write_status_fd);