OpenSRF/src/utils/socket_bundle.c

   1 #include "socket_bundle.h"
   2
   3 /* --------------------------------------------------------------------
   4         Test Code
   5         -------------------------------------------------------------------- */
   6 /*
   7 int count = 0;
   8 void printme(void* blob, socket_manager* mgr,
   9                 int sock_fd, char* data, int parent_id) {
  10
  11         fprintf(stderr, "Got data from socket %d with parent %d => %s",
  12                         sock_fd, parent_id, data );
  13
  14         socket_send(sock_fd, data);
  15
  16         if(count++ > 2) {
  17                 socket_disconnect(mgr, sock_fd);
  18                 _socket_print_list(mgr);
  19         }
  20 }
  21
  22 int main(int argc, char* argv[]) {
  23         socket_manager manager;
  24         memset(&manager, 0, sizeof(socket_manager));
  25         int port = 11000;
  26         if(argv[1])
  27                 port = atoi(argv[1]);
  28
  29         manager.data_received = &printme;
  30         socket_open_tcp_server(&manager, port);
  31
  32         while(1)
  33                 socket_wait_all(&manager, -1);
  34
  35         return 0;
  36 }
  37 */
  38 /* -------------------------------------------------------------------- */
  39
  40
  41 /*
  42 int debug_handler(char* msg, ...) {
  43         va_list args;
  44         va_start(args, msg);
  45         vfprintf(stderr, msg, args);
  46         va_end(args);
  47         fprintf( stderr, "\n" );
  48         return -1;
  49 }
  50
  51 int warning_handler(char* msg, ...) {
  52         va_list args;
  53         va_start(args, msg);
  54         vfprintf(stderr, msg, args);
  55         va_end(args);
  56         fprintf( stderr, "\n" );
  57         return -1;
  58 }
  59 */
  60
  61
  62 socket_node* _socket_add_node(socket_manager* mgr,
  63                 int endpoint, int addr_type, int sock_fd, int parent_id ) {
  64
  65         if(mgr == NULL) return NULL;
  66         debug_handler("Adding socket node with fd %d", sock_fd);
  67         socket_node* new_node = safe_malloc(sizeof(socket_node));
  68
  69         new_node->endpoint      = endpoint;
  70         new_node->addr_type     = addr_type;
  71         new_node->sock_fd               = sock_fd;
  72         new_node->next                  = NULL;
  73         new_node->parent_id = 0;
  74         if(parent_id > 0)
  75                 new_node->parent_id = parent_id;
  76
  77         new_node->next                  = mgr->socket;
  78         mgr->socket                             = new_node;
  79         return new_node;
  80 }
  81
  82 /* creates a new server socket node and adds it to the socket set.
  83         returns new socket fd on success.  -1 on failure.
  84         socket_type is one of INET or UNIX  */
  85 int socket_open_tcp_server(socket_manager* mgr, int port, char* listen_ip) {
  86
  87         if( mgr == NULL ) return warning_handler("socket_open_tcp_server(): NULL mgr");
  88
  89         int sock_fd;
  90         struct sockaddr_in server_addr;
  91
  92         sock_fd = socket(AF_INET, SOCK_STREAM, 0);
  93
  94         if(sock_fd < 0)
  95                 return warning_handler("tcp_server_connect(): Unable to create socket");
  96
  97         server_addr.sin_family = AF_INET;
  98
  99         if(listen_ip != NULL) {
 100                 server_addr.sin_addr.s_addr = inet_addr(listen_ip);
 101         } else {
 102                 server_addr.sin_addr.s_addr = htonl(INADDR_ANY);
 103         }
 104
 105         server_addr.sin_port = htons(port);
 106
 107         if(bind( sock_fd, (struct sockaddr*) &server_addr, sizeof(server_addr)) < 0)
 108                 return warning_handler("tcp_server_connect(): cannot bind to port %d", port );
 109
 110         if(listen(sock_fd, 20) == -1)
 111                 return warning_handler("tcp_server_connect(): listen() returned error");
 112
 113         _socket_add_node(mgr, SERVER_SOCKET, INET, sock_fd, 0);
 114         return sock_fd;
 115 }
 116
 117 int socket_open_unix_server(socket_manager* mgr, char* path) {
 118         if(mgr == NULL || path == NULL) return -1;
 119
 120         debug_handler("opening unix socket at %s", path);
 121         int sock_fd;
 122         struct sockaddr_un server_addr;
 123
 124         sock_fd = socket(AF_UNIX, SOCK_STREAM, 0);
 125         if(sock_fd < 0)
 126                 return warning_handler("socket_open_unix_server(): socket() failed");
 127
 128         server_addr.sun_family = AF_UNIX;
 129         strcpy(server_addr.sun_path, path);
 130
 131         if( bind(sock_fd, (struct sockaddr*) &server_addr,
 132                                 sizeof(struct sockaddr_un)) < 0) {
 133                 return warning_handler(
 134                         "socket_open_unix_server(): cannot bind to unix port %s", path );
 135         }
 136
 137         if(listen(sock_fd, 20) == -1)
 138                 return warning_handler("socket_open_unix_server(): listen() returned error");
 139
 140         debug_handler("unix socket successfully opened");
 141         _socket_add_node(mgr, SERVER_SOCKET, UNIX, sock_fd, 0);
 142         return sock_fd;
 143 }
 144
 145
 146 int socket_open_tcp_client(socket_manager* mgr, int port, char* dest_addr) {
 147
 148         struct sockaddr_in remoteAddr, localAddr;
 149    struct hostent *hptr;
 150    int sock_fd;
 151
 152    // ------------------------------------------------------------------
 153    // Create the socket
 154    // ------------------------------------------------------------------
 155    if( (sock_fd = socket( AF_INET, SOCK_STREAM, 0 )) < 0 ) {
 156       fatal_handler( "tcp_connect(): Cannot create socket" );
 157       return -1;
 158    }
 159
 160    // ------------------------------------------------------------------
 161    // Get the hostname
 162    // ------------------------------------------------------------------
 163    if( (hptr = gethostbyname( dest_addr ) ) == NULL ) {
 164       fatal_handler( "tcp_connect(): Unknown Host => %s", dest_addr );
 165       return -1;
 166    }
 167
 168    // ------------------------------------------------------------------
 169    // Construct server info struct
 170    // ------------------------------------------------------------------
 171    memset( &remoteAddr, 0, sizeof(remoteAddr));
 172    remoteAddr.sin_family = AF_INET;
 173    remoteAddr.sin_port = htons( port );
 174    memcpy( (char*) &remoteAddr.sin_addr.s_addr,
 175          hptr->h_addr_list[0], hptr->h_length );
 176
 177    // ------------------------------------------------------------------
 178    // Construct local info struct
 179    // ------------------------------------------------------------------
 180    memset( &localAddr, 0, sizeof( localAddr ) );
 181    localAddr.sin_family = AF_INET;
 182    localAddr.sin_addr.s_addr = htonl( INADDR_ANY );
 183    localAddr.sin_port = htons(0);
 184
 185    // ------------------------------------------------------------------
 186    // Bind to a local port
 187    // ------------------------------------------------------------------
 188    if( bind( sock_fd, (struct sockaddr *) &localAddr, sizeof( localAddr ) ) < 0 ) {
 189       fatal_handler( "tcp_connect(): Cannot bind to local port" );
 190       return -1;
 191    }
 192
 193    // ------------------------------------------------------------------
 194    // Connect to server
 195    // ------------------------------------------------------------------
 196    if( connect( sock_fd, (struct sockaddr*) &remoteAddr, sizeof( struct sockaddr_in ) ) < 0 ) {
 197       fatal_handler( "tcp_connect(): Cannot connect to server %s", dest_addr );
 198       return -1;
 199    }
 200
 201         _socket_add_node(mgr, CLIENT_SOCKET, INET, sock_fd, -1 );
 202
 203    return sock_fd;
 204 }
 205
 206
 207 int socket_open_unix_client(socket_manager* mgr, char* sock_path) {
 208
 209         int sock_fd, len;
 210    struct sockaddr_un usock;
 211
 212    if( (sock_fd = socket( AF_UNIX, SOCK_STREAM, 0 )) < 0 )
 213       return warning_handler( "Cannot create socket" );
 214
 215    usock.sun_family = AF_UNIX;
 216    strcpy( usock.sun_path, sock_path );
 217
 218    len = sizeof( usock.sun_family ) + strlen( usock.sun_path );
 219
 220    if( connect( sock_fd, (struct sockaddr *) &usock, len ) < 0 )
 221       return warning_handler( "Error connecting to unix socket" );
 222
 223         _socket_add_node(mgr, CLIENT_SOCKET, UNIX, sock_fd, -1 );
 224
 225    return sock_fd;
 226 }
 227
 228
 229
 230 /* returns the socket_node with the given sock_fd */
 231 socket_node* socket_find_node(socket_manager* mgr, int sock_fd) {
 232         if(mgr == NULL) return NULL;
 233         socket_node* node = mgr->socket;
 234         while(node) {
 235                 if(node->sock_fd == sock_fd)
 236                         return node;
 237                 node = node->next;
 238         }
 239         return NULL;
 240 }
 241
 242 /* removes the node with the given sock_fd from the list and frees it */
 243 void socket_remove_node(socket_manager* mgr, int sock_fd) {
 244
 245         if(mgr == NULL) return;
 246
 247         debug_handler("removing socket %d", sock_fd);
 248
 249         socket_node* head = mgr->socket;
 250         socket_node* tail = head;
 251         if(head == NULL) return;
 252
 253         /* if removing the first node in the list */
 254         if(head->sock_fd == sock_fd) {
 255                 mgr->socket = head->next;
 256                 free(head);
 257                 debug_handler("removing first socket in list");
 258                 return;
 259         }
 260
 261         head = head->next;
 262
 263         /* if removing any other node */
 264         while(head) {
 265                 if(head->sock_fd == sock_fd) {
 266                         tail->next = head->next;
 267                         free(head);
 268                         return;
 269                 }
 270                 tail = head;
 271                 head = head->next;
 272         }
 273 }
 274
 275
 276
 277 void _socket_print_list(socket_manager* mgr) {
 278         if(mgr == NULL) return;
 279         socket_node* node = mgr->socket;
 280         debug_handler("socket_node list: [");
 281         while(node) {
 282                 debug_handler("sock_fd: %d | parent_id: %d",
 283                                 node->sock_fd, node->parent_id);
 284                 node = node->next;
 285         }
 286         debug_handler("]");
 287 }
 288
 289 /* sends the given data to the given socket */
 290 int socket_send(int sock_fd, const char* data) {
 291         debug_handler( "socket_bundle sending to %d data %s",
 292                 sock_fd, data);
 293
 294         info_handler("%d : Sending data at %lf\n", getpid(), get_timestamp_millis());
 295         signal(SIGPIPE, SIG_IGN); /* in case a unix socket was closed */
 296         if( send( sock_fd, data, strlen(data), 0 ) < 0 ) {
 297                 return warning_handler( "tcp_server_send(): Error sending data" );
 298         }
 299
 300         return 0;
 301 }
 302
 303 /* disconnects the node with the given sock_fd and removes
 304         it from the socket set */
 305 void socket_disconnect(socket_manager* mgr, int sock_fd) {
 306
 307         debug_handler("Closing socket %d", sock_fd);
 308
 309         if( shutdown( sock_fd, SHUT_RDWR ) )
 310                 warning_handler( "socket_disconnect(): Error shuting down socket, removing anyway" );
 311
 312         if( close( sock_fd ) == -1 )
 313                 warning_handler( "socket_disconnect(): Error closing socket, removing anyway" );
 314
 315         if(mgr != NULL)
 316                 socket_remove_node(mgr, sock_fd);
 317
 318 }
 319
 320
 321 /* we assume that if select() fails, the socket is no longer valid */
 322 int socket_connected(int sock_fd) {
 323         fd_set read_set;
 324         FD_ZERO( &read_set );
 325         FD_SET( sock_fd, &read_set );
 326         if( select( sock_fd + 1, &read_set, NULL, NULL, NULL) == -1 )
 327                 return 0;
 328         return 1;
 329
 330 }
 331
 332 /* this only waits on the server socket and does not handle the actual
 333         data coming in from the client..... XXX */
 334 int socket_wait(socket_manager* mgr, int timeout, int sock_fd) {
 335
 336         int retval = 0;
 337         fd_set read_set;
 338         FD_ZERO( &read_set );
 339         FD_SET( sock_fd, &read_set );
 340
 341         struct timeval tv;
 342         tv.tv_sec = timeout;
 343         tv.tv_usec = 0;
 344
 345         if( timeout < 0 ) {
 346
 347                 // If timeout is -1, we block indefinitely
 348                 if( (retval = select( sock_fd + 1, &read_set, NULL, NULL, NULL)) == -1 ) {
 349                         return warning_handler("Call to select interrupted");
 350                 }
 351
 352         } else if( timeout > 0 ) { /* timeout of 0 means don't block */
 353
 354                 if( (retval = select( sock_fd + 1, &read_set, NULL, NULL, &tv)) == -1 ) {
 355                         return warning_handler( "Call to select interrupted" );
 356                 }
 357         }
 358
 359         debug_handler("%d active sockets after select()", retval);
 360         return _socket_route_data_id(mgr, sock_fd);
 361 }
 362
 363
 364 int socket_wait_all(socket_manager* mgr, int timeout) {
 365
 366         if(mgr == NULL) return warning_handler( "tcp_wait(): null mgr" );
 367
 368         int retval = 0;
 369         fd_set read_set;
 370         FD_ZERO( &read_set );
 371
 372         socket_node* node = mgr->socket;
 373         int max_fd = 0;
 374         while(node) {
 375                 //debug_handler("Adding socket %d to select set",node->sock_fd);
 376                 FD_SET( node->sock_fd, &read_set );
 377                 if(node->sock_fd > max_fd) max_fd = node->sock_fd;
 378                 node = node->next;
 379         }
 380         max_fd += 1;
 381
 382         struct timeval tv;
 383         tv.tv_sec = timeout;
 384         tv.tv_usec = 0;
 385
 386         if( timeout < 0 ) {
 387
 388                 // If timeout is -1, there is no timeout passed to the call to select
 389                 if( (retval = select( max_fd, &read_set, NULL, NULL, NULL)) == -1 ) {
 390                         return warning_handler("Call to select interrupted");
 391                 }
 392
 393         } else if( timeout != 0 ) { /* timeout of 0 means don't block */
 394
 395                 if( (retval = select( max_fd, &read_set, NULL, NULL, &tv)) == -1 ) {
 396                         return warning_handler( "Call to select interrupted" );
 397                 }
 398         }
 399
 400         debug_handler("%d active sockets after select()", retval);
 401         return _socket_route_data(mgr, retval, &read_set);
 402 }
 403
 404 /* determines if we'er receiving a new client or data
 405         on an existing client */
 406 int _socket_route_data(
 407         socket_manager* mgr, int num_active, fd_set* read_set) {
 408
 409         if(mgr == NULL) return -1;
 410
 411         int last_failed_id = -1;
 412
 413
 414         /* come back here if someone yanks a socket_node from beneath us */
 415         while(1) {
 416
 417                 socket_node* node = mgr->socket;
 418                 int handled = 0;
 419                 int status = 0;
 420
 421                 while(node && (handled < num_active)) {
 422
 423                         int sock_fd = node->sock_fd;
 424
 425                         if(last_failed_id != -1) {
 426                                 /* in case it was not removed by our overlords */
 427                                 debug_handler("Attempting to remove last_failed_id of %d", last_failed_id);
 428                                 socket_remove_node( mgr, last_failed_id );
 429                                 last_failed_id = -1;
 430                                 status = -1;
 431                                 break;
 432                         }
 433
 434                         /* does this socket have data? */
 435                         if( FD_ISSET( sock_fd, read_set ) ) {
 436
 437                                 debug_handler("Socket %d active", sock_fd);
 438                                 handled++;
 439                                 FD_CLR(sock_fd, read_set);
 440
 441                                 if(node->endpoint == SERVER_SOCKET)
 442                                         _socket_handle_new_client(mgr, node);
 443
 444                                 if(node->endpoint == CLIENT_SOCKET )
 445                                         status = _socket_handle_client_data(mgr, node);
 446
 447                                 /* someone may have yanked a socket_node out from under
 448                                         us...start over with the first socket */
 449                                 if(status == -1)  {
 450                                         last_failed_id = sock_fd;
 451                                         debug_handler("Backtracking back to start of loop because "
 452                                                         "of -1 return code from _socket_handle_client_data()");
 453                                 }
 454                         }
 455
 456                         if(status == -1) break;
 457                         node = node->next;
 458
 459                 } // is_set
 460
 461                 if(status == 0) break;
 462                 if(status == -1) status = 0;
 463         }
 464
 465         return 0;
 466 }
 467
 468
 469 int _socket_route_data_id( socket_manager* mgr, int sock_id) {
 470         socket_node* node = socket_find_node(mgr, sock_id);
 471         int status = 0;
 472
 473         if(node) {
 474                 if(node->endpoint == SERVER_SOCKET)
 475                         _socket_handle_new_client(mgr, node);
 476
 477                 if(node->endpoint == CLIENT_SOCKET )
 478                         status = _socket_handle_client_data(mgr, node);
 479
 480                 if(status == -1) socket_remove_node(mgr, sock_id);
 481                 return 0;
 482         }
 483
 484         return -1;
 485 }
 486
 487
 488 int _socket_handle_new_client(socket_manager* mgr, socket_node* node) {
 489         if(mgr == NULL || node == NULL) return -1;
 490
 491         int new_sock_fd;
 492         new_sock_fd = accept(node->sock_fd, NULL, NULL);
 493         if(new_sock_fd < 0)
 494                 return warning_handler("_socket_route_data(): accept() failed");
 495
 496         if(node->addr_type == INET) {
 497                 _socket_add_node(mgr, CLIENT_SOCKET, INET, new_sock_fd, node->sock_fd);
 498                 debug_handler("Adding new INET client for %d", node->sock_fd);
 499
 500         } else if(node->addr_type == UNIX) {
 501                 _socket_add_node(mgr, CLIENT_SOCKET, UNIX, new_sock_fd, node->sock_fd);
 502                 debug_handler("Adding new UNIX client for %d", node->sock_fd);
 503         }
 504
 505         return 0;
 506 }
 507
 508
 509 int _socket_handle_client_data(socket_manager* mgr, socket_node* node) {
 510         if(mgr == NULL || node == NULL) return -1;
 511
 512         char buf[RBUFSIZE];
 513         int read_bytes;
 514         int sock_fd = node->sock_fd;
 515
 516         memset(buf, 0, RBUFSIZE);
 517         set_fl(sock_fd, O_NONBLOCK);
 518         debug_handler("Gathering client data for %d", node->sock_fd);
 519
 520         info_handler("%d : Received data at %lf\n", getpid(), get_timestamp_millis());
 521
 522         while( (read_bytes = recv(sock_fd, buf, RBUFSIZE-1, 0) ) > 0 ) {
 523                 debug_handler("Socket %d Read %d bytes and data: %s", sock_fd, read_bytes, buf);
 524                 if(mgr->data_received)
 525                         mgr->data_received(mgr->blob, mgr, sock_fd, buf, node->parent_id);
 526
 527                 memset(buf, 0, RBUFSIZE);
 528         }
 529
 530         if(socket_find_node(mgr, sock_fd)) {  /* someone may have closed this socket */
 531                 clr_fl(sock_fd, O_NONBLOCK);
 532                 if(read_bytes < 0) {
 533                         if( errno != EAGAIN )
 534                                 warning_handler( " * Error reading socket with errno %d", errno );
 535                 }
 536         }
 537
 538         if(read_bytes == 0) {  /* socket closed by client */
 539                 if(mgr->on_socket_closed) {
 540                         mgr->on_socket_closed(mgr->blob, sock_fd);
 541                         return -1;
 542                 }
 543         }
 544
 545         return 0;
 546
 547 }
 548
 549
 550 void socket_manager_free(socket_manager* mgr) {
 551         if(mgr == NULL) return;
 552         socket_node* tmp;
 553         while(mgr->socket) {
 554                 tmp = mgr->socket->next;
 555                 socket_disconnect(mgr, mgr->socket->sock_fd);
 556                 mgr->socket = tmp;
 557         }
 558         free(mgr);
 559
 560 }