3 /* transport - low level communication */
5 /* Copyright (c) 2004 Martin Quinson. All rights reserved. */
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. */
12 #include "gras/Transport/transport_private.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(transport,gras,"Conveying bytes over the network");
15 XBT_LOG_NEW_SUBCATEGORY(trp_meas,transport,"Conveying bytes over the network without formating for perf measurements");
16 static short int _gras_trp_started = 0;
18 static xbt_dict_t _gras_trp_plugins; /* All registered plugins */
19 static void gras_trp_plugin_free(void *p); /* free one of the plugins */
22 gras_trp_plugin_new(const char *name, gras_trp_setup_t setup) {
25 gras_trp_plugin_t plug = xbt_new0(s_gras_trp_plugin_t, 1);
27 DEBUG1("Create plugin %s",name);
29 plug->name=xbt_strdup(name);
34 if (e.category == mismatch_error) {
35 /* SG plugin raise mismatch when in RL mode (and vice versa) */
46 xbt_dict_set(_gras_trp_plugins, name, plug, gras_trp_plugin_free);
49 void gras_trp_init(void){
50 if (!_gras_trp_started) {
51 /* make room for all plugins */
52 _gras_trp_plugins=xbt_dict_new();
54 #ifdef HAVE_WINSOCK2_H
55 /* initialize the windows mechanism */
57 WORD wVersionRequested;
60 wVersionRequested = MAKEWORD( 2, 0 );
61 xbt_assert0(WSAStartup( wVersionRequested, &wsaData ) == 0,
62 "Cannot find a usable WinSock DLL");
64 /* Confirm that the WinSock DLL supports 2.0.*/
65 /* Note that if the DLL supports versions greater */
66 /* than 2.0 in addition to 2.0, it will still return */
67 /* 2.0 in wVersion since that is the version we */
70 xbt_assert0(LOBYTE( wsaData.wVersion ) == 2 &&
71 HIBYTE( wsaData.wVersion ) == 0,
72 "Cannot find a usable WinSock DLL");
73 INFO0("Found and initialized winsock2");
74 } /* The WinSock DLL is acceptable. Proceed. */
77 xbt_assert0(WSAStartup( 0x0101, &wsaData ) == 0,
78 "Cannot find a usable WinSock DLL");
79 INFO0("Found and initialized winsock");
84 gras_trp_plugin_new("file",gras_trp_file_setup);
85 gras_trp_plugin_new("sg",gras_trp_sg_setup);
86 gras_trp_plugin_new("tcp", gras_trp_tcp_setup);
94 xbt_dynar_t sockets = ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
95 gras_socket_t sock_iter;
98 if (_gras_trp_started == 0) {
102 if ( --_gras_trp_started == 0 ) {
103 #ifdef HAVE_WINSOCK_H
104 if ( WSACleanup() == SOCKET_ERROR ) {
105 if ( WSAGetLastError() == WSAEINPROGRESS ) {
106 WSACancelBlockingCall();
112 /* Close all the sockets */
113 xbt_dynar_foreach(sockets,cursor,sock_iter) {
114 VERB1("Closing the socket %p left open on exit. Maybe a socket leak?",
116 gras_socket_close(sock_iter);
119 /* Delete the plugins */
120 xbt_dict_free(&_gras_trp_plugins);
125 void gras_trp_plugin_free(void *p) {
126 gras_trp_plugin_t plug = p;
131 } else if (plug->data) {
132 DEBUG1("Plugin %s lacks exit(). Free data anyway.",plug->name);
143 * gras_trp_socket_new:
145 * Malloc a new socket, and initialize it with defaults
147 void gras_trp_socket_new(int incoming,
148 gras_socket_t *dst) {
150 gras_socket_t sock=xbt_new0(s_gras_socket_t,1);
152 DEBUG1("Create a new socket (%p)", (void*)sock);
156 sock->incoming = incoming ? 1:0;
157 sock->outgoing = incoming ? 0:1;
158 sock->accepting = incoming ? 1:0;
163 sock->peer_port = -1;
164 sock->peer_name = NULL;
167 sock->bufdata = NULL;
171 xbt_dynar_push(((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets,dst);
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)
182 * In real life, you'll get a TCP socket.
185 gras_socket_server_ext(unsigned short port,
187 unsigned long int buf_size,
191 gras_trp_plugin_t trp;
194 DEBUG2("Create a server socket from plugin %s on port %d",
195 gras_if_RL() ? "tcp" : "sg",
197 trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
199 /* defaults settings */
200 gras_trp_socket_new(1,&sock);
203 sock->buf_size = buf_size>0 ? buf_size : 32*1024;
204 sock->meas = measurement;
206 /* Call plugin socket creation function */
207 DEBUG1("Prepare socket with plugin (fct=%p)",trp->socket_server);
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');
223 * @brief Opens a client socket to a remote host.
224 * @param host: who you want to connect to
225 * @param port: where you want to connect to on this host
226 * @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)
227 * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
229 * In real life, you'll get a TCP socket.
232 gras_socket_client_ext(const char *host,
235 unsigned long int buf_size,
239 gras_trp_plugin_t trp;
242 trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
244 DEBUG1("Create a client socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
245 /* defaults settings */
246 gras_trp_socket_new(0,&sock);
248 sock->peer_port = port;
249 sock->peer_name = (char*)strdup(host?host:"localhost");
250 sock->buf_size = buf_size>0 ? buf_size: 32*1024;
251 sock->meas = measurement;
253 /* plugin-specific */
255 (*trp->socket_client)(trp, sock);
256 DEBUG3("in=%c out=%c accept=%c",
257 sock->incoming?'y':'n',
258 sock->outgoing?'y':'n',
259 sock->accepting?'y':'n');
269 * gras_socket_server:
271 * Opens a server socket and make it ready to be listened to.
272 * In real life, you'll get a TCP socket.
275 gras_socket_server(unsigned short port) {
276 return gras_socket_server_ext(port,32,0);
280 * gras_socket_client:
282 * Opens a client socket to a remote host.
283 * In real life, you'll get a TCP socket.
286 gras_socket_client(const char *host,
287 unsigned short port) {
288 return gras_socket_client_ext(host,port,32,0);
292 void gras_socket_close(gras_socket_t sock) {
293 xbt_dynar_t sockets = ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
294 gras_socket_t sock_iter;
298 /* FIXME: Issue an event when the socket is closed */
300 xbt_dynar_foreach(sockets,cursor,sock_iter) {
301 if (sock == sock_iter) {
302 xbt_dynar_cursor_rm(sockets,&cursor);
303 if (sock->plugin->socket_close)
304 (* sock->plugin->socket_close)(sock);
306 /* free the memory */
308 free(sock->peer_name);
314 WARN1("Ignoring request to free an unknown socket (%p)",sock);
322 * Send a bunch of bytes from on socket
323 * (stable if we know the storage will keep as is until the next trp_flush)
326 gras_trp_send(gras_socket_t sd, char *data, long int size, int stable) {
327 xbt_assert0(sd->outgoing,"Socket not suited for data send");
328 (*sd->plugin->send)(sd,data,size,stable);
331 * gras_trp_chunk_recv:
333 * Receive a bunch of bytes from a socket
336 gras_trp_recv(gras_socket_t sd, char *data, long int size) {
337 xbt_assert0(sd->incoming,"Socket not suited for data receive");
338 (sd->plugin->recv)(sd,data,size);
344 * Make sure all pending communications are done
347 gras_trp_flush(gras_socket_t sd) {
348 if (sd->plugin->flush)
349 (sd->plugin->flush)(sd);
353 gras_trp_plugin_get_by_name(const char *name){
354 return xbt_dict_get(_gras_trp_plugins,name);
357 int gras_socket_my_port (gras_socket_t sock) {
360 int gras_socket_peer_port(gras_socket_t sock) {
361 return sock->peer_port;
363 char *gras_socket_peer_name(gras_socket_t sock) {
364 return sock->peer_name;
367 /** \brief Check if the provided socket is a measurement one (or a regular one) */
368 int gras_socket_is_meas(gras_socket_t sock) {
372 /** \brief Send a chunk of (random) data over a measurement socket
374 * @param peer measurement socket to use for the experiment
375 * @param timeout timeout (in seconds)
376 * @param exp_size total amount of data to send (in bytes).
377 * @param msg_size size of each chunk sent over the socket (in bytes).
379 * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
380 * each side of the socket should be paired.
382 * The exchanged data is zeroed to make sure it's initialized, but
383 * there is no way to control what is sent (ie, you cannot use these
384 * functions to exchange data out of band).
386 void gras_socket_meas_send(gras_socket_t peer,
387 unsigned int timeout,
388 unsigned long int exp_size,
389 unsigned long int msg_size) {
391 unsigned long int exp_sofar;
396 chunk=xbt_malloc0(msg_size);
398 xbt_assert0(peer->meas,"Asked to send measurement data on a regular socket");
399 xbt_assert0(peer->outgoing,"Socket not suited for data send (was created with gras_socket_server(), not gras_socket_client())");
401 for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
402 CDEBUG5(trp_meas,"Sent %lu of %lu (msg_size=%ld) to %s:%d",
403 exp_sofar,exp_size,msg_size,
404 gras_socket_peer_name(peer), gras_socket_peer_port(peer));
405 (*peer->plugin->raw_send)(peer,chunk,msg_size);
407 CDEBUG5(trp_meas,"Sent %lu of %lu (msg_size=%ld) to %s:%d",
408 exp_sofar,exp_size,msg_size,
409 gras_socket_peer_name(peer), gras_socket_peer_port(peer));
417 /** \brief Receive a chunk of data over a measurement socket
419 * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
420 * each side of the socket should be paired.
422 void gras_socket_meas_recv(gras_socket_t peer,
423 unsigned int timeout,
424 unsigned long int exp_size,
425 unsigned long int msg_size){
428 unsigned long int exp_sofar;
433 chunk = xbt_malloc(msg_size);
435 xbt_assert0(peer->meas,
436 "Asked to receive measurement data on a regular socket");
437 xbt_assert0(peer->incoming,"Socket not suited for data receive");
439 for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
440 CDEBUG5(trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
441 exp_sofar,exp_size,msg_size,
442 gras_socket_peer_name(peer), gras_socket_peer_port(peer));
443 (peer->plugin->raw_recv)(peer,chunk,msg_size);
445 CDEBUG5(trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
446 exp_sofar,exp_size,msg_size,
447 gras_socket_peer_name(peer), gras_socket_peer_port(peer));
455 * \brief Something similar to the good old accept system call.
457 * Make sure that there is someone speaking to the provided server socket.
458 * In RL, it does an accept(2) and return the result as last argument.
459 * In SG, as accepts are useless, it returns the provided argument as result.
460 * You should thus test whether (peer != accepted) before closing both of them.
462 * You should only call this on measurement sockets. It is automatically
463 * done for regular sockets, but you usually want more control about
464 * what's going on with measurement sockets.
466 gras_socket_t gras_socket_meas_accept(gras_socket_t peer){
469 xbt_assert0(peer->meas,
470 "No need to accept on non-measurement sockets (it's automatic)");
472 if (!peer->accepting) {
473 /* nothing to accept here */
477 res = (peer->plugin->socket_accept)(peer);
478 res->meas = peer->meas;
479 CDEBUG1(trp_meas,"meas_accepted onto %d",res->sd);
486 * Creating procdata for this module
488 static void *gras_trp_procdata_new() {
489 gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t,1);
491 res->name = xbt_strdup("gras_trp");
493 res->sockets = xbt_dynar_new(sizeof(gras_socket_t*), NULL);
499 * Freeing procdata for this module
501 static void gras_trp_procdata_free(void *data) {
502 gras_trp_procdata_t res = (gras_trp_procdata_t)data;
504 xbt_dynar_free(&( res->sockets ));
510 * Module registration
512 int gras_trp_libdata_id;
513 void gras_trp_register() {
514 gras_trp_libdata_id = gras_procdata_add("gras_trp",gras_trp_procdata_new, gras_trp_procdata_free);