summaryrefslogtreecommitdiff
path: root/trans/fifo.c
blob: 08d20198470390a9288ce0d173de221a34126240 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
/* A translator for fifos

   Copyright (C) 1995 Free Software Foundation, Inc.

   Written by Miles Bader <miles@gnu.ai.mit.edu>

   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, 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
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */

#include <stdio.h>
#include <errno.h>
#include <getopt.h>
#include <unistd.h>
#include <error.h>
#include <string.h>
#include <fcntl.h>

#include <cthreads.h>
#include <hurd.h>
#include <hurd/ports.h>
#include <hurd/trivfs.h>
#include <hurd/fsys.h>
#include <hurd/pipe.h>

/* Global options.  These defaults are the standard ones, I think...   */
int wait_for_reader = 1, wait_for_writer = 1;
int one_reader = 1;

/* What kinds of pipes we use.  */
struct pipe_class *fifo_pipe_class;

/* The current fifo that new opens will see, or NULL if there is none.  */
struct pipe *active_fifo = NULL;

/* Lock this when changing ACTIVE_FIFO.  */
struct mutex active_fifo_lock;
/* Signal this when ACTIVE_FIFO may have changed.  */
struct condition active_fifo_changed;

/* ---------------------------------------------------------------- */

#define USAGE "Usage: %s [OPTION...]\n"

static void
usage(int status)
{
  if (status != 0)
    fprintf(stderr, "Try `%s --help' for more information.\n",
	    program_invocation_name);
  else
    {
      printf(USAGE, program_invocation_name);
      printf("\
\n\
  -r, --multiple-readers     Allow multiple simultaneous readers\n\
  -n, --noblock              Don't block on open\n\
  -d, --dgram                Reads reflect write record boundaries\n\
      --help                 Give this usage message\n\
");
    }

  exit(status);
}

#define SHORT_OPTIONS "&"

static struct option options[] =
{
  {"multiple-readers", no_argument, 0, 'r'},
  {"noblock", no_argument, 0, 'n'},
  {"dgram", no_argument, 0, 'd'},
  {"help", no_argument, 0, '&'},
  {0, 0, 0, 0}
};

/* ---------------------------------------------------------------- */

struct port_class *trivfs_protid_portclasses[1];
struct port_class *trivfs_cntl_portclasses[1];
int trivfs_protid_nportclasses = 1;
int trivfs_cntl_nportclasses = 1;

void
main (int argc, char **argv)
{
  int opt;
  error_t err;
  mach_port_t bootstrap;
  struct port_bucket *port_bucket;
  struct port_class *fifo_port_class, *fsys_port_class;

  fifo_pipe_class = stream_pipe_class;

  while ((opt = getopt_long(argc, argv, SHORT_OPTIONS, options, 0)) != EOF)
    switch (opt)
      {
      case 'r': one_reader = 0; break;
      case 'n': wait_for_reader = wait_for_writer = 0; break;
      case 'd': fifo_pipe_class = seqpack_pipe_class;
      case '&': usage(0);
      default:  usage(1);
      }

  if (argc != 1)
    {
      fprintf(stderr, "Usage: %s", program_invocation_name);
      exit(1);
    }
  
  port_bucket = ports_create_bucket ();
  fifo_port_class = ports_create_class (trivfs_clean_protid, 0);
  fsys_port_class = ports_create_class (trivfs_clean_cntl, 0);

  trivfs_protid_portclasses[0] = fifo_port_class;
  trivfs_cntl_portclasses[0] = fsys_port_class;

  task_get_bootstrap_port (mach_task_self (), &bootstrap);
  if (bootstrap == MACH_PORT_NULL)
    error(1, 0, "must be started as a translator");

  /* Reply to our parent */
  err = trivfs_startup(bootstrap,
		       fsys_port_class, port_bucket,
		       fifo_port_class, port_bucket,
		       NULL);
  if (err)
    error(3, err, "Contacting parent");

  /* Launch. */
  do
    {
      ports_enable_class (fifo_port_class);
      ports_manage_port_operations_multithread (port_bucket,
						trivfs_demuxer,
						30*1000, 5*60*1000, 0, 0);
    }
  while (ports_count_class (fifo_port_class) > 0);

  exit(0);
}

/* ---------------------------------------------------------------- */

