io.c 40.2 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
/* io.c
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 *
 * $Id$ */

/* lsh, an implementation of the ssh protocol
 *
 * Copyright (C) 1998 Niels Mller
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
J.H.M. Dassen's avatar
J.H.M. Dassen committed
21
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
Niels Möller's avatar
Niels Möller committed
22
23
 */

24
#include "io.h"
25
26

#include "format.h"
27
28
29
#include "werror.h"
#include "xalloc.h"

Niels Möller's avatar
Niels Möller committed
30
31
32
#include <assert.h>
#include <string.h>

33
#if HAVE_UNISTD_H
Niels Möller's avatar
Niels Möller committed
34
#include <unistd.h>
35
#endif
36
37

#ifdef HAVE_POLL
38
39
40
41
42
# if HAVE_POLL_H
#  include <poll.h>
# elif HAVE_SYS_POLL_H
#  include <sys/poll.h>
# endif
43
#else
44
# include "jpoll.h"
45
46
#endif

47
48
49
50
51
52
53
/* Workaround for some version of FreeBSD. */
#ifdef POLLRDNORM
# define MY_POLLIN (POLLIN | POLLRDNORM)
#else /* !POLLRDNORM */
# define MY_POLLIN POLLIN
#endif /* !POLLRDNORM */

Niels Möller's avatar
Niels Möller committed
54
55
56
57
#include <errno.h>
#include <fcntl.h>
#include <sys/types.h>
#include <sys/socket.h>
58
#include <sys/un.h>
Niels Möller's avatar
Niels Möller committed
59
#include <arpa/inet.h>
60
#include <signal.h>
61
62
#include <sys/stat.h>

Niels Möller's avatar
Niels Möller committed
63

64
#define GABA_DEFINE
65
#include "io.h.x"
66
#undef GABA_DEFINE
67
68
69

#include "io.c.x"

Niels Möller's avatar
Niels Möller committed
70
71
72

/* Backend loop */

Niels Möller's avatar
Niels Möller committed
73
74
75
76
77
/* If there's nothing to do for this amount of time (ms), do
 * spontaneous gc. */

#define IDLE_TIME 100

