include/gras/messages.h

   1 /* messaging - high level communication (send/receive messages)             */
   2 /* module's public interface exported to end user.                          */
   3
   4 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
   5  * All rights reserved.                                                     */
   6
   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. */
   9
  10 #ifndef GRAS_MESSAGES_H
  11 #define GRAS_MESSAGES_H
  12
  13 #include "gras/transport.h"
  14 #include "xbt/datadesc.h"
  15 #include "xbt/socket.h"
  16
  17 SG_BEGIN_DECL()
  18
  19 /** @addtogroup GRAS_msg
  20  *  @brief Defining messages and callbacks, and exchanging messages
  21  *
  22  *  There is two way to receive messages in GRAS. The first one is to
  23  *  register a given function as callback to a given type of messages (see
  24  *  \ref gras_cb_register and associated section). But you can also
  25  *  explicitely wait for a given message with the \ref gras_msg_wait
  26  *  function.
  27  *
  28  *  Usually, both ways are not intended to be mixed of a given type of
  29  *  messages. But if you do so, it shouldn't trigger any issue.  If the
  30  *  message arrives when gras_msg_wait is blocked, then it will be routed to
  31  *  it. If it arrives when before or after \ref gras_msg_wait, it will be
  32  *  passed to the callback.
  33  *
  34  *  For an example of use, please refer to \ref GRAS_ex_ping. The archive
  35  *  contains much more examples, but their are not properly integrated into
  36  *  this documentation yet.
  37  */
  38 /** @defgroup GRAS_msg_decl Message declaration and retrival
  39  *  @ingroup  GRAS_msg
  40  *
  41  *  GRAS messages can only accept one type of payload. See \ref GRAS_dd for
  42  *  more information on how to describe data in GRAS.
  43  *
  44  *  If you absolutely want use a message able to convey several datatypes,
  45  *  you can always say that it conveys a generic reference (see
  46  *  \ref xbt_datadesc_ref_generic).
  47  *
  48  *  In order to ease the upgrade of GRAS applications, it is possible to \e
  49  *  version the messages, ie to add a version number to the message (by
  50  *  default, the version is set to 0). Any messages of the wrong version will
  51  *  be ignored by the applications not providing any specific callback for
  52  *  them.
  53  *
  54  *  This mechanism (stolen from the dynamic loader one) should ensure you to
  55  *  change the semantic of a given message while still understanding the old
  56  *  one.
  57  */
  58 /** @{ */
  59 /** \brief Opaque type */
  60 typedef struct s_gras_msgtype *gras_msgtype_t;
  61
  62 XBT_PUBLIC(void) gras_msgtype_declare(const char *name,
  63                                       xbt_datadesc_type_t payload);
  64 XBT_PUBLIC(void) gras_msgtype_declare_v(const char *name,
  65                                         short int version,
  66                                         xbt_datadesc_type_t payload);
  67
  68 XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_name(const char *name);
  69 XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_name_or_null(const char *name);
  70 XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_namev(const char *name,
  71                                                  short int version);
  72 XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_id(int id);
  73 XBT_PUBLIC(const char *) gras_msgtype_get_name(gras_msgtype_t type);
  74
  75 XBT_PUBLIC(void) gras_msgtype_dumpall(void);
  76
  77
  78 /** @} */
  79 /** @defgroup GRAS_msg_cb Callback declaration and use
  80  *  @ingroup  GRAS_msg
  81  *
  82  *
  83  * This is how to register a given function so that it gets called when a
  84  * given type of message arrives.
  85  *
  86  * You can register several callbacks to the same kind of messages, and
  87  * they will get stacked. The lastly added callback gets the message first.
  88  * If it consumes the message, it should return a true value when done. If
  89  * not, it should return 0, and the message will be passed to the second
  90  * callback of the stack, if any.
  91  *
  92  * @{
  93  */
  94
  95   /** \brief Context of callbacks (opaque structure, created by the middleware only, never by user) */
  96 typedef struct s_gras_msg_cb_ctx *gras_msg_cb_ctx_t;
  97
  98 XBT_PUBLIC(void) gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx);
  99 XBT_PUBLIC(xbt_socket_t) gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx);
 100
 101   /** \brief Type of message callback functions.
 102    *
 103    * \param expeditor: a socket to contact who sent this message
 104    * \param payload: the message itself
 105    *
 106    * \return true if the message was consumed by the callback,
 107    *  false if the message was refused by the callback (and should be
 108    *  passed to the next callback of the stack for this message)
 109    *
 110    * Once a such a function is registered to handle messages of a given
 111    * type with \ref gras_cb_register(), it will be called each time such
 112    * a message arrives (unless a gras_msg_wait() intercepts it on arrival).
 113    *
 114    * If the callback accepts the message, it should free it after use.
 115    */
 116 typedef int (*gras_msg_cb_t) (gras_msg_cb_ctx_t ctx, void *payload);
 117
 118  /**
 119   * @brief Bind the given callback to the given message type (described by its name)
 120   * @hideinitializer
 121   *
 122   * Several callbacks can be attached to a given message type. The lastly added one will get the message first, and
 123   * if it returns a non-null value, the message will be passed to the second one.
 124   * And so on until one of the callbacks accepts the message.
 125   *
 126   * Using gras_cb_register is a bit slower than using gras_cb_register_ since GRAS
 127   * has to search for the given msgtype in the hash table, but you don't care in most case.
 128   */
 129 #define gras_cb_register(msgtype_name, cb)   gras_cb_register_(gras_msgtype_by_name(msgtype_name),cb)
 130
 131  /**
 132   * @brief Unbind the given callback to the given message type (described by its name)
 133   * @hideinitializer
 134   *
 135   * Using gras_cb_unregister is a bit slower than using gras_cb_unregister_ since GRAS
 136   * has to search for the given msgtype in the hash table, but you don't care in most case.
 137   */
 138 #define gras_cb_unregister(msgtype_name, cb) gras_cb_unregister_(gras_msgtype_by_name(msgtype_name),cb)
 139
 140 XBT_PUBLIC(void) gras_cb_register_(gras_msgtype_t msgtype,
 141                                    gras_msg_cb_t cb);
 142 XBT_PUBLIC(void) gras_cb_unregister_(gras_msgtype_t msgtype,
 143                                      gras_msg_cb_t cb);
 144
 145 /** @} */
 146
 147 /** @defgroup GRAS_msg_exchange Message exchange
 148  *  @ingroup  GRAS_msg
 149  *
 150  */
 151 /** @{ */
 152
 153 /** \brief Send the data pointed by \a payload as a message \a msgname on the \a sock
 154  *  @hideinitializer
 155  *
 156  * Using gras_msg_wait() is a bit slower than using gras_msg_wait_() since GRAS
 157  * has to search for the given msgtype in the hash table.
 158  */
 159 #define gras_msg_send(sock,name,payload) gras_msg_send_(sock,gras_msgtype_by_name(name),payload)
 160 XBT_PUBLIC(void) gras_msg_send_(xbt_socket_t sock,
 161                                 gras_msgtype_t msgtype, void *payload);
 162
 163 /** \brief Waits for a message to come in over a given socket
 164  *  @hideinitializer
 165  * @param timeout: How long should we wait for this message.
 166  * @param msgt_want: type of awaited msg
 167  * @param[out] expeditor: where to create a socket to answer the incomming message
 168  * @param[out] payload: where to write the payload of the incomming message
 169  * @return the error code (or no_error).
 170  *
 171  * Every message of another type received before the one waited will be queued
 172  * and used by subsequent call to this function or gras_msg_handle().
 173  *
 174  * Using gras_msg_wait() is a bit slower than using gras_msg_wait_() since GRAS
 175  * has to search for the given msgtype in the hash table.
 176  */
 177
 178 #define gras_msg_wait(timeout,msgt_want,expeditor,payload) gras_msg_wait_(timeout,gras_msgtype_by_name(msgt_want),expeditor,payload)
 179 XBT_PUBLIC(void) gras_msg_wait_(double timeout,
 180                                 gras_msgtype_t msgt_want,
 181                                 xbt_socket_t * expeditor, void *payload);
 182 XBT_PUBLIC(void) gras_msg_handleall(double period);
 183 XBT_PUBLIC(void) gras_msg_handle(double timeOut);
 184
 185 /** @} */
 186
 187 /** @defgroup GRAS_msg_rpc RPC specific functions
 188  *  @ingroup  GRAS_msg
 189  *
 190  * Remote Procedure Call (RPC) are a classical mecanism to request a service
 191  * from a remote host. Using this set of functions, you let GRAS doing most of
 192  * the work of sending the request, wait for an answer, make sure it is the
 193  * right answer from the right host and so on.  Any exception raised on the
 194  * server is also passed over the network to the client.
 195  *
 196  * Callbacks are attached to RPC incomming messages the regular way using
 197  * \ref gras_cb_register.
 198  *
 199  * For an example of use, check the examples/gras/rpc directory of the distribution.
 200  */
 201 /** @{ */
 202
 203 /* declaration */
 204 XBT_PUBLIC(void) gras_msgtype_declare_rpc(const char *name,
 205                                           xbt_datadesc_type_t
 206                                           payload_request,
 207                                           xbt_datadesc_type_t
 208                                           payload_answer);
 209
 210 XBT_PUBLIC(void) gras_msgtype_declare_rpc_v(const char *name,
 211                                             short int version,
 212                                             xbt_datadesc_type_t
 213                                             payload_request,
 214                                             xbt_datadesc_type_t
 215                                             payload_answer);
 216
 217 /* client side */
 218
 219 /** @brief Conduct a RPC call
 220  *  @hideinitializer
 221  */
 222 #define gras_msg_rpccall(server,timeout,msg,req,ans) gras_msg_rpccall_(server,timeout,gras_msgtype_by_name(msg),req,ans)
 223 XBT_PUBLIC(void) gras_msg_rpccall_(xbt_socket_t server,
 224                                    double timeOut,
 225                                    gras_msgtype_t msgtype,
 226                                    void *request, void *answer);
 227 XBT_PUBLIC(gras_msg_cb_ctx_t)
 228
 229 /** @brief Launch a RPC call, but do not block for the answer
 230  *  @hideinitializer
 231  */
 232 #define gras_msg_rpc_async_call(server,timeout,msg,req) gras_msg_rpc_async_call_(server,timeout,gras_msgtype_by_name(msg),req)
 233     gras_msg_rpc_async_call_(xbt_socket_t server,
 234                          double timeOut,
 235                          gras_msgtype_t msgtype, void *request);
 236 XBT_PUBLIC(void) gras_msg_rpc_async_wait(gras_msg_cb_ctx_t ctx,
 237                                          void *answer);
 238
 239 /* server side */
 240 XBT_PUBLIC(void) gras_msg_rpcreturn(double timeOut, gras_msg_cb_ctx_t ctx,
 241                                     void *answer);
 242
 243
 244 /** @} */
 245
 246 /** @defgroup GRAS_msg_exchangeadv Message exchange (advanced interface)
 247  *  @ingroup  GRAS_msg
 248  *
 249  */
 250 /** @{ */
 251
 252 /** @brief Message kind (internal enum) */
 253 typedef enum {
 254   e_gras_msg_kind_unknown = 0,
 255
 256   e_gras_msg_kind_oneway = 1,
 257                                /**< good old regular messages */
 258
 259   e_gras_msg_kind_rpccall = 2,
 260                                /**< RPC request */
 261   /* HACK: e_gras_msg_kind_rpccall also designate RPC message *type* in
 262      msgtype_t, not only in msg_t */
 263   e_gras_msg_kind_rpcanswer = 3,
 264                                /**< RPC successful answer */
 265   e_gras_msg_kind_rpcerror = 4,
 266                                /**< RPC failure on server (payload=exception); should not leak to user-space */
 267
 268   /* future:
 269      call cancel, and others
 270      even after:
 271      forwarding request and other application level routing stuff
 272      group communication
 273    */
 274
 275   e_gras_msg_kind_count = 5     /* sentinel, dont mess with */
 276 } e_gras_msg_kind_t;
 277
 278
 279 /** @brief Message instance (internal struct) */
 280 typedef struct {
 281   xbt_socket_t expe;
 282   e_gras_msg_kind_t kind;
 283   gras_msgtype_t type;
 284   unsigned long int ID;
 285   void *payl;
 286   int payl_size;
 287 } s_gras_msg_t, *gras_msg_t;
 288
 289 typedef int (*gras_msg_filter_t) (gras_msg_t msg, void *ctx);
 290
 291 #define gras_msg_wait_ext(timeout, msg, expe, filter, fctx,got) gras_msg_wait_ext_(timeout, gras_msgtype_by_name(msg), expe, filter, fctx,got)
 292 XBT_PUBLIC(void) gras_msg_wait_ext_(double timeout,
 293                                     gras_msgtype_t msgt_want,
 294                                     xbt_socket_t expe_want,
 295                                     gras_msg_filter_t filter,
 296                                     void *filter_ctx, gras_msg_t msg_got);
 297
 298 XBT_PUBLIC(void) gras_msg_wait_or(double timeout,
 299                                   xbt_dynar_t msgt_want,
 300                                   gras_msg_cb_ctx_t * ctx,
 301                                   int *msgt_got, void *payload);
 302
 303
 304 /* @} */
 305
 306 SG_END_DECL()
 307 #endif                          /* GRAS_MSG_H */