Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Partial fix of GRAS: gras-ping-sg now works again
[simgrid.git] / src / gras / Transport / transport_interface.h
index b606cf7..d59cef1 100644 (file)
@@ -1,10 +1,9 @@
-/* $Id$ */
-
 /* transport - low level communication (send/receive bunches of bytes)      */
 
 /* module's public interface exported within GRAS, but not to end user.     */
 
-/* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
+/* Copyright (c) 2004, 2005, 2006, 2007, 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. */
@@ -12,7 +11,9 @@
 #ifndef GRAS_TRP_INTERFACE_H
 #define GRAS_TRP_INTERFACE_H
 
-#include "portable.h" /* sometimes needed for fd_set */
+#include "portable.h"           /* sometimes needed for fd_set */
+#include "simix/simix.h"
+#include "xbt/queue.h"
 
 /***
  *** Options
@@ -23,15 +24,18 @@ extern int gras_opt_trp_nomoredata_on_close;
  *** Main user functions
  ***/
 /* stable if we know the storage will keep as is until the next trp_flush */
-void gras_trp_send(gras_socket_t sd, char *data, long int size, int stable);
-void gras_trp_recv(gras_socket_t sd, char *data, long int size);
-void gras_trp_flush(gras_socket_t sd);
+XBT_PUBLIC(void) gras_trp_send(gras_socket_t sd, char *data, long int size,
+                               int stable);
+XBT_PUBLIC(void) gras_trp_recv(gras_socket_t sd, char *data,
+                               long int size);
+XBT_PUBLIC(void) gras_trp_flush(gras_socket_t sd);
 
 /* Find which socket needs to be read next */
-gras_socket_t gras_trp_select(double timeout);
+XBT_PUBLIC(gras_socket_t) gras_trp_select(double timeout);
 
 /* Set the peer process name (used by messaging layer) */
-void gras_socket_peer_proc_set(gras_socket_t sock,char*peer_proc);
+XBT_PUBLIC(void) gras_socket_peer_proc_set(gras_socket_t sock,
+                                           char *peer_proc);
 
 /***
  *** Plugin mechanism 
@@ -42,51 +46,53 @@ typedef struct gras_trp_plugin_ s_gras_trp_plugin_t, *gras_trp_plugin_t;
 
 /* A plugin type */
 struct gras_trp_plugin_ {
-  char          *name;
+  char *name;
+
   /* dst pointers are created and initialized with default values
      before call to socket_client/server. 
      Retrive the info you need from there. */
-  void (*socket_client)(gras_trp_plugin_t self,
-                       gras_socket_t    dst);
-  void (*socket_server)(gras_trp_plugin_t self,
-                       gras_socket_t    dst);
-   
-  gras_socket_t (*socket_accept)(gras_socket_t  from);
-   
-   
-   /* socket_close() is responsible of telling the OS that the socket is over,
-    but should not free the socket itself (beside the specific part) */
-  void (*socket_close)(gras_socket_t sd);
-    
+  void (*socket_client) (gras_trp_plugin_t self,const char *host,int port, gras_socket_t dst);
+  void (*socket_server) (gras_trp_plugin_t self, int port,gras_socket_t dst);
+
+  gras_socket_t(*socket_accept) (gras_socket_t from);
+
+  /* Getting info about who's speaking */
+  int (*my_port)(gras_socket_t sd);
+  int (*peer_port)(gras_socket_t sd);
+  const char* (*peer_name)(gras_socket_t sd);
+  const char* (*peer_proc)(gras_socket_t sd);
+  void (*peer_proc_set)(gras_socket_t sd,char*peer_proc);
+
+
+  /* socket_close() is responsible of telling the OS that the socket is over,
+     but should not free the socket itself (beside the specific part) */
+  void (*socket_close) (gras_socket_t sd);
+
   /* send/recv may be buffered */
-  void (*send)(gras_socket_t sd,
-              const char *data,
-              unsigned long int size,
-              int stable /* storage will survive until flush*/);
-  int (*recv)(gras_socket_t sd,
-             char *data,
-             unsigned long int size);
+  void (*send) (gras_socket_t sd,
+                const char *data,
+                unsigned long int size,
+                int stable /* storage will survive until flush */ );
+  int (*recv) (gras_socket_t sd, char *data, unsigned long int size);
   /* raw_send/raw_recv is never buffered (use it for measurement stuff) */
-  void (*raw_send)(gras_socket_t sd,
-                  const char *data,
-                  unsigned long int size);
-  int (*raw_recv)(gras_socket_t sd,
-                 char *data,
-                 unsigned long int size);
+  void (*raw_send) (gras_socket_t sd,
+                    const char *data, unsigned long int size);
+  int (*raw_recv) (gras_socket_t sd, char *data, unsigned long int size);
 
   /* flush has to make sure that the pending communications are achieved */
-  void (*flush)(gras_socket_t sd);
+  void (*flush) (gras_socket_t sd);
+
+  void *data;                   /* plugin-specific data */
 
-  void *data; /* plugin-specific data */
-   /* exit is responsible for freeing data and telling the OS this plugin goes */
-   /* exit=NULL, data gets freed. (ie exit function needed only when data contains pointers) */
-  void (*exit)(gras_trp_plugin_t);
+  /* exit is responsible for freeing data and telling to the OS that 
+     this plugin is gone */
+  /* exit=NULL, data gets brutally free()d by the generic interface. 
+     (ie exit function needed only when data contains pointers) */
+  void (*exit) (gras_trp_plugin_t);
 };
 
-gras_trp_plugin_t
-gras_trp_plugin_get_by_name(const char *name);
+XBT_PUBLIC(gras_trp_plugin_t)
+    gras_trp_plugin_get_by_name(const char *name);
 
 /* Data of this module specific to each process
  * (used by sg_process.c to cleanup the SG channel cruft)
@@ -94,20 +100,22 @@ gras_trp_plugin_get_by_name(const char *name);
 typedef struct {
   /* set headers */
   unsigned int ID;
-  char        *name;
+  char *name;
   unsigned int name_len;
 
-  xbt_dynar_t sockets; /* all sockets known to this process */
-  int myport; /* Port on which I listen myself */
-  fd_set *fdset;
+  int myport;                   /* Port on which I listen myself */
+
+  xbt_dynar_t sockets;          /* all sockets known to this process */
 
   /* SG only elements. In RL, they are part of the OS ;) */
-  int chan;    /* Formated messages channel */
-  int measChan; /* Unformated echange channel for performance measurement*/
-   
-} s_gras_trp_procdata_t,*gras_trp_procdata_t;
+
+  /* List of sockets ready to be select()ed */
+  xbt_queue_t msg_selectable_sockets;   /* regular sockets  */
+  xbt_queue_t meas_selectable_sockets;  /* measurement ones */
+
+} s_gras_trp_procdata_t, *gras_trp_procdata_t;
 
 /* Display the content of our socket set (debugging purpose) */
-void gras_trp_socketset_dump(const char *name);
+XBT_PUBLIC(void) gras_trp_socketset_dump(const char *name);
 
-#endif /* GRAS_TRP_INTERFACE_H */
+#endif                          /* GRAS_TRP_INTERFACE_H */