Niels Möller's avatar
Niels Möller committed
78
79
80
81
int io_iter(struct io_backend *b)
{
  unsigned long nfds; /* FIXME: Should be nfds_t if that type is defined */
  struct pollfd *fds;
82
83
  struct lsh_fd **active_fds;
  
84
  /* FIXME: Real scheduling of callouts not implemented */
Niels Möller's avatar
Niels Möller committed
85
  /* int timeout; */
Niels Möller's avatar
Niels Möller committed
86
87
  int res;

88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
  /* Invoke all callouts. Clear the list first; if any callout
   * installs another one, that will not be invoked until the next
   * iteration. */
  if (b->callouts)
    {
      struct callout *p = b->callouts;
      b->callouts = NULL;
      
      while (p)
	{
	  LSH_CALLBACK(p->action);
	  p = p->next;
	}
    }
      
Niels Möller's avatar
Niels Möller committed
103
  {
104
105
106
    struct lsh_fd *fd;
    int need_close;
    
107
    /* Prepare fd:s. This phase calls the prepare-methods, also closes
Niels Möller's avatar
Niels Möller committed
108
109
     * and unlinks any fd:s that should be closed, and also counts how
     * many fd:s there are. */
110
111

    for (fd = b->files; fd; fd = fd->next)
Niels Möller's avatar
Niels Möller committed
112
      {
113
	if (fd->super.alive && fd->prepare)
114
	  FD_PREPARE(fd);
115
116
117
118
119
120
121
122
123
124
125
126
127
128
      }
    
    /* Note that calling a close callback might cause other files to
     * be closed as well, so we need a double loop.
     *
     * FIXME: How can we improve this? We could keep a stack of closed
     * files, but that will require backpointers from the fd:s to the
     * backend (so that kill_fd() can find the top of the stack). */

    do
      {
	struct lsh_fd **fd_p;
	need_close = 0;
	nfds = 0;
Niels Möller's avatar
Niels Möller committed
129
	
130
	for(fd_p = &b->files; (fd = *fd_p); )
Niels Möller's avatar
Niels Möller committed
131
	  {
132
	    if (!fd->super.alive)
Niels Möller's avatar
Niels Möller committed
133
	      {
134
135
136
137
138
139
140
141
142
143
		if (fd->fd < 0)
		  /* Unlink the file object, but don't close any
		   * underlying file. */
		  ;
		else
		  {
		    /* Used by write fd:s to make sure that writing to its
		     * buffer fails. */
		    if (fd->write_close)
		      FD_WRITE_CLOSE(fd);
Niels Möller's avatar
Niels Möller committed
144
		
145
146
		    if (fd->close_callback)
		      {
147
			LSH_CALLBACK(fd->close_callback);
148
149
150
			need_close = 1;
		      }
		    trace("io.c: Closing fd %i.\n", fd->fd);
Niels Möller's avatar
Niels Möller committed
151
		
152
153
		    if (close(fd->fd) < 0)
		      {
154
			werror("io.c: close() failed, (errno = %i): %z\n",
155
156
157
158
159
			       errno, STRERROR(errno));
			EXCEPTION_RAISE(fd->e,
					make_io_exception(EXC_IO_CLOSE, fd,
							  errno, NULL));
		      }
160
161
162
163
		  }
		/* Unlink this fd */
		*fd_p = fd->next;
		continue;
Niels Möller's avatar
Niels Möller committed
164
	      }
165

166
167
	    if (fd->want_read || fd->want_write)
	      nfds++;
168

169
170
171
	    fd_p = &fd->next;
	  }
      } while (need_close);
Niels Möller's avatar
Niels Möller committed
172
173
174
175
176
177
178
179
  }

  if (!nfds)
    /* Nothing more to do.
     *
     * NOTE: There might be some callouts left, but we won't wait for them. */
    return 0;

180
181
182
  fds = alloca(sizeof(struct pollfd) * nfds);
  active_fds = alloca(sizeof(struct lsh_fd *) *nfds);
  
Niels Möller's avatar
Niels Möller committed
183
184
185
  /* Fill out fds-array */
  {
    struct lsh_fd *fd;
186
    unsigned long i;
Niels Möller's avatar
Niels Möller committed
187
188
    int all_events = 0;
    
189
    for (fd = b->files, i = 0; fd; fd = fd->next)
Niels Möller's avatar
Niels Möller committed
190
      {
191
192
	assert(fd->super.alive);
	
193
194
	if (fd->want_read || fd->want_write)
	  {
195
196
	    assert(i < nfds);

197
	    active_fds[i] = fd;
Niels Möller's avatar
Niels Möller committed
198

199
200
201
202
	    fds[i].fd = fd->fd;
	    fds[i].events = 0;
	    
	    if (fd->want_read)
203
	      fds[i].events |= MY_POLLIN;
Niels Möller's avatar
Niels Möller committed
204

205
206
	    if (fd->want_write)
	      fds[i].events |= POLLOUT;
Niels Möller's avatar
Niels Möller committed
207

208
209
210
	    all_events |= fds[i].events;
	    i++;
	  }
Niels Möller's avatar
Niels Möller committed
211
212
      }
    assert(i == nfds);
213
    assert(all_events);
Niels Möller's avatar
Niels Möller committed
214
215
  }

Niels Möller's avatar
Niels Möller committed
216
  res = poll(fds, nfds, IDLE_TIME);
Niels Möller's avatar
Niels Möller committed
217

Niels Möller's avatar
Niels Möller committed
218
219
220
221
222
  if (!res)
    {
      gc_maybe(&b->super, 0);
      res = poll(fds, nfds, -1);
    }
223
224
  else
    gc_maybe(&b->super, 1);
Niels Möller's avatar
Niels Möller committed
225
  
Niels Möller's avatar
Niels Möller committed
226
227
228
229
230
231
232
233
234
235
236
237
  if (!res)
    {
      /* Callouts are not implemented */
      fatal("Unexpected timeout\n");
    }
  if (res < 0)
    switch(errno)
      {
      case EAGAIN:
      case EINTR:
	return 1;
      default:
238
	fatal("io_iter: poll failed: %z", STRERROR(errno));
Niels Möller's avatar
Niels Möller committed
239
240
241
242
      }
  
  {
    /* Do io. Note that the callback functions may add new fds to the
243
244
     * head of the list, or clear the alive flag on any fd. But this
     * is less of a problem now, as we use the active_fd array.*/
Niels Möller's avatar
Niels Möller committed
245

246
    /* struct lsh_fd *fd; */
247
    unsigned long i;
Niels Möller's avatar
Niels Möller committed
248
    
249
    for(i=0; i<nfds; i++)
Niels Möller's avatar
Niels Möller committed
250
      {
251
	struct lsh_fd *fd = active_fds[i];
Niels Möller's avatar
Niels Möller committed
252
	assert(i<nfds);
253
254

	debug("io.c: poll for fd %i: events = 0x%xi, revents = 0x%xi.\n",
255
 	      fds[i].fd, fds[i].events, fds[i].revents);
Niels Möller's avatar
Niels Möller committed
256
	
257
	if (!fd->super.alive)
Niels Möller's avatar
Niels Möller committed
258
259
	  continue;

260
261
262
	/* On systems without poll(), we use jpoll.c to emulate some
	 * of poll(), but we lack POLLNVAL, POLLPRI and POLLHUP. */
#ifdef POLLNVAL
263
264
265
266
267
268
269
270
	if (fds[i].revents & POLLNVAL)
	  {
	    werror("io.c: poll request on fd %i, for events of type %xi\n"
		   "      return POLLNVAL, revents = %xi\n",
		   fds[i].fd, fds[i].events, fds[i].revents);
	    kill_fd(fd);
	    continue;
	  }
271
#endif /* POLLNVAL */
272

273
#ifdef POLLHUP
274
275
276
277
278
279
280
	/* FIXME: According to Solaris' man page, POLLHUP is mutually
	 * exclusive with POLLOUT, but orthogonal to POLLIN.
	 *
	 * However, on my system (sparc-linux) POLLHUP is set when we
	 * get EOF on an fd we are reading. This will cause an i/o
	 * exception to be raised rather than the ordinary EOF
	 * handling. */
281
282
	if (fds[i].revents & POLLHUP)
	  {
283
284
	    if (fd->want_write)
	      /* Will raise an i/o error */
285
	      FD_WRITE(fd);
286
287
288
	    else if (fd->want_read)
	      /* Ought to behave like EOF, but might raise an i/o
	       * error instead. */
289
	      FD_READ(fd);
290
	    else
291
292
	      {
		werror("io.c: poll said POLLHUP on an inactive fd.\n");
293
		close_fd(fd);
294
	      }
295
296
	    continue;
	  }
297
#endif /* POLLHUP */
298

299
#ifdef POLLPRI
300
301
302
	if (fds[i].revents & POLLPRI)
	  {
	    werror("io.c: Peer is trying to send Out of Band data. Hanging up.\n");
303
304

	    /* FIXME: Should we raise any exception here? */
305

306
	    close_fd(fd); 
307
308
309

	    continue;
	  }
310
#endif /* POLLPRI */
Niels Möller's avatar
Niels Möller committed
311
	if (fds[i].revents & POLLOUT)
312
	  FD_WRITE(fd);
Niels Möller's avatar
Niels Möller committed
313

314
	if (!fd->super.alive)
Niels Möller's avatar
Niels Möller committed
315
316
	  continue;

317
	if (fds[i].revents & MY_POLLIN)
318
	  FD_READ(fd);
Niels Möller's avatar
Niels Möller committed
319
320
321
322
323
324
      }
    assert(i == nfds);
  }

  return 1;
}
Niels Möller's avatar
Niels Möller committed
325

