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
 142         int i = 1;
 143         debug_handler("Setting SO_REUSEADDR");
 144         setsockopt(sock_fd, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
 145
 146         debug_handler("Setting TCP_NODELAY");
 147         setsockopt(sock_fd, IPPROTO_TCP, TCP_NODELAY, &i, sizeof(i));
 148
 149         _socket_add_node(mgr, SERVER_SOCKET, UNIX, sock_fd, 0);
 150         return sock_fd;
 151 }
 152
 153
 154 int socket_open_tcp_client(socket_manager* mgr, int port, char* dest_addr) {
 155
 156         struct sockaddr_in remoteAddr, localAddr;
 157    struct hostent *hptr;
 158    int sock_fd;
 159
 160    // ------------------------------------------------------------------
 161    // Create the socket
 162    // ------------------------------------------------------------------
 163    if( (sock_fd = socket( AF_INET, SOCK_STREAM, 0 )) < 0 ) {
 164       fatal_handler( "tcp_connect(): Cannot create socket" );
 165       return -1;
 166    }
 167
 168         int i = 1;
 169         debug_handler("Setting TCP_NODELAY");
 170         setsockopt(sock_fd, IPPROTO_TCP, TCP_NODELAY, &i, sizeof(i));
 171
 172
 173    // ------------------------------------------------------------------
 174    // Get the hostname
 175    // ------------------------------------------------------------------
 176    if( (hptr = gethostbyname( dest_addr ) ) == NULL ) {
 177       fatal_handler( "tcp_connect(): Unknown Host => %s", dest_addr );
 178       return -1;
 179    }
 180
 181    // ------------------------------------------------------------------
 182    // Construct server info struct
 183    // ------------------------------------------------------------------
 184    memset( &remoteAddr, 0, sizeof(remoteAddr));
 185    remoteAddr.sin_family = AF_INET;
 186    remoteAddr.sin_port = htons( port );
 187    memcpy( (char*) &remoteAddr.sin_addr.s_addr,
 188          hptr->h_addr_list[0], hptr->h_length );
 189
 190    // ------------------------------------------------------------------
 191    // Construct local info struct
 192    // ------------------------------------------------------------------
 193    memset( &localAddr, 0, sizeof( localAddr ) );
 194    localAddr.sin_family = AF_INET;
 195    localAddr.sin_addr.s_addr = htonl( INADDR_ANY );
 196    localAddr.sin_port = htons(0);
 197
 198    // ------------------------------------------------------------------
 199    // Bind to a local port
 200    // ------------------------------------------------------------------
 201    if( bind( sock_fd, (struct sockaddr *) &localAddr, sizeof( localAddr ) ) < 0 ) {
 202       fatal_handler( "tcp_connect(): Cannot bind to local port" );
 203       return -1;
 204    }
 205
 206    // ------------------------------------------------------------------
 207    // Connect to server
 208    // ------------------------------------------------------------------
 209    if( connect( sock_fd, (struct sockaddr*) &remoteAddr, sizeof( struct sockaddr_in ) ) < 0 ) {
 210       fatal_handler( "tcp_connect(): Cannot connect to server %s", dest_addr );
 211       return -1;
 212    }
 213
 214         _socket_add_node(mgr, CLIENT_SOCKET, INET, sock_fd, -1 );
 215
 216    return sock_fd;
 217 }
 218
 219
 220 int socket_open_unix_client(socket_manager* mgr, char* sock_path) {
 221
 222         int sock_fd, len;
 223    struct sockaddr_un usock;
 224
 225    if( (sock_fd = socket( AF_UNIX, SOCK_STREAM, 0 )) < 0 )
 226       return warning_handler( "Cannot create socket" );
 227
 228    usock.sun_family = AF_UNIX;
 229    strcpy( usock.sun_path, sock_path );
 230
 231    len = sizeof( usock.sun_family ) + strlen( usock.sun_path );
 232
 233    if( connect( sock_fd, (struct sockaddr *) &usock, len ) < 0 )
 234       return warning_handler( "Error connecting to unix socket" );
 235
 236         _socket_add_node(mgr, CLIENT_SOCKET, UNIX, sock_fd, -1 );
 237
 238    return sock_fd;
 239 }
 240
 241
 242
 243 /* returns the socket_node with the given sock_fd */
 244 socket_node* socket_find_node(socket_manager* mgr, int sock_fd) {
 245         if(mgr == NULL) return NULL;
 246         socket_node* node = mgr->socket;
 247         while(node) {
 248                 if(node->sock_fd == sock_fd)
 249                         return node;
 250                 node = node->next;
 251         }
 252         return NULL;
 253 }
 254
 255 /* removes the node with the given sock_fd from the list and frees it */
 256 void socket_remove_node(socket_manager* mgr, int sock_fd) {
 257
 258         if(mgr == NULL) return;
 259
 260         debug_handler("removing socket %d", sock_fd);
 261
 262         socket_node* head = mgr->socket;
 263         socket_node* tail = head;
 264         if(head == NULL) return;
 265
 266         /* if removing the first node in the list */
 267         if(head->sock_fd == sock_fd) {
 268                 mgr->socket = head->next;
 269                 free(head);
 270                 debug_handler("removing first socket in list");
 271                 return;
 272         }
 273
 274         head = head->next;
 275
 276         /* if removing any other node */
 277         while(head) {
 278                 if(head->sock_fd == sock_fd) {
 279                         tail->next = head->next;
 280                         free(head);
 281                         return;
 282                 }
 283                 tail = head;
 284                 head = head->next;
 285         }
 286 }
 287
 288
 289
 290 void _socket_print_list(socket_manager* mgr) {
 291         if(mgr == NULL) return;
 292         socket_node* node = mgr->socket;
 293         debug_handler("socket_node list: [");
 294         while(node) {
 295                 debug_handler("sock_fd: %d | parent_id: %d",
 296                                 node->sock_fd, node->parent_id);
 297                 node = node->next;
 298         }
 299         debug_handler("]");
 300 }
 301
 302 /* sends the given data to the given socket */
 303 int socket_send(int sock_fd, const char* data) {
 304         debug_handler( "socket_bundle sending to %d data %s",
 305                 sock_fd, data);
 306
 307         info_handler("%d : Sending data at %lf\n", getpid(), get_timestamp_millis());
 308         signal(SIGPIPE, SIG_IGN); /* in case a unix socket was closed */
 309         if( send( sock_fd, data, strlen(data), 0 ) < 0 ) {
 310                 return warning_handler( "tcp_server_send(): Error sending data" );
 311         }
 312
 313         return 0;
 314 }
 315
 316 /* disconnects the node with the given sock_fd and removes
 317         it from the socket set */
 318 void socket_disconnect(socket_manager* mgr, int sock_fd) {
 319
 320         debug_handler("Closing socket %d", sock_fd);
 321
 322         if( shutdown( sock_fd, SHUT_RDWR ) )
 323                 warning_handler( "socket_disconnect(): Error shuting down socket, removing anyway" );
 324
 325         if( close( sock_fd ) == -1 )
 326                 warning_handler( "socket_disconnect(): Error closing socket, removing anyway" );
 327
 328         if(mgr != NULL)
 329                 socket_remove_node(mgr, sock_fd);
 330
 331 }
 332
 333
 334 /* we assume that if select() fails, the socket is no longer valid */
 335 int socket_connected(int sock_fd) {
 336         fd_set read_set;
 337         FD_ZERO( &read_set );
 338         FD_SET( sock_fd, &read_set );
 339         if( select( sock_fd + 1, &read_set, NULL, NULL, NULL) == -1 )
 340                 return 0;
 341         return 1;
 342
 343 }
 344
 345 /* this only waits on the server socket and does not handle the actual
 346         data coming in from the client..... XXX */
 347 int socket_wait(socket_manager* mgr, int timeout, int sock_fd) {
 348
 349         int retval = 0;
 350         fd_set read_set;
 351         FD_ZERO( &read_set );
 352         FD_SET( sock_fd, &read_set );
 353
 354         struct timeval tv;
 355         tv.tv_sec = timeout;
 356         tv.tv_usec = 0;
 357
 358         if( timeout < 0 ) {
 359
 360                 // If timeout is -1, we block indefinitely
 361                 if( (retval = select( sock_fd + 1, &read_set, NULL, NULL, NULL)) == -1 ) {
 362                         return warning_handler("Call to select interrupted");
 363                 }
 364
 365         } else if( timeout > 0 ) { /* timeout of 0 means don't block */
 366
 367                 if( (retval = select( sock_fd + 1, &read_set, NULL, NULL, &tv)) == -1 ) {
 368                         return warning_handler( "Call to select interrupted" );
 369                 }
 370         }
 371
 372         debug_handler("%d active sockets after select()", retval);
 373         return _socket_route_data_id(mgr, sock_fd);
 374 }
 375
 376
 377 int socket_wait_all(socket_manager* mgr, int timeout) {
 378
 379         if(mgr == NULL) return warning_handler( "tcp_wait(): null mgr" );
 380
 381         int retval = 0;
 382         fd_set read_set;
 383         FD_ZERO( &read_set );
 384
 385         socket_node* node = mgr->socket;
 386         int max_fd = 0;
 387         while(node) {
 388                 //debug_handler("Adding socket %d to select set",node->sock_fd);
 389                 FD_SET( node->sock_fd, &read_set );
 390                 if(node->sock_fd > max_fd) max_fd = node->sock_fd;
 391                 node = node->next;
 392         }
 393         max_fd += 1;
 394
 395         struct timeval tv;
 396         tv.tv_sec = timeout;
 397         tv.tv_usec = 0;
 398
 399         if( timeout < 0 ) {
 400
 401                 // If timeout is -1, there is no timeout passed to the call to select
 402                 if( (retval = select( max_fd, &read_set, NULL, NULL, NULL)) == -1 ) {
 403                         return warning_handler("Call to select interrupted");
 404                 }
 405
 406         } else if( timeout != 0 ) { /* timeout of 0 means don't block */
 407
 408                 if( (retval = select( max_fd, &read_set, NULL, NULL, &tv)) == -1 ) {
 409                         return warning_handler( "Call to select interrupted" );
 410                 }
 411         }
 412
 413         debug_handler("%d active sockets after select()", retval);
 414         return _socket_route_data(mgr, retval, &read_set);
 415 }
 416
 417 /* determines if we'er receiving a new client or data
 418         on an existing client */
 419 int _socket_route_data(
 420         socket_manager* mgr, int num_active, fd_set* read_set) {
 421
 422         if(mgr == NULL) return -1;
 423
 424         int last_failed_id = -1;
 425
 426
 427         /* come back here if someone yanks a socket_node from beneath us */
 428         while(1) {
 429
 430                 socket_node* node = mgr->socket;
 431                 int handled = 0;
 432                 int status = 0;
 433
 434                 while(node && (handled < num_active)) {
 435
 436                         int sock_fd = node->sock_fd;
 437
 438                         if(last_failed_id != -1) {
 439                                 /* in case it was not removed by our overlords */
 440                                 debug_handler("Attempting to remove last_failed_id of %d", last_failed_id);
 441                                 socket_remove_node( mgr, last_failed_id );
 442                                 last_failed_id = -1;
 443                                 status = -1;
 444                                 break;
 445                         }
 446
 447                         /* does this socket have data? */
 448                         if( FD_ISSET( sock_fd, read_set ) ) {
 449
 450                                 debug_handler("Socket %d active", sock_fd);
 451                                 handled++;
 452                                 FD_CLR(sock_fd, read_set);
 453
 454                                 if(node->endpoint == SERVER_SOCKET)
 455                                         _socket_handle_new_client(mgr, node);
 456
 457                                 if(node->endpoint == CLIENT_SOCKET )
 458                                         status = _socket_handle_client_data(mgr, node);
 459
 460                                 /* someone may have yanked a socket_node out from under
 461                                         us...start over with the first socket */
 462                                 if(status == -1)  {
 463                                         last_failed_id = sock_fd;
 464                                         debug_handler("Backtracking back to start of loop because "
 465                                                         "of -1 return code from _socket_handle_client_data()");
 466                                 }
 467                         }
 468
 469                         if(status == -1) break;
 470                         node = node->next;
 471
 472                 } // is_set
 473
 474                 if(status == 0) break;
 475                 if(status == -1) status = 0;
 476         }
 477
 478         return 0;
 479 }
 480
 481
 482 int _socket_route_data_id( socket_manager* mgr, int sock_id) {
 483         socket_node* node = socket_find_node(mgr, sock_id);
 484         int status = 0;
 485
 486         if(node) {
 487                 if(node->endpoint == SERVER_SOCKET)
 488                         _socket_handle_new_client(mgr, node);
 489
 490                 if(node->endpoint == CLIENT_SOCKET )
 491                         status = _socket_handle_client_data(mgr, node);
 492
 493                 if(status == -1) socket_remove_node(mgr, sock_id);
 494                 return 0;
 495         }
 496
 497         return -1;
 498 }
 499
 500
 501 int _socket_handle_new_client(socket_manager* mgr, socket_node* node) {
 502         if(mgr == NULL || node == NULL) return -1;
 503
 504         int new_sock_fd;
 505         new_sock_fd = accept(node->sock_fd, NULL, NULL);
 506         if(new_sock_fd < 0)
 507                 return warning_handler("_socket_route_data(): accept() failed");
 508
 509         if(node->addr_type == INET) {
 510                 _socket_add_node(mgr, CLIENT_SOCKET, INET, new_sock_fd, node->sock_fd);
 511                 debug_handler("Adding new INET client for %d", node->sock_fd);
 512
 513         } else if(node->addr_type == UNIX) {
 514                 _socket_add_node(mgr, CLIENT_SOCKET, UNIX, new_sock_fd, node->sock_fd);
 515                 debug_handler("Adding new UNIX client for %d", node->sock_fd);
 516         }
 517
 518         return 0;
 519 }
 520
 521
 522 int _socket_handle_client_data(socket_manager* mgr, socket_node* node) {
 523         if(mgr == NULL || node == NULL) return -1;
 524
 525         char buf[RBUFSIZE];
 526         int read_bytes;
 527         int sock_fd = node->sock_fd;
 528
 529         memset(buf, 0, RBUFSIZE);
 530         set_fl(sock_fd, O_NONBLOCK);
 531         debug_handler("Gathering client data for %d", node->sock_fd);
 532
 533         info_handler("%d : Received data at %lf\n", getpid(), get_timestamp_millis());
 534
 535         while( (read_bytes = recv(sock_fd, buf, RBUFSIZE-1, 0) ) > 0 ) {
 536                 debug_handler("Socket %d Read %d bytes and data: %s", sock_fd, read_bytes, buf);
 537                 if(mgr->data_received)
 538                         mgr->data_received(mgr->blob, mgr, sock_fd, buf, node->parent_id);
 539
 540                 memset(buf, 0, RBUFSIZE);
 541         }
 542
 543         if(socket_find_node(mgr, sock_fd)) {  /* someone may have closed this socket */
 544                 clr_fl(sock_fd, O_NONBLOCK);
 545                 if(read_bytes < 0) {
 546                         if( errno != EAGAIN )
 547                                 warning_handler( " * Error reading socket with errno %d", errno );
 548                 }
 549         }
 550
 551         if(read_bytes == 0) {  /* socket closed by client */
 552                 if(mgr->on_socket_closed) {
 553                         mgr->on_socket_closed(mgr->blob, sock_fd);
 554                         return -1;
 555                 }
 556         }
 557
 558         return 0;
 559
 560 }
 561
 562
 563 void socket_manager_free(socket_manager* mgr) {
 564         if(mgr == NULL) return;
 565         socket_node* tmp;
 566         while(mgr->socket) {
 567                 tmp = mgr->socket->next;
 568                 socket_disconnect(mgr, mgr->socket->sock_fd);
 569                 mgr->socket = tmp;
 570         }
 571         free(mgr);
 572
 573 }