static error_t
open_hook (struct trivfs_peropen *po)
{
  error_t err = 0;
  int flags = po->openmodes;

/* Wait until the active fifo has changed so that CONDITION is true.  */
#define WAIT(condition) 						     \
  while (!err && !(condition)) 						     \
    if (flags & O_NONBLOCK) 						     \
      err = EWOULDBLOCK; 						     \
    else if (hurd_condition_wait (&active_fifo_changed, &active_fifo_lock))  \
      err = EINTR;

  mutex_lock (&active_fifo_lock);

  if (flags & O_READ)
    /* When opening for read, what we do depends on what mode this server is
       running in.  The default (if ONE_READER is set) is to only allow one
       reader at a time, with additional opens for read blocking here until
       the old reader goes away; otherwise, we allow multiple readers.  If
       WAIT_FOR_WRITER is true, then once we've created a fifo, we also block
       until someone opens it for writing; otherwise, the first read will
       block until someone writes something.  */
    {
      if (one_reader)
	/* Wait until there isn't any active fifo, so we can make one. */
	WAIT (!active_fifo || !active_fifo->readers);

      if (!err && active_fifo == NULL)
	/* No other readers, and indeed, no fifo; make one.  */
	err = pipe_create (fifo_pipe_class, &active_fifo);
      if (!err)
	{
	  pipe_add_reader (active_fifo);
	  condition_broadcast (&active_fifo_changed);
	  /* We'll unlock ACTIVE_FIFO_LOCK below; the writer code won't make
	     us block because we've ensured that there's a reader for it.  */

	  if (wait_for_writer)
	    /* Wait until there's a writer.  */
	    {
	      WAIT (active_fifo->writers);
	      if (err)
		/* Back out the new pipe creation.  */
		{
		  pipe_remove_reader (active_fifo);
		  active_fifo = NULL;
		  condition_broadcast (&active_fifo_changed);
		}
	    }
	  else
	    /* Otherwise prevent an immediate eof.  */
	    active_fifo->flags &= ~PIPE_BROKEN;
	}
    }

  if (!err && (flags & O_WRITE))
    /* Open the active_fifo for writing.  If WAIT_FOR_READER is true, then we
       block until there's someone to read what we wrote, otherwise, if
       there's no fifo, we create one, which we just write into and leave it
       for someone to read later.  */
    {
      if (wait_for_reader)
	/* Wait until there's a fifo to write to.  */
	WAIT (active_fifo && active_fifo->readers);
      if (!err && active_fifo == NULL)
	/* No other readers, and indeed, no fifo; make one.  */
	{
	  err = pipe_create (fifo_pipe_class, &active_fifo);
	  if (!err)
	    active_fifo->flags &= ~PIPE_BROKEN;
	}
      if (!err)
	{
	  pipe_add_writer (active_fifo);
	  condition_broadcast (&active_fifo_changed);
	}
    }

  po->hook = active_fifo;

  mutex_unlock (&active_fifo_lock);

  return err;
}

static void
close_hook (struct trivfs_peropen *po)
{
  int was_active, going_away = 0;
  int flags = po->openmodes;
  struct pipe *pipe = po->hook;

  if (!pipe)
    return;

  mutex_lock (&active_fifo_lock);
  was_active = (active_fifo == pipe);

  if (was_active)
    {
      /* We're the last reader; when we're gone there is no more joy.  */
      going_away = ((flags & O_READ) && pipe->readers == 1);
    }
  else
    /* Let others have their fun.  */
    mutex_unlock (&active_fifo_lock);

  if (flags & O_READ)
    pipe_remove_reader (pipe);
  if (flags & O_WRITE)
    pipe_remove_writer (pipe);
  /* At this point, PIPE may be gone, so we can't look at it again.  */

  if (was_active)
    {
      if (going_away)
	active_fifo = NULL;
      condition_broadcast (&active_fifo_changed);
      mutex_unlock (&active_fifo_lock);
    }
}

/* Trivfs hooks  */

int trivfs_fstype = FSTYPE_MISC;
int trivfs_fsid = 0;

int trivfs_support_read = 1;
int trivfs_support_write = 1;
int trivfs_support_exec = 0;

int trivfs_allow_open = O_READ | O_WRITE;

error_t (*trivfs_peropen_create_hook) (struct trivfs_peropen *) = open_hook;
void (*trivfs_peropen_destroy_hook) (struct trivfs_peropen *) = close_hook;