326
  
Niels Möller's avatar
Niels Möller committed
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
void io_run(struct io_backend *b)
{
  struct sigaction pipe;
  memset(&pipe, 0, sizeof(pipe));

  pipe.sa_handler = SIG_IGN;
  sigemptyset(&pipe.sa_mask);
  pipe.sa_flags = 0;
  
  if (sigaction(SIGPIPE, &pipe, NULL) < 0)
    fatal("Failed to ignore SIGPIPE.\n");
  
  while(io_iter(b))
    ;
}

void init_backend(struct io_backend *b)
{
  b->files = NULL;
346
  b->callouts = NULL;
Niels Möller's avatar
Niels Möller committed
347
348
349
350
351
}


/* Read-related callbacks */

352
353
354
static void
do_buffered_read(struct io_callback *s,
		 struct lsh_fd *fd)
Niels Möller's avatar
Niels Möller committed
355
356
357
{
  CAST(io_buffered_read, self, s);
  UINT8 *buffer = alloca(self->buffer_size);
358
359
360
361
362
  int res;

  assert(fd->want_read);   
  
  res = read(fd->fd, buffer, self->buffer_size);
Niels Möller's avatar
Niels Möller committed
363
364
365
366
367
368
369
370
371
372

  if (res < 0)
    switch(errno)
      {
      case EINTR:
	break;
      case EWOULDBLOCK:
	werror("io.c: read_callback: Unexpected EWOULDBLOCK\n");
	break;
      case EPIPE:
373
374
375
	/* Getting EPIPE from read() seems strange, but appearantly
	 * it happens sometimes. */
	werror("Unexpected EPIPE.\n");
Niels Möller's avatar
Niels Möller committed
376
      default:
Niels Möller's avatar
Niels Möller committed
377
378
379
	EXCEPTION_RAISE(fd->e, 
			make_io_exception(EXC_IO_READ, fd,
					  errno, NULL));
Niels Möller's avatar
Niels Möller committed
380
381
382
383
384
385
	break;
      }
  else if (res > 0)
    {
      UINT32 left = res;
    
386
      while (fd->super.alive && fd->read && left)
Niels Möller's avatar
Niels Möller committed
387
388
	{
	  UINT32 done;
Niels Möller's avatar
Niels Möller committed
389

390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
	  /* FIXME: What to do if want_read is false?
	   * To improve the connection_lock() mechanism,
	   * it must be possible to temporarily stop reading, which means that
	   * fd->want_read has to be cleared.
	   *
	   * But when doing this, we have to keep the data that we
	   * have read, some of which is buffered here, on the stack,
	   * and the rest inside the read-handler.
	   *
	   * There are two alternatives: Save our buffer here, or
	   * continue looping, letting the read-handler process it
	   * into packets. In the latter case, the ssh_connection
	   * could keep a queue of waiting packets, but it would still
	   * have to clear the want_read flag, to prevent that queue
	   * from growing arbitrarily large.
405
406
	   *
	   * We now go with the second alternative. 
407
408
	   */

409
	  assert(self->handler);
Niels Möller's avatar
Niels Möller committed
410
411

	  /* NOTE: This call may replace self->handler */
Niels Möller's avatar
Niels Möller committed
412
	  done = READ_HANDLER(self->handler, left, buffer);
413
	  
Niels Möller's avatar
Niels Möller committed
414
415
	  buffer += done;
	  left -= done;
416

417
418
419
	  if (!fd->want_read)
	    debug("do_buffered_read: want_read = 0; handler needs a pause.\n");
	  
420
421
422
423
424
425
426
	  if (fd->want_read && !self->handler)
	    {
	      werror("do_buffered_read: Handler disappeared! Ignoring %i bytes\n",
		     left);
	      fd->want_read = 0;
	      return;
	    }
Niels Möller's avatar
Niels Möller committed
427
428
429
430
431
432
433
	}

      if (left)
	verbose("read_buffered(): fd died, %i buffered bytes discarded\n",
		left);
    }
  else
434
435
436
437
438
439
440
    {
      /* We have read EOF. Pass available == 0 to the handler */
      assert(fd->super.alive);
      assert(fd->read);
      assert(fd->want_read);
      assert(self->handler);

441
      close_fd_nicely(fd);
442
443
444
      READ_HANDLER(self->handler, 0, NULL);
    }
	
Niels Möller's avatar
Niels Möller committed
445
446
}

447
struct io_callback *
Niels Möller's avatar
Niels Möller committed
448
449
450
451
452
make_buffered_read(UINT32 buffer_size,
		   struct read_handler *handler)
{
  NEW(io_buffered_read, self);

453
  self->super.f = do_buffered_read;
Niels Möller's avatar
Niels Möller committed
454
455
456
457
458
459
  self->buffer_size = buffer_size;
  self->handler = handler;

