2 * Copyright (c) 1990, 1993, 1995
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * @(#)fifo_vnops.c 8.10 (Berkeley) 5/27/95
34 * $FreeBSD: src/sys/miscfs/fifofs/fifo_vnops.c,v 1.45.2.4 2003/04/22 10:11:24 bde Exp $
35 * $DragonFly: src/sys/vfs/fifofs/fifo_vnops.c,v 1.12 2003/09/04 23:46:59 hmp Exp $
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/unistd.h>
41 #include <sys/kernel.h>
43 #include <sys/malloc.h>
44 #include <sys/vnode.h>
45 #include <sys/socket.h>
46 #include <sys/socketvar.h>
47 #include <sys/filio.h>
48 #include <sys/fcntl.h>
50 #include <sys/event.h>
56 * This structure is associated with the FIFO vnode and stores
57 * the state associated with the FIFO.
60 struct socket *fi_readsock;
61 struct socket *fi_writesock;
66 static int fifo_badop (void);
67 static int fifo_print (struct vop_print_args *);
68 static int fifo_lookup (struct vop_lookup_args *);
69 static int fifo_open (struct vop_open_args *);
70 static int fifo_close (struct vop_close_args *);
71 static int fifo_read (struct vop_read_args *);
72 static int fifo_write (struct vop_write_args *);
73 static int fifo_ioctl (struct vop_ioctl_args *);
74 static int fifo_poll (struct vop_poll_args *);
75 static int fifo_kqfilter (struct vop_kqfilter_args *);
76 static int fifo_inactive (struct vop_inactive_args *);
77 static int fifo_bmap (struct vop_bmap_args *);
78 static int fifo_pathconf (struct vop_pathconf_args *);
79 static int fifo_advlock (struct vop_advlock_args *);
81 static void filt_fifordetach(struct knote *kn);
82 static int filt_fiforead(struct knote *kn, long hint);
83 static void filt_fifowdetach(struct knote *kn);
84 static int filt_fifowrite(struct knote *kn, long hint);
86 static struct filterops fiforead_filtops =
87 { 1, NULL, filt_fifordetach, filt_fiforead };
88 static struct filterops fifowrite_filtops =
89 { 1, NULL, filt_fifowdetach, filt_fifowrite };
91 vop_t **fifo_vnodeop_p;
92 static struct vnodeopv_entry_desc fifo_vnodeop_entries[] = {
93 { &vop_default_desc, (vop_t *) vop_defaultop },
94 { &vop_access_desc, (vop_t *) vop_ebadf },
95 { &vop_advlock_desc, (vop_t *) fifo_advlock },
96 { &vop_bmap_desc, (vop_t *) fifo_bmap },
97 { &vop_close_desc, (vop_t *) fifo_close },
98 { &vop_create_desc, (vop_t *) fifo_badop },
99 { &vop_getattr_desc, (vop_t *) vop_ebadf },
100 { &vop_inactive_desc, (vop_t *) fifo_inactive },
101 { &vop_ioctl_desc, (vop_t *) fifo_ioctl },
102 { &vop_kqfilter_desc, (vop_t *) fifo_kqfilter },
103 { &vop_lease_desc, (vop_t *) vop_null },
104 { &vop_link_desc, (vop_t *) fifo_badop },
105 { &vop_lookup_desc, (vop_t *) fifo_lookup },
106 { &vop_mkdir_desc, (vop_t *) fifo_badop },
107 { &vop_mknod_desc, (vop_t *) fifo_badop },
108 { &vop_open_desc, (vop_t *) fifo_open },
109 { &vop_pathconf_desc, (vop_t *) fifo_pathconf },
110 { &vop_poll_desc, (vop_t *) fifo_poll },
111 { &vop_print_desc, (vop_t *) fifo_print },
112 { &vop_read_desc, (vop_t *) fifo_read },
113 { &vop_readdir_desc, (vop_t *) fifo_badop },
114 { &vop_readlink_desc, (vop_t *) fifo_badop },
115 { &vop_reallocblks_desc, (vop_t *) fifo_badop },
116 { &vop_reclaim_desc, (vop_t *) vop_null },
117 { &vop_remove_desc, (vop_t *) fifo_badop },
118 { &vop_rename_desc, (vop_t *) fifo_badop },
119 { &vop_rmdir_desc, (vop_t *) fifo_badop },
120 { &vop_setattr_desc, (vop_t *) vop_ebadf },
121 { &vop_symlink_desc, (vop_t *) fifo_badop },
122 { &vop_write_desc, (vop_t *) fifo_write },
125 static struct vnodeopv_desc fifo_vnodeop_opv_desc =
126 { &fifo_vnodeop_p, fifo_vnodeop_entries };
128 VNODEOP_SET(fifo_vnodeop_opv_desc);
132 struct vop_generic_args /* {
133 struct vnodeop_desc *a_desc;
134 <other random data follows, presumably>
137 return (VOCALL(fifo_vnodeop_p, ap->a_desc->vdesc_offset, ap));
141 * Trivial lookup routine that always fails.
146 struct vop_lookup_args /* {
147 struct vnode * a_dvp;
148 struct vnode ** a_vpp;
149 struct componentname * a_cnp;
158 * Open called to set up a new instance of a fifo or
159 * to find an active instance of a fifo.
164 struct vop_open_args /* {
167 struct ucred *a_cred;
171 struct vnode *vp = ap->a_vp;
172 struct fifoinfo *fip;
173 struct socket *rso, *wso;
176 if ((fip = vp->v_fifoinfo) == NULL) {
177 MALLOC(fip, struct fifoinfo *, sizeof(*fip), M_VNODE, M_WAITOK);
178 vp->v_fifoinfo = fip;
179 error = socreate(AF_LOCAL, &rso, SOCK_STREAM, 0, ap->a_td);
182 vp->v_fifoinfo = NULL;
185 fip->fi_readsock = rso;
186 error = socreate(AF_LOCAL, &wso, SOCK_STREAM, 0, ap->a_td);
190 vp->v_fifoinfo = NULL;
193 fip->fi_writesock = wso;
194 error = unp_connect2(wso, rso);
199 vp->v_fifoinfo = NULL;
202 fip->fi_readers = fip->fi_writers = 0;
203 wso->so_snd.sb_lowat = PIPE_BUF;
204 rso->so_state |= SS_CANTRCVMORE;
206 if (ap->a_mode & FREAD) {
208 if (fip->fi_readers == 1) {
209 fip->fi_writesock->so_state &= ~SS_CANTSENDMORE;
210 if (fip->fi_writers > 0) {
211 wakeup((caddr_t)&fip->fi_writers);
212 sowwakeup(fip->fi_writesock);
216 if (ap->a_mode & FWRITE) {
218 if (fip->fi_writers == 1) {
219 fip->fi_readsock->so_state &= ~SS_CANTRCVMORE;
220 if (fip->fi_readers > 0) {
221 wakeup((caddr_t)&fip->fi_readers);
222 sorwakeup(fip->fi_writesock);
226 if ((ap->a_mode & FREAD) && (ap->a_mode & O_NONBLOCK) == 0) {
227 if (fip->fi_writers == 0) {
228 VOP_UNLOCK(vp, 0, ap->a_td);
229 error = tsleep((caddr_t)&fip->fi_readers,
230 PCATCH, "fifoor", 0);
231 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, ap->a_td);
235 * We must have got woken up because we had a writer.
236 * That (and not still having one) is the condition
237 * that we must wait for.
241 if (ap->a_mode & FWRITE) {
242 if (ap->a_mode & O_NONBLOCK) {
243 if (fip->fi_readers == 0) {
248 if (fip->fi_readers == 0) {
249 VOP_UNLOCK(vp, 0, ap->a_td);
250 error = tsleep((caddr_t)&fip->fi_writers,
251 PCATCH, "fifoow", 0);
252 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, ap->a_td);
256 * We must have got woken up because we had
257 * a reader. That (and not still having one)
258 * is the condition that we must wait for.
265 VOP_CLOSE(vp, ap->a_mode, ap->a_td);
275 struct vop_read_args /* {
279 struct ucred *a_cred;
282 struct uio *uio = ap->a_uio;
283 struct socket *rso = ap->a_vp->v_fifoinfo->fi_readsock;
284 struct thread *td = uio->uio_td;
285 int error, startresid;
288 if (uio->uio_rw != UIO_READ)
289 panic("fifo_read mode");
291 if (uio->uio_resid == 0)
293 if (ap->a_ioflag & IO_NDELAY)
294 rso->so_state |= SS_NBIO;
295 startresid = uio->uio_resid;
296 VOP_UNLOCK(ap->a_vp, 0, td);
297 error = soreceive(rso, (struct sockaddr **)0, uio, (struct mbuf **)0,
298 (struct mbuf **)0, (int *)0);
299 vn_lock(ap->a_vp, LK_EXCLUSIVE | LK_RETRY, td);
300 if (ap->a_ioflag & IO_NDELAY)
301 rso->so_state &= ~SS_NBIO;
311 struct vop_write_args /* {
315 struct ucred *a_cred;
318 struct socket *wso = ap->a_vp->v_fifoinfo->fi_writesock;
319 struct thread *td = ap->a_uio->uio_td;
323 if (ap->a_uio->uio_rw != UIO_WRITE)
324 panic("fifo_write mode");
326 if (ap->a_ioflag & IO_NDELAY)
327 wso->so_state |= SS_NBIO;
328 VOP_UNLOCK(ap->a_vp, 0, td);
329 error = sosend(wso, (struct sockaddr *)0, ap->a_uio, 0,
330 (struct mbuf *)0, 0, td);
331 vn_lock(ap->a_vp, LK_EXCLUSIVE | LK_RETRY, td);
332 if (ap->a_ioflag & IO_NDELAY)
333 wso->so_state &= ~SS_NBIO;
338 * Device ioctl operation.
343 struct vop_ioctl_args /* {
348 struct ucred *a_cred;
352 struct file filetmp; /* Local */
355 if (ap->a_command == FIONBIO)
357 if (ap->a_fflag & FREAD) {
358 filetmp.f_data = (caddr_t)ap->a_vp->v_fifoinfo->fi_readsock;
359 error = soo_ioctl(&filetmp, ap->a_command, ap->a_data, ap->a_td);
363 if (ap->a_fflag & FWRITE) {
364 filetmp.f_data = (caddr_t)ap->a_vp->v_fifoinfo->fi_writesock;
365 error = soo_ioctl(&filetmp, ap->a_command, ap->a_data, ap->a_td);
375 struct vop_kqfilter_args /* {
380 struct fifoinfo *fi = ap->a_vp->v_fifoinfo;
384 switch (ap->a_kn->kn_filter) {
386 ap->a_kn->kn_fop = &fiforead_filtops;
387 so = fi->fi_readsock;
391 ap->a_kn->kn_fop = &fifowrite_filtops;
392 so = fi->fi_writesock;
399 ap->a_kn->kn_hook = (caddr_t)so;
401 SLIST_INSERT_HEAD(&sb->sb_sel.si_note, ap->a_kn, kn_selnext);
402 sb->sb_flags |= SB_KNOTE;
408 filt_fifordetach(struct knote *kn)
410 struct socket *so = (struct socket *)kn->kn_hook;
412 SLIST_REMOVE(&so->so_rcv.sb_sel.si_note, kn, knote, kn_selnext);
413 if (SLIST_EMPTY(&so->so_rcv.sb_sel.si_note))
414 so->so_rcv.sb_flags &= ~SB_KNOTE;
418 filt_fiforead(struct knote *kn, long hint)
420 struct socket *so = (struct socket *)kn->kn_hook;
422 kn->kn_data = so->so_rcv.sb_cc;
423 if (so->so_state & SS_CANTRCVMORE) {
424 kn->kn_flags |= EV_EOF;
427 kn->kn_flags &= ~EV_EOF;
428 return (kn->kn_data > 0);
432 filt_fifowdetach(struct knote *kn)
434 struct socket *so = (struct socket *)kn->kn_hook;
436 SLIST_REMOVE(&so->so_snd.sb_sel.si_note, kn, knote, kn_selnext);
437 if (SLIST_EMPTY(&so->so_snd.sb_sel.si_note))
438 so->so_snd.sb_flags &= ~SB_KNOTE;
442 filt_fifowrite(struct knote *kn, long hint)
444 struct socket *so = (struct socket *)kn->kn_hook;
446 kn->kn_data = sbspace(&so->so_snd);
447 if (so->so_state & SS_CANTSENDMORE) {
448 kn->kn_flags |= EV_EOF;
451 kn->kn_flags &= ~EV_EOF;
452 return (kn->kn_data >= so->so_snd.sb_lowat);
458 struct vop_poll_args /* {
461 struct ucred *a_cred;
466 int events, revents = 0;
468 events = ap->a_events &
469 (POLLIN | POLLINIGNEOF | POLLPRI | POLLRDNORM | POLLRDBAND);
472 * If POLLIN or POLLRDNORM is requested and POLLINIGNEOF is
473 * not, then convert the first two to the last one. This
474 * tells the socket poll function to ignore EOF so that we
475 * block if there is no writer (and no data). Callers can
476 * set POLLINIGNEOF to get non-blocking behavior.
478 if (events & (POLLIN | POLLRDNORM) &&
479 !(events & POLLINIGNEOF)) {
480 events &= ~(POLLIN | POLLRDNORM);
481 events |= POLLINIGNEOF;
484 filetmp.f_data = (caddr_t)ap->a_vp->v_fifoinfo->fi_readsock;
486 revents |= soo_poll(&filetmp, events, ap->a_cred,
489 /* Reverse the above conversion. */
490 if ((revents & POLLINIGNEOF) &&
491 !(ap->a_events & POLLINIGNEOF)) {
492 revents |= (ap->a_events & (POLLIN | POLLRDNORM));
493 revents &= ~POLLINIGNEOF;
496 events = ap->a_events & (POLLOUT | POLLWRNORM | POLLWRBAND);
498 filetmp.f_data = (caddr_t)ap->a_vp->v_fifoinfo->fi_writesock;
500 revents |= soo_poll(&filetmp, events, ap->a_cred,
508 struct vop_inactive_args /* {
513 VOP_UNLOCK(ap->a_vp, 0, ap->a_td);
518 * This is a noop, simply returning what one has been given.
522 struct vop_bmap_args /* {
525 struct vnode **a_vpp;
532 if (ap->a_vpp != NULL)
533 *ap->a_vpp = ap->a_vp;
534 if (ap->a_bnp != NULL)
535 *ap->a_bnp = ap->a_bn;
536 if (ap->a_runp != NULL)
538 if (ap->a_runb != NULL)
544 * Device close routine
549 struct vop_close_args /* {
552 struct ucred *a_cred;
556 struct vnode *vp = ap->a_vp;
557 struct fifoinfo *fip = vp->v_fifoinfo;
560 if (ap->a_fflag & FREAD) {
562 if (fip->fi_readers == 0)
563 socantsendmore(fip->fi_writesock);
565 if (ap->a_fflag & FWRITE) {
567 if (fip->fi_writers == 0)
568 socantrcvmore(fip->fi_readsock);
570 if (vp->v_usecount > 1)
572 error1 = soclose(fip->fi_readsock);
573 error2 = soclose(fip->fi_writesock);
575 vp->v_fifoinfo = NULL;
583 * Print out internal contents of a fifo vnode.
589 struct fifoinfo *fip = vp->v_fifoinfo;
591 printf(", fifo with %ld readers and %ld writers",
592 fip->fi_readers, fip->fi_writers);
597 * Print out the contents of a fifo vnode.
601 struct vop_print_args /* {
606 printf("tag VT_NON");
607 fifo_printinfo(ap->a_vp);
613 * Return POSIX pathconf information applicable to fifo's.
617 struct vop_pathconf_args /* {
624 switch (ap->a_name) {
626 *ap->a_retval = LINK_MAX;
629 *ap->a_retval = PIPE_BUF;
631 case _PC_CHOWN_RESTRICTED:
641 * Fifo advisory byte-level locks.
646 struct vop_advlock_args /* {
655 return (ap->a_flags & F_FLOCK ? EOPNOTSUPP : EINVAL);
665 panic("fifo_badop called");