void
trivfs_modify_stat (struct trivfs_protid *cred, struct stat *st)
{
  struct pipe *pipe = cred->po->hook;

  st->st_mode &= ~S_IFMT;
  st->st_mode |= S_IFIFO;

  if (pipe)
    {
      mutex_lock (&pipe->lock);
      st->st_size = pipe_readable (pipe, 1);
      st->st_blocks = st->st_size >> 9;
      mutex_unlock (&pipe->lock);
    }

  /* As we try to be clever with large transfers, ask for them. */
  st->st_blksize = vm_page_size * 16;
}

error_t
trivfs_goaway (struct trivfs_control *cntl, int flags)
{
  struct port_bucket *bucket = ((struct port_info *)cntl)->bucket;

  ports_inhibit_bucket_rpcs (bucket);
  if (ports_count_class (cntl->protid_class) > 0
      && !(flags & FSYS_GOAWAY_FORCE))
    /* Still some opens, and we're not being forced to go away, so don't.  */
    {
      ports_enable_class (cntl->protid_class);
      ports_resume_bucket_rpcs (bucket);
      return EBUSY;
    }

  exit(0);
}

/* ---------------------------------------------------------------- */

/* Return objects mapping the data underlying this memory object.  If
   the object can be read then memobjrd will be provided; if the
   object can be written then memobjwr will be provided.  For objects
   where read data and write data are the same, these objects will be
   equal, otherwise they will be disjoint.  Servers are permitted to
   implement io_map but not io_map_cntl.  Some objects do not provide
   mapping; they will set none of the ports and return an error.  Such
   objects can still be accessed by io_read and io_write.  */
error_t
trivfs_S_io_map(struct trivfs_protid *cred,
		memory_object_t *rdobj,
		mach_msg_type_name_t *rdtype,
		memory_object_t *wrobj,
		mach_msg_type_name_t *wrtype)
{
  return EINVAL;
}

/* ---------------------------------------------------------------- */

/* Read data from an IO object.  If offset if -1, read from the object
   maintained file pointer.  If the object is not seekable, offset is
   ignored.  The amount desired to be read is in AMT.  */
error_t
trivfs_S_io_read (struct trivfs_protid *cred,
		  mach_port_t reply, mach_msg_type_name_t reply_type,
		  char **data, size_t *data_len,
		  off_t offs, size_t amount)
{
  error_t err;

  if (!cred)
    err = EOPNOTSUPP;
  else if (!(cred->po->openmodes & O_READ))
    err = EBADF;
  else
    {
      struct pipe *pipe = cred->po->hook;
      mutex_lock (&pipe->lock);
      err = pipe_read (pipe, cred->po->openmodes & O_NONBLOCK, NULL,
		       data, data_len, amount);
      mutex_unlock (&pipe->lock);
    }

  return err;
}

/* ---------------------------------------------------------------- */

/* Tell how much data can be read from the object without blocking for
   a "long time" (this should be the same meaning of "long time" used
   by the nonblocking flag.  */
error_t
trivfs_S_io_readable (struct trivfs_protid *cred,
		      mach_port_t reply, mach_msg_type_name_t reply_type,
		      size_t *amount)
{
  error_t err;

  if (!cred)
    err = EOPNOTSUPP;
  else if (!(cred->po->openmodes & O_READ))
    err = EBADF;
  else
    {
      struct pipe *pipe = cred->po->hook;
      mutex_lock (&pipe->lock);
      *amount = pipe_readable (pipe, 1);
      mutex_unlock (&pipe->lock);
      err = 0;
    }

  return err;
}

/* ---------------------------------------------------------------- */

/* Change current read/write offset */
error_t
trivfs_S_io_seek (struct trivfs_protid *cred,
		  mach_port_t reply, mach_msg_type_name_t reply_type,
		  off_t offset, int whence, off_t *new_offset)
{
  if (!cred)
    return EOPNOTSUPP;
  return ESPIPE;
}

/* ---------------------------------------------------------------- */

/* SELECT_TYPE is the bitwise OR of SELECT_READ, SELECT_WRITE, and SELECT_URG.
   Block until one of the indicated types of i/o can be done "quickly", and
   return the types that are then available.  ID_TAG is returned as passed; it
u   is just for the convenience of the user in matching up reply messages with
   specific requests sent.  */