  return &self->super;
}

460
461
462
static void
do_consuming_read(struct io_callback *c,
		  struct lsh_fd *fd)
Niels Möller's avatar
Niels Möller committed
463
{
464
  CAST_SUBTYPE(io_consuming_read, self, c);
Niels Möller's avatar
Niels Möller committed
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
  UINT32 wanted = READ_QUERY(self);

  if (!wanted)
    {
      fd->want_read = 0;
    }
  else
    {
      struct lsh_string *s = lsh_string_alloc(wanted);
      int res = read(fd->fd, s->data, wanted);

      if (res < 0)
	switch(errno)
	  {
	  case EINTR:
	    break;
	  case EWOULDBLOCK:
	    werror("io.c: read_consume: Unexpected EWOULDBLOCK\n");
	    break;
	  case EPIPE:
485
486
487
488
	    /* FIXME: I don't understand why reading should return
	     * EPIPE, but it happens occasionally under linux. Perhaps
	     * we should treat it as EOF instead? */
	    werror("io.c: read_consume: Unexpected EPIPE.\n");
Niels Möller's avatar
Niels Möller committed
489
	  default:
Niels Möller's avatar
Niels Möller committed
490
491
492
	    EXCEPTION_RAISE(fd->e, 
			    make_io_exception(EXC_IO_READ,
					      fd, errno, NULL));
Niels Möller's avatar
Niels Möller committed
493
494
495
496
497
	    break;
	  }
      else if (res > 0)
	{
	  s->length = res;
498
	  A_WRITE(self->consumer, s);
Niels Möller's avatar
Niels Möller committed
499
500
	}
      else
501
	{
502
	  close_fd_nicely(fd);
503
504
505
	  A_WRITE(self->consumer, NULL);
	}
      
Niels Möller's avatar
Niels Möller committed
506
507
508
509
510
511
512
513
    }
}

/* NOTE: Doesn't initialize the query field. That should be done in
 * the subclass's constructor. */
void init_consuming_read(struct io_consuming_read *self,
			 struct abstract_write *consumer)
{
514
  self->super.f = do_consuming_read;
Niels Möller's avatar
Niels Möller committed
515
516
  self->consumer = consumer;
}
517

518

Niels Möller's avatar
Niels Möller committed
519
/* Write related callbacks */
520
521
522
static void
do_write_callback(struct io_callback *s UNUSED,
		  struct lsh_fd *fd)
Niels Möller's avatar
Niels Möller committed
523
{
524
  /* CAST(io_write_callback, self, s); */
Niels Möller's avatar
Niels Möller committed
525
526
527
  UINT32 size;
  int res;
  
528
529
  size = MIN(fd->write_buffer->end - fd->write_buffer->start,
	     fd->write_buffer->block_size);
Niels Möller's avatar
Niels Möller committed
530
531
532
  assert(size);
  
  res = write(fd->fd,
533
	      fd->write_buffer->buffer + fd->write_buffer->start,
Niels Möller's avatar
Niels Möller committed
534
535
536
537
538
539
540
541
542
543
	      size);
  if (!res)
    fatal("Closed?");
  if (res < 0)
    switch(errno)
      {
      case EINTR:
      case EAGAIN:
	break;
      case EPIPE:
544
	debug("io.c: Broken pipe.\n");
545
	close_fd(fd);
Niels Möller's avatar
Niels Möller committed
546
547
	break;
      default:
548
	werror("io.c: write failed, %z\n", STRERROR(errno));
Niels Möller's avatar
Niels Möller committed
549
550
	EXCEPTION_RAISE(fd->e,
			make_io_exception(EXC_IO_WRITE, fd, errno, NULL));
551
	close_fd(fd);
Niels Möller's avatar
Niels Möller committed
552
553
554
555
	
	break;
      }
  else
556
    write_buffer_consume(fd->write_buffer, res);
Niels Möller's avatar
Niels Möller committed
557
}  
558

559
560
561
562
563
564
565
566
567
568
static struct io_callback io_write_callback =
{ STATIC_HEADER, do_write_callback };

static void
do_write_prepare(struct lsh_fd *fd)
{
  assert(fd->write_buffer);

  if (! (fd->want_write = write_buffer_pre_write(fd->write_buffer))
      && fd->write_buffer->closed)
569
    close_fd(fd);
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
}

static void
do_write_close(struct lsh_fd *fd)
{
  /* CAST(io_write_callback, self, s); */

  assert(fd->write_buffer);

  write_buffer_close(fd->write_buffer);
}

struct listen_value *
make_listen_value(struct lsh_fd *fd,
		  struct address_info *peer)
{
  NEW(listen_value, self);

  self->fd = fd;
  self->peer = peer;

  return self;
}

Niels Möller's avatar
Niels Möller committed
594
595
596

/* Listen callback */

597
598
599
600
601
602
603
604
605
606
/* GABA:
   (class
     (name io_listen_callback)
     (super io_callback)
     (vars
       (backend object io_backend)
       (c object command_continuation)
       (e object exception_handler)))
*/

Niels Möller's avatar
Niels Möller committed
607
static void
608
do_listen_callback(struct io_callback *s,
Niels Möller's avatar
Niels Möller committed
609
		   struct lsh_fd *fd)
