3 /* buf trp (transport) - buffered transport using the TCP one */
5 /* Copyright (c) 2004 Martin Quinson. All rights reserved. */
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. */
11 #include <string.h> /* memset */
15 #include "xbt/sysdep.h"
17 #include "transport_private.h"
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(trp_buf,transport,
20 "Generic buffered transport (works on top of TCP or Files, but not SG)");
23 static gras_trp_plugin_t _buf_super;
28 void hexa_print(const char*name, unsigned char *data, int size); /* in gras.c */
30 void gras_trp_buf_socket_client(gras_trp_plugin_t self,
32 void gras_trp_buf_socket_server(gras_trp_plugin_t self,
34 gras_socket_t gras_trp_buf_socket_accept(gras_socket_t sock);
36 void gras_trp_buf_socket_close(gras_socket_t sd);
38 void gras_trp_buf_chunk_send(gras_socket_t sd,
40 unsigned long int size);
42 void gras_trp_buf_chunk_recv(gras_socket_t sd,
44 unsigned long int size,
45 unsigned long int bufsize);
46 void gras_trp_buf_flush(gras_socket_t sock);
50 *** Specific plugin part
55 } gras_trp_buf_plug_data_t;
58 *** Specific socket part
64 int pos; /* for receive; not exchanged over the net */
67 struct gras_trp_bufdata_{
73 void gras_trp_buf_init_sock(gras_socket_t sock) {
74 gras_trp_bufdata_t *data=xbt_new(gras_trp_bufdata_t,1);
77 data->buffsize = 100 * 1024 ; /* 100k */
80 data->in.data = xbt_malloc(data->buffsize);
81 data->in.pos = 0; /* useless, indeed, since size==pos */
83 /* In SG, the 4 first bytes are for the chunk size as htonl'ed, so that we can send it in one shoot.
84 * This is mandatory in SG because all emissions go to the same channel, so if we split them,
85 * they can get mixed. */
87 data->out.data = xbt_malloc(data->buffsize);
88 data->out.pos = data->out.size;
97 gras_trp_buf_setup(gras_trp_plugin_t plug) {
98 gras_trp_buf_plug_data_t *data =xbt_new(gras_trp_buf_plug_data_t,1);
101 _buf_super = gras_trp_plugin_get_by_name("tcp");
103 DEBUG1("Derivate a buffer plugin from %s","tcp");
105 plug->socket_client = gras_trp_buf_socket_client;
106 plug->socket_server = gras_trp_buf_socket_server;
107 plug->socket_accept = gras_trp_buf_socket_accept;
108 plug->socket_close = gras_trp_buf_socket_close;
110 plug->chunk_send = gras_trp_buf_chunk_send;
111 plug->chunk_recv = gras_trp_buf_chunk_recv;
113 plug->flush = gras_trp_buf_flush;
115 plug->data = (void*)data;
119 void gras_trp_buf_socket_client(gras_trp_plugin_t self,
120 /* OUT */ gras_socket_t sock){
123 _buf_super->socket_client(_buf_super,sock);
125 gras_trp_buf_init_sock(sock);
129 * gras_trp_buf_socket_server:
131 * Open a socket used to receive messages.
133 void gras_trp_buf_socket_server(gras_trp_plugin_t self,
134 /* OUT */ gras_socket_t sock){
137 _buf_super->socket_server(_buf_super,sock);
139 gras_trp_buf_init_sock(sock);
143 gras_trp_buf_socket_accept(gras_socket_t sock) {
148 res = _buf_super->socket_accept(sock);
149 res->plugin = sock->plugin;
150 gras_trp_buf_init_sock(res);
155 void gras_trp_buf_socket_close(gras_socket_t sock){
156 gras_trp_bufdata_t *data=sock->bufdata;
159 if (data->in.size!=data->in.pos) {
160 WARN3("Socket closed, but %d bytes were unread (size=%d,pos=%d)",
161 data->in.size - data->in.pos,data->in.size, data->in.pos);
164 if (data->out.size!=data->out.pos) {
165 DEBUG2("Flush the socket before closing (in=%d,out=%d)",data->in.size, data->out.size);
166 gras_trp_buf_flush(sock);
172 free(data->out.data);
175 _buf_super->socket_close(sock);
179 * gras_trp_buf_chunk_send:
181 * Send data on a buffered socket
184 gras_trp_buf_chunk_send(gras_socket_t sock,
186 unsigned long int size) {
188 gras_trp_bufdata_t *data=(gras_trp_bufdata_t*)sock->bufdata;
192 /* Let underneath plugin check for direction, we work even in duplex */
193 xbt_assert0(size >= 0, "Cannot send a negative amount of data");
195 while (chunk_pos < size) {
196 /* size of the chunck to receive in that shot */
197 long int thissize = min(size-chunk_pos,data->buffsize - data->out.size);
198 DEBUG5("Set the chars %d..%ld into the buffer (size=%ld, ctn='%.*s')",
200 ((int)data->out.size) + thissize -1,
201 size, chunk_pos, chunk);
203 memcpy(data->out.data + data->out.size, chunk + chunk_pos, thissize);
205 data->out.size += thissize;
206 chunk_pos += thissize;
207 DEBUG5("New pos = %d; Still to send = %ld of %ld; ctn sofar='%.*s'",
208 data->out.size,size-chunk_pos,size,(int)chunk_pos,chunk);
210 if (data->out.size == data->buffsize) /* out of space. Flush it */
211 gras_trp_buf_flush(sock);
218 * gras_trp_buf_chunk_recv:
220 * Receive data on a buffered socket.
223 gras_trp_buf_chunk_recv(gras_socket_t sock,
225 unsigned long int size,
226 unsigned long int bufsize) {
229 gras_trp_bufdata_t *data=sock->bufdata;
230 long int chunck_pos = 0;
232 /* Let underneath plugin check for direction, we work even in duplex */
233 xbt_assert0(sock, "Cannot recv on an NULL socket");
234 xbt_assert0(size >= 0, "Cannot receive a negative amount of data");
238 while (chunck_pos < size) {
239 /* size of the chunck to receive in that shot */
242 if (data->in.size == data->in.pos) { /* out of data. Get more */
244 DEBUG0("Recv the size");
246 _buf_super->chunk_recv(sock,(char*)&nextsize, 4,4);
248 RETHROW3("Unable to get the chunk size on %p (peer = %s:%d): %s",
249 sock,gras_socket_peer_name(sock),gras_socket_peer_port(sock));
251 data->in.size = (int)ntohl(nextsize);
252 VERB1("Recv the chunk (size=%d)",data->in.size);
254 _buf_super->chunk_recv(sock, data->in.data, data->in.size, data->in.size);
259 thissize = min(size-chunck_pos , data->in.size - data->in.pos);
260 DEBUG2("Get the chars %d..%ld out of the buffer",
262 data->in.pos + thissize - 1);
263 memcpy(chunk+chunck_pos, data->in.data + data->in.pos, thissize);
265 data->in.pos += thissize;
266 chunck_pos += thissize;
267 DEBUG5("New pos = %d; Still to receive = %ld of %ld. Ctn so far='%.*s'",
268 data->in.pos,size - chunck_pos,size,(int)chunck_pos,chunk);
275 * gras_trp_buf_flush:
277 * Make sure the data is sent
280 gras_trp_buf_flush(gras_socket_t sock) {
282 gras_trp_bufdata_t *data=sock->bufdata;
286 if (XBT_LOG_ISENABLED(trp_buf,xbt_log_priority_debug))
287 hexa_print("chunck to send ",(unsigned char *) data->out.data,data->out.size);
288 if ((data->out.size - data->out.pos) == 0) {
289 DEBUG2("Nothing to flush (size=%d; pos=%d)",data->out.size,data->out.pos);
293 size = (int)data->out.size - data->out.pos;
294 DEBUG3("Send the size (=%d) to %s:%d",data->out.size-data->out.pos,
295 gras_socket_peer_name(sock),gras_socket_peer_port(sock));
296 size = (int)htonl(size);
297 _buf_super->chunk_send(sock,(char*) &size, 4);
300 DEBUG3("Send the chunk (size=%d) to %s:%d",data->out.size,
301 gras_socket_peer_name(sock),gras_socket_peer_port(sock));
302 _buf_super->chunk_send(sock, data->out.data, data->out.size);
303 VERB1("Chunk sent (size=%d)",data->out.size);
304 if (XBT_LOG_ISENABLED(trp_buf,xbt_log_priority_debug))
305 hexa_print("chunck sent ",(unsigned char *) data->out.data,data->out.size);