error_t
trivfs_S_io_select (struct trivfs_protid *cred,
		    mach_port_t reply, mach_msg_type_name_t reply_type,
		    int *select_type, int *tag)
{
  if (!cred)
    return EOPNOTSUPP;
  *select_type &= SELECT_READ | SELECT_WRITE;
  return pipe_pair_select (cred->hook, cred->hook, select_type, 1);
}

/* ---------------------------------------------------------------- */

/* Write data to an IO object.  If offset is -1, write at the object
   maintained file pointer.  If the object is not seekable, offset is
   ignored.  The amount successfully written is returned in amount.  A
   given user should not have more than one outstanding io_write on an
   object at a time; servers implement congestion control by delaying
   responses to io_write.  Servers may drop data (returning ENOBUFS)
   if they recevie more than one write when not prepared for it.  */
error_t
trivfs_S_io_write (struct trivfs_protid *cred,
		   mach_port_t reply, mach_msg_type_name_t reply_type,
		   char *data, size_t data_len,
		   off_t offs, size_t *amount)
{
  error_t err;

  if (!cred)
    err = EOPNOTSUPP;
  else
    {
      int flags = cred->po->openmodes;
      struct pipe *pipe = cred->po->hook;

      if (!(flags & O_WRITE))
	err = EBADF;
      else
	{
	  mutex_lock (&pipe->lock);
	  err = pipe_write (pipe, flags & O_NONBLOCK, NULL,
			    data, data_len, amount);
	  mutex_unlock (&pipe->lock);
	}
    }

  return err;
}

/* ---------------------------------------------------------------- */

/* Truncate file.  */
error_t
trivfs_S_file_truncate (struct trivfs_protid *cred, off_t size)
{
  return 0;
}

/* ---------------------------------------------------------------- */
/* These four routines modify the O_APPEND, O_ASYNC, O_FSYNC, and
   O_NONBLOCK bits for the IO object. In addition, io_get_openmodes
   will tell you which of O_READ, O_WRITE, and O_EXEC the object can
   be used for.  The O_ASYNC bit affects icky async I/O; good async 
   I/O is done through io_async which is orthogonal to these calls. */

error_t
trivfs_S_io_get_openmodes (struct trivfs_protid *cred,
			   mach_port_t reply, mach_msg_type_name_t reply_type,
			   int *bits)
{
  if (!cred)
    return EOPNOTSUPP;
  else
    {
      *bits = cred->po->openmodes;
      return 0;
    }
}

error_t
trivfs_S_io_set_all_openmodes(struct trivfs_protid *cred,
			      mach_port_t reply,
			      mach_msg_type_name_t reply_type,
			      int mode)
{
  if (!cred)
    return EOPNOTSUPP;
  else
    return 0;
}

error_t
trivfs_S_io_set_some_openmodes (struct trivfs_protid *cred,
				mach_port_t reply,
				mach_msg_type_name_t reply_type,
				int bits)
{
  if (!cred)
    return EOPNOTSUPP;
  else
    return 0;
}

error_t
trivfs_S_io_clear_some_openmodes (struct trivfs_protid *cred,
				  mach_port_t reply,
				  mach_msg_type_name_t reply_type,
				  int bits)
{
  if (!cred)
    return EOPNOTSUPP;
  else
    return 0;
}

/* ---------------------------------------------------------------- */
/* Get/set the owner of the IO object.  For terminals, this affects
   controlling terminal behavior (see term_become_ctty).  For all
   objects this affects old-style async IO.  Negative values represent
   pgrps.  This has nothing to do with the owner of a file (as
   returned by io_stat, and as used for various permission checks by
   filesystems).  An owner of 0 indicates that there is no owner.  */

error_t
trivfs_S_io_get_owner (struct trivfs_protid *cred,
		       mach_port_t reply,
		       mach_msg_type_name_t reply_type,
		       pid_t *owner)
{
  if (!cred)
    return EOPNOTSUPP;
  *owner = 0;
  return 0;
}

error_t
trivfs_S_io_mod_owner (struct trivfs_protid *cred,
		       mach_port_t reply, mach_msg_type_name_t reply_type,
		       pid_t owner)
{
  if (!cred)
    return EOPNOTSUPP;
  else
    return EINVAL;
}