Niels Möller's avatar
Niels Möller committed
610
{
611
  CAST(io_listen_callback, self, s);
612
613
614
615
616
617

#if WITH_IPV6
  struct sockaddr_storage peer;
#else
  struct sockaddr peer;
#endif
618
619

  socklen_t addr_len = sizeof(peer);
Niels Möller's avatar
Niels Möller committed
620
  int conn;
621

Niels Möller's avatar
Niels Möller committed
622
623
624
  conn = accept(fd->fd,
		(struct sockaddr *) &peer, &addr_len);
  if (conn < 0)
625
    {
626
      werror("io.c: accept() failed, %z", STRERROR(errno));
Niels Möller's avatar
Niels Möller committed
627
      return;
628
    }
629
  trace("io.c: accept() on fd %i\n", conn);
630
631
632
633
634
  COMMAND_RETURN(self->c,
		 make_listen_value(make_lsh_fd(self->backend,
					       conn, self->e),
				   sockaddr2info(addr_len,
						 (struct sockaddr *) &peer)));
Niels Möller's avatar
Niels Möller committed
635
}
636

637
638
639
640
641
642
643
644
645
646
647
648
649
struct io_callback *
make_listen_callback(struct io_backend *backend,
		     struct command_continuation *c,
		     struct exception_handler *e)
{
  NEW(io_listen_callback, self);
  self->super.f = do_listen_callback;
  self->backend = backend;
  self->c = c;
  self->e = e;
  
  return &self->super;
}
Niels Möller's avatar
Niels Möller committed
650

651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
#if 0

static void
do_listen_callback_no_peer(struct io_callback *s,
			   struct lsh_fd *fd)
{
  CAST(io_listen_callback, self, s);

  int conn;

  conn = accept(fd->fd,
		(struct sockaddr *) &peer, &addr_len);
  if (conn < 0)
    {
      werror("io.c: accept() failed, %z", STRERROR(errno));
      return;
    }
  trace("io.c: accept() on fd %i\n", conn);
  COMMAND_RETURN(self->c, make_lsh_fd(self->backend,
				      conn, self->e));
}

struct io_callback *
make_listen_callback_no_peer(struct io_backend *backend,
			     struct command_continuation *c)
{
  NEW(io_listen_callback, self);
  self->super.f = do_listen_callback_no_peer;
  self->backend = backend;
  self->c = c;
  
  return &self->super;
}
#endif
Niels Möller's avatar
Niels Möller committed
685
686
687

/* Connect callback */

688
689
690
691
692
693
694
695
696
697
698
/* GABA:
   (class
     (name io_connect_callback)
     (super io_callback)
     (vars
       (c object command_continuation)))
*/

static void
do_connect_callback(struct io_callback *s,
		    struct lsh_fd *fd)
Niels Möller's avatar
Niels Möller committed
699
{
700
  CAST(io_connect_callback, self, s);
701
  int socket_error;
702
  socklen_t len = sizeof(socket_error);
703
  
704
  /* Check if the connection was successful */
705
706
  if ((getsockopt(fd->fd, SOL_SOCKET, SO_ERROR,
		  (char *) &socket_error, &len) < 0)
707
      || socket_error)
708
    {
709
      debug("io.c: connect_callback: Connect failed.\n");
Niels Möller's avatar
Niels Möller committed
710
      EXCEPTION_RAISE(fd->e,
711
		      make_io_exception(EXC_IO_CONNECT, fd, 0, "connect() failed."));
712
      kill_fd(fd);
713
714
    }
  else
Niels Möller's avatar
Niels Möller committed
715
    {
716
717
718
      fd->write = NULL;
      fd->want_write = 0;
      COMMAND_RETURN(self->c, fd);
719
    }
720
721
722
723
724
725
726
727
728
729
730
}

static struct io_callback *
make_connect_callback(struct command_continuation *c)
{
  NEW(io_connect_callback, self);

  self->super.f = do_connect_callback;
  self->c = c;

  return &self->super;
731
732
}

733

Niels Möller's avatar
Niels Möller committed
734
/* This function is called if a connection this file somehow depends
735
736
737
738
739
740
741
742
 * on disappears. For instance, the connection may have spawned a
 * child process, and this file may be the stdin of that process. */

/* To kill a file, mark it for closing and the backend will do the work. */
static void do_kill_fd(struct resource *r)
{
  CAST_SUBTYPE(lsh_fd, fd, r);

743
  /* FIXME: Should we use close_fd() or close_fd_nicely() ? */
744
  if (r->alive)
745
    close_fd_nicely(fd);
746
747
}

748
749
750
751
752
753
754
755
756
757
/* Closes the file on i/o errors, and passes the exception on */

static void
do_exc_io_handler(struct exception_handler *self,
		  const struct exception *x)
{
  if (x->type & EXC_IO)
    {
      CAST_SUBTYPE(io_exception, e, x);

758
      if (e->fd)
759
	close_fd(e->fd);
760
761
762
763
764
    }
  EXCEPTION_RAISE(self->parent, x);
  return;
}

Niels Möller's avatar
Niels Möller committed
765
/* Initializes a file structure, and adds it to the backend's list. */
766
767
768
static void
init_file(struct io_backend *b, struct lsh_fd *f, int fd,
	  struct exception_handler *e)
Niels Möller's avatar
Niels Möller committed
769
770
{
  f->fd = fd;
Niels Möller's avatar
Niels Möller committed
771

772
  f->e = make_exception_handler(do_exc_io_handler, e, HANDLER_CONTEXT);
773
  
Niels Möller's avatar
Niels Möller committed
774
775
776
  f->close_callback = NULL;

  f->prepare = NULL;
777

Niels Möller's avatar
Niels Möller committed
778
779
780
781
782
  f->want_read = 0;
  f->read = NULL;

  f->want_write = 0;
  f->write = NULL;
783
784
  f->write_close = NULL;
  
785
786
  f->super.alive = 1;
  f->super.kill = do_kill_fd;
Niels Möller's avatar
Niels Möller committed
787
788
789
790

  f->next = b->files;
  b->files = f;
}
791

