src/gras/Transport/transport_plugin_file.c

   1 /* $Id$ */
   2
   3 /* File transport - send/receive a bunch of bytes from a file               */
   4
   5 /* Copyright (c) 2004 Martin Quinson. 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 #include "portable.h"
  11 #include "gras/Transport/transport_private.h"
  12 #include "xbt/ex.h"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_trp_file,gras_trp,
  15         "Pseudo-transport to write to/read from a file");
  16
  17 /***
  18  *** Prototypes
  19  ***/
  20 void gras_trp_file_close(gras_socket_t sd);
  21
  22 void gras_trp_file_chunk_send_raw(gras_socket_t sd,
  23                                   const char *data,
  24                                   unsigned long int size);
  25 void gras_trp_file_chunk_send(gras_socket_t sd,
  26                               const char *data,
  27                               unsigned long int size,
  28                               int stable_ignored);
  29
  30 int gras_trp_file_chunk_recv(gras_socket_t sd,
  31                              char *data,
  32                              unsigned long int size);
  33
  34 /***
  35  *** Specific plugin part
  36  ***/
  37
  38 typedef struct {
  39   fd_set incoming_socks;
  40 } gras_trp_file_plug_data_t;
  41
  42 /***
  43  *** Specific socket part
  44  ***/
  45
  46
  47
  48 /***
  49  *** Code
  50  ***/
  51 void
  52 gras_trp_file_setup(gras_trp_plugin_t plug) {
  53
  54   gras_trp_file_plug_data_t *file = xbt_new(gras_trp_file_plug_data_t,1);
  55
  56   FD_ZERO(&(file->incoming_socks));
  57
  58   plug->socket_close = gras_trp_file_close;
  59
  60   plug->raw_send = gras_trp_file_chunk_send_raw;
  61   plug->send = gras_trp_file_chunk_send;
  62
  63   plug->raw_recv = plug->recv = gras_trp_file_chunk_recv;
  64
  65   plug->data         = (void*)file;
  66 }
  67
  68 /**
  69  * gras_socket_client_from_file:
  70  *
  71  * Create a client socket from a file path.
  72  *
  73  * This only possible in RL, and is mainly for debugging.
  74  */
  75 gras_socket_t
  76 gras_socket_client_from_file(const char*path) {
  77   gras_socket_t res;
  78
  79   xbt_assert0(gras_if_RL(),
  80                "Cannot use file as socket in the simulator");
  81
  82   gras_trp_socket_new(0,&res);
  83
  84   res->plugin=gras_trp_plugin_get_by_name("file");
  85
  86   if (strcmp("-", path)) {
  87     res->sd = open(path, O_WRONLY|O_CREAT | O_BINARY, S_IRUSR|S_IWUSR|S_IRGRP );
  88
  89     if ( res->sd < 0) {
  90       THROW2(system_error,0,
  91              "Cannot create a client socket from file %s: %s",
  92              path, strerror(errno));
  93     }
  94   } else {
  95     res->sd = 1; /* stdout */
  96   }
  97
  98   DEBUG5("sock_client_from_file(%s): sd=%d in=%c out=%c accept=%c",
  99          path,
 100          res->sd,
 101          res->incoming?'y':'n',
 102          res->outgoing?'y':'n',
 103          res->accepting?'y':'n');
 104
 105   xbt_dynar_push(((gras_trp_procdata_t)
 106                   gras_libdata_by_id(gras_trp_libdata_id))->sockets,&res);
 107   return res;
 108 }
 109
 110 /**
 111  * gras_socket_server_from_file:
 112  *
 113  * Create a server socket from a file path.
 114  *
 115  * This only possible in RL, and is mainly for debugging.
 116  */
 117 gras_socket_t gras_socket_server_from_file(const char*path) {
 118   gras_socket_t res;
 119
 120   xbt_assert0(gras_if_RL(),
 121                "Cannot use file as socket in the simulator");
 122
 123   gras_trp_socket_new(1,&res);
 124
 125   res->plugin=gras_trp_plugin_get_by_name("file");
 126
 127
 128   if (strcmp("-", path)) {
 129     res->sd = open(path, O_RDONLY | O_BINARY);
 130
 131     if ( res->sd < 0) {
 132       THROW2(system_error,0,
 133              "Cannot create a server socket from file %s: %s",
 134              path, strerror(errno));
 135     }
 136   } else {
 137     res->sd = 0; /* stdin */
 138   }
 139
 140   DEBUG4("sd=%d in=%c out=%c accept=%c",
 141          res->sd,
 142          res->incoming?'y':'n',
 143          res->outgoing?'y':'n',
 144          res->accepting?'y':'n');
 145
 146   xbt_dynar_push(((gras_trp_procdata_t)
 147                   gras_libdata_by_id(gras_trp_libdata_id))->sockets,&res);
 148   return res;
 149 }
 150
 151 void gras_trp_file_close(gras_socket_t sock){
 152   gras_trp_file_plug_data_t *data;
 153
 154   if (!sock) return; /* close only once */
 155   data=sock->plugin->data;
 156
 157   if (sock->sd == 0) {
 158     DEBUG0("Do not close stdin");
 159   } else if (sock->sd == 1) {
 160     DEBUG0("Do not close stdout");
 161   } else {
 162     DEBUG1("close file connection %d", sock->sd);
 163
 164     /* forget about the socket */
 165     FD_CLR(sock->sd, &(data->incoming_socks));
 166
 167     /* close the socket */
 168     if(close(sock->sd) < 0) {
 169       WARN2("error while closing file %d: %s",
 170                sock->sd, strerror(errno));
 171     }
 172   }
 173 }
 174
 175 /**
 176  * gras_trp_file_chunk_send:
 177  *
 178  * Send data on a file pseudo-socket
 179  */
 180 void
 181 gras_trp_file_chunk_send(gras_socket_t sock,
 182                          const char *data,
 183                          unsigned long int size,
 184                          int stable_ignored) {
 185   gras_trp_file_chunk_send_raw(sock,data,size);
 186 }
 187 void
 188 gras_trp_file_chunk_send_raw(gras_socket_t sock,
 189                              const char *data,
 190                              unsigned long int size) {
 191
 192   xbt_assert0(sock->outgoing, "Cannot write on client file socket");
 193   xbt_assert0(size >= 0, "Cannot send a negative amount of data");
 194
 195   while (size) {
 196     int status = 0;
 197
 198     DEBUG3("write(%d, %p, %ld);", sock->sd, data, (long int)size);
 199     status = write(sock->sd, data, (long int)size);
 200
 201     if (status == -1) {
 202       THROW4(system_error,0,"write(%d,%p,%d) failed: %s",
 203              sock->sd, data, (int)size,
 204              strerror(errno));
 205     }
 206
 207     if (status) {
 208       size  -= status;
 209       data  += status;
 210     } else {
 211       THROW0(system_error,0,"file descriptor closed");
 212     }
 213   }
 214 }
 215 /**
 216  * gras_trp_file_chunk_recv:
 217  *
 218  * Receive data on a file pseudo-socket.
 219  */
 220 int
 221 gras_trp_file_chunk_recv(gras_socket_t sock,
 222                          char *data,
 223                          unsigned long int size) {
 224
 225   int got = 0;
 226
 227   xbt_assert0(sock, "Cannot recv on an NULL socket");
 228   xbt_assert0(sock->incoming, "Cannot recv on client file socket");
 229   xbt_assert0(size >= 0, "Cannot receive a negative amount of data");
 230
 231   if (sock->recvd) {
 232      data[0] = sock->recvd_val;
 233      sock->recvd = 0;
 234      got++;
 235      size--;
 236   }
 237
 238   while (size) {
 239     int status = 0;
 240
 241     status = read(sock->sd, data+got, (long int)size);
 242     DEBUG3("read(%d, %p, %ld);", sock->sd, data+got, size);
 243
 244     if (status < 0) {
 245       THROW4(system_error,0,"read(%d,%p,%d) failed: %s",
 246              sock->sd, data+got, (int)size,
 247              strerror(errno));
 248     }
 249
 250     if (status) {
 251       size    -= status;
 252       got    += status;
 253     } else {
 254        THROW1(system_error,errno,"file descriptor closed after %d bytes",got);
 255     }
 256   }
 257   return got;
 258 }
 259