-/* $Id$ */
-
/* transport - low level communication */
-/* Authors: Martin Quinson */
-/* Copyright (C) 2004 Martin Quinson. */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
- under the terms of the license (GNU LGPL) which comes with this package. */
-
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+/***
+ *** Options
+ ***/
+#ifndef NDEBUG
+static int gras_opt_trp_nomoredata_on_close = 0;
+#endif
+
+#include "xbt/ex.h"
+#include "xbt/peer.h"
+#include "xbt/socket.h"
+#include "xbt/xbt_socket_private.h" /* FIXME */
+#include "portable.h"
#include "gras/Transport/transport_private.h"
+#include "gras/Msg/msg_interface.h"
-GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(transport,gras,"Conveying bytes over the network");
-
-static gras_dict_t *_gras_trp_plugins; /* All registered plugins */
-static void gras_trp_plugin_free(void *p); /* free one of the plugins */
-
-static void gras_trp_socket_free(void *s); /* free one socket */
-
-static void
-gras_trp_plugin_new(const char *name, gras_trp_setup_t setup) {
- gras_error_t errcode;
-
- gras_trp_plugin_t *plug = gras_new0(gras_trp_plugin_t, 1);
-
- DEBUG1("Create plugin %s",name);
-
- plug->name=gras_strdup(name);
-
- errcode = setup(plug);
- switch (errcode) {
- case mismatch_error:
- /* SG plugin return mismatch when in RL mode (and vice versa) */
- gras_free(plug->name);
- gras_free(plug);
- break;
-
- case no_error:
- gras_dict_set(_gras_trp_plugins,
- name, plug, gras_trp_plugin_free);
- break;
-
- default:
- DIE_IMPOSSIBLE;
- }
-
-}
-
-void
-gras_trp_init(void){
-
- /* make room for all plugins */
- gras_dict_new(&_gras_trp_plugins);
-
- /* Add them */
- gras_trp_plugin_new("tcp", gras_trp_tcp_setup);
- gras_trp_plugin_new("file",gras_trp_file_setup);
- gras_trp_plugin_new("sg",gras_trp_sg_setup);
-
- /* buf is composed, so it must come after the others */
- gras_trp_plugin_new("buf", gras_trp_buf_setup);
-
-}
-
-void
-gras_trp_exit(void){
- gras_dict_free(&_gras_trp_plugins);
-}
-
-
-void gras_trp_plugin_free(void *p) {
- gras_trp_plugin_t *plug = p;
-
- if (plug) {
- if (plug->exit) {
- plug->exit(plug);
- } else if (plug->data) {
- DEBUG1("Plugin %s lacks exit(). Free data anyway.",plug->name);
- gras_free(plug->data);
- }
-
- gras_free(plug->name);
- gras_free(plug);
- }
-}
-
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_trp, gras,
+ "Conveying bytes over the network");
/**
- * gras_trp_socket_new:
+ * @brief Opens a server socket and makes it ready to be listened to.
+ * @param port: port on which you want to listen
+ * @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)
+ * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
*
- * Malloc a new socket, and initialize it with defaults
+ * In real life, you'll get a TCP socket.
*/
-void gras_trp_socket_new(int incoming,
- gras_socket_t **dst) {
-
- gras_socket_t *sock=gras_new(gras_socket_t,1);
-
- DEBUG1("Create a new socket (%p)", (void*)sock);
+xbt_socket_t
+gras_socket_server_ext(unsigned short port,
+ unsigned long int buf_size, int measurement)
+{
+ xbt_trp_plugin_t trp;
+ xbt_socket_t sock;
- sock->plugin = NULL;
- sock->sd = -1;
- sock->data = NULL;
+ XBT_DEBUG("Create a server socket from plugin %s on port %d",
+ gras_if_RL() ? "tcp" : "sg", port);
+ trp = xbt_trp_plugin_get_by_name(gras_if_SG() ? "sg" : "tcp");
- sock->incoming = incoming ? 1:0;
- sock->outgoing = incoming ? 0:1;
- sock->accepting = incoming ? 1:0;
+ /* defaults settings */
+ xbt_socket_new_ext(1,
+ &sock,
+ trp,
+ (buf_size > 0 ? buf_size : 32 * 1024),
+ measurement);
- sock->port = -1;
- sock->peer_port = -1;
- sock->peer_name = NULL;
- sock->raw = 0;
+ /* Call plugin socket creation function */
+ XBT_DEBUG("Prepare socket with plugin (fct=%p)", trp->socket_server);
+ TRY {
+ trp->socket_server(trp, port, sock);
+ }
+ CATCH_ANONYMOUS {
+ free(sock);
+ RETHROW;
+ }
- *dst = sock;
+ if (!measurement)
+ ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->myport
+ = port;
+ xbt_dynar_push(((gras_trp_procdata_t)
+ gras_libdata_by_id(gras_trp_libdata_id))->sockets,
+ &sock);
- gras_dynar_push(gras_socketset_get(),dst);
+ gras_msg_listener_awake();
+ return sock;
}
-
/**
- * gras_socket_server_ext:
+ * @brief Opens a server socket on any port in the given range
*
- * Opens a server socket and make it ready to be listened to.
- * In real life, you'll get a TCP socket.
+ * @param minport: first port we will try
+ * @param maxport: last port we will try
+ * @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)
+ * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
+ *
+ * If none of the provided ports works, raises the exception got when trying the last possibility
*/
-gras_error_t
-gras_socket_server_ext(unsigned short port,
-
- unsigned long int bufSize,
- int raw,
-
- /* OUT */ gras_socket_t **dst) {
-
- gras_error_t errcode;
- gras_trp_plugin_t *trp;
- gras_socket_t *sock;
-
- *dst = NULL;
-
- DEBUG1("Create a server socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
- TRY(gras_trp_plugin_get_by_name("buf",&trp));
-
- /* defaults settings */
- gras_trp_socket_new(1,&sock);
- sock->plugin= trp;
- sock->port=port;
- sock->bufSize = bufSize;
- sock->raw = raw;
-
- /* Call plugin socket creation function */
- errcode = trp->socket_server(trp, sock);
- DEBUG3("in=%c out=%c accept=%c",
- sock->incoming?'y':'n',
- sock->outgoing?'y':'n',
- sock->accepting?'y':'n');
-
- if (errcode != no_error) {
- gras_free(sock);
- return errcode;
+xbt_socket_t
+gras_socket_server_range(unsigned short minport, unsigned short maxport,
+ unsigned long int buf_size, int measurement)
+{
+
+ int port;
+ xbt_socket_t res = NULL;
+ xbt_ex_t e;
+
+ for (port = minport; port < maxport; port++) {
+ TRY {
+ res = gras_socket_server_ext(port, buf_size, measurement);
+ }
+ CATCH(e) {
+ if (port == maxport)
+ RETHROW;
+ xbt_ex_free(e);
+ }
+ if (res)
+ return res;
}
-
- *dst = sock;
-
- return no_error;
+ THROW_IMPOSSIBLE;
}
-
+
/**
- * gras_socket_client_ext:
+ * @brief Opens a client socket to a remote host.
+ * @param host: who you want to connect to
+ * @param port: where you want to connect to on this host
+ * @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)
+ * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
*
- * Opens a client socket to a remote host.
* In real life, you'll get a TCP socket.
*/
-gras_error_t
+xbt_socket_t
gras_socket_client_ext(const char *host,
- unsigned short port,
-
- unsigned long int bufSize,
- int raw,
-
- /* OUT */ gras_socket_t **dst) {
-
- gras_error_t errcode;
- gras_trp_plugin_t *trp;
- gras_socket_t *sock;
-
- *dst = NULL;
-
- TRY(gras_trp_plugin_get_by_name("buf",&trp));
-
- DEBUG1("Create a client socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
+ unsigned short port,
+ unsigned long int buf_size, int measurement)
+{
+ xbt_trp_plugin_t trp;
+ xbt_socket_t sock;
+
+ trp = xbt_trp_plugin_get_by_name(gras_if_SG() ? "sg" : "tcp");
+
+ XBT_DEBUG("Create a client socket from plugin %s",
+ gras_if_RL()? "tcp" : "sg");
/* defaults settings */
- gras_trp_socket_new(0,&sock);
- sock->plugin= trp;
- sock->peer_port = port;
- sock->peer_name = (char*)strdup(host?host:"localhost");
- sock->bufSize = bufSize;
- sock->raw = raw;
+ xbt_socket_new_ext(0,
+ &sock,
+ trp,
+ (buf_size > 0 ? buf_size : 32 * 1024),
+ measurement);
/* plugin-specific */
- errcode= (*trp->socket_client)(trp, sock);
- DEBUG3("in=%c out=%c accept=%c",
- sock->incoming?'y':'n',
- sock->outgoing?'y':'n',
- sock->accepting?'y':'n');
-
- if (errcode != no_error) {
- gras_free(sock);
- return errcode;
+ TRY {
+ (*trp->socket_client) (trp, host, port, sock);
}
-
- *dst = sock;
-
- return no_error;
+ CATCH_ANONYMOUS {
+ free(sock);
+ RETHROW;
+ }
+ xbt_dynar_push(((gras_trp_procdata_t)
+ gras_libdata_by_id(gras_trp_libdata_id))->sockets,
+ &sock);
+ gras_msg_listener_awake();
+ return sock;
}
/**
- * gras_socket_server:
+ * @brief Opens a server socket and make it ready to be listened to.
*
- * Opens a server socket and make it ready to be listened to.
* In real life, you'll get a TCP socket.
*/
-gras_error_t
-gras_socket_server(unsigned short port,
- /* OUT */ gras_socket_t **dst) {
- return gras_socket_server_ext(port,32,0,dst);
+xbt_socket_t gras_socket_server(unsigned short port)
+{
+ return gras_socket_server_ext(port, 32 * 1024, 0);
}
-/**
- * gras_socket_client:
- *
- * Opens a client socket to a remote host.
- * In real life, you'll get a TCP socket.
- */
-gras_error_t
-gras_socket_client(const char *host,
- unsigned short port,
- /* OUT */ gras_socket_t **dst) {
- return gras_socket_client_ext(host,port,32,0,dst);
+/** @brief Opens a client socket to a remote host */
+xbt_socket_t gras_socket_client(const char *host, unsigned short port)
+{
+ return gras_socket_client_ext(host, port, 0, 0);
}
+/** @brief Opens a client socket to a remote host specified as '\a host:\a port' */
+xbt_socket_t gras_socket_client_from_string(const char *host)
+{
+ xbt_peer_t p = xbt_peer_from_string(host);
+ xbt_socket_t res = gras_socket_client_ext(p->name, p->port, 0, 0);
+ xbt_peer_free(p);
+ return res;
+}
-void gras_socket_close(gras_socket_t *sock) {
- gras_dynar_t *sockets = gras_socketset_get();
- gras_socket_t *sock_iter;
- int cursor;
+void gras_socket_close_voidp(void *sock)
+{
+ gras_socket_close((xbt_socket_t) sock);
+}
+
+/** \brief Close socket */
+void gras_socket_close(xbt_socket_t sock)
+{
+ if (--sock->refcount)
+ return;
+
+ xbt_dynar_t sockets =
+ ((gras_trp_procdata_t)
+ gras_libdata_by_id(gras_trp_libdata_id))->sockets;
+ xbt_socket_t sock_iter = NULL;
+ unsigned int cursor;
+
+ XBT_IN("");
+ XBT_VERB("Close %p", sock);
+ if (sock == _gras_lastly_selected_socket) {
+ xbt_assert(!gras_opt_trp_nomoredata_on_close || !sock->moredata,
+ "Closing a socket having more data in buffer while the nomoredata_on_close option is activated");
+
+ if (sock->moredata)
+ XBT_CRITICAL
+ ("Closing a socket having more data in buffer. Option nomoredata_on_close disabled, so continuing.");
+ _gras_lastly_selected_socket = NULL;
+ }
/* FIXME: Issue an event when the socket is closed */
+ XBT_DEBUG("sockets pointer before %p", sockets);
if (sock) {
- gras_dynar_foreach(sockets,cursor,sock_iter) {
+ /* FIXME: Cannot get the dynar mutex, because it can be already locked */
+// _xbt_dynar_foreach(sockets,cursor,sock_iter) {
+ for (cursor = 0; cursor < xbt_dynar_length(sockets); cursor++) {
+ _xbt_dynar_cursor_get(sockets, cursor, &sock_iter);
if (sock == sock_iter) {
- gras_dynar_cursor_rm(sockets,&cursor);
- if ( sock->plugin->socket_close)
- (* sock->plugin->socket_close)(sock);
-
- /* free the memory */
- if (sock->peer_name)
- gras_free(sock->peer_name);
- gras_free(sock);
- return;
+ XBT_DEBUG("remove sock cursor %u dize %lu\n", cursor,
+ xbt_dynar_length(sockets));
+ xbt_dynar_cursor_rm(sockets, &cursor);
+ if (sock->plugin->socket_close)
+ (*sock->plugin->socket_close) (sock);
+
+ /* free the memory */
+ free(sock);
+ XBT_OUT();
+ return;
}
}
- WARN0("Ignoring request to free an unknown socket");
+ XBT_WARN
+ ("Ignoring request to free an unknown socket (%p). Execution stack:",
+ sock);
+ xbt_backtrace_display_current();
}
+ XBT_OUT();
}
-/**
- * gras_trp_chunk_send:
- *
- * Send a bunch of bytes from on socket
- */
-gras_error_t
-gras_trp_chunk_send(gras_socket_t *sd,
- char *data,
- long int size) {
- gras_assert1(sd->outgoing,
- "Socket not suited for data send (outgoing=%c)",
- sd->outgoing?'y':'n');
- gras_assert1(sd->plugin->chunk_send,
- "No function chunk_send on transport plugin %s",
- sd->plugin->name);
- return (*sd->plugin->chunk_send)(sd,data,size);
-}
-/**
- * gras_trp_chunk_recv:
- *
- * Receive a bunch of bytes from a socket
+/*
+ * Creating procdata for this module
*/
-gras_error_t
-gras_trp_chunk_recv(gras_socket_t *sd,
- char *data,
- long int size) {
- gras_assert0(sd->incoming,
- "Socket not suited for data receive");
- gras_assert1(sd->plugin->chunk_recv,
- "No function chunk_recv on transport plugin %s",
- sd->plugin->name);
- return (sd->plugin->chunk_recv)(sd,data,size);
+static void *gras_trp_procdata_new(void)
+{
+ gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t, 1);
+
+ res->name = xbt_strdup("gras_trp");
+ res->name_len = 0;
+ res->sockets = xbt_dynar_new_sync(sizeof(xbt_socket_t *), NULL);
+ res->myport = 0;
+
+ return (void *) res;
}
-/**
- * gras_trp_flush:
- *
- * Make sure all pending communications are done
+/*
+ * Freeing procdata for this module
*/
-gras_error_t
-gras_trp_flush(gras_socket_t *sd) {
- return (sd->plugin->flush)(sd);
+static void gras_trp_procdata_free(void *data)
+{
+ gras_trp_procdata_t res = (gras_trp_procdata_t) data;
+
+ xbt_dynar_free(&(res->sockets));
+ free(res->name);
+ free(res);
}
-gras_error_t
-gras_trp_plugin_get_by_name(const char *name,
- gras_trp_plugin_t **dst){
+void gras_trp_socketset_dump(const char *name)
+{
+ gras_trp_procdata_t procdata =
+ (gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id);
- return gras_dict_get(_gras_trp_plugins,name,(void**)dst);
-}
+ unsigned int it;
+ xbt_socket_t s;
-int gras_socket_my_port (gras_socket_t *sock) {
- return sock->port;
-}
-int gras_socket_peer_port(gras_socket_t *sock) {
- return sock->peer_port;
-}
-char *gras_socket_peer_name(gras_socket_t *sock) {
- return sock->peer_name;
+ XBT_INFO("** Dump the socket set %s", name);
+ xbt_dynar_foreach(procdata->sockets, it, s) {
+ XBT_INFO(" %p -> %s:%d %s",
+ s, xbt_socket_peer_name(s), xbt_socket_peer_port(s),
+ s->valid ? "(valid)" : "(peer dead)");
+ }
+ XBT_INFO("** End of socket set %s", name);
}
-gras_error_t gras_socket_raw_send(gras_socket_t *peer,
- unsigned int timeout,
- unsigned long int expSize,
- unsigned long int msgSize) {
-
- gras_assert0(peer->raw,"Asked to send raw data on a regular socket\n");
- return gras_socket_raw_exchange(peer,1,timeout,expSize,msgSize);
+/*
+ * Module registration
+ */
+int gras_trp_libdata_id;
+void gras_trp_register()
+{
+ gras_trp_libdata_id =
+ gras_procdata_add("gras_trp", gras_trp_procdata_new,
+ gras_trp_procdata_free);
}
-gras_error_t gras_socket_raw_recv(gras_socket_t *peer,
- unsigned int timeout,
- unsigned long int expSize,
- unsigned long int msgSize){
-
- gras_assert0(peer->raw,"Asked to recveive raw data on a regular socket\n");
- return gras_socket_raw_exchange(peer,0,timeout,expSize,msgSize);
+int gras_os_myport(void)
+{
+ return ((gras_trp_procdata_t)
+ gras_libdata_by_id(gras_trp_libdata_id))->myport;
}
