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  * Return all bytes up to count from dsi->buffer if there are any buffered there
 127  */
 128 static size_t from_buf(DSI *dsi, u_int8_t *buf, size_t count)
 129 {
 130     size_t nbe = 0;
 131
 132     if (dsi->buffer == NULL)
 133         /* afpd master has no DSI buffering */
 134         return 0;
 135
 136     LOG(log_maxdebug, logtype_dsi, "from_buf: %u bytes", count);
 137
 138     nbe = dsi->eof - dsi->start;
 139
 140     if (nbe > 0) {
 141         nbe = min((size_t)nbe, count);
 142         memcpy(buf, dsi->start, nbe);
 143         dsi->start += nbe;
 144
 145         if (dsi->eof == dsi->start)
 146             dsi->start = dsi->eof = dsi->buffer;
 147     }
 148
 149     LOG(log_debug, logtype_dsi, "from_buf(read: %u, unread:%u , space left: %u): returning %u",
 150         dsi->start - dsi->buffer, dsi->eof - dsi->start, dsi->end - dsi->eof, nbe);
 151
 152     return nbe;
 153 }
 154
 155 /*
 156  * Get bytes from buffer dsi->buffer or read from socket
 157  *
 158  * 1. Check if there are bytes in the the dsi->buffer buffer.
 159  * 2. Return bytes from (1) if yes.
 160  *    Note: this may return fewer bytes then requested in count !!
 161  * 3. If the buffer was empty, read from the socket.
 162  */
 163 static ssize_t buf_read(DSI *dsi, u_int8_t *buf, size_t count)
 164 {
 165     ssize_t len;
 166
 167     LOG(log_maxdebug, logtype_dsi, "buf_read(%u bytes)", count);
 168
 169     if (!count)
 170         return 0;
 171
 172     len = from_buf(dsi, buf, count); /* 1. */
 173     if (len)
 174         return len;             /* 2. */
 175
 176     len = readt(dsi->socket, buf, count, 0, 1); /* 3. */
 177
 178     LOG(log_maxdebug, logtype_dsi, "buf_read(%u bytes): got: %d", count, len);
 179
 180     return len;
 181 }
 182
 183 /*
 184  * Get "length" bytes from buffer and/or socket. In order to avoid frequent small reads
 185  * this tries to read larger chunks (8192 bytes) into a buffer.
 186  */
 187 static size_t dsi_buffered_stream_read(DSI *dsi, u_int8_t *data, const size_t length)
 188 {
 189   size_t len;
 190   size_t buflen;
 191
 192   LOG(log_maxdebug, logtype_dsi, "dsi_buffered_stream_read: %u bytes", length);
 193
 194   len = from_buf(dsi, data, length); /* read from buffer dsi->buffer */
 195   dsi->read_count += len;
 196   if (len == length) {          /* got enough bytes from there ? */
 197       return len;               /* yes */
 198   }
 199
 200   /* fill the buffer with 8192 bytes or until buffer is full */
 201   buflen = min(8192, dsi->end - dsi->eof);
 202   if (buflen > 0) {
 203       ssize_t ret;
 204       ret = read(dsi->socket, dsi->eof, buflen);
 205       if (ret > 0)
 206           dsi->eof += ret;
 207   }
 208
 209   /* now get the remaining data */
 210   if ((buflen = dsi_stream_read(dsi, data + len, length - len)) != length - len)
 211       return 0;
 212   len += buflen;
 213
 214   return len;
 215 }
 216
 217 /* ---------------------------------------
 218 */
 219 static void block_sig(DSI *dsi)
 220 {
 221   dsi->in_write++;
 222 }
 223
 224 /* ---------------------------------------
 225 */
 226 static void unblock_sig(DSI *dsi)
 227 {
 228   dsi->in_write--;
 229 }
 230
 231 /*********************************************************************************
 232  * Public functions
 233  *********************************************************************************/
 234
 235 /*!
 236  * Communication error with the client, enter disconnected state
 237  *
 238  * 1. close the socket
 239  * 2. set the DSI_DISCONNECTED flag, remove possible sleep flags
 240  *
 241  * @returns  0 if successfully entered disconnected state
 242  *          -1 if ppid is 1 which means afpd master died
 243  *             or euid == 0 ie where still running as root (unauthenticated session)
 244  */
 245 int dsi_disconnect(DSI *dsi)
 246 {
 247     LOG(log_note, logtype_dsi, "dsi_disconnect: entering disconnected state");
 248     dsi->proto_close(dsi);          /* 1 */
 249     dsi->flags &= ~(DSI_SLEEPING | DSI_EXTSLEEP); /* 2 */
 250     dsi->flags |= DSI_DISCONNECTED;
 251     if (geteuid() == 0)
 252         return -1;
 253     return 0;
 254 }
 255
 256 /* ------------------------------
 257  * write raw data. return actual bytes read. checks against EINTR
 258  * aren't necessary if all of the signals have SA_RESTART
 259  * specified. */
 260 ssize_t dsi_stream_write(DSI *dsi, void *data, const size_t length, int mode)
 261 {
 262   size_t written;
 263   ssize_t len;
 264   unsigned int flags = 0;
 265
 266   dsi->in_write++;
 267   written = 0;
 268
 269   LOG(log_maxdebug, logtype_dsi, "dsi_stream_write(send: %zd bytes): START", length);
 270
 271   if (dsi->flags & DSI_DISCONNECTED)
 272       return -1;
 273
 274   while (written < length) {
 275       len = send(dsi->socket, (u_int8_t *) data + written, length - written, flags);
 276       if (len >= 0) {
 277           written += len;
 278           continue;
 279       }
 280
 281       if (errno == EINTR)
 282           continue;
 283
 284       if (errno == EAGAIN || errno == EWOULDBLOCK) {
 285           LOG(log_debug, logtype_dsi, "dsi_stream_write: send: %s", strerror(errno));
 286
 287           if (mode == DSI_NOWAIT && written == 0) {
 288               /* DSI_NOWAIT is used by attention give up in this case. */
 289               written = -1;
 290               goto exit;
 291           }
 292
 293           /* Try to read sth. in order to break up possible deadlock */
 294           if (dsi_peek(dsi) != 0) {
 295               written = -1;
 296               goto exit;
 297           }
 298           /* Now try writing again */
 299           continue;
 300       }
 301
 302       LOG(log_error, logtype_dsi, "dsi_stream_write: %s", strerror(errno));
 303       written = -1;
 304       goto exit;
 305   }
 306
 307   dsi->write_count += written;
 308   LOG(log_maxdebug, logtype_dsi, "dsi_stream_write(send: %zd bytes): END", length);
 309
 310 exit:
 311   dsi->in_write--;
 312   return written;
 313 }
 314
 315
 316 /* ---------------------------------
 317 */
 318 #ifdef WITH_SENDFILE
 319 ssize_t dsi_stream_read_file(DSI *dsi, int fromfd, off_t offset, const size_t length)
 320 {
 321   int ret = 0;
 322   size_t written;
 323   ssize_t len;
 324   off_t pos = offset;
 325
 326   LOG(log_maxdebug, logtype_dsi, "dsi_stream_read_file(send %zd bytes): START", length);
 327
 328   if (dsi->flags & DSI_DISCONNECTED)
 329       return -1;
 330
 331   dsi->in_write++;
 332   written = 0;
 333
 334   while (written < length) {
 335     len = sys_sendfile(dsi->socket, fromfd, &pos, length - written);
 336
 337     if (len < 0) {
 338       if (errno == EINTR)
 339           continue;
 340       if (errno == EINVAL || errno == ENOSYS) {
 341           ret = -1;
 342           goto exit;
 343       }
 344       if (errno == EAGAIN || errno == EWOULDBLOCK) {
 345 #if defined(SOLARIS) || defined(FREEBSD)
 346           if (pos > offset) {
 347               /* we actually have sent sth., adjust counters and keep trying */
 348               len = pos - offset;
 349               written += len;
 350               offset = pos;
 351           }
 352 #endif
 353           if (dsi_peek(dsi)) {
 354               /* can't go back to blocking mode, exit, the next read
 355                  will return with an error and afpd will die.
 356               */
 357               break;
 358           }
 359           continue;
 360       }
 361       LOG(log_error, logtype_dsi, "dsi_stream_read_file: %s", strerror(errno));
 362       break;
 363     }
 364     else if (!len) {
 365         /* afpd is going to exit */
 366           ret = -1;
 367           goto exit;
 368     }
 369     else
 370         written += len;
 371   }
 372
 373   dsi->write_count += written;
 374
 375 exit:
 376   dsi->in_write--;
 377   LOG(log_maxdebug, logtype_dsi, "dsi_stream_read_file: sent: %zd", written);
 378   if (ret != 0)
 379       return -1;
 380   return written;
 381 }
 382 #endif
 383
 384
 385 /*
 386  * Essentially a loop around buf_read() to ensure "length" bytes are read
 387  * from dsi->buffer and/or the socket.
 388  *
 389  * @returns length on success, some value smaller then length indicates an error
 390  */
 391 size_t dsi_stream_read(DSI *dsi, void *data, const size_t length)
 392 {
 393   size_t stored;
 394   ssize_t len;
 395
 396   if (dsi->flags & DSI_DISCONNECTED)
 397       return 0;
 398
 399   LOG(log_maxdebug, logtype_dsi, "dsi_stream_read(%u bytes)", length);
 400
 401   stored = 0;
 402   while (stored < length) {
 403       len = buf_read(dsi, (u_int8_t *) data + stored, length - stored);
 404       if (len == -1 && (errno == EINTR || errno == EAGAIN)) {
 405           LOG(log_maxdebug, logtype_dsi, "dsi_stream_read: select read loop");
 406           continue;
 407       } else if (len > 0) {
 408           stored += len;
 409       } else { /* eof or error */
 410           /* don't log EOF error if it's just after connect (OSX 10.3 probe) */
 411 #if 0
 412           if (errno == ECONNRESET)
 413               dsi->flags |= DSI_GOT_ECONNRESET;
 414 #endif
 415           if (len || stored || dsi->read_count) {
 416               if (! (dsi->flags & DSI_DISCONNECTED)) {
 417                   LOG(log_error, logtype_dsi, "dsi_stream_read: len:%d, %s",
 418                       len, (len < 0) ? strerror(errno) : "unexpected EOF");
 419               }
 420               return 0;
 421           }
 422           break;
 423       }
 424   }
 425
 426   dsi->read_count += stored;
 427
 428   LOG(log_maxdebug, logtype_dsi, "dsi_stream_read(%u bytes): got: %u", length, stored);
 429   return stored;
 430 }
 431
 432 /* ---------------------------------------
 433  * write data. 0 on failure. this assumes that dsi_len will never
 434  * cause an overflow in the data buffer.
 435  */
 436 int dsi_stream_send(DSI *dsi, void *buf, size_t length)
 437 {
 438   char block[DSI_BLOCKSIZ];
 439   struct iovec iov[2];
 440   size_t towrite;
 441   ssize_t len;
 442
 443   LOG(log_maxdebug, logtype_dsi, "dsi_stream_send(%u bytes): START", length);
 444
 445   if (dsi->flags & DSI_DISCONNECTED)
 446       return 0;
 447
 448   block[0] = dsi->header.dsi_flags;
 449   block[1] = dsi->header.dsi_command;
 450   memcpy(block + 2, &dsi->header.dsi_requestID,
 451          sizeof(dsi->header.dsi_requestID));
 452   memcpy(block + 4, &dsi->header.dsi_code, sizeof(dsi->header.dsi_code));
 453   memcpy(block + 8, &dsi->header.dsi_len, sizeof(dsi->header.dsi_len));
 454   memcpy(block + 12, &dsi->header.dsi_reserved,
 455          sizeof(dsi->header.dsi_reserved));
 456
 457   if (!length) { /* just write the header */
 458       LOG(log_maxdebug, logtype_dsi, "dsi_stream_send(%u bytes): DSI header, no data", sizeof(block));
 459     length = (dsi_stream_write(dsi, block, sizeof(block), 0) == sizeof(block));
 460     return length; /* really 0 on failure, 1 on success */
 461   }
 462
 463   /* block signals */
 464   block_sig(dsi);
 465   iov[0].iov_base = block;
 466   iov[0].iov_len = sizeof(block);
 467   iov[1].iov_base = buf;
 468   iov[1].iov_len = length;
 469
 470   towrite = sizeof(block) + length;
 471   dsi->write_count += towrite;
 472   while (towrite > 0) {
 473       if (((len = writev(dsi->socket, iov, 2)) == -1 && errno == EINTR) || (len == 0))
 474           continue;
 475
 476       if ((size_t)len == towrite) /* wrote everything out */
 477           break;
 478       else if (len < 0) { /* error */
 479           if (errno == EAGAIN || errno == EWOULDBLOCK) {
 480               if (!dsi_peek(dsi)) {
 481                   continue;
 482               }
 483           }
 484           LOG(log_error, logtype_dsi, "dsi_stream_send: %s", strerror(errno));
 485           unblock_sig(dsi);
 486           return 0;
 487       }
 488
 489       towrite -= len;
 490       if (towrite > length) { /* skip part of header */
 491           iov[0].iov_base = (char *) iov[0].iov_base + len;
 492           iov[0].iov_len -= len;
 493       } else { /* skip to data */
 494           if (iov[0].iov_len) {
 495               len -= iov[0].iov_len;
 496               iov[0].iov_len = 0;
 497           }
 498           iov[1].iov_base = (char *) iov[1].iov_base + len;
 499           iov[1].iov_len -= len;
 500       }
 501   }
 502
 503   LOG(log_maxdebug, logtype_dsi, "dsi_stream_send(%u bytes): END", length);
 504
 505   unblock_sig(dsi);
 506   return 1;
 507 }
 508
 509
 510 /*!
 511  * Read DSI command and data
 512  *
 513  * @param  dsi   (rw) DSI handle
 514  *
 515  * @return    DSI function on success, 0 on failure
 516  */
 517 int dsi_stream_receive(DSI *dsi)
 518 {
 519   char block[DSI_BLOCKSIZ];
 520
 521   LOG(log_maxdebug, logtype_dsi, "dsi_stream_receive: START");
 522
 523   if (dsi->flags & DSI_DISCONNECTED)
 524       return 0;
 525
 526   /* read in the header */
 527   if (dsi_buffered_stream_read(dsi, (u_int8_t *)block, sizeof(block)) != sizeof(block))
 528     return 0;
 529
 530   dsi->header.dsi_flags = block[0];
 531   dsi->header.dsi_command = block[1];
 532
 533   if (dsi->header.dsi_command == 0)
 534       return 0;
 535
 536   memcpy(&dsi->header.dsi_requestID, block + 2, sizeof(dsi->header.dsi_requestID));
 537   memcpy(&dsi->header.dsi_code, block + 4, sizeof(dsi->header.dsi_code));
 538   memcpy(&dsi->header.dsi_len, block + 8, sizeof(dsi->header.dsi_len));
 539   memcpy(&dsi->header.dsi_reserved, block + 12, sizeof(dsi->header.dsi_reserved));
 540   dsi->clientID = ntohs(dsi->header.dsi_requestID);
 541
 542   /* make sure we don't over-write our buffers. */
 543   dsi->cmdlen = min(ntohl(dsi->header.dsi_len), DSI_CMDSIZ);
 544   if (dsi_stream_read(dsi, dsi->commands, dsi->cmdlen) != dsi->cmdlen)
 545     return 0;
 546
 547   LOG(log_debug, logtype_dsi, "dsi_stream_receive: DSI cmdlen: %zd", dsi->cmdlen);
 548
 549   return block[1];
 550 }