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