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("tcp", gras_trp_tcp_setup);
85 gras_trp_plugin_new("file",gras_trp_file_setup);
86 gras_trp_plugin_new("sg",gras_trp_sg_setup);
88 /* buf is composed, so it must come after the others */
89 gras_trp_plugin_new("buf", gras_trp_buf_setup);
97 xbt_dynar_t sockets = gras_socketset_get();
98 gras_socket_t sock_iter;
101 if (_gras_trp_started == 0) {
105 if ( --_gras_trp_started == 0 ) {
106 #ifdef HAVE_WINSOCK_H
107 if ( WSACleanup() == SOCKET_ERROR ) {
108 if ( WSAGetLastError() == WSAEINPROGRESS ) {
109 WSACancelBlockingCall();
115 /* Close all the sockets */
116 xbt_dynar_foreach(sockets,cursor,sock_iter) {
117 VERB1("Closing the socket %p left open on exit. Maybe a socket leak?",
119 gras_socket_close(sock_iter);
122 /* Delete the plugins */
123 xbt_dict_free(&_gras_trp_plugins);
128 void gras_trp_plugin_free(void *p) {
129 gras_trp_plugin_t plug = p;
134 } else if (plug->data) {
135 DEBUG1("Plugin %s lacks exit(). Free data anyway.",plug->name);
146 * gras_trp_socket_new:
148 * Malloc a new socket, and initialize it with defaults
150 void gras_trp_socket_new(int incoming,
151 gras_socket_t *dst) {
153 gras_socket_t sock=xbt_new0(s_gras_socket_t,1);
155 DEBUG1("Create a new socket (%p)", (void*)sock);
159 sock->incoming = incoming ? 1:0;
160 sock->outgoing = incoming ? 0:1;
161 sock->accepting = incoming ? 1:0;
166 sock->peer_port = -1;
167 sock->peer_name = NULL;
170 sock->bufdata = NULL;
174 xbt_dynar_push(gras_socketset_get(),dst);
180 * gras_socket_server_ext:
182 * Opens a server socket and make it ready to be listened to.
183 * In real life, you'll get a TCP socket.
186 gras_socket_server_ext(unsigned short port,
188 unsigned long int bufSize,
192 gras_trp_plugin_t trp;
195 DEBUG2("Create a server socket from plugin %s on port %d",
196 gras_if_RL() ? "tcp" : "sg",
198 trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":(measurement?"tcp":"buf"));
200 /* defaults settings */
201 gras_trp_socket_new(1,&sock);
204 sock->bufSize = bufSize;
205 sock->meas = measurement;
207 /* Call plugin socket creation function */
208 DEBUG1("Prepare socket with plugin (fct=%p)",trp->socket_server);
210 trp->socket_server(trp, sock);
211 DEBUG3("in=%c out=%c accept=%c",
212 sock->incoming?'y':'n',
213 sock->outgoing?'y':'n',
214 sock->accepting?'y':'n');
224 * gras_socket_client_ext:
226 * Opens a client socket to a remote host.
227 * In real life, you'll get a TCP socket.
230 gras_socket_client_ext(const char *host,
233 unsigned long int bufSize,
237 gras_trp_plugin_t trp;
240 trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":(measurement?"tcp":"buf"));
242 DEBUG1("Create a client socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
243 /* defaults settings */
244 gras_trp_socket_new(0,&sock);
246 sock->peer_port = port;
247 sock->peer_name = (char*)strdup(host?host:"localhost");
248 sock->bufSize = bufSize;
249 sock->meas = measurement;
251 /* plugin-specific */
253 (*trp->socket_client)(trp, sock);
254 DEBUG3("in=%c out=%c accept=%c",
255 sock->incoming?'y':'n',
256 sock->outgoing?'y':'n',
257 sock->accepting?'y':'n');
267 * gras_socket_server:
269 * Opens a server socket and make it ready to be listened to.
270 * In real life, you'll get a TCP socket.
273 gras_socket_server(unsigned short port) {
274 return gras_socket_server_ext(port,32,0);
278 * gras_socket_client:
280 * Opens a client socket to a remote host.
281 * In real life, you'll get a TCP socket.
284 gras_socket_client(const char *host,
285 unsigned short port) {
286 return gras_socket_client_ext(host,port,32,0);
290 void gras_socket_close(gras_socket_t sock) {
291 xbt_dynar_t sockets = gras_socketset_get();
292 gras_socket_t sock_iter;
296 /* FIXME: Issue an event when the socket is closed */
298 xbt_dynar_foreach(sockets,cursor,sock_iter) {
299 if (sock == sock_iter) {
300 xbt_dynar_cursor_rm(sockets,&cursor);
301 if (sock->plugin->socket_close)
302 (* sock->plugin->socket_close)(sock);
304 /* free the memory */
306 free(sock->peer_name);
312 WARN1("Ignoring request to free an unknown socket (%p)",sock);
318 * gras_trp_chunk_send:
320 * Send a bunch of bytes from on socket
323 gras_trp_chunk_send(gras_socket_t sd,
326 xbt_assert1(sd->outgoing,
327 "Socket not suited for data send (outgoing=%c)",
328 sd->outgoing?'y':'n');
329 xbt_assert1(sd->plugin->chunk_send,
330 "No function chunk_send on transport plugin %s",
332 (*sd->plugin->chunk_send)(sd,data,size);
335 * gras_trp_chunk_recv:
337 * Receive a bunch of bytes from a socket
340 gras_trp_chunk_recv(gras_socket_t sd,
343 xbt_assert0(sd->incoming,
344 "Socket not suited for data receive");
345 xbt_assert1(sd->plugin->chunk_recv,
346 "No function chunk_recv on transport plugin %s",
348 (sd->plugin->chunk_recv)(sd,data,size,size);
354 * Make sure all pending communications are done
357 gras_trp_flush(gras_socket_t sd) {
358 (sd->plugin->flush)(sd);
362 gras_trp_plugin_get_by_name(const char *name){
363 return xbt_dict_get(_gras_trp_plugins,name);
366 int gras_socket_my_port (gras_socket_t sock) {
369 int gras_socket_peer_port(gras_socket_t sock) {
370 return sock->peer_port;
372 char *gras_socket_peer_name(gras_socket_t sock) {
373 return sock->peer_name;
376 /** \brief Check if the provided socket is a measurement one (or a regular one) */
377 int gras_socket_is_meas(gras_socket_t sock) {
381 /** \brief Send a chunk of (random) data over a measurement socket
383 * @param peer measurement socket to use for the experiment
384 * @param timeout timeout (in seconds)
385 * @param exp_size total amount of data to send (in bytes).
386 * @param msg_size size of each chunk sent over the socket (in bytes).
388 * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
389 * each side of the socket should be paired.
391 * The exchanged data is zeroed to make sure it's initialized, but
392 * there is no way to control what is sent (ie, you cannot use these
393 * functions to exchange data out of band).
395 void gras_socket_meas_send(gras_socket_t peer,
396 unsigned int timeout,
397 unsigned long int exp_size,
398 unsigned long int msg_size) {
399 char *chunk = xbt_malloc0(msg_size);
400 unsigned long int exp_sofar;
404 xbt_assert0(peer->meas,"Asked to send measurement data on a regular socket");
406 for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += 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));
410 gras_trp_chunk_send(peer,chunk,msg_size);
412 CDEBUG5(trp_meas,"Sent %lu of %lu (msg_size=%ld) to %s:%d",
413 exp_sofar,exp_size,msg_size,
414 gras_socket_peer_name(peer), gras_socket_peer_port(peer));
421 /** \brief Receive a chunk of data over a measurement socket
423 * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
424 * each side of the socket should be paired.
426 void gras_socket_meas_recv(gras_socket_t peer,
427 unsigned int timeout,
428 unsigned long int exp_size,
429 unsigned long int msg_size){
431 char *chunk = xbt_malloc(msg_size);
432 unsigned long int exp_sofar;
436 xbt_assert0(peer->meas,"Asked to receive measurement data on a regular socket\n");
438 for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
439 CDEBUG5(trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
440 exp_sofar,exp_size,msg_size,
441 gras_socket_peer_name(peer), gras_socket_peer_port(peer));
442 gras_trp_chunk_recv(peer,chunk,msg_size);
444 CDEBUG5(trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
445 exp_sofar,exp_size,msg_size,
446 gras_socket_peer_name(peer), gras_socket_peer_port(peer));
453 * \brief Something similar to the good old accept system call.
455 * Make sure that there is someone speaking to the provided server socket.
456 * In RL, it does an accept(2) and return the result as last argument.
457 * In SG, as accepts are useless, it returns the provided argument as result.
458 * You should thus test whether (peer != accepted) before closing both of them.
460 * You should only call this on measurement sockets. It is automatically
461 * done for regular sockets, but you usually want more control about
462 * what's going on with measurement sockets.
464 gras_socket_t gras_socket_meas_accept(gras_socket_t peer){
467 xbt_assert0(peer->meas,
468 "No need to accept on non-measurement sockets (it's automatic)");
470 if (!peer->accepting) {
471 /* nothing to accept here */
475 res = (peer->plugin->socket_accept)(peer);
476 res->meas = peer->meas;
477 CDEBUG1(trp_meas,"meas_accepted onto %d",res->sd);
484 * Creating procdata for this module
486 static void *gras_trp_procdata_new() {
487 gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t,1);
489 res->sockets = xbt_dynar_new(sizeof(gras_socket_t*), NULL);
495 * Freeing procdata for this module
497 static void gras_trp_procdata_free(void *data) {
498 gras_trp_procdata_t res = (gras_trp_procdata_t)data;
500 xbt_dynar_free(&( res->sockets ));
505 * Module registration
507 void gras_trp_register() {
508 gras_procdata_add("gras_trp",gras_trp_procdata_new, gras_trp_procdata_free);
513 gras_socketset_get(void) {
515 return ((gras_trp_procdata_t) gras_libdata_get("gras_trp"))->sockets;