Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Do not use recv() but read() to check whether a socket returned by select() is valid...
[simgrid.git] / src / gras / Transport / transport.c
1 /* $Id$ */
2
3 /* transport - low level communication                                      */
4
5 /* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10 /***
11  *** Options
12  ***/
13 int gras_opt_trp_nomoredata_on_close=0;
14
15 #include "xbt/ex.h"
16 #include "xbt/peer.h"
17 #include "portable.h"
18 #include "gras/Transport/transport_private.h"
19
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_trp,gras,"Conveying bytes over the network");
21 XBT_LOG_NEW_SUBCATEGORY(gras_trp_meas,gras_trp,"Conveying bytes over the network without formating for perf measurements");
22 static short int _gras_trp_started = 0;
23
24 static xbt_dict_t _gras_trp_plugins;      /* All registered plugins */
25 static void gras_trp_plugin_free(void *p); /* free one of the plugins */
26
27 static void
28 gras_trp_plugin_new(const char *name, gras_trp_setup_t setup) {
29   xbt_ex_t e;
30
31   gras_trp_plugin_t plug = xbt_new0(s_gras_trp_plugin_t, 1);
32   
33   DEBUG1("Create plugin %s",name);
34
35   plug->name=xbt_strdup(name);
36
37   TRY {
38     setup(plug);
39   } CATCH(e) {
40     if (e.category == mismatch_error) {
41       /* SG plugin raise mismatch when in RL mode (and vice versa) */
42       free(plug->name);
43       free(plug);
44       plug=NULL;
45       xbt_ex_free(e);
46     } else {
47       RETHROW;
48     }
49   }
50
51   if (plug)
52     xbt_dict_set(_gras_trp_plugins, name, plug, gras_trp_plugin_free);
53 }
54
55 void gras_trp_init(void){
56   if (!_gras_trp_started) {
57      /* make room for all plugins */
58      _gras_trp_plugins=xbt_dict_new();
59
60 #ifdef HAVE_WINSOCK2_H
61      /* initialize the windows mechanism */
62      {  
63         WORD wVersionRequested;
64         WSADATA wsaData;
65         
66         wVersionRequested = MAKEWORD( 2, 0 );
67         xbt_assert0(WSAStartup( wVersionRequested, &wsaData ) == 0,
68                     "Cannot find a usable WinSock DLL");
69         
70         /* Confirm that the WinSock DLL supports 2.0.*/
71         /* Note that if the DLL supports versions greater    */
72         /* than 2.0 in addition to 2.0, it will still return */
73         /* 2.0 in wVersion since that is the version we      */
74         /* requested.                                        */
75         
76         xbt_assert0(LOBYTE( wsaData.wVersion ) == 2 &&
77                     HIBYTE( wsaData.wVersion ) == 0,
78                     "Cannot find a usable WinSock DLL");
79         INFO0("Found and initialized winsock2");
80      }       /* The WinSock DLL is acceptable. Proceed. */
81 #elif HAVE_WINSOCK_H
82      {       WSADATA wsaData;
83         xbt_assert0(WSAStartup( 0x0101, &wsaData ) == 0,
84                     "Cannot find a usable WinSock DLL");
85         INFO0("Found and initialized winsock");
86      }
87 #endif
88    
89      /* Add plugins */
90      gras_trp_plugin_new("file",gras_trp_file_setup);
91      gras_trp_plugin_new("sg",gras_trp_sg_setup);
92      gras_trp_plugin_new("tcp", gras_trp_tcp_setup);
93   }
94    
95   _gras_trp_started++;
96 }
97
98 void
99 gras_trp_exit(void){
100    DEBUG1("gras_trp value %d",_gras_trp_started);
101    if (_gras_trp_started == 0) {
102       return;
103    }
104    
105    if ( --_gras_trp_started == 0 ) {
106 #ifdef HAVE_WINSOCK_H
107       if ( WSACleanup() == SOCKET_ERROR ) {
108          if ( WSAGetLastError() == WSAEINPROGRESS ) {
109             WSACancelBlockingCall();
110             WSACleanup();
111          }
112         }
113 #endif
114
115       /* Delete the plugins */
116       xbt_dict_free(&_gras_trp_plugins);
117    }
118 }
119
120
121 void gras_trp_plugin_free(void *p) {
122   gras_trp_plugin_t plug = p;
123
124   if (plug) {
125     if (plug->exit) {
126       plug->exit(plug);
127     } else if (plug->data) {
128       DEBUG1("Plugin %s lacks exit(). Free data anyway.",plug->name);
129       free(plug->data);
130     }
131
132     free(plug->name);
133     free(plug);
134   }
135 }
136
137
138 /**
139  * gras_trp_socket_new:
140  *
141  * Malloc a new socket, and initialize it with defaults
142  */
143 void gras_trp_socket_new(int incoming,
144                          gras_socket_t *dst) {
145
146   gras_socket_t sock=xbt_new0(s_gras_socket_t,1);
147
148   VERB1("Create a new socket (%p)", (void*)sock);
149
150   sock->plugin = NULL;
151
152   sock->incoming  = incoming ? 1:0;
153   sock->outgoing  = incoming ? 0:1;
154   sock->accepting = incoming ? 1:0;
155   sock->meas = 0;
156   sock->recvd = 0;
157   sock->valid = 1;
158   sock->moredata = 0;
159
160   sock->sd     = -1;
161   sock->port      = -1;
162   sock->peer_port = -1;
163   sock->peer_name = NULL;
164   sock->peer_proc = NULL;
165
166   sock->data   = NULL;
167   sock->bufdata = NULL;
168   
169   *dst = sock;
170
171   XBT_OUT;
172 }
173  
174 /**
175  * @brief Opens a server socket and makes it ready to be listened to.
176  * @param port: port on which you want to listen
177  * @param buf_size: size of the buffer (in byte) on the socket (for TCP sockets only). If 0, a sain default is used (32k, but may change)
178  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
179  * 
180  * In real life, you'll get a TCP socket. 
181  */
182 gras_socket_t
183 gras_socket_server_ext(unsigned short port,
184                        
185                        unsigned long int buf_size,
186                        int measurement) {
187  
188   xbt_ex_t e;
189   gras_trp_plugin_t trp;
190   gras_socket_t sock;
191
192   DEBUG2("Create a server socket from plugin %s on port %d",
193          gras_if_RL() ? "tcp" : "sg",
194          port);
195   trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
196
197   /* defaults settings */
198   gras_trp_socket_new(1,&sock);
199   sock->plugin= trp;
200   sock->port=port;
201   sock->buf_size = buf_size>0 ? buf_size : 32*1024;
202   sock->meas = measurement;
203
204   /* Call plugin socket creation function */
205   DEBUG1("Prepare socket with plugin (fct=%p)",trp->socket_server);
206   TRY {
207     trp->socket_server(trp, sock);
208     DEBUG3("in=%c out=%c accept=%c",
209            sock->incoming?'y':'n', 
210            sock->outgoing?'y':'n',
211            sock->accepting?'y':'n');
212   } CATCH(e) {
213
214     free(sock);
215     RETHROW;
216   }
217
218   if (!measurement)
219      ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->myport = port;
220   xbt_dynar_push(((gras_trp_procdata_t) 
221                   gras_libdata_by_id(gras_trp_libdata_id))->sockets,&sock);
222   return sock;
223 }
224 /**
225  * @brief Opens a server socket on any port in the given range
226  * 
227  * @param minport: first port we will try
228  * @param maxport: last port we will try
229  * @param buf_size: size of the buffer (in byte) on the socket (for TCP sockets only). If 0, a sain default is used (32k, but may change)
230  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
231  * 
232  * If none of the provided ports works, raises the exception got when trying the last possibility
233  */ 
234 gras_socket_t
235 gras_socket_server_range(unsigned short minport, unsigned short maxport,
236                          unsigned long int buf_size, int measurement) {
237    
238   int port;
239   gras_socket_t res=NULL;
240   xbt_ex_t e;
241   
242   for (port=minport; port<maxport;port ++) {
243     TRY {
244       res=gras_socket_server_ext(port,buf_size,measurement);
245     } CATCH(e) {
246       if (port==maxport)
247         RETHROW;
248       xbt_ex_free(e);
249     }
250     if (res)
251       return res;
252   }
253   THROW_IMPOSSIBLE;
254 }
255    
256 /**
257  * @brief Opens a client socket to a remote host.
258  * @param host: who you want to connect to
259  * @param port: where you want to connect to on this host
260  * @param buf_size: size of the buffer (in bytes) on the socket (for TCP sockets only). If 0, a sain default is used (32k, but may change)
261  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
262  * 
263  * In real life, you'll get a TCP socket. 
264  */
265 gras_socket_t
266 gras_socket_client_ext(const char *host,
267                        unsigned short port,
268                        
269                        unsigned long int buf_size,
270                        int measurement) {
271  
272   xbt_ex_t e;
273   gras_trp_plugin_t trp;
274   gras_socket_t sock;
275
276   trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
277
278   DEBUG1("Create a client socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
279   /* defaults settings */
280   gras_trp_socket_new(0,&sock);
281   sock->plugin= trp;
282   sock->peer_port = port;
283   sock->peer_name = (char*)strdup(host?host:"localhost");
284   sock->buf_size = buf_size>0 ? buf_size: 32*1024;
285   sock->meas = measurement;
286
287   /* plugin-specific */
288   TRY {
289     (*trp->socket_client)(trp, sock);
290     DEBUG3("in=%c out=%c accept=%c",
291            sock->incoming?'y':'n', 
292            sock->outgoing?'y':'n',
293            sock->accepting?'y':'n');
294   } CATCH(e) {
295      free(sock);
296      RETHROW;
297   }
298   xbt_dynar_push(((gras_trp_procdata_t) 
299                   gras_libdata_by_id(gras_trp_libdata_id))->sockets,&sock);
300   return sock;
301 }
302
303 /**
304  * gras_socket_server:
305  *
306  * Opens a server socket and make it ready to be listened to.
307  * In real life, you'll get a TCP socket.
308  */
309 gras_socket_t
310 gras_socket_server(unsigned short port) {
311    return gras_socket_server_ext(port,32*1024,0);
312 }
313
314 /** @brief Opens a client socket to a remote host */
315 gras_socket_t
316 gras_socket_client(const char *host,
317                    unsigned short port) {
318    return gras_socket_client_ext(host,port,0,0);
319 }
320
321 /** @brief Opens a client socket to a remote host specified as '\a host:\a port' */
322 gras_socket_t
323 gras_socket_client_from_string(const char *host) {
324    xbt_peer_t p = xbt_peer_from_string(host);
325    gras_socket_t res = gras_socket_client_ext(p->name,p->port,0,0);
326    xbt_peer_free(p);
327    return res;
328 }
329
330 /** \brief Close socket */
331 void gras_socket_close(gras_socket_t sock) {
332   xbt_dynar_t sockets = ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
333   gras_socket_t sock_iter = NULL;
334   int cursor;
335
336   XBT_IN;
337   VERB1("Close %p",sock);
338   if (sock == _gras_lastly_selected_socket) {
339      xbt_assert0(!gras_opt_trp_nomoredata_on_close || !sock->moredata,
340                  "Closing a socket having more data in buffer while the nomoredata_on_close option is activated");
341                  
342      if (sock->moredata) 
343        CRITICAL0("Closing a socket having more data in buffer. Option nomoredata_on_close disabled, so continuing.");
344      _gras_lastly_selected_socket=NULL;
345   }
346    
347   /* FIXME: Issue an event when the socket is closed */
348         DEBUG1("sockets pointer before %p",sockets);
349   if (sock) {
350         /* FIXME: Cannot get the dynar mutex, because it can be already locked */
351 //              _xbt_dynar_foreach(sockets,cursor,sock_iter) {
352                 for (cursor=0; cursor< xbt_dynar_length(sockets); cursor++)  {
353                         _xbt_dynar_cursor_get(sockets,&cursor,&sock_iter);
354                         if (sock == sock_iter) {
355                                 DEBUG2("remove sock cursor %d dize %lu\n",cursor,xbt_dynar_length(sockets));
356                                 xbt_dynar_cursor_rm(sockets,&cursor);
357                                 if (sock->plugin->socket_close) 
358                                         (* sock->plugin->socket_close)(sock);
359
360                                 /* free the memory */
361                                 if (sock->peer_name)
362                                         free(sock->peer_name);
363                                 free(sock);
364                                 XBT_OUT;
365                                 return;
366                         }
367     }
368     WARN1("Ignoring request to free an unknown socket (%p). Execution stack:",sock);
369     xbt_backtrace_display_current();
370   }
371   XBT_OUT;
372 }
373
374 /**
375  * gras_trp_send:
376  *
377  * Send a bunch of bytes from on socket
378  * (stable if we know the storage will keep as is until the next trp_flush)
379  */
380 void
381 gras_trp_send(gras_socket_t sd, char *data, long int size, int stable) {
382   xbt_assert0(sd->outgoing,"Socket not suited for data send");
383   (*sd->plugin->send)(sd,data,size,stable);
384 }
385 /**
386  * gras_trp_chunk_recv:
387  *
388  * Receive a bunch of bytes from a socket
389  */
390 void
391 gras_trp_recv(gras_socket_t sd, char *data, long int size) {
392   xbt_assert0(sd->incoming,"Socket not suited for data receive");
393   (sd->plugin->recv)(sd,data,size);
394 }
395
396 /**
397  * gras_trp_flush:
398  *
399  * Make sure all pending communications are done
400  */
401 void
402 gras_trp_flush(gras_socket_t sd) {
403   if (sd->plugin->flush)
404     (sd->plugin->flush)(sd);
405 }
406
407 gras_trp_plugin_t
408 gras_trp_plugin_get_by_name(const char *name){
409   return xbt_dict_get(_gras_trp_plugins,name);
410 }
411
412 int gras_socket_my_port  (gras_socket_t sock) {
413   return sock->port;
414 }
415 int   gras_socket_peer_port(gras_socket_t sock) {
416   return sock->peer_port;
417 }
418 char *gras_socket_peer_name(gras_socket_t sock) {
419   return sock->peer_name;
420 }
421 char *gras_socket_peer_proc(gras_socket_t sock) {
422   return sock->peer_proc;
423 }
424
425 void gras_socket_peer_proc_set(gras_socket_t sock,char*peer_proc) {
426   sock->peer_proc = peer_proc;
427 }
428
429 /** \brief Check if the provided socket is a measurement one (or a regular one) */
430 int gras_socket_is_meas(gras_socket_t sock) {
431   return sock->meas;
432 }
433
434 /** \brief Send a chunk of (random) data over a measurement socket 
435  *
436  * @param peer measurement socket to use for the experiment
437  * @param timeout timeout (in seconds)
438  * @param msg_size size of each chunk sent over the socket (in bytes).
439  * @param msg_amount how many of these packets you want to send. 
440  *
441  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on 
442  * each side of the socket should be paired. 
443  * 
444  * The exchanged data is zeroed to make sure it's initialized, but
445  * there is no way to control what is sent (ie, you cannot use these 
446  * functions to exchange data out of band).
447  * 
448  * @warning: in SimGrid version 3.1 and previous, the numerical arguments 
449  *           were the total amount of data to send and the msg_size. This 
450  *           was changed for the fool wanting to send more than MAXINT 
451  *           bytes in a fat pipe. 
452  */
453 void gras_socket_meas_send(gras_socket_t peer, 
454                            unsigned int timeout,
455                            unsigned long int msg_size, 
456                            unsigned long int msg_amount) {
457   char *chunk=NULL;
458   unsigned long int sent_sofar;
459   
460   XBT_IN;
461
462   if (gras_if_RL()) 
463     chunk=xbt_malloc0(msg_size);
464
465   xbt_assert0(peer->meas,"Asked to send measurement data on a regular socket");
466   xbt_assert0(peer->outgoing,"Socket not suited for data send (was created with gras_socket_server(), not gras_socket_client())");
467
468   for (sent_sofar=0; sent_sofar < msg_amount; sent_sofar++) {
469      CDEBUG5(gras_trp_meas,"Sent %lu msgs of %lu (size of each: %ld) to %s:%d",
470              sent_sofar,msg_amount,msg_size,
471              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
472      (*peer->plugin->raw_send)(peer,chunk,msg_size);
473   }
474   CDEBUG5(gras_trp_meas,"Sent %lu msgs of %lu (size of each: %ld) to %s:%d",
475           sent_sofar,msg_amount,msg_size,
476           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
477              
478   if (gras_if_RL()) 
479     free(chunk);
480
481   XBT_OUT;
482 }
483
484 /** \brief Receive a chunk of data over a measurement socket 
485  *
486  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on 
487  * each side of the socket should be paired. 
488  *
489  * @warning: in SimGrid version 3.1 and previous, the numerical arguments 
490  *           were the total amount of data to send and the msg_size. This 
491  *           was changed for the fool wanting to send more than MAXINT 
492  *           bytes in a fat pipe. 
493  */
494 void gras_socket_meas_recv(gras_socket_t peer, 
495                            unsigned int timeout,
496                            unsigned long int msg_size, 
497                            unsigned long int msg_amount){
498   
499   char *chunk=NULL;
500   unsigned long int got_sofar;
501
502   XBT_IN;
503
504   if (gras_if_RL()) 
505     chunk = xbt_malloc(msg_size);
506
507   xbt_assert0(peer->meas,
508               "Asked to receive measurement data on a regular socket");
509   xbt_assert0(peer->incoming,"Socket not suited for data receive");
510
511   for (got_sofar=0; got_sofar < msg_amount; got_sofar ++) {
512      CDEBUG5(gras_trp_meas,"Recvd %ld msgs of %lu (size of each: %ld) from %s:%d",
513              got_sofar,msg_amount,msg_size,
514              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
515      (peer->plugin->raw_recv)(peer,chunk,msg_size);
516   }
517   CDEBUG5(gras_trp_meas,"Recvd %ld msgs of %lu (size of each: %ld) from %s:%d",
518           got_sofar,msg_amount,msg_size,
519           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
520
521   if (gras_if_RL()) 
522     free(chunk);
523   XBT_OUT;
524 }
525
526 /**
527  * \brief Something similar to the good old accept system call. 
528  *
529  * Make sure that there is someone speaking to the provided server socket.
530  * In RL, it does an accept(2) and return the result as last argument. 
531  * In SG, as accepts are useless, it returns the provided argument as result.
532  * You should thus test whether (peer != accepted) before closing both of them.
533  *
534  * You should only call this on measurement sockets. It is automatically 
535  * done for regular sockets, but you usually want more control about 
536  * what's going on with measurement sockets.
537  */
538 gras_socket_t gras_socket_meas_accept(gras_socket_t peer){
539   gras_socket_t res;
540
541   xbt_assert0(peer->meas,
542               "No need to accept on non-measurement sockets (it's automatic)");
543
544   if (!peer->accepting) {
545     /* nothing to accept here (must be in SG) */
546     /* BUG: FIXME: this is BAD! it makes tricky to free the accepted socket*/
547     return peer;
548   }
549
550   res = (peer->plugin->socket_accept)(peer);
551   res->meas = peer->meas;
552   CDEBUG1(gras_trp_meas,"meas_accepted onto %d",res->sd);
553
554   return res;
555
556
557
558 /*
559  * Creating procdata for this module
560  */
561 static void *gras_trp_procdata_new() {
562    gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t,1);
563    
564    res->name = xbt_strdup("gras_trp");
565    res->name_len = 0;
566    res->sockets = xbt_dynar_new_sync(sizeof(gras_socket_t*), NULL);
567    res->myport = 0;
568    
569    return (void*)res;
570 }
571
572 /*
573  * Freeing procdata for this module
574  */
575 static void gras_trp_procdata_free(void *data) {
576   gras_trp_procdata_t res = (gras_trp_procdata_t)data;
577   
578   xbt_dynar_free(&( res->sockets ));
579   free(res->name);
580   free(res);
581 }
582
583 void gras_trp_socketset_dump(const char *name) {
584   gras_trp_procdata_t procdata = 
585     (gras_trp_procdata_t)gras_libdata_by_id(gras_trp_libdata_id);
586
587   int it;
588   gras_socket_t s;
589
590   INFO1("** Dump the socket set %s",name);
591   xbt_dynar_foreach(procdata->sockets, it, s) {
592     INFO4("  %p -> %s:%d %s",
593           s,gras_socket_peer_name(s),gras_socket_peer_port(s),
594           s->valid?"(valid)":"(peer dead)");
595   }
596   INFO1("** End of socket set %s",name);
597 }
598
599 /*
600  * Module registration
601  */
602 int gras_trp_libdata_id;
603 void gras_trp_register() {
604    gras_trp_libdata_id = gras_procdata_add("gras_trp",gras_trp_procdata_new, gras_trp_procdata_free);
605 }
606
607 int gras_os_myport(void)  {
608    return ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->myport;
609 }
610