Niels Möller's avatar
Niels Möller committed
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
/* These functions are used by werror() and friends */

/* For fd:s in blocking mode. */
const struct exception *
write_raw(int fd, UINT32 length, const UINT8 *data)
{
  while(length)
    {
      int written = write(fd, data, length);

      if (written < 0)
	switch(errno)
	  {
	  case EINTR:
	  case EAGAIN:
	    continue;
	  default:
	    return make_io_exception(EXC_IO_BLOCKING_WRITE,
				     NULL, errno, NULL);
	  }
      
      length -= written;
      data += written;
    }
  return NULL;
}

const struct exception *
write_raw_with_poll(int fd, UINT32 length, const UINT8 *data)
{
  while(length)
    {
      struct pollfd pfd;
      int res;
      int written;
      
      pfd.fd = fd;
      pfd.events = POLLOUT;

      res = poll(&pfd, 1, -1);

      if (res < 0)
	switch(errno)
	  {
	  case EINTR:
	  case EAGAIN:
	    continue;
	  default:
	    return make_io_exception(EXC_IO_BLOCKING_WRITE,
				     NULL, errno, NULL);
	  }
      
      written = write(fd, data, length);

      if (written < 0)
	switch(errno)
	  {
	  case EINTR:
	  case EAGAIN:
	    continue;
	  default:
	    return make_io_exception(EXC_IO_BLOCKING_WRITE,
				     NULL, errno, NULL);
	  }
      
      length -= written;
      data += written;
    }
  return NULL;
}

863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
/* For fd:s in blocking mode. */
const struct exception *
read_raw(int fd, UINT32 length, UINT8 *data)
{
  while(length)
    {
      int done = read(fd, data, length);

      if (done < 0)
	switch(errno)
	  {
	  case EINTR:
	  case EAGAIN:
	    continue;
	  default:
	    return make_io_exception(EXC_IO_BLOCKING_READ,
				     NULL, errno, NULL);
	  }
      else if (done == 0)
	{
	  /* EOF. */
	  /* FIXME: Indicate the amount of data read, somehow. */
	  return make_io_exception(EXC_IO_BLOCKING_READ,
				   NULL, 0, NULL);
	}
	
      length -= done;
      data += done;
    }
  return NULL;
}
Niels Möller's avatar
Niels Möller committed
894
895
896

/* Network utility functions */

897
/* Converts a string port number or service name to a port number.
898
899
 * Returns the port number in _host_ byte order, or 0 if lookup
 * fails. */
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920

int get_portno(const char *service, const char *protocol)
{
  if (service == NULL)
    return 0;
  else
    {
      char *end;
      long portno;

      portno = strtol(service, &end, 10);
      if (portno > 0
	  &&  portno <= 65535
	  &&  end != service
	  &&  *end == '\0')
	  return portno;
      else
	{
	  struct servent * serv;

	  serv = getservbyname(service, protocol);
921
922
	  if (!serv)
	    return 0;
923
924
925
926
927
928
	  return ntohs(serv->s_port);
	}
    }
}


929
930
931
932
933
/* If def != 0, use that value as a fallback if the lookup fails. */
struct address_info *
make_address_info_c(const char *host,
		    const char *port,
		    int def)
934
935
{
  int portno = get_portno(port, "tcp");
936
937
938
939
940
941
  if (!portno)
    portno = def;

  if (!portno)
    return NULL;

942
943
944
945
946
  else
    {
      NEW(address_info, info);
      
      info->port = portno;
947
      info->ip = host ? ssh_format("%lz", host) : NULL;
948
949
950
951
      
      return info;
    }
}
952

953
954
struct address_info *
make_address_info(struct lsh_string *host, UINT32 port)
955
956
957
958
959
960
961
962
{
  NEW(address_info, info);

  info->port = port; /* htons(port); */
  info->ip = host;
  return info;
}

963
964
965
struct address_info *
sockaddr2info(size_t addr_len UNUSED,
	      struct sockaddr *addr)
966
{
967
  NEW(address_info, info);
968
969
970
971
972
973
974
  
  switch(addr->sa_family)
    {
    case AF_INET:
      {
	struct sockaddr_in *in = (struct sockaddr_in *) addr;
	UINT32 ip = ntohl(in->sin_addr.s_addr);
975
	info->port = ntohs(in->sin_port);
976
977
978
979
980
	info->ip = ssh_format("%di.%di.%di.%di",
			      (ip >> 24) & 0xff,
			      (ip >> 16) & 0xff,
			      (ip >> 8) & 0xff,
			      ip & 0xff);
981
982
	return info;
      }
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
#if WITH_IPV6
    case AF_INET6:
      {
	struct sockaddr_in6 *in = (struct sockaddr_in6 *) addr;
	UINT8 *ip = in->sin6_addr.s6_addr;
	info->port = ntohs(in->sin6_port);
	info->ip = ssh_format("%xi:%xi:%xi:%xi:%xi:%xi:%xi:%xi",
			      (ip[0]  << 8) | ip[1],
			      (ip[2]  << 8) | ip[3],
			      (ip[4]  << 8) | ip[5],
			      (ip[6]  << 8) | ip[7],
			      (ip[8]  << 8) | ip[9],
			      (ip[10] << 8) | ip[11],
			      (ip[12] << 8) | ip[13],
			      (ip[14] << 8) | ip[15]);
	return info;
      }
1000
1001
#endif
    default:
1002
1003
      werror("io.c: sockaddr2info(): Unsupported address family.\n");
      return NULL;
1004
1005
    }
}
1006

