2 * Copyright (c) 1998 Adrian Sun (asun@zoology.washington.edu)
3 * All rights reserved. See COPYRIGHT.
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.
14 #endif /* HAVE_CONFIG_H */
25 #include <sys/types.h>
26 #include <sys/socket.h>
29 #include <atalk/logger.h>
30 #include <atalk/dsi.h>
31 #include <netatalk/endian.h>
32 #include <atalk/util.h>
34 #define min(a,b) ((a) < (b) ? (a) : (b))
37 #define MSG_MORE 0x8000
41 #define MSG_DONTWAIT 0x40
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.
50 * @returns 0 when is possible to send again, -1 on error
52 static int dsi_peek(DSI *dsi)
54 static int warned = 0;
55 fd_set readfds, writefds;
60 LOG(log_debug, logtype_dsi, "dsi_peek");
62 maxfd = dsi->socket + 1;
68 if (dsi->eof < dsi->end) {
69 /* space in read buffer */
70 FD_SET( dsi->socket, &readfds);
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",
77 dsi->server_quantum ? dsi->server_quantum : DSI_SERVQUANT_DEF,
78 dsi->end - dsi->buffer);
82 FD_SET( dsi->socket, &writefds);
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 */
91 LOG(log_error, logtype_dsi, "dsi_peek: unexpected select return: %d %s",
92 ret, ret < 0 ? strerror(errno) : "");
96 if (FD_ISSET(dsi->socket, &writefds)) {
97 /* we can write again */
98 LOG(log_debug, logtype_dsi, "dsi_peek: can write again");
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 */
106 if ((len = read(dsi->socket, dsi->eof, len)) <= 0) {
108 LOG(log_error, logtype_dsi, "dsi_peek: EOF");
111 LOG(log_error, logtype_dsi, "dsi_peek: read: %s", strerror(errno));
116 LOG(log_debug, logtype_dsi, "dsi_peek: read %d bytes", len);
126 * Return all bytes up to count from dsi->buffer if there are any buffered there
128 static size_t from_buf(DSI *dsi, u_int8_t *buf, size_t count)
132 if (dsi->buffer == NULL)
133 /* afpd master has no DSI buffering */
136 LOG(log_maxdebug, logtype_dsi, "from_buf: %u bytes", count);
138 nbe = dsi->eof - dsi->start;
141 nbe = min((size_t)nbe, count);
142 memcpy(buf, dsi->start, nbe);
145 if (dsi->eof == dsi->start)
146 dsi->start = dsi->eof = dsi->buffer;
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);
156 * Get bytes from buffer dsi->buffer or read from socket
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.
163 static ssize_t buf_read(DSI *dsi, u_int8_t *buf, size_t count)
167 LOG(log_maxdebug, logtype_dsi, "buf_read(%u bytes)", count);
172 len = from_buf(dsi, buf, count); /* 1. */
176 len = readt(dsi->socket, buf, count, 0, 1); /* 3. */
178 LOG(log_maxdebug, logtype_dsi, "buf_read(%u bytes): got: %d", count, len);
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.
187 static size_t dsi_buffered_stream_read(DSI *dsi, u_int8_t *data, const size_t length)
192 LOG(log_maxdebug, logtype_dsi, "dsi_buffered_stream_read: %u bytes", length);
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 */
200 /* fill the buffer with 8192 bytes or until buffer is full */
201 buflen = min(8192, dsi->end - dsi->eof);
204 ret = read(dsi->socket, dsi->eof, buflen);
209 /* now get the remaining data */
210 if ((buflen = dsi_stream_read(dsi, data + len, length - len)) != length - len)
217 /* ---------------------------------------
219 static void block_sig(DSI *dsi)
224 /* ---------------------------------------
226 static void unblock_sig(DSI *dsi)
231 /*********************************************************************************
233 *********************************************************************************/
236 * Communication error with the client, enter disconnected state
238 * 1. close the socket
239 * 2. set the DSI_DISCONNECTED flag, remove possible sleep flags
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)
245 int dsi_disconnect(DSI *dsi)
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;
256 /* ------------------------------
257 * write raw data. return actual bytes read. checks against EINTR
258 * aren't necessary if all of the signals have SA_RESTART
260 ssize_t dsi_stream_write(DSI *dsi, void *data, const size_t length, int mode)
264 unsigned int flags = 0;
269 LOG(log_maxdebug, logtype_dsi, "dsi_stream_write(send: %zd bytes): START", length);
271 if (dsi->flags & DSI_DISCONNECTED)
274 while (written < length) {
275 len = send(dsi->socket, (u_int8_t *) data + written, length - written, flags);
284 if (errno == EAGAIN || errno == EWOULDBLOCK) {
285 LOG(log_debug, logtype_dsi, "dsi_stream_write: send: %s", strerror(errno));
287 if (mode == DSI_NOWAIT && written == 0) {
288 /* DSI_NOWAIT is used by attention give up in this case. */
293 /* Try to read sth. in order to break up possible deadlock */
294 if (dsi_peek(dsi) != 0) {
298 /* Now try writing again */
302 LOG(log_error, logtype_dsi, "dsi_stream_write: %s", strerror(errno));
307 dsi->write_count += written;
308 LOG(log_maxdebug, logtype_dsi, "dsi_stream_write(send: %zd bytes): END", length);
316 /* ---------------------------------
319 ssize_t dsi_stream_read_file(DSI *dsi, int fromfd, off_t offset, const size_t length)
326 LOG(log_maxdebug, logtype_dsi, "dsi_stream_read_file(send %zd bytes): START", length);
328 if (dsi->flags & DSI_DISCONNECTED)
334 while (written < length) {
335 len = sys_sendfile(dsi->socket, fromfd, &pos, length - written);
340 if (errno == EINVAL || errno == ENOSYS) {
344 if (errno == EAGAIN || errno == EWOULDBLOCK) {
345 #if defined(SOLARIS) || defined(FREEBSD)
347 /* we actually have sent sth., adjust counters and keep trying */
354 /* can't go back to blocking mode, exit, the next read
355 will return with an error and afpd will die.
361 LOG(log_error, logtype_dsi, "dsi_stream_read_file: %s", strerror(errno));
365 /* afpd is going to exit */
373 dsi->write_count += written;
377 LOG(log_maxdebug, logtype_dsi, "dsi_stream_read_file: sent: %zd", written);
386 * Essentially a loop around buf_read() to ensure "length" bytes are read
387 * from dsi->buffer and/or the socket.
389 * @returns length on success, some value smaller then length indicates an error
391 size_t dsi_stream_read(DSI *dsi, void *data, const size_t length)
396 if (dsi->flags & DSI_DISCONNECTED)
399 LOG(log_maxdebug, logtype_dsi, "dsi_stream_read(%u bytes)", length);
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");
407 } else if (len > 0) {
409 } else { /* eof or error */
410 /* don't log EOF error if it's just after connect (OSX 10.3 probe) */
412 if (errno == ECONNRESET)
413 dsi->flags |= DSI_GOT_ECONNRESET;
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");
426 dsi->read_count += stored;
428 LOG(log_maxdebug, logtype_dsi, "dsi_stream_read(%u bytes): got: %u", length, stored);
432 /* ---------------------------------------
433 * write data. 0 on failure. this assumes that dsi_len will never
434 * cause an overflow in the data buffer.
436 int dsi_stream_send(DSI *dsi, void *buf, size_t length)
438 char block[DSI_BLOCKSIZ];
443 LOG(log_maxdebug, logtype_dsi, "dsi_stream_send(%u bytes): START", length);
445 if (dsi->flags & DSI_DISCONNECTED)
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));
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 */
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;
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))
476 if ((size_t)len == towrite) /* wrote everything out */
478 else if (len < 0) { /* error */
479 if (errno == EAGAIN || errno == EWOULDBLOCK) {
480 if (!dsi_peek(dsi)) {
484 LOG(log_error, logtype_dsi, "dsi_stream_send: %s", strerror(errno));
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;
498 iov[1].iov_base = (char *) iov[1].iov_base + len;
499 iov[1].iov_len -= len;
503 LOG(log_maxdebug, logtype_dsi, "dsi_stream_send(%u bytes): END", length);
511 * Read DSI command and data
513 * @param dsi (rw) DSI handle
515 * @return DSI function on success, 0 on failure
517 int dsi_stream_receive(DSI *dsi)
519 char block[DSI_BLOCKSIZ];
521 LOG(log_maxdebug, logtype_dsi, "dsi_stream_receive: START");
523 if (dsi->flags & DSI_DISCONNECTED)
526 /* read in the header */
527 if (dsi_buffered_stream_read(dsi, (u_int8_t *)block, sizeof(block)) != sizeof(block))
530 dsi->header.dsi_flags = block[0];
531 dsi->header.dsi_command = block[1];
533 if (dsi->header.dsi_command == 0)
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);
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)
547 LOG(log_debug, logtype_dsi, "dsi_stream_receive: DSI cmdlen: %zd", dsi->cmdlen);