3 /* transport - low level communication (send/receive bunches of bytes) */
5 /* module's public interface exported within GRAS, but not to end user. */
7 /* Copyright (c) 2004 Martin Quinson. All rights reserved. */
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. */
12 #ifndef GRAS_TRP_INTERFACE_H
13 #define GRAS_TRP_INTERFACE_H
15 #include "portable.h" /* sometimes needed for fd_set */
16 #include "simix/simix.h"
17 #include "xbt/queue.h"
22 extern int gras_opt_trp_nomoredata_on_close;
25 *** Main user functions
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,
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);
33 /* Find which socket needs to be read next */
34 XBT_PUBLIC(gras_socket_t) gras_trp_select(double timeout);
36 /* Set the peer process name (used by messaging layer) */
37 XBT_PUBLIC(void) gras_socket_peer_proc_set(gras_socket_t sock,
45 typedef struct gras_trp_plugin_ s_gras_trp_plugin_t, *gras_trp_plugin_t;
48 struct gras_trp_plugin_ {
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);
57 gras_socket_t(*socket_accept) (gras_socket_t from);
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);
64 /* send/recv may be buffered */
65 void (*send) (gras_socket_t sd,
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);
75 /* flush has to make sure that the pending communications are achieved */
76 void (*flush) (gras_socket_t sd);
78 void *data; /* plugin-specific data */
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);
87 XBT_PUBLIC(gras_trp_plugin_t)
88 gras_trp_plugin_get_by_name(const char *name);
90 /* Data of this module specific to each process
91 * (used by sg_process.c to cleanup the SG channel cruft)
97 unsigned int name_len;
99 int myport; /* Port on which I listen myself */
101 xbt_dynar_t sockets; /* all sockets known to this process */
103 /* SG only elements. In RL, they are part of the OS ;) */
105 /* List of sockets ready to be select()ed */
106 xbt_queue_t msg_selectable_sockets; /* regular sockets */
107 xbt_queue_t meas_selectable_sockets; /* measurement ones */
109 } s_gras_trp_procdata_t, *gras_trp_procdata_t;
111 /* Display the content of our socket set (debugging purpose) */
112 XBT_PUBLIC(void) gras_trp_socketset_dump(const char *name);
114 #endif /* GRAS_TRP_INTERFACE_H */