libatalk/dsi/dsi_stream.c

   1 /*
   2  * Copyright (c) 1998 Adrian Sun (asun@zoology.washington.edu)
   3  * All rights reserved. See COPYRIGHT.
   4  *
   5  * this file provides the following functions:
   6  * dsi_stream_write:    just write a bunch of bytes.
   7  * dsi_stream_read:     just read a bunch of bytes.
   8  * dsi_stream_send:     send a DSI header + data.
   9  * dsi_stream_receive:  read a DSI header + data.
  10  */
  11
  12 #ifdef HAVE_CONFIG_H
  13 #include "config.h"
  14 #endif /* HAVE_CONFIG_H */
  15
  16 #include <stdio.h>
  17 #include <stdlib.h>
  18
  19 #ifdef HAVE_UNISTD_H
  20 #include <unistd.h>
  21 #endif
  22
  23 #include <string.h>
  24 #include <errno.h>
  25 #include <sys/types.h>
  26 #include <sys/socket.h>
  27 #include <sys/uio.h>
  28
  29 #include <atalk/logger.h>
  30 #include <atalk/dsi.h>
  31 #include <netatalk/endian.h>
  32 #include <atalk/util.h>
  33
  34 #define min(a,b)  ((a) < (b) ? (a) : (b))
  35
  36 #ifndef MSG_MORE
  37 #define MSG_MORE 0x8000
  38 #endif
  39
  40 #ifndef MSG_DONTWAIT
  41 #define MSG_DONTWAIT 0x40
  42 #endif
  43
  44 /*
  45  * afpd is sleeping too much while trying to send something.
  46  * May be there's no reader or the reader is also sleeping in write,
  47  * look if there's some data for us to read, hopefully it will wake up
  48  * the reader so we can write again.
  49  *
  50  * @returns 0 when is possible to send again, -1 on error
  51  */
  52 static int dsi_peek(DSI *dsi)
  53 {
  54     static int warned = 0;
  55     fd_set readfds, writefds;
  56     int    len;
  57     int    maxfd;
  58     int    ret;
  59
  60     LOG(log_debug, logtype_dsi, "dsi_peek");
  61
  62     maxfd = dsi->socket + 1;
  63
  64     while (1) {
  65         FD_ZERO(&readfds);
  66         FD_ZERO(&writefds);
  67
  68         if (dsi->eof < dsi->end) {
  69             /* space in read buffer */
  70             FD_SET( dsi->socket, &readfds);
  71         } else {
  72             if (!warned) {
  73                 warned = 1;
  74                 LOG(log_note, logtype_dsi, "dsi_peek: readahead buffer is full, possibly increase -dsireadbuf option");
  75                 LOG(log_note, logtype_dsi, "dsi_peek: dsireadbuf: %d, DSI quantum: %d, effective buffer size: %d",
  76                     dsi->dsireadbuf,
  77                     dsi->server_quantum ? dsi->server_quantum : DSI_SERVQUANT_DEF,
  78                     dsi->end - dsi->buffer);
  79             }
  80         }
  81
  82         FD_SET( dsi->socket, &writefds);
  83
  84         /* No timeout: if there's nothing to read nor nothing to write,
  85          * we've got nothing to do at all */
  86         if ((ret = select( maxfd, &readfds, &writefds, NULL, NULL)) <= 0) {
  87             if (ret == -1 && errno == EINTR)
  88                 /* we might have been interrupted by out timer, so restart select */
  89                 continue;
  90             /* give up */
  91             LOG(log_error, logtype_dsi, "dsi_peek: unexpected select return: %d %s",
  92                 ret, ret < 0 ? strerror(errno) : "");
  93             return -1;
  94         }
  95
  96         if (FD_ISSET(dsi->socket, &writefds)) {
  97             /* we can write again */
  98             LOG(log_debug, logtype_dsi, "dsi_peek: can write again");
  99             break;
 100         }
 101
 102         /* Check if there's sth to read, hopefully reading that will unblock the client */
 103         if (FD_ISSET(dsi->socket, &readfds)) {
 104             len = dsi->end - dsi->eof; /* it's ensured above that there's space */
 105
 106             if ((len = read(dsi->socket, dsi->eof, len)) <= 0) {
 107                 if (len == 0) {
 108                     LOG(log_error, logtype_dsi, "dsi_peek: EOF");
 109                     return -1;
 110                 }
 111                 LOG(log_error, logtype_dsi, "dsi_peek: read: %s", strerror(errno));
 112                 if (errno == EAGAIN)
 113                     continue;
 114                 return -1;
 115             }
 116             LOG(log_debug, logtype_dsi, "dsi_peek: read %d bytes", len);
 117
 118             dsi->eof += len;
 119         }
 120     }
 121
 122     return 0;
 123 }
 124
 125 /* ------------------------------
 126  * write raw data. return actual bytes read. checks against EINTR
 127  * aren't necessary if all of the signals have SA_RESTART
 128  * specified. */
 129 ssize_t dsi_stream_write(DSI *dsi, void *data, const size_t length, int mode)
 130 {
 131   size_t written;
 132   ssize_t len;
 133   unsigned int flags = 0;
 134
 135   dsi->in_write++;
 136   written = 0;
 137
 138   LOG(log_maxdebug, logtype_dsi, "dsi_stream_write: sending %u bytes", length);
 139
 140   while (written < length) {
 141       len = send(dsi->socket, (u_int8_t *) data + written, length - written, flags);
 142       if (len >= 0) {
 143           written += len;
 144           continue;
 145       }
 146
 147       if (errno == EINTR)
 148           continue;
 149
 150       if (errno == EAGAIN || errno == EWOULDBLOCK) {
 151           LOG(log_debug, logtype_dsi, "dsi_stream_write: send: %s", strerror(errno));
 152
 153           if (mode == DSI_NOWAIT && written == 0) {
 154               /* DSI_NOWAIT is used by attention give up in this case. */
 155               written = -1;
 156               goto exit;
 157           }
 158
 159           /* Try to read sth. in order to break up possible deadlock */
 160           if (dsi_peek(dsi) != 0) {
 161               written = -1;
 162               goto exit;
 163           }
 164           /* Now try writing again */
 165           continue;
 166       }
 167
 168       LOG(log_error, logtype_dsi, "dsi_stream_write: %s", strerror(errno));
 169       written = -1;
 170       goto exit;
 171   }
 172
 173   dsi->write_count += written;
 174
 175 exit:
 176   dsi->in_write--;
 177   return written;
 178 }
 179
 180
 181 /* ---------------------------------
 182 */
 183 #ifdef WITH_SENDFILE
 184 ssize_t dsi_stream_read_file(DSI *dsi, int fromfd, off_t offset, const size_t length)
 185 {
 186   size_t written;
 187   ssize_t len;
 188
 189   LOG(log_maxdebug, logtype_dsi, "dsi_stream_read_file: sending %u bytes", length);
 190
 191   dsi->in_write++;
 192   written = 0;
 193
 194   while (written < length) {
 195     len = sys_sendfile(dsi->socket, fromfd, &offset, length - written);
 196
 197     if (len < 0) {
 198       if (errno == EINTR)
 199           continue;
 200       if (errno == EINVAL || errno == ENOSYS)
 201           return -1;
 202
 203       if (errno == EAGAIN || errno == EWOULDBLOCK) {
 204           if (dsi_peek(dsi)) {
 205               /* can't go back to blocking mode, exit, the next read
 206                  will return with an error and afpd will die.
 207               */
 208               break;
 209           }
 210           continue;
 211       }
 212       LOG(log_error, logtype_dsi, "dsi_stream_read_file: %s", strerror(errno));
 213       break;
 214     }
 215     else if (!len) {
 216         /* afpd is going to exit */
 217         errno = EIO;
 218         return -1; /* I think we're at EOF here... */
 219     }
 220     else
 221         written += len;
 222   }
 223
 224   dsi->write_count += written;
 225   dsi->in_write--;
 226   return written;
 227 }
 228 #endif
 229
 230 /*
 231  * Return all bytes up to count from dsi->buffer if there are any buffered there
 232  */
 233 static size_t from_buf(DSI *dsi, u_int8_t *buf, size_t count)
 234 {
 235     size_t nbe = 0;
 236
 237     if (dsi->buffer == NULL)
 238         /* afpd master has no DSI buffering */
 239         return 0;
 240
 241     LOG(log_maxdebug, logtype_dsi, "from_buf: %u bytes", count);
 242
 243     nbe = dsi->eof - dsi->start;
 244
 245     if (nbe > 0) {
 246         nbe = min((size_t)nbe, count);
 247         memcpy(buf, dsi->start, nbe);
 248         dsi->start += nbe;
 249
 250         if (dsi->eof == dsi->start)
 251             dsi->start = dsi->eof = dsi->buffer;
 252     }
 253
 254     LOG(log_debug, logtype_dsi, "from_buf(read: %u, unread:%u , space left: %u): returning %u",
 255         dsi->start - dsi->buffer, dsi->eof - dsi->start, dsi->end - dsi->eof, nbe);
 256
 257     return nbe;
 258 }
 259
 260 /*
 261  * Get bytes from buffer dsi->buffer or read from socket
 262  *
 263  * 1. Check if there are bytes in the the dsi->buffer buffer.
 264  * 2. Return bytes from (1) if yes.
 265  *    Note: this may return fewer bytes then requested in count !!
 266  * 3. If the buffer was empty, read from the socket.
 267  */
 268 static ssize_t buf_read(DSI *dsi, u_int8_t *buf, size_t count)
 269 {
 270     ssize_t len;
 271
 272     LOG(log_maxdebug, logtype_dsi, "buf_read(%u bytes)", count);
 273
 274     if (!count)
 275         return 0;
 276
 277     len = from_buf(dsi, buf, count); /* 1. */
 278     if (len)
 279         return len;             /* 2. */
 280
 281     len = readt(dsi->socket, buf, count, 0, 1); /* 3. */
 282
 283     LOG(log_maxdebug, logtype_dsi, "buf_read(%u bytes): got: %d", count, len);
 284
 285     return len;
 286 }
 287
 288 /*
 289  * Essentially a loop around buf_read() to ensure "length" bytes are read
 290  * from dsi->buffer and/or the socket.
 291  *
 292  * @returns length on success, some value smaller then length indicates an error
 293  */
 294 size_t dsi_stream_read(DSI *dsi, void *data, const size_t length)
 295 {
 296   size_t stored;
 297   ssize_t len;
 298
 299   LOG(log_maxdebug, logtype_dsi, "dsi_stream_read(%u bytes)", length);
 300
 301   stored = 0;
 302   while (stored < length) {
 303       len = buf_read(dsi, (u_int8_t *) data + stored, length - stored);
 304       if (len == -1 && (errno == EINTR || errno == EAGAIN)) {
 305           LOG(log_debug, logtype_dsi, "dsi_stream_read: select read loop");
 306           continue;
 307       } else if (len > 0) {
 308           stored += len;
 309       } else { /* eof or error */
 310           /* don't log EOF error if it's just after connect (OSX 10.3 probe) */
 311           if (len || stored || dsi->read_count) {
 312               if (! (dsi->flags & DSI_DISCONNECTED)) {
 313                   LOG(log_error, logtype_dsi, "dsi_stream_read: len:%d, %s",
 314                       len, (len < 0) ? strerror(errno) : "unexpected EOF");
 315               }
 316               return 0;
 317           }
 318           break;
 319       }
 320   }
 321
 322   dsi->read_count += stored;
 323
 324   LOG(log_maxdebug, logtype_dsi, "dsi_stream_read(%u bytes): got: %u", length, stored);
 325   return stored;
 326 }
 327
 328 /*
 329  * Get "length" bytes from buffer and/or socket. In order to avoid frequent small reads
 330  * this tries to read larger chunks (8192 bytes) into a buffer.
 331  */
 332 static size_t dsi_buffered_stream_read(DSI *dsi, u_int8_t *data, const size_t length)
 333 {
 334   size_t len;
 335   size_t buflen;
 336
 337   LOG(log_maxdebug, logtype_dsi, "dsi_buffered_stream_read: %u bytes", length);
 338
 339   len = from_buf(dsi, data, length); /* read from buffer dsi->buffer */
 340   dsi->read_count += len;
 341   if (len == length) {          /* got enough bytes from there ? */
 342       return len;               /* yes */
 343   }
 344
 345   /* fill the buffer with 8192 bytes or until buffer is full */
 346   buflen = min(8192, dsi->end - dsi->eof);
 347   if (buflen > 0) {
 348       ssize_t ret;
 349       ret = read(dsi->socket, dsi->eof, buflen);
 350       if (ret > 0)
 351           dsi->eof += ret;
 352   }
 353
 354   /* now get the remaining data */
 355   len += dsi_stream_read(dsi, data + len, length - len);
 356   return len;
 357 }
 358
 359 /* ---------------------------------------
 360 */
 361 static void block_sig(DSI *dsi)
 362 {
 363   dsi->in_write++;
 364 }
 365
 366 /* ---------------------------------------
 367 */
 368 static void unblock_sig(DSI *dsi)
 369 {
 370   dsi->in_write--;
 371 }
 372
 373 /* ---------------------------------------
 374  * write data. 0 on failure. this assumes that dsi_len will never
 375  * cause an overflow in the data buffer.
 376  */
 377 int dsi_stream_send(DSI *dsi, void *buf, size_t length)
 378 {
 379   char block[DSI_BLOCKSIZ];
 380   struct iovec iov[2];
 381   size_t towrite;
 382   ssize_t len;
 383
 384   LOG(log_maxdebug, logtype_dsi, "dsi_stream_send: %u bytes",
 385       length ? length : sizeof(block));
 386
 387   block[0] = dsi->header.dsi_flags;
 388   block[1] = dsi->header.dsi_command;
 389   memcpy(block + 2, &dsi->header.dsi_requestID,
 390          sizeof(dsi->header.dsi_requestID));
 391   memcpy(block + 4, &dsi->header.dsi_code, sizeof(dsi->header.dsi_code));
 392   memcpy(block + 8, &dsi->header.dsi_len, sizeof(dsi->header.dsi_len));
 393   memcpy(block + 12, &dsi->header.dsi_reserved,
 394          sizeof(dsi->header.dsi_reserved));
 395
 396   if (!length) { /* just write the header */
 397     length = (dsi_stream_write(dsi, block, sizeof(block), 0) == sizeof(block));
 398     return length; /* really 0 on failure, 1 on success */
 399   }
 400
 401   /* block signals */
 402   block_sig(dsi);
 403   iov[0].iov_base = block;
 404   iov[0].iov_len = sizeof(block);
 405   iov[1].iov_base = buf;
 406   iov[1].iov_len = length;
 407
 408   towrite = sizeof(block) + length;
 409   dsi->write_count += towrite;
 410   while (towrite > 0) {
 411       if (((len = writev(dsi->socket, iov, 2)) == -1 && errno == EINTR) || (len == 0))
 412           continue;
 413
 414       if ((size_t)len == towrite) /* wrote everything out */
 415           break;
 416       else if (len < 0) { /* error */
 417           if (errno == EAGAIN || errno == EWOULDBLOCK) {
 418               if (!dsi_peek(dsi)) {
 419                   continue;
 420               }
 421           }
 422           LOG(log_error, logtype_dsi, "dsi_stream_send: %s", strerror(errno));
 423           unblock_sig(dsi);
 424           return 0;
 425       }
 426
 427       towrite -= len;
 428       if (towrite > length) { /* skip part of header */
 429           iov[0].iov_base = (char *) iov[0].iov_base + len;
 430           iov[0].iov_len -= len;
 431       } else { /* skip to data */
 432           if (iov[0].iov_len) {
 433               len -= iov[0].iov_len;
 434               iov[0].iov_len = 0;
 435           }
 436           iov[1].iov_base = (char *) iov[1].iov_base + len;
 437           iov[1].iov_len -= len;
 438       }
 439   }
 440
 441   unblock_sig(dsi);
 442   return 1;
 443 }
 444
 445
 446 /* ---------------------------------------
 447  * read data. function on success. 0 on failure. data length gets
 448  * stored in length variable. this should really use size_t's, but
 449  * that would require changes elsewhere. */
 450 int dsi_stream_receive(DSI *dsi, void *buf, const size_t ilength,
 451                        size_t *rlength)
 452 {
 453   char block[DSI_BLOCKSIZ];
 454
 455   LOG(log_maxdebug, logtype_dsi, "dsi_stream_receive: %u bytes", ilength);
 456
 457   /* read in the header */
 458   if (dsi_buffered_stream_read(dsi, (u_int8_t *)block, sizeof(block)) != sizeof(block))
 459     return 0;
 460
 461   dsi->header.dsi_flags = block[0];
 462   dsi->header.dsi_command = block[1];
 463   /* FIXME, not the right place,
 464      but we get a server disconnect without reason in the log
 465   */
 466   if (!block[1]) {
 467       LOG(log_error, logtype_dsi, "dsi_stream_receive: invalid packet, fatal");
 468       return 0;
 469   }
 470
 471   memcpy(&dsi->header.dsi_requestID, block + 2,
 472          sizeof(dsi->header.dsi_requestID));
 473   memcpy(&dsi->header.dsi_code, block + 4, sizeof(dsi->header.dsi_code));
 474   memcpy(&dsi->header.dsi_len, block + 8, sizeof(dsi->header.dsi_len));
 475   memcpy(&dsi->header.dsi_reserved, block + 12,
 476          sizeof(dsi->header.dsi_reserved));
 477   dsi->clientID = ntohs(dsi->header.dsi_requestID);
 478
 479   /* make sure we don't over-write our buffers. */
 480   *rlength = min(ntohl(dsi->header.dsi_len), ilength);
 481   if (dsi_stream_read(dsi, buf, *rlength) != *rlength)
 482     return 0;
 483
 484   return block[1];
 485 }