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.2 2003/06/17 04:28:42 dillon 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>
53 #include <miscfs/fifofs/fifo.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 __P((void));
67 static int fifo_print __P((struct vop_print_args *));
68 static int fifo_lookup __P((struct vop_lookup_args *));
69 static int fifo_open __P((struct vop_open_args *));
70 static int fifo_close __P((struct vop_close_args *));
71 static int fifo_read __P((struct vop_read_args *));
72 static int fifo_write __P((struct vop_write_args *));
73 static int fifo_ioctl __P((struct vop_ioctl_args *));
74 static int fifo_poll __P((struct vop_poll_args *));
75 static int fifo_kqfilter __P((struct vop_kqfilter_args *));
76 static int fifo_inactive __P((struct vop_inactive_args *));
77 static int fifo_bmap __P((struct vop_bmap_args *));
78 static int fifo_pathconf __P((struct vop_pathconf_args *));
79 static int fifo_advlock __P((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 proc *p = ap->a_p;
174 struct socket *rso, *wso;
177 if ((fip = vp->v_fifoinfo) == NULL) {
178 MALLOC(fip, struct fifoinfo *, sizeof(*fip), M_VNODE, M_WAITOK);
179 vp->v_fifoinfo = fip;
180 error = socreate(AF_LOCAL, &rso, SOCK_STREAM, 0, ap->a_p);
183 vp->v_fifoinfo = NULL;
186 fip->fi_readsock = rso;
187 error = socreate(AF_LOCAL, &wso, SOCK_STREAM, 0, ap->a_p);
191 vp->v_fifoinfo = NULL;
194 fip->fi_writesock = wso;
195 error = unp_connect2(wso, rso);
200 vp->v_fifoinfo = NULL;
203 fip->fi_readers = fip->fi_writers = 0;
204 wso->so_snd.sb_lowat = PIPE_BUF;
205 rso->so_state |= SS_CANTRCVMORE;
207 if (ap->a_mode & FREAD) {
209 if (fip->fi_readers == 1) {
210 fip->fi_writesock->so_state &= ~SS_CANTSENDMORE;
211 if (fip->fi_writers > 0) {
212 wakeup((caddr_t)&fip->fi_writers);
213 sowwakeup(fip->fi_writesock);
217 if (ap->a_mode & FWRITE) {
219 if (fip->fi_writers == 1) {
220 fip->fi_readsock->so_state &= ~SS_CANTRCVMORE;
221 if (fip->fi_readers > 0) {
222 wakeup((caddr_t)&fip->fi_readers);
223 sorwakeup(fip->fi_writesock);
227 if ((ap->a_mode & FREAD) && (ap->a_mode & O_NONBLOCK) == 0) {
228 if (fip->fi_writers == 0) {
229 VOP_UNLOCK(vp, 0, p);
230 error = tsleep((caddr_t)&fip->fi_readers,
231 PCATCH | PSOCK, "fifoor", 0);
232 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, p);
236 * We must have got woken up because we had a writer.
237 * That (and not still having one) is the condition
238 * that we must wait for.
242 if (ap->a_mode & FWRITE) {
243 if (ap->a_mode & O_NONBLOCK) {
244 if (fip->fi_readers == 0) {
249 if (fip->fi_readers == 0) {
250 VOP_UNLOCK(vp, 0, p);
251 error = tsleep((caddr_t)&fip->fi_writers,
252 PCATCH | PSOCK, "fifoow", 0);
253 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, p);
257 * We must have got woken up because we had
258 * a reader. That (and not still having one)
259 * is the condition that we must wait for.
266 VOP_CLOSE(vp, ap->a_mode, ap->a_cred, p);
276 struct vop_read_args /* {
280 struct ucred *a_cred;
283 struct uio *uio = ap->a_uio;
284 struct socket *rso = ap->a_vp->v_fifoinfo->fi_readsock;
285 struct proc *p = uio->uio_procp;
286 int error, startresid;
289 if (uio->uio_rw != UIO_READ)
290 panic("fifo_read mode");
292 if (uio->uio_resid == 0)
294 if (ap->a_ioflag & IO_NDELAY)
295 rso->so_state |= SS_NBIO;
296 startresid = uio->uio_resid;
297 VOP_UNLOCK(ap->a_vp, 0, p);
298 error = soreceive(rso, (struct sockaddr **)0, uio, (struct mbuf **)0,
299 (struct mbuf **)0, (int *)0);
300 vn_lock(ap->a_vp, LK_EXCLUSIVE | LK_RETRY, p);
301 if (ap->a_ioflag & IO_NDELAY)
302 rso->so_state &= ~SS_NBIO;
312 struct vop_write_args /* {
316 struct ucred *a_cred;
319 struct socket *wso = ap->a_vp->v_fifoinfo->fi_writesock;
320 struct proc *p = ap->a_uio->uio_procp;
324 if (ap->a_uio->uio_rw != UIO_WRITE)
325 panic("fifo_write mode");
327 if (ap->a_ioflag & IO_NDELAY)
328 wso->so_state |= SS_NBIO;
329 VOP_UNLOCK(ap->a_vp, 0, p);
330 error = sosend(wso, (struct sockaddr *)0, ap->a_uio, 0,
331 (struct mbuf *)0, 0, p);
332 vn_lock(ap->a_vp, LK_EXCLUSIVE | LK_RETRY, p);
333 if (ap->a_ioflag & IO_NDELAY)
334 wso->so_state &= ~SS_NBIO;
339 * Device ioctl operation.
344 struct vop_ioctl_args /* {
349 struct ucred *a_cred;
356 if (ap->a_command == FIONBIO)
358 if (ap->a_fflag & FREAD) {
359 filetmp.f_data = (caddr_t)ap->a_vp->v_fifoinfo->fi_readsock;
360 error = soo_ioctl(&filetmp, ap->a_command, ap->a_data, ap->a_p);
364 if (ap->a_fflag & FWRITE) {
365 filetmp.f_data = (caddr_t)ap->a_vp->v_fifoinfo->fi_writesock;
366 error = soo_ioctl(&filetmp, ap->a_command, ap->a_data, ap->a_p);
376 struct vop_kqfilter_args /* {
381 struct fifoinfo *fi = ap->a_vp->v_fifoinfo;
385 switch (ap->a_kn->kn_filter) {
387 ap->a_kn->kn_fop = &fiforead_filtops;
388 so = fi->fi_readsock;
392 ap->a_kn->kn_fop = &fifowrite_filtops;
393 so = fi->fi_writesock;
400 ap->a_kn->kn_hook = (caddr_t)so;
402 SLIST_INSERT_HEAD(&sb->sb_sel.si_note, ap->a_kn, kn_selnext);
403 sb->sb_flags |= SB_KNOTE;
409 filt_fifordetach(struct knote *kn)
411 struct socket *so = (struct socket *)kn->kn_hook;
413 SLIST_REMOVE(&so->so_rcv.sb_sel.si_note, kn, knote, kn_selnext);
414 if (SLIST_EMPTY(&so->so_rcv.sb_sel.si_note))
415 so->so_rcv.sb_flags &= ~SB_KNOTE;
419 filt_fiforead(struct knote *kn, long hint)
421 struct socket *so = (struct socket *)kn->kn_hook;
423 kn->kn_data = so->so_rcv.sb_cc;
424 if (so->so_state & SS_CANTRCVMORE) {
425 kn->kn_flags |= EV_EOF;
428 kn->kn_flags &= ~EV_EOF;
429 return (kn->kn_data > 0);
433 filt_fifowdetach(struct knote *kn)
435 struct socket *so = (struct socket *)kn->kn_hook;
437 SLIST_REMOVE(&so->so_snd.sb_sel.si_note, kn, knote, kn_selnext);
438 if (SLIST_EMPTY(&so->so_snd.sb_sel.si_note))
439 so->so_snd.sb_flags &= ~SB_KNOTE;
443 filt_fifowrite(struct knote *kn, long hint)
445 struct socket *so = (struct socket *)kn->kn_hook;
447 kn->kn_data = sbspace(&so->so_snd);
448 if (so->so_state & SS_CANTSENDMORE) {
449 kn->kn_flags |= EV_EOF;
452 kn->kn_flags &= ~EV_EOF;
453 return (kn->kn_data >= so->so_snd.sb_lowat);
459 struct vop_poll_args /* {
462 struct ucred *a_cred;
469 if (ap->a_events & (POLLIN | POLLPRI | POLLRDNORM | POLLRDBAND)) {
470 filetmp.f_data = (caddr_t)ap->a_vp->v_fifoinfo->fi_readsock;
472 revents |= soo_poll(&filetmp, ap->a_events, ap->a_cred,
475 if (ap->a_events & (POLLOUT | POLLWRNORM | POLLWRBAND)) {
476 filetmp.f_data = (caddr_t)ap->a_vp->v_fifoinfo->fi_writesock;
478 revents |= soo_poll(&filetmp, ap->a_events, ap->a_cred,
486 struct vop_inactive_args /* {
492 VOP_UNLOCK(ap->a_vp, 0, ap->a_p);
497 * This is a noop, simply returning what one has been given.
501 struct vop_bmap_args /* {
504 struct vnode **a_vpp;
511 if (ap->a_vpp != NULL)
512 *ap->a_vpp = ap->a_vp;
513 if (ap->a_bnp != NULL)
514 *ap->a_bnp = ap->a_bn;
515 if (ap->a_runp != NULL)
517 if (ap->a_runb != NULL)
523 * Device close routine
528 struct vop_close_args /* {
531 struct ucred *a_cred;
535 register struct vnode *vp = ap->a_vp;
536 register struct fifoinfo *fip = vp->v_fifoinfo;
539 if (ap->a_fflag & FREAD) {
541 if (fip->fi_readers == 0)
542 socantsendmore(fip->fi_writesock);
544 if (ap->a_fflag & FWRITE) {
546 if (fip->fi_writers == 0)
547 socantrcvmore(fip->fi_readsock);
549 if (vp->v_usecount > 1)
551 error1 = soclose(fip->fi_readsock);
552 error2 = soclose(fip->fi_writesock);
554 vp->v_fifoinfo = NULL;
562 * Print out internal contents of a fifo vnode.
568 register struct fifoinfo *fip = vp->v_fifoinfo;
570 printf(", fifo with %ld readers and %ld writers",
571 fip->fi_readers, fip->fi_writers);
576 * Print out the contents of a fifo vnode.
580 struct vop_print_args /* {
585 printf("tag VT_NON");
586 fifo_printinfo(ap->a_vp);
592 * Return POSIX pathconf information applicable to fifo's.
596 struct vop_pathconf_args /* {
603 switch (ap->a_name) {
605 *ap->a_retval = LINK_MAX;
608 *ap->a_retval = PIPE_BUF;
610 case _PC_CHOWN_RESTRICTED:
620 * Fifo advisory byte-level locks.
625 struct vop_advlock_args /* {
634 return (ap->a_flags & F_FLOCK ? EOPNOTSUPP : EINVAL);
644 panic("fifo_badop called");