1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
#if HAVE_GETADDRINFO
static struct addrinfo *
choose_address(struct addrinfo *list,
	       const int *preference)
{
  int i;
  for (i = 0; preference[i]; i++)
    {
      struct addrinfo *p;
      for (p = list; p; p = p->ai_next)
	if (preference[i] == p->ai_family)
	  return p;
    }
  return NULL;
}
#endif /* HAVE_GETADDRINFO */

/* FIXME: Perhaps this function should be changed to return a list of
 * sockaddr:s? */
1026
1027
1028
struct sockaddr *
address_info2sockaddr(socklen_t *length,
		      struct address_info *a,
1029
1030
		      /* Preferred address families. Zero-terminated array. */
		      const int *preference,
1031
		      int lookup)
1032
{
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
  char *host;

  if (a->ip)
    {
      host = alloca(a->ip->length + 1);
  
      memcpy(host, a->ip->data, a->ip->length);
      host[a->ip->length] = '\0';
    }
  else
    host = NULL;
1044
1045
1046
1047
1048

/* Some systems have getaddrinfo(), but still doesn't implement all of
 * RFC 2553 */
#if defined(HAVE_GETADDRINFO) && \
    defined(HAVE_GAI_STRERROR) && defined(HAVE_AI_NUMERICHOST)
1049
1050
1051
  {
    struct addrinfo hints;
    struct addrinfo *list;
1052
    struct addrinfo *chosen;
1053
    struct sockaddr *res;
1054
1055
1056
1057
1058
1059
1060
    const int default_preference
#if WITH_IPV6
      [3] = { AF_INET6, AF_INET }
#else
      [2] = { AF_INET, 0 }
#endif      
      ;
1061
1062
1063
    int err;
    /* FIXME: It seems ugly to have to convert the port number to a
     * string. */
1064
    struct lsh_string *service = ssh_cformat("%di", a->port);
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078

    memset(&hints, 0, sizeof(hints));
    hints.ai_family = PF_UNSPEC;
    hints.ai_socktype = SOCK_STREAM;
    hints.ai_flags = AI_PASSIVE;

    if (!lookup)
      hints.ai_flags |= AI_NUMERICHOST;
    
    err = getaddrinfo(host, service->data, &hints, &list);
    lsh_string_free(service);

    if (err)
      {
1079
	debug("address_info2sockaddr: getaddrinfo failed (err = %d): %z\n",
1080
1081
1082
1083
	      err, gai_strerror(err));
	return NULL;
      }

1084
1085
1086
1087
1088
1089
1090
1091
1092
    chosen = choose_address(list,
			    preference ? preference : default_preference);
    if (!chosen)
      {
	freeaddrinfo(list);
	return NULL;
      }
    
    *length = chosen->ai_addrlen;
1093
1094
    
    res = lsh_space_alloc(*length);
1095
    memcpy(res, chosen->ai_addr, *length);
1096
1097
1098
1099
    freeaddrinfo(list);

    return res;
  }
1100
1101
1102
#else
/* !(defined(HAVE_GETADDRINFO) &&
     defined(HAVE_GAI_STRERROR) && defined(HAVE_AI_NUMERICHOST) */ 
1103
1104

#if WITH_IPV6
1105
#error IPv6 enabled, but getaddrinfo() and friends were not found. 
1106
#endif
1107

1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
  if (a->ip && memchr(a->ip->data, ':', a->ip->length))
    {
      debug("address_info2sockaddr: Literal IPv6 used. Failing.\n");
      return NULL;
    }
  else
    {
      struct sockaddr_in *addr;
      NEW_SPACE(addr);

      *length = sizeof(*addr);
      addr->sin_port = htons(a->port);
1120
1121
1122

      /* Use IPv4 only */
      addr->sin_family = AF_INET;
1123
1124
    
      if (!host)
1125
1126
	/* Any interface */
	addr->sin_addr.s_addr = INADDR_ANY;
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157

      else
	{
	  /* First check for numerical ip-number */
#if HAVE_INET_ATON
	  if (!inet_aton(host, &addr->sin_addr))
#else /* !HAVE_INET_ATON */
	    /* NOTE: It is wrong to work with ((unsigned long int) -1)
	     * directly, as this breaks Linux/Alpha systems. But
	     * INADDR_NONE isn't portable. That's what inet_aton is for;
	     * see the GNU libc documentation. */
# ifndef INADDR_NONE
# define INADDR_NONE ((unsigned long int) -1)
# endif /* !INADDR_NONE */
	  addr->sin_addr.s_addr = inet_addr(host);
	  if (addr->sin_addr.s_addr == INADDR_NONE)
#endif  /* !HAVE_INET_ATON */
	    {
	      struct hostent *hp;

	      if (! (lookup 
		     && (hp = gethostbyname(host))
		     && (hp->h_addrtype == AF_INET)))
		{
		  lsh_space_free(addr);
		  return NULL;
		}

	      memcpy(&addr->sin_addr, hp->h_addr, hp->h_length);
	    }
	}
1158
      return (struct sockaddr *) addr;
1159
1160
1161
1162
    }
#endif /* !HAVE_GETADDRINFO */  
}

1163

Niels Möller's avatar
Niels Möller committed
1164
1165
void io_set_nonblocking(int fd)
{
1166
1167
1168
1169
1170
1171
1172
  int old = fcntl(fd, F_GETFL);

  if (old < 0)
    fatal("io_set_nonblocking: fcntl(F_GETFL) failed, %z", STRERROR(errno));
  
  if (fcntl(fd, F_SETFL, old | O_NONBLOCK) < 0)
    fatal("io_set_nonblocking: fcntl(F_SETFL) failed, %z", STRERROR(errno));
Niels Möller's avatar
Niels Möller committed
1173
1174
}

