Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
27f5274fc71cccbb42d5647ed3e37e868443800b
[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->recv_ok = 1;
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_dynar_push(((gras_trp_procdata_t) 
172                   gras_libdata_by_id(gras_trp_libdata_id))->sockets,dst);
173   XBT_OUT;
174 }
175  
176 /**
177  * @brief Opens a server socket and makes it ready to be listened to.
178  * @param port: port on which you want to listen
179  * @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)
180  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
181  * 
182  * In real life, you'll get a TCP socket. 
183  */
184 gras_socket_t
185 gras_socket_server_ext(unsigned short port,
186                        
187                        unsigned long int buf_size,
188                        int measurement) {
189  
190   xbt_ex_t e;
191   gras_trp_plugin_t trp;
192   gras_socket_t sock;
193
194   DEBUG2("Create a server socket from plugin %s on port %d",
195          gras_if_RL() ? "tcp" : "sg",
196          port);
197   trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
198
199   /* defaults settings */
200   gras_trp_socket_new(1,&sock);
201   sock->plugin= trp;
202   sock->port=port;
203   sock->buf_size = buf_size>0 ? buf_size : 32*1024;
204   sock->meas = measurement;
205
206   /* Call plugin socket creation function */
207   DEBUG1("Prepare socket with plugin (fct=%p)",trp->socket_server);
208   TRY {
209     trp->socket_server(trp, sock);
210     DEBUG3("in=%c out=%c accept=%c",
211            sock->incoming?'y':'n', 
212            sock->outgoing?'y':'n',
213            sock->accepting?'y':'n');
214   } CATCH(e) {
215     int cursor;
216     gras_socket_t sock_iter;
217     xbt_dynar_t socks = ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
218     xbt_dynar_foreach(socks, cursor, sock_iter) {
219        if (sock_iter==sock) {
220                                  xbt_dynar_cursor_rm(socks,&cursor);
221                          }
222     }     
223     free(sock);
224     RETHROW;
225   }
226
227   if (!measurement)
228      ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->myport = port;
229   return sock;
230 }
231 /**
232  * @brief Opens a server socket on any port in the given range
233  * 
234  * @param minport: first port we will try
235  * @param maxport: last port we will try
236  * @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)
237  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
238  * 
239  * If none of the provided ports works, raises the exception got when trying the last possibility
240  */ 
241 gras_socket_t
242 gras_socket_server_range(unsigned short minport, unsigned short maxport,
243                          unsigned long int buf_size, int measurement) {
244    
245   int port;
246   gras_socket_t res=NULL;
247   xbt_ex_t e;
248   
249   for (port=minport; port<maxport;port ++) {
250     TRY {
251       res=gras_socket_server_ext(port,buf_size,measurement);
252     } CATCH(e) {
253       if (port==maxport)
254         RETHROW;
255       xbt_ex_free(e);
256     }
257     if (res)
258       return res;
259   }
260   THROW_IMPOSSIBLE;
261 }
262    
263 /**
264  * @brief Opens a client socket to a remote host.
265  * @param host: who you want to connect to
266  * @param port: where you want to connect to on this host
267  * @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)
268  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
269  * 
270  * In real life, you'll get a TCP socket. 
271  */
272 gras_socket_t
273 gras_socket_client_ext(const char *host,
274                        unsigned short port,
275                        
276                        unsigned long int buf_size,
277                        int measurement) {
278  
279   xbt_ex_t e;
280   gras_trp_plugin_t trp;
281   gras_socket_t sock;
282
283   trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
284
285   DEBUG1("Create a client socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
286   /* defaults settings */
287   gras_trp_socket_new(0,&sock);
288   sock->plugin= trp;
289   sock->peer_port = port;
290   sock->peer_name = (char*)strdup(host?host:"localhost");
291   sock->buf_size = buf_size>0 ? buf_size: 32*1024;
292   sock->meas = measurement;
293
294   /* plugin-specific */
295   TRY {
296     (*trp->socket_client)(trp, sock);
297     DEBUG3("in=%c out=%c accept=%c",
298            sock->incoming?'y':'n', 
299            sock->outgoing?'y':'n',
300            sock->accepting?'y':'n');
301   } CATCH(e) {
302      xbt_dynar_pop(((gras_trp_procdata_t)
303                     gras_libdata_by_id(gras_trp_libdata_id))->sockets,NULL);
304      free(sock);
305     RETHROW;
306   }
307
308   return sock;
309 }
310
311 /**
312  * gras_socket_server:
313  *
314  * Opens a server socket and make it ready to be listened to.
315  * In real life, you'll get a TCP socket.
316  */
317 gras_socket_t
318 gras_socket_server(unsigned short port) {
319    return gras_socket_server_ext(port,32*1024,0);
320 }
321
322 /** @brief Opens a client socket to a remote host */
323 gras_socket_t
324 gras_socket_client(const char *host,
325                    unsigned short port) {
326    return gras_socket_client_ext(host,port,0,0);
327 }
328
329 /** @brief Opens a client socket to a remote host specified as '\a host:\a port' */
330 gras_socket_t
331 gras_socket_client_from_string(const char *host) {
332    xbt_peer_t p = xbt_peer_from_string(host);
333    gras_socket_t res = gras_socket_client_ext(p->name,p->port,0,0);
334    xbt_peer_free(p);
335    return res;
336 }
337
338 /** \brief Close socket */
339 void gras_socket_close(gras_socket_t sock) {
340   xbt_dynar_t sockets = ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
341   gras_socket_t sock_iter = NULL;
342   int cursor;
343
344   XBT_IN;
345   VERB1("Close %p",sock);
346   if (sock == _gras_lastly_selected_socket) {
347      xbt_assert0(!gras_opt_trp_nomoredata_on_close || !sock->moredata,
348                  "Closing a socket having more data in buffer while the nomoredata_on_close option is activated");
349                  
350      if (sock->moredata) 
351        CRITICAL0("Closing a socket having more data in buffer. Option nomoredata_on_close disabled, so continuing.");
352      _gras_lastly_selected_socket=NULL;
353   }
354    
355   /* FIXME: Issue an event when the socket is closed */
356         DEBUG1("sockets pointer before %p",sockets);
357   if (sock) {
358         /* FIXME: Cannot get the dynar mutex, because it can be already locked */
359 //              _xbt_dynar_foreach(sockets,cursor,sock_iter) {
360                 for (cursor=0; cursor< xbt_dynar_length(sockets); cursor++)  {
361                         _xbt_dynar_cursor_get(sockets,&cursor,&sock_iter);
362                         if (sock == sock_iter) {
363                                 DEBUG2("remove sock cursor %d dize %lu\n",cursor,xbt_dynar_length(sockets));
364                                 xbt_dynar_cursor_rm(sockets,&cursor);
365                                 if (sock->plugin->socket_close) 
366                                         (* sock->plugin->socket_close)(sock);
367
368                                 /* free the memory */
369                                 if (sock->peer_name)
370                                         free(sock->peer_name);
371                                 free(sock);
372                                 XBT_OUT;
373                                 return;
374                         }
375     }
376     WARN1("Ignoring request to free an unknown socket (%p). Execution stack:",sock);
377     xbt_backtrace_display_current();
378   }
379   XBT_OUT;
380 }
381
382 /**
383  * gras_trp_send:
384  *
385  * Send a bunch of bytes from on socket
386  * (stable if we know the storage will keep as is until the next trp_flush)
387  */
388 void
389 gras_trp_send(gras_socket_t sd, char *data, long int size, int stable) {
390   xbt_assert0(sd->outgoing,"Socket not suited for data send");
391   (*sd->plugin->send)(sd,data,size,stable);
392 }
393 /**
394  * gras_trp_chunk_recv:
395  *
396  * Receive a bunch of bytes from a socket
397  */
398 void
399 gras_trp_recv(gras_socket_t sd, char *data, long int size) {
400   xbt_assert0(sd->incoming,"Socket not suited for data receive");
401   (sd->plugin->recv)(sd,data,size);
402 }
403
404 /**
405  * gras_trp_flush:
406  *
407  * Make sure all pending communications are done
408  */
409 void
410 gras_trp_flush(gras_socket_t sd) {
411   if (sd->plugin->flush)
412     (sd->plugin->flush)(sd);
413 }
414
415 gras_trp_plugin_t
416 gras_trp_plugin_get_by_name(const char *name){
417   return xbt_dict_get(_gras_trp_plugins,name);
418 }
419
420 int gras_socket_my_port  (gras_socket_t sock) {
421   return sock->port;
422 }
423 int   gras_socket_peer_port(gras_socket_t sock) {
424   return sock->peer_port;
425 }
426 char *gras_socket_peer_name(gras_socket_t sock) {
427   return sock->peer_name;
428 }
429 char *gras_socket_peer_proc(gras_socket_t sock) {
430   return sock->peer_proc;
431 }
432
433 void gras_socket_peer_proc_set(gras_socket_t sock,char*peer_proc) {
434   sock->peer_proc = peer_proc;
435 }
436
437 /** \brief Check if the provided socket is a measurement one (or a regular one) */
438 int gras_socket_is_meas(gras_socket_t sock) {
439   return sock->meas;
440 }
441
442 /** \brief Send a chunk of (random) data over a measurement socket 
443  *
444  * @param peer measurement socket to use for the experiment
445  * @param timeout timeout (in seconds)
446  * @param msg_size size of each chunk sent over the socket (in bytes).
447  * @param msg_amount how many of these packets you want to send. 
448  *
449  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on 
450  * each side of the socket should be paired. 
451  * 
452  * The exchanged data is zeroed to make sure it's initialized, but
453  * there is no way to control what is sent (ie, you cannot use these 
454  * functions to exchange data out of band).
455  * 
456  * @warning: in SimGrid version 3.1 and previous, the numerical arguments 
457  *           were the total amount of data to send and the msg_size. This 
458  *           was changed for the fool wanting to send more than MAXINT 
459  *           bytes in a fat pipe. 
460  */
461 void gras_socket_meas_send(gras_socket_t peer, 
462                            unsigned int timeout,
463                            unsigned long int msg_size, 
464                            unsigned long int msg_amount) {
465   char *chunk=NULL;
466   unsigned long int sent_sofar;
467   
468   XBT_IN;
469
470   if (gras_if_RL()) 
471     chunk=xbt_malloc0(msg_size);
472
473   xbt_assert0(peer->meas,"Asked to send measurement data on a regular socket");
474   xbt_assert0(peer->outgoing,"Socket not suited for data send (was created with gras_socket_server(), not gras_socket_client())");
475
476   for (sent_sofar=0; sent_sofar < msg_amount; sent_sofar++) {
477      CDEBUG5(gras_trp_meas,"Sent %lu msgs of %lu (size of each: %ld) to %s:%d",
478              sent_sofar,msg_amount,msg_size,
479              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
480      (*peer->plugin->raw_send)(peer,chunk,msg_size);
481   }
482   CDEBUG5(gras_trp_meas,"Sent %lu msgs of %lu (size of each: %ld) to %s:%d",
483           sent_sofar,msg_amount,msg_size,
484           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
485              
486   if (gras_if_RL()) 
487     free(chunk);
488
489   XBT_OUT;
490 }
491
492 /** \brief Receive a chunk of data over a measurement socket 
493  *
494  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on 
495  * each side of the socket should be paired. 
496  *
497  * @warning: in SimGrid version 3.1 and previous, the numerical arguments 
498  *           were the total amount of data to send and the msg_size. This 
499  *           was changed for the fool wanting to send more than MAXINT 
500  *           bytes in a fat pipe. 
501  */
502 void gras_socket_meas_recv(gras_socket_t peer, 
503                            unsigned int timeout,
504                            unsigned long int msg_size, 
505                            unsigned long int msg_amount){
506   
507   char *chunk=NULL;
508   unsigned long int got_sofar;
509
510   XBT_IN;
511
512   if (gras_if_RL()) 
513     chunk = xbt_malloc(msg_size);
514
515   xbt_assert0(peer->meas,
516               "Asked to receive measurement data on a regular socket");
517   xbt_assert0(peer->incoming,"Socket not suited for data receive");
518
519   for (got_sofar=0; got_sofar < msg_amount; got_sofar ++) {
520      CDEBUG5(gras_trp_meas,"Recvd %ld msgs of %lu (size of each: %ld) from %s:%d",
521              got_sofar,msg_amount,msg_size,
522              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
523      (peer->plugin->raw_recv)(peer,chunk,msg_size);
524   }
525   CDEBUG5(gras_trp_meas,"Recvd %ld msgs of %lu (size of each: %ld) from %s:%d",
526           got_sofar,msg_amount,msg_size,
527           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
528
529   if (gras_if_RL()) 
530     free(chunk);
531   XBT_OUT;
532 }
533
534 /**
535  * \brief Something similar to the good old accept system call. 
536  *
537  * Make sure that there is someone speaking to the provided server socket.
538  * In RL, it does an accept(2) and return the result as last argument. 
539  * In SG, as accepts are useless, it returns the provided argument as result.
540  * You should thus test whether (peer != accepted) before closing both of them.
541  *
542  * You should only call this on measurement sockets. It is automatically 
543  * done for regular sockets, but you usually want more control about 
544  * what's going on with measurement sockets.
545  */
546 gras_socket_t gras_socket_meas_accept(gras_socket_t peer){
547   gras_socket_t res;
548
549   xbt_assert0(peer->meas,
550               "No need to accept on non-measurement sockets (it's automatic)");
551
552   if (!peer->accepting) {
553     /* nothing to accept here (must be in SG) */
554     /* BUG: FIXME: this is BAD! it makes tricky to free the accepted socket*/
555     return peer;
556   }
557
558   res = (peer->plugin->socket_accept)(peer);
559   res->meas = peer->meas;
560   CDEBUG1(gras_trp_meas,"meas_accepted onto %d",res->sd);
561
562   return res;
563
564
565
566 /*
567  * Creating procdata for this module
568  */
569 static void *gras_trp_procdata_new() {
570    gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t,1);
571    
572    res->name = xbt_strdup("gras_trp");
573    res->name_len = 0;
574    res->sockets = xbt_dynar_new_sync(sizeof(gras_socket_t*), NULL);
575    res->myport = 0;
576    
577    return (void*)res;
578 }
579
580 /*
581  * Freeing procdata for this module
582  */
583 static void gras_trp_procdata_free(void *data) {
584   gras_trp_procdata_t res = (gras_trp_procdata_t)data;
585   
586   xbt_dynar_free(&( res->sockets ));
587   free(res->name);
588   free(res);
589 }
590
591 void gras_trp_socketset_dump(const char *name) {
592   gras_trp_procdata_t procdata = 
593     (gras_trp_procdata_t)gras_libdata_by_id(gras_trp_libdata_id);
594
595   int it;
596   gras_socket_t s;
597
598   INFO1("** Dump the socket set %s",name);
599   xbt_dynar_foreach(procdata->sockets, it, s) {
600     INFO4("  %p -> %s:%d %s",
601           s,gras_socket_peer_name(s),gras_socket_peer_port(s),
602           s->valid?"(valid)":"(peer dead)");
603   }
604   INFO1("** End of socket set %s",name);
605 }
606
607 /*
608  * Module registration
609  */
610 int gras_trp_libdata_id;
611 void gras_trp_register() {
612    gras_trp_libdata_id = gras_procdata_add("gras_trp",gras_trp_procdata_new, gras_trp_procdata_free);
613 }
614
615 int gras_os_myport(void)  {
616    return ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->myport;
617 }
618