src/gras/Transport/transport_private.h

   1 /* $Id$ */
   2
   3 /* transport - low level communication (send/receive bunches of bytes)      */
   4
   5 /* module's private interface masked even to other parts of GRAS.           */
   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_PRIVATE_H
  13 #define GRAS_TRP_PRIVATE_H
  14
  15 #include "xbt/sysdep.h"
  16 #include "xbt/log.h"
  17 #include "xbt/dynar.h"
  18 #include "xbt/dict.h"
  19
  20 #include "gras/emul.h"       /* gras_if_RL() */
  21
  22 #include "gras_modinter.h"   /* module init/exit */
  23 #include "gras/transport.h"  /* rest of module interface */
  24
  25 #include "gras/Transport/transport_interface.h" /* semi-public API */
  26 #include "gras/Virtu/virtu_interface.h" /* libdata management */
  27
  28 extern int gras_trp_libdata_id; /* our libdata identifier */
  29
  30 /* The function that select returned the last time we asked. We need this because the TCP read
  31    are greedy and try to get as much data in their buffer as possible (to avoid subsequent syscalls).
  32    (measurement sockets are not buffered and thus not concerned).
  33
  34    So, we can get more than one message in one shoot. And when this happens, we have to handle
  35    the same socket again afterward without select()ing at all.
  36
  37    Then, this data is not a static of the TCP driver because we want to zero it when
  38    it gets closed by the user. If not, we use an already freed pointer, which is bad.
  39
  40    It gets tricky since gras_socket_close is part of the common API, not only the RL one. */
  41 extern gras_socket_t _gras_lastly_selected_socket;
  42
  43 /**
  44  * s_gras_socket:
  45  *
  46  * Description of a socket.
  47  */
  48 typedef struct gras_trp_bufdata_ gras_trp_bufdata_t;
  49
  50 typedef struct s_gras_socket  {
  51   gras_trp_plugin_t plugin;
  52
  53   int incoming :1; /* true if we can read from this sock */
  54   int outgoing :1; /* true if we can write on this sock */
  55   int accepting :1; /* true if master incoming sock in tcp */
  56   int meas :1; /* true if this is an experiment socket instead of messaging */
  57   int recv_ok :1; /* true if it is valid to recv() on the socket (false if it is a file) */
  58   int valid :1; /* false if a select returned that the peer quitted, forcing us to "close" the socket */
  59   int moredata :1; /* TCP socket use a buffer and read operation get as much data as possible.
  60                       It is possible that several messages are received in one shoot, and select won't catch them afterward again.
  61                       This boolean indicates that this is the case, so that we don't call select in that case.
  62                       Note that measurement sockets are not concerned since they use the TCP interface directly, with no buffer. */
  63
  64   unsigned long int buf_size; /* what to say to the OS. field here to remember it when accepting */
  65
  66   int  sd;
  67   int  port; /* port on this side */
  68   int  peer_port; /* port on the other side */
  69   char *peer_name; /* hostname of the other side */
  70   char *peer_proc; /* process on the other side */
  71
  72   void *data;    /* plugin specific data */
  73
  74   /* buffer plugin specific data. Yeah, C is not OO, so I got to trick */
  75   gras_trp_bufdata_t *bufdata;
  76 }s_gras_socket_t;
  77
  78 void gras_trp_socket_new(int incomming,
  79                          gras_socket_t *dst);
  80
  81 /* The drivers */
  82 typedef void (*gras_trp_setup_t)(gras_trp_plugin_t dst);
  83
  84 void gras_trp_tcp_setup(gras_trp_plugin_t plug);
  85 void gras_trp_iov_setup(gras_trp_plugin_t plug);
  86 void gras_trp_file_setup(gras_trp_plugin_t plug);
  87 void gras_trp_sg_setup(gras_trp_plugin_t plug);
  88
  89 /*
  90
  91   I'm tired of that shit. the select in SG has to create a socket to expeditor
  92   manually do deal with the weirdness of the hostdata, themselves here to deal
  93   with the weird channel concept of SG and convert them back to ports.
  94
  95   When introducing buffered transport (which I want to get used in SG to debug
  96   the buffering itself), we should not make the rest of the code aware of the
  97   change and not specify code for this. This is bad design.
  98
  99   But there is bad design all over the place, so fuck off for now, when we can
 100   get rid of MSG and rely directly on SG, this crude hack can go away. But in
 101   the meanwhile, I want to sleep this night (FIXME).
 102
 103   Hu! You evil problem! Taste my axe!
 104
 105 */
 106
 107 gras_socket_t gras_trp_buf_init_sock(gras_socket_t sock);
 108
 109 #endif /* GRAS_TRP_PRIVATE_H */