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. */
13 int gras_opt_trp_nomoredata_on_close = 0;
18 #include "gras/Transport/transport_private.h"
19 #include "gras/Msg/msg_interface.h"
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_trp, gras,
22 "Conveying bytes over the network");
23 XBT_LOG_NEW_SUBCATEGORY(gras_trp_meas, gras_trp,
24 "Conveying bytes over the network without formating for perf measurements");
25 static short int _gras_trp_started = 0;
27 static xbt_dict_t _gras_trp_plugins; /* All registered plugins */
28 static void gras_trp_plugin_free(void *p); /* free one of the plugins */
30 static void gras_trp_plugin_new(const char *name, gras_trp_setup_t setup)
34 gras_trp_plugin_t plug = xbt_new0(s_gras_trp_plugin_t, 1);
36 DEBUG1("Create plugin %s", name);
38 plug->name = xbt_strdup(name);
43 if (e.category == mismatch_error) {
44 /* SG plugin raise mismatch when in RL mode (and vice versa) */
55 xbt_dict_set(_gras_trp_plugins, name, plug, gras_trp_plugin_free);
58 void gras_trp_init(void)
60 if (!_gras_trp_started) {
61 /* make room for all plugins */
62 _gras_trp_plugins = xbt_dict_new();
64 #ifdef HAVE_WINSOCK2_H
65 /* initialize the windows mechanism */
67 WORD wVersionRequested;
70 wVersionRequested = MAKEWORD(2, 0);
71 xbt_assert0(WSAStartup(wVersionRequested, &wsaData) == 0,
72 "Cannot find a usable WinSock DLL");
74 /* Confirm that the WinSock DLL supports 2.0. */
75 /* Note that if the DLL supports versions greater */
76 /* than 2.0 in addition to 2.0, it will still return */
77 /* 2.0 in wVersion since that is the version we */
80 xbt_assert0(LOBYTE(wsaData.wVersion) == 2 &&
81 HIBYTE(wsaData.wVersion) == 0,
82 "Cannot find a usable WinSock DLL");
83 INFO0("Found and initialized winsock2");
84 } /* The WinSock DLL is acceptable. Proceed. */
88 xbt_assert0(WSAStartup(0x0101, &wsaData) == 0,
89 "Cannot find a usable WinSock DLL");
90 INFO0("Found and initialized winsock");
95 gras_trp_plugin_new("file", gras_trp_file_setup);
96 gras_trp_plugin_new("sg", gras_trp_sg_setup);
97 gras_trp_plugin_new("tcp", gras_trp_tcp_setup);
103 void gras_trp_exit(void)
105 DEBUG1("gras_trp value %d", _gras_trp_started);
106 if (_gras_trp_started == 0) {
110 if (--_gras_trp_started == 0) {
111 #ifdef HAVE_WINSOCK_H
112 if (WSACleanup() == SOCKET_ERROR) {
113 if (WSAGetLastError() == WSAEINPROGRESS) {
114 WSACancelBlockingCall();
120 /* Delete the plugins */
121 xbt_dict_free(&_gras_trp_plugins);
126 void gras_trp_plugin_free(void *p)
128 gras_trp_plugin_t plug = p;
133 } else if (plug->data) {
134 DEBUG1("Plugin %s lacks exit(). Free data anyway.", plug->name);
145 * gras_trp_socket_new:
147 * Malloc a new socket, and initialize it with defaults
149 void gras_trp_socket_new(int incoming, gras_socket_t * dst)
152 gras_socket_t sock = xbt_new0(s_gras_socket_t, 1);
154 VERB1("Create a new socket (%p)", (void *) sock);
158 sock->incoming = incoming ? 1 : 0;
159 sock->outgoing = incoming ? 0 : 1;
160 sock->accepting = incoming ? 1 : 0;
168 sock->peer_port = -1;
169 sock->peer_name = NULL;
170 sock->peer_proc = NULL;
173 sock->bufdata = NULL;
181 * @brief Opens a server socket and makes it ready to be listened to.
182 * @param port: port on which you want to listen
183 * @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)
184 * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
186 * In real life, you'll get a TCP socket.
189 gras_socket_server_ext(unsigned short port,
190 unsigned long int buf_size, int measurement)
194 gras_trp_plugin_t trp;
197 DEBUG2("Create a server socket from plugin %s on port %d",
198 gras_if_RL()? "tcp" : "sg", port);
199 trp = gras_trp_plugin_get_by_name(gras_if_SG()? "sg" : "tcp");
201 /* defaults settings */
202 gras_trp_socket_new(1, &sock);
205 sock->buf_size = buf_size > 0 ? buf_size : 32 * 1024;
206 sock->meas = measurement;
208 /* Call plugin socket creation function */
209 DEBUG1("Prepare socket with plugin (fct=%p)", trp->socket_server);
211 trp->socket_server(trp, sock);
212 DEBUG3("in=%c out=%c accept=%c",
213 sock->incoming ? 'y' : 'n',
214 sock->outgoing ? 'y' : 'n', sock->accepting ? 'y' : 'n');
222 ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->myport =
224 xbt_dynar_push(((gras_trp_procdata_t)
225 gras_libdata_by_id(gras_trp_libdata_id))->sockets, &sock);
227 gras_msg_listener_awake();
232 * @brief Opens a server socket on any port in the given range
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)
239 * If none of the provided ports works, raises the exception got when trying the last possibility
242 gras_socket_server_range(unsigned short minport, unsigned short maxport,
243 unsigned long int buf_size, int measurement)
247 gras_socket_t res = NULL;
250 for (port = minport; port < maxport; port++) {
252 res = gras_socket_server_ext(port, buf_size, measurement);
266 * @brief Opens a client socket to a remote host.
267 * @param host: who you want to connect to
268 * @param port: where you want to connect to on this host
269 * @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)
270 * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
272 * In real life, you'll get a TCP socket.
275 gras_socket_client_ext(const char *host,
277 unsigned long int buf_size, int measurement)
281 gras_trp_plugin_t trp;
284 trp = gras_trp_plugin_get_by_name(gras_if_SG()? "sg" : "tcp");
286 DEBUG1("Create a client socket from plugin %s", gras_if_RL()? "tcp" : "sg");
287 /* defaults settings */
288 gras_trp_socket_new(0, &sock);
290 sock->peer_port = port;
291 sock->peer_name = (char *) strdup(host ? host : "localhost");
292 sock->buf_size = buf_size > 0 ? buf_size : 32 * 1024;
293 sock->meas = measurement;
295 /* plugin-specific */
297 (*trp->socket_client) (trp, sock);
298 DEBUG3("in=%c out=%c accept=%c",
299 sock->incoming ? 'y' : 'n',
300 sock->outgoing ? 'y' : 'n', sock->accepting ? 'y' : 'n');
305 xbt_dynar_push(((gras_trp_procdata_t)
306 gras_libdata_by_id(gras_trp_libdata_id))->sockets, &sock);
307 gras_msg_listener_awake();
312 * @brief Opens a server socket and make it ready to be listened to.
314 * In real life, you'll get a TCP socket.
316 gras_socket_t gras_socket_server(unsigned short port)
318 return gras_socket_server_ext(port, 32 * 1024, 0);
321 /** @brief Opens a client socket to a remote host */
322 gras_socket_t gras_socket_client(const char *host, unsigned short port)
324 return gras_socket_client_ext(host, port, 0, 0);
327 /** @brief Opens a client socket to a remote host specified as '\a host:\a port' */
328 gras_socket_t gras_socket_client_from_string(const char *host)
330 xbt_peer_t p = xbt_peer_from_string(host);
331 gras_socket_t res = gras_socket_client_ext(p->name, p->port, 0, 0);
336 void gras_socket_close_voidp(void *sock) {
337 gras_socket_close((gras_socket_t)sock);
340 /** \brief Close socket */
341 void gras_socket_close(gras_socket_t sock)
343 xbt_dynar_t sockets =
344 ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
345 gras_socket_t sock_iter = NULL;
349 VERB1("Close %p", sock);
350 if (sock == _gras_lastly_selected_socket) {
351 xbt_assert0(!gras_opt_trp_nomoredata_on_close || !sock->moredata,
352 "Closing a socket having more data in buffer while the nomoredata_on_close option is activated");
356 ("Closing a socket having more data in buffer. Option nomoredata_on_close disabled, so continuing.");
357 _gras_lastly_selected_socket = NULL;
360 /* FIXME: Issue an event when the socket is closed */
361 DEBUG1("sockets pointer before %p", sockets);
363 /* FIXME: Cannot get the dynar mutex, because it can be already locked */
364 // _xbt_dynar_foreach(sockets,cursor,sock_iter) {
365 for (cursor = 0; cursor < xbt_dynar_length(sockets); cursor++) {
366 _xbt_dynar_cursor_get(sockets, cursor, &sock_iter);
367 if (sock == sock_iter) {
368 DEBUG2("remove sock cursor %d dize %lu\n", cursor,
369 xbt_dynar_length(sockets));
370 xbt_dynar_cursor_rm(sockets, &cursor);
371 if (sock->plugin->socket_close)
372 (*sock->plugin->socket_close) (sock);
374 /* free the memory */
376 free(sock->peer_name);
382 WARN1("Ignoring request to free an unknown socket (%p). Execution stack:",
384 xbt_backtrace_display_current();
392 * Send a bunch of bytes from on socket
393 * (stable if we know the storage will keep as is until the next trp_flush)
395 void gras_trp_send(gras_socket_t sd, char *data, long int size, int stable)
397 xbt_assert0(sd->outgoing, "Socket not suited for data send");
398 (*sd->plugin->send) (sd, data, size, stable);
402 * gras_trp_chunk_recv:
404 * Receive a bunch of bytes from a socket
406 void gras_trp_recv(gras_socket_t sd, char *data, long int size)
408 xbt_assert0(sd->incoming, "Socket not suited for data receive");
409 (sd->plugin->recv) (sd, data, size);
415 * Make sure all pending communications are done
417 void gras_trp_flush(gras_socket_t sd)
419 if (sd->plugin->flush)
420 (sd->plugin->flush) (sd);
423 gras_trp_plugin_t gras_trp_plugin_get_by_name(const char *name)
425 return xbt_dict_get(_gras_trp_plugins, name);
428 int gras_socket_my_port(gras_socket_t sock)
433 int gras_socket_peer_port(gras_socket_t sock)
435 return sock->peer_port;
438 char *gras_socket_peer_name(gras_socket_t sock)
440 return sock->peer_name;
443 char *gras_socket_peer_proc(gras_socket_t sock)
445 return sock->peer_proc;
448 void gras_socket_peer_proc_set(gras_socket_t sock, char *peer_proc)
450 sock->peer_proc = peer_proc;
453 /** \brief Check if the provided socket is a measurement one (or a regular one) */
454 int gras_socket_is_meas(gras_socket_t sock)
459 /** \brief Send a chunk of (random) data over a measurement socket
461 * @param peer measurement socket to use for the experiment
462 * @param timeout timeout (in seconds)
463 * @param msg_size size of each chunk sent over the socket (in bytes).
464 * @param msg_amount how many of these packets you want to send.
466 * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
467 * each side of the socket should be paired.
469 * The exchanged data is zeroed to make sure it's initialized, but
470 * there is no way to control what is sent (ie, you cannot use these
471 * functions to exchange data out of band).
473 * @warning: in SimGrid version 3.1 and previous, the numerical arguments
474 * were the total amount of data to send and the msg_size. This
475 * was changed for the fool wanting to send more than MAXINT
476 * bytes in a fat pipe.
478 void gras_socket_meas_send(gras_socket_t peer,
479 unsigned int timeout,
480 unsigned long int msg_size,
481 unsigned long int msg_amount)
484 unsigned long int sent_sofar;
489 chunk = xbt_malloc0(msg_size);
491 xbt_assert0(peer->meas,
492 "Asked to send measurement data on a regular socket");
493 xbt_assert0(peer->outgoing,
494 "Socket not suited for data send (was created with gras_socket_server(), not gras_socket_client())");
496 for (sent_sofar = 0; sent_sofar < msg_amount; sent_sofar++) {
497 CDEBUG5(gras_trp_meas,
498 "Sent %lu msgs of %lu (size of each: %ld) to %s:%d", sent_sofar,
499 msg_amount, msg_size, gras_socket_peer_name(peer),
500 gras_socket_peer_port(peer));
501 (*peer->plugin->raw_send) (peer, chunk, msg_size);
503 CDEBUG5(gras_trp_meas, "Sent %lu msgs of %lu (size of each: %ld) to %s:%d",
504 sent_sofar, msg_amount, msg_size,
505 gras_socket_peer_name(peer), gras_socket_peer_port(peer));
513 /** \brief Receive a chunk of data over a measurement socket
515 * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
516 * each side of the socket should be paired.
518 * @warning: in SimGrid version 3.1 and previous, the numerical arguments
519 * were the total amount of data to send and the msg_size. This
520 * was changed for the fool wanting to send more than MAXINT
521 * bytes in a fat pipe.
523 void gras_socket_meas_recv(gras_socket_t peer,
524 unsigned int timeout,
525 unsigned long int msg_size,
526 unsigned long int msg_amount)
530 unsigned long int got_sofar;
535 chunk = xbt_malloc(msg_size);
537 xbt_assert0(peer->meas,
538 "Asked to receive measurement data on a regular socket");
539 xbt_assert0(peer->incoming, "Socket not suited for data receive");
541 for (got_sofar = 0; got_sofar < msg_amount; got_sofar++) {
542 CDEBUG5(gras_trp_meas,
543 "Recvd %ld msgs of %lu (size of each: %ld) from %s:%d", got_sofar,
544 msg_amount, msg_size, gras_socket_peer_name(peer),
545 gras_socket_peer_port(peer));
546 (peer->plugin->raw_recv) (peer, chunk, msg_size);
548 CDEBUG5(gras_trp_meas,
549 "Recvd %ld msgs of %lu (size of each: %ld) from %s:%d", got_sofar,
550 msg_amount, msg_size, gras_socket_peer_name(peer),
551 gras_socket_peer_port(peer));
559 * \brief Something similar to the good old accept system call.
561 * Make sure that there is someone speaking to the provided server socket.
562 * In RL, it does an accept(2) and return the result as last argument.
563 * In SG, as accepts are useless, it returns the provided argument as result.
564 * You should thus test whether (peer != accepted) before closing both of them.
566 * You should only call this on measurement sockets. It is automatically
567 * done for regular sockets, but you usually want more control about
568 * what's going on with measurement sockets.
570 gras_socket_t gras_socket_meas_accept(gras_socket_t peer)
574 xbt_assert0(peer->meas,
575 "No need to accept on non-measurement sockets (it's automatic)");
577 if (!peer->accepting) {
578 /* nothing to accept here (must be in SG) */
579 /* BUG: FIXME: this is BAD! it makes tricky to free the accepted socket */
583 res = (peer->plugin->socket_accept) (peer);
584 res->meas = peer->meas;
585 CDEBUG1(gras_trp_meas, "meas_accepted onto %d", res->sd);
592 * Creating procdata for this module
594 static void *gras_trp_procdata_new(void)
596 gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t, 1);
598 res->name = xbt_strdup("gras_trp");
600 res->sockets = xbt_dynar_new_sync(sizeof(gras_socket_t *), NULL);
607 * Freeing procdata for this module
609 static void gras_trp_procdata_free(void *data)
611 gras_trp_procdata_t res = (gras_trp_procdata_t) data;
613 xbt_dynar_free(&(res->sockets));
618 void gras_trp_socketset_dump(const char *name)
620 gras_trp_procdata_t procdata =
621 (gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id);
626 INFO1("** Dump the socket set %s", name);
627 xbt_dynar_foreach(procdata->sockets, it, s) {
628 INFO4(" %p -> %s:%d %s",
629 s, gras_socket_peer_name(s), gras_socket_peer_port(s),
630 s->valid ? "(valid)" : "(peer dead)");
632 INFO1("** End of socket set %s", name);
636 * Module registration
638 int gras_trp_libdata_id;
639 void gras_trp_register()
641 gras_trp_libdata_id =
642 gras_procdata_add("gras_trp", gras_trp_procdata_new,
643 gras_trp_procdata_free);
646 int gras_os_myport(void)
648 return ((gras_trp_procdata_t)
649 gras_libdata_by_id(gras_trp_libdata_id))->myport;