1175
1176
void io_set_close_on_exec(int fd)
{
1177
1178
1179
1180
1181
1182
1183
1184
1185
  /* NOTE: There's only one documented flag bit, so reading the old
   * value should be redundant. */
  
  int old = fcntl(fd, F_GETFD);

  if (old < 0)
    fatal("io_set_nonblocking: fcntl(F_GETFD) failed, %z", STRERROR(errno));
  
  if (fcntl(fd, F_SETFD, old | 1) < 0)
1186
    fatal("Can't set close-on-exec flag for fd %i: %z\n",
1187
	  fd, STRERROR(errno));
1188
1189
}

Niels Möller's avatar
Niels Möller committed
1190

1191
1192
1193
1194
1195
1196
1197
1198
1199
/* ALL file descripters handled by the backend should use non-blocking mode,
 * and have the close-on-exec flag set. */

void io_init_fd(int fd)
{
  io_set_nonblocking(fd);
  io_set_close_on_exec(fd);
}

1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
struct lsh_fd *
make_lsh_fd(struct io_backend *b,
	    int fd,
	    struct exception_handler *e)
{
  NEW(lsh_fd, f);

  io_init_fd(fd);
  init_file(b, f, fd, e);

  return f;
}

Niels Möller's avatar
Niels Möller committed
1213
/* Some code is taken from Thomas Bellman's tcputils. */
1214
struct lsh_fd *
1215
io_connect(struct io_backend *b,
1216
1217
	   struct sockaddr *remote,
	   socklen_t remote_length,
1218
	   struct command_continuation *c,
1219
	   struct exception_handler *e)
Niels Möller's avatar
Niels Möller committed
1220
{
1221
  int s = socket(remote->sa_family, SOCK_STREAM, 0);
1222
  struct lsh_fd *fd;
Niels Möller's avatar
Niels Möller committed
1223
  
1224
1225
  if (s<0)
    return NULL;
Niels Möller's avatar
Niels Möller committed
1226

1227
  trace("io.c: Connecting using fd %i\n", s);
1228
  
1229
  io_init_fd(s);
Niels Möller's avatar
Niels Möller committed
1230

1231
#if 0
1232
1233
1234
1235
1236
1237
1238
  if (local  &&  bind(s, (struct sockaddr *)local, sizeof *local) < 0)
    {
      int saved_errno = errno;
      close(s);
      errno = saved_errno;
      return NULL;
    }
1239
1240
1241
#endif
  
  if ( (connect(s, remote, remote_length) < 0)
1242
1243
1244
1245
1246
1247
1248
1249
       && (errno != EINPROGRESS) )       
    {
      int saved_errno = errno;
      close(s);
      errno = saved_errno;
      return NULL;
    }

1250
1251
1252
1253
  fd = make_lsh_fd(b, s, e);
  
  fd->want_write = 1;
  fd->write = make_connect_callback(c);
1254
    
1255
  return fd;
Niels Möller's avatar
Niels Möller committed
1256
1257
}

1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
struct lsh_fd *
io_listen(struct io_backend *b,
	  struct sockaddr *local,
	  socklen_t length,
	  struct io_callback *callback,
	  struct exception_handler *e)
{
  int s = socket(local->sa_family, SOCK_STREAM, 0);
  struct lsh_fd *fd;
  
  if (s<0)
    return NULL;

  trace("io.c: Listening on fd %i\n", s);
  
  io_init_fd(s);

  {
    int yes = 1;
    setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (char*)&yes, sizeof yes);
  }

  if (bind(s, (struct sockaddr *)local, length) < 0)
    {
      close(s);
      return NULL;
    }

  if (listen(s, 256) < 0) 
    {
      close(s);
      return NULL;
    }

  fd = make_lsh_fd(b, s, e);

  fd->want_read = 1;
  fd->read = callback;

  return fd;
}

1300
1301
1302

/* AF_LOCAL sockets */

1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
/* Requires DIRECTORY and NAME to be NUL-terminated */

struct local_info *
make_local_info(struct lsh_string *directory,
		struct lsh_string *name)
{
  if (!directory || !name || memchr(name->data, '/', name->length))
    return NULL;

  assert(NUL_TERMINATED(directory));
  assert(NUL_TERMINATED(name));
  
  {
    NEW(local_info, self);
    self->directory = directory;
    self->name = name;
    return self;
  }
}

1323
static void
1324
safe_popd(int old_cd, const char *directory)
1325
{
1326
1327
  while (fchdir(old_cd) < 0)
    if (errno != EINTR)
1328
      fatal("io.c: Failed to cd back from %z (errno = %i): %z\n",
1329
1330
1331
1332
1333
1334
1335
1336
	    directory, errno, STRERROR(errno));
      
  close(old_cd);
}

/* Changes the cwd, making sure that it it has reasonable permissions,
 * and that we can change back later. */
static int
1337
safe_pushd(const char *directory,
1338
1339
1340
1341
1342
1343
1344
1345
	   int create)
{
  int old_cd;
  struct stat sbuf;

  if (create)
    {  
      /* First create the directory, in case it doesn't yet exist. */
1346
      if ( (mkdir(directory, 0700) < 0)
1347
1348
	   && (errno != EEXIST) )
	{
1349
	  werror("io.c: Creating directory %z failed "
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360