src/gras/Transport/transport_interface.h

   1 /* $Id$ */
   2
   3 /* transport - low level communication (send/receive bunches of bytes)      */
   4
   5 /* module's public interface exported within GRAS, but not to end user.     */
   6
   7 /* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
   8
   9 /* This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the license (GNU LGPL) which comes with this package. */
  11
  12 #ifndef GRAS_TRP_INTERFACE_H
  13 #define GRAS_TRP_INTERFACE_H
  14
  15 #include "portable.h"           /* sometimes needed for fd_set */
  16 #include "simix/simix.h"
  17 #include "xbt/queue.h"
  18
  19 /***
  20  *** Options
  21  ***/
  22 extern int gras_opt_trp_nomoredata_on_close;
  23
  24 /***
  25  *** Main user functions
  26  ***/
  27 /* stable if we know the storage will keep as is until the next trp_flush */
  28 XBT_PUBLIC(void) gras_trp_send(gras_socket_t sd, char *data, long int size,
  29                                int stable);
  30 XBT_PUBLIC(void) gras_trp_recv(gras_socket_t sd, char *data, long int size);
  31 XBT_PUBLIC(void) gras_trp_flush(gras_socket_t sd);
  32
  33 /* Find which socket needs to be read next */
  34 XBT_PUBLIC(gras_socket_t) gras_trp_select(double timeout);
  35
  36 /* Set the peer process name (used by messaging layer) */
  37 XBT_PUBLIC(void) gras_socket_peer_proc_set(gras_socket_t sock,
  38                                            char *peer_proc);
  39
  40 /***
  41  *** Plugin mechanism
  42  ***/
  43
  44 /* A plugin type */
  45      typedef struct gras_trp_plugin_ s_gras_trp_plugin_t, *gras_trp_plugin_t;
  46
  47 /* A plugin type */
  48      struct gras_trp_plugin_ {
  49        char *name;
  50
  51        /* dst pointers are created and initialized with default values
  52           before call to socket_client/server.
  53           Retrive the info you need from there. */
  54        void (*socket_client) (gras_trp_plugin_t self, gras_socket_t dst);
  55        void (*socket_server) (gras_trp_plugin_t self, gras_socket_t dst);
  56
  57        gras_socket_t(*socket_accept) (gras_socket_t from);
  58
  59
  60        /* socket_close() is responsible of telling the OS that the socket is over,
  61           but should not free the socket itself (beside the specific part) */
  62        void (*socket_close) (gras_socket_t sd);
  63
  64        /* send/recv may be buffered */
  65        void (*send) (gras_socket_t sd,
  66                      const char *data,
  67                      unsigned long int size,
  68                      int stable /* storage will survive until flush */ );
  69        int (*recv) (gras_socket_t sd, char *data, unsigned long int size);
  70        /* raw_send/raw_recv is never buffered (use it for measurement stuff) */
  71        void (*raw_send) (gras_socket_t sd,
  72                          const char *data, unsigned long int size);
  73        int (*raw_recv) (gras_socket_t sd, char *data, unsigned long int size);
  74
  75        /* flush has to make sure that the pending communications are achieved */
  76        void (*flush) (gras_socket_t sd);
  77
  78        void *data;              /* plugin-specific data */
  79
  80        /* exit is responsible for freeing data and telling to the OS that
  81           this plugin is gone */
  82        /* exit=NULL, data gets brutally free()d by the generic interface.
  83           (ie exit function needed only when data contains pointers) */
  84        void (*exit) (gras_trp_plugin_t);
  85      };
  86
  87 XBT_PUBLIC(gras_trp_plugin_t)
  88   gras_trp_plugin_get_by_name(const char *name);
  89
  90 /* Data of this module specific to each process
  91  * (used by sg_process.c to cleanup the SG channel cruft)
  92  */
  93      typedef struct {
  94        /* set headers */
  95        unsigned int ID;
  96        char *name;
  97        unsigned int name_len;
  98
  99        int myport;              /* Port on which I listen myself */
 100
 101        xbt_dynar_t sockets;     /* all sockets known to this process */
 102        xbt_dynar_t comms; /* SG cruft: the ongoing communications */
 103        xbt_dynar_t sockets_to_close; /* The listener is in charge of closing the sockets */
 104
 105      } s_gras_trp_procdata_t, *gras_trp_procdata_t;
 106
 107 /* Display the content of our socket set (debugging purpose) */
 108 XBT_PUBLIC(void) gras_trp_socketset_dump(const char *name);
 109
 110 #endif /* GRAS_TRP_INTERFACE_H */