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.25 2006/04/01 20:46:53 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>
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_old_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 struct vop_ops *fifo_vnode_vops;
92 static struct vnodeopv_entry_desc fifo_vnodeop_entries[] = {
93 { &vop_default_desc, (vnodeopv_entry_t) vop_defaultop },
94 { &vop_access_desc, (vnodeopv_entry_t) vop_ebadf },
95 { &vop_advlock_desc, (vnodeopv_entry_t) fifo_advlock },
96 { &vop_bmap_desc, (vnodeopv_entry_t) fifo_bmap },
97 { &vop_close_desc, (vnodeopv_entry_t) fifo_close },
98 { &vop_old_create_desc, (vnodeopv_entry_t) fifo_badop },
99 { &vop_getattr_desc, (vnodeopv_entry_t) vop_ebadf },
100 { &vop_inactive_desc, (vnodeopv_entry_t) fifo_inactive },
101 { &vop_ioctl_desc, (vnodeopv_entry_t) fifo_ioctl },
102 { &vop_kqfilter_desc, (vnodeopv_entry_t) fifo_kqfilter },
103 { &vop_old_link_desc, (vnodeopv_entry_t) fifo_badop },
104 { &vop_old_lookup_desc, (vnodeopv_entry_t) fifo_lookup },
105 { &vop_old_mkdir_desc, (vnodeopv_entry_t) fifo_badop },
106 { &vop_old_mknod_desc, (vnodeopv_entry_t) fifo_badop },
107 { &vop_open_desc, (vnodeopv_entry_t) fifo_open },
108 { &vop_pathconf_desc, (vnodeopv_entry_t) fifo_pathconf },
109 { &vop_poll_desc, (vnodeopv_entry_t) fifo_poll },
110 { &vop_print_desc, (vnodeopv_entry_t) fifo_print },
111 { &vop_read_desc, (vnodeopv_entry_t) fifo_read },
112 { &vop_readdir_desc, (vnodeopv_entry_t) fifo_badop },
113 { &vop_readlink_desc, (vnodeopv_entry_t) fifo_badop },
114 { &vop_reallocblks_desc, (vnodeopv_entry_t) fifo_badop },
115 { &vop_reclaim_desc, (vnodeopv_entry_t) vop_null },
116 { &vop_old_remove_desc, (vnodeopv_entry_t) fifo_badop },
117 { &vop_old_rename_desc, (vnodeopv_entry_t) fifo_badop },
118 { &vop_old_rmdir_desc, (vnodeopv_entry_t) fifo_badop },
119 { &vop_setattr_desc, (vnodeopv_entry_t) vop_ebadf },
120 { &vop_old_symlink_desc, (vnodeopv_entry_t) fifo_badop },
121 { &vop_write_desc, (vnodeopv_entry_t) fifo_write },
124 static struct vnodeopv_desc fifo_vnodeop_opv_desc =
125 { &fifo_vnode_vops, fifo_vnodeop_entries, 0 };
127 VNODEOP_SET(fifo_vnodeop_opv_desc);
129 static MALLOC_DEFINE(M_FIFOINFO, "Fifo info", "Fifo info entries");
132 * fifo_vnoperate(struct vnodeop_desc *a_desc, ...)
135 fifo_vnoperate(struct vop_generic_args *ap)
137 return (VOCALL(fifo_vnode_vops, ap));
141 * Trivial lookup routine that always fails.
143 * fifo_lookup(struct vnode *a_dvp, struct vnode **a_vpp,
144 * struct componentname *a_cnp)
148 fifo_lookup(struct vop_old_lookup_args *ap)
155 * Open called to set up a new instance of a fifo or
156 * to find an active instance of a fifo.
158 * fifo_open(struct vnode *a_vp, int a_mode, struct ucred *a_cred,
159 * struct thread *a_td)
163 fifo_open(struct vop_open_args *ap)
165 struct vnode *vp = ap->a_vp;
166 struct fifoinfo *fip;
167 struct socket *rso, *wso;
170 if ((fip = vp->v_fifoinfo) == NULL) {
171 MALLOC(fip, struct fifoinfo *, sizeof(*fip), M_FIFOINFO, M_WAITOK);
172 vp->v_fifoinfo = fip;
173 error = socreate(AF_LOCAL, &rso, SOCK_STREAM, 0, ap->a_td);
175 free(fip, M_FIFOINFO);
176 vp->v_fifoinfo = NULL;
179 fip->fi_readsock = rso;
180 error = socreate(AF_LOCAL, &wso, SOCK_STREAM, 0, ap->a_td);
183 free(fip, M_FIFOINFO);
184 vp->v_fifoinfo = NULL;
187 fip->fi_writesock = wso;
188 error = unp_connect2(wso, rso);
192 free(fip, M_FIFOINFO);
193 vp->v_fifoinfo = NULL;
196 fip->fi_readers = fip->fi_writers = 0;
197 wso->so_snd.sb_lowat = PIPE_BUF;
198 rso->so_state |= SS_CANTRCVMORE;
200 if (ap->a_mode & FREAD) {
202 if (fip->fi_readers == 1) {
203 fip->fi_writesock->so_state &= ~SS_CANTSENDMORE;
204 if (fip->fi_writers > 0) {
205 wakeup((caddr_t)&fip->fi_writers);
206 sowwakeup(fip->fi_writesock);
210 if (ap->a_mode & FWRITE) {
212 if (fip->fi_writers == 1) {
213 fip->fi_readsock->so_state &= ~SS_CANTRCVMORE;
214 if (fip->fi_readers > 0) {
215 wakeup((caddr_t)&fip->fi_readers);
216 sorwakeup(fip->fi_writesock);
220 if ((ap->a_mode & FREAD) && (ap->a_mode & O_NONBLOCK) == 0) {
221 if (fip->fi_writers == 0) {
222 VOP_UNLOCK(vp, 0, ap->a_td);
223 error = tsleep((caddr_t)&fip->fi_readers,
224 PCATCH, "fifoor", 0);
225 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, ap->a_td);
229 * We must have got woken up because we had a writer.
230 * That (and not still having one) is the condition
231 * that we must wait for.
235 if (ap->a_mode & FWRITE) {
236 if (ap->a_mode & O_NONBLOCK) {
237 if (fip->fi_readers == 0) {
242 if (fip->fi_readers == 0) {
243 VOP_UNLOCK(vp, 0, ap->a_td);
244 error = tsleep((caddr_t)&fip->fi_writers,
245 PCATCH, "fifoow", 0);
246 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, ap->a_td);
250 * We must have got woken up because we had
251 * a reader. That (and not still having one)
252 * is the condition that we must wait for.
257 return (vop_stdopen(ap));
259 VOP_CLOSE(vp, ap->a_mode, ap->a_td);
266 * fifo_read(struct vnode *a_vp, struct uio *a_uio, int a_ioflag,
267 * struct ucred *a_cred)
271 fifo_read(struct vop_read_args *ap)
273 struct uio *uio = ap->a_uio;
274 struct socket *rso = ap->a_vp->v_fifoinfo->fi_readsock;
275 struct thread *td = uio->uio_td;
276 int error, startresid;
279 if (uio->uio_rw != UIO_READ)
280 panic("fifo_read mode");
282 if (uio->uio_resid == 0)
284 if (ap->a_ioflag & IO_NDELAY)
285 rso->so_state |= SS_NBIO;
286 startresid = uio->uio_resid;
287 VOP_UNLOCK(ap->a_vp, 0, td);
288 error = soreceive(rso, (struct sockaddr **)0, uio, (struct mbuf **)0,
289 (struct mbuf **)0, (int *)0);
290 vn_lock(ap->a_vp, LK_EXCLUSIVE | LK_RETRY, td);
291 if (ap->a_ioflag & IO_NDELAY)
292 rso->so_state &= ~SS_NBIO;
299 * fifo_write(struct vnode *a_vp, struct uio *a_uio, int a_ioflag,
300 * struct ucred *a_cred)
304 fifo_write(struct vop_write_args *ap)
306 struct socket *wso = ap->a_vp->v_fifoinfo->fi_writesock;
307 struct thread *td = ap->a_uio->uio_td;
311 if (ap->a_uio->uio_rw != UIO_WRITE)
312 panic("fifo_write mode");
314 if (ap->a_ioflag & IO_NDELAY)
315 wso->so_state |= SS_NBIO;
316 VOP_UNLOCK(ap->a_vp, 0, td);
317 error = sosend(wso, (struct sockaddr *)0, ap->a_uio, 0,
318 (struct mbuf *)0, 0, td);
319 vn_lock(ap->a_vp, LK_EXCLUSIVE | LK_RETRY, td);
320 if (ap->a_ioflag & IO_NDELAY)
321 wso->so_state &= ~SS_NBIO;
326 * Device ioctl operation.
328 * fifo_ioctl(struct vnode *a_vp, int a_command, caddr_t a_data, int a_fflag,
329 * struct ucred *a_cred, struct thread *a_td)
333 fifo_ioctl(struct vop_ioctl_args *ap)
335 struct file filetmp; /* Local */
338 if (ap->a_command == FIONBIO)
340 if (ap->a_fflag & FREAD) {
341 filetmp.f_data = ap->a_vp->v_fifoinfo->fi_readsock;
342 error = soo_ioctl(&filetmp, ap->a_command, ap->a_data, ap->a_td);
346 if (ap->a_fflag & FWRITE) {
347 filetmp.f_data = ap->a_vp->v_fifoinfo->fi_writesock;
348 error = soo_ioctl(&filetmp, ap->a_command, ap->a_data, ap->a_td);
356 * fifo_kqfilter(struct vnode *a_vp, struct knote *a_kn)
360 fifo_kqfilter(struct vop_kqfilter_args *ap)
362 struct fifoinfo *fi = ap->a_vp->v_fifoinfo;
366 switch (ap->a_kn->kn_filter) {
368 ap->a_kn->kn_fop = &fiforead_filtops;
369 so = fi->fi_readsock;
373 ap->a_kn->kn_fop = &fifowrite_filtops;
374 so = fi->fi_writesock;
381 ap->a_kn->kn_hook = (caddr_t)so;
383 SLIST_INSERT_HEAD(&sb->sb_sel.si_note, ap->a_kn, kn_selnext);
384 sb->sb_flags |= SB_KNOTE;
390 filt_fifordetach(struct knote *kn)
392 struct socket *so = (struct socket *)kn->kn_hook;
394 SLIST_REMOVE(&so->so_rcv.sb_sel.si_note, kn, knote, kn_selnext);
395 if (SLIST_EMPTY(&so->so_rcv.sb_sel.si_note))
396 so->so_rcv.sb_flags &= ~SB_KNOTE;
400 filt_fiforead(struct knote *kn, long hint)
402 struct socket *so = (struct socket *)kn->kn_hook;
404 kn->kn_data = so->so_rcv.sb_cc;
405 if (so->so_state & SS_CANTRCVMORE) {
406 kn->kn_flags |= EV_EOF;
409 kn->kn_flags &= ~EV_EOF;
410 return (kn->kn_data > 0);
414 filt_fifowdetach(struct knote *kn)
416 struct socket *so = (struct socket *)kn->kn_hook;
418 SLIST_REMOVE(&so->so_snd.sb_sel.si_note, kn, knote, kn_selnext);
419 if (SLIST_EMPTY(&so->so_snd.sb_sel.si_note))
420 so->so_snd.sb_flags &= ~SB_KNOTE;
424 filt_fifowrite(struct knote *kn, long hint)
426 struct socket *so = (struct socket *)kn->kn_hook;
428 kn->kn_data = sbspace(&so->so_snd);
429 if (so->so_state & SS_CANTSENDMORE) {
430 kn->kn_flags |= EV_EOF;
433 kn->kn_flags &= ~EV_EOF;
434 return (kn->kn_data >= so->so_snd.sb_lowat);
438 * fifo_poll(struct vnode *a_vp, int a_events, struct ucred *a_cred,
439 * struct thread *a_td)
443 fifo_poll(struct vop_poll_args *ap)
446 int events, revents = 0;
448 events = ap->a_events &
449 (POLLIN | POLLINIGNEOF | POLLPRI | POLLRDNORM | POLLRDBAND);
452 * If POLLIN or POLLRDNORM is requested and POLLINIGNEOF is
453 * not, then convert the first two to the last one. This
454 * tells the socket poll function to ignore EOF so that we
455 * block if there is no writer (and no data). Callers can
456 * set POLLINIGNEOF to get non-blocking behavior.
458 if (events & (POLLIN | POLLRDNORM) &&
459 !(events & POLLINIGNEOF)) {
460 events &= ~(POLLIN | POLLRDNORM);
461 events |= POLLINIGNEOF;
464 filetmp.f_data = ap->a_vp->v_fifoinfo->fi_readsock;
466 revents |= soo_poll(&filetmp, events, ap->a_cred,
469 /* Reverse the above conversion. */
470 if ((revents & POLLINIGNEOF) &&
471 !(ap->a_events & POLLINIGNEOF)) {
472 revents |= (ap->a_events & (POLLIN | POLLRDNORM));
473 revents &= ~POLLINIGNEOF;
476 events = ap->a_events & (POLLOUT | POLLWRNORM | POLLWRBAND);
478 filetmp.f_data = ap->a_vp->v_fifoinfo->fi_writesock;
480 revents |= soo_poll(&filetmp, events, ap->a_cred,
487 * fifo_inactive(struct vnode *a_vp, struct thread *a_td)
490 fifo_inactive(struct vop_inactive_args *ap)
496 * This is a noop, simply returning what one has been given.
498 * fifo_bmap(struct vnode *a_vp, off_t a_loffset, struct vnode **a_vpp,
499 * off_t *a_doffsetp, int *a_runp, int *a_runb)
502 fifo_bmap(struct vop_bmap_args *ap)
504 if (ap->a_vpp != NULL)
505 *ap->a_vpp = ap->a_vp;
506 if (ap->a_doffsetp != NULL)
507 *ap->a_doffsetp = ap->a_loffset;
508 if (ap->a_runp != NULL)
510 if (ap->a_runb != NULL)
516 * Device close routine
518 * fifo_close(struct vnode *a_vp, int a_fflag, struct ucred *a_cred,
519 * struct thread *a_td)
523 fifo_close(struct vop_close_args *ap)
525 struct vnode *vp = ap->a_vp;
526 struct fifoinfo *fip = vp->v_fifoinfo;
529 if (ap->a_fflag & FREAD) {
531 if (fip->fi_readers == 0)
532 socantsendmore(fip->fi_writesock);
534 if (ap->a_fflag & FWRITE) {
536 if (fip->fi_writers == 0)
537 socantrcvmore(fip->fi_readsock);
539 if (vp->v_usecount > 1) {
543 error1 = soclose(fip->fi_readsock);
544 error2 = soclose(fip->fi_writesock);
545 FREE(fip, M_FIFOINFO);
546 vp->v_fifoinfo = NULL;
555 * Print out internal contents of a fifo vnode.
558 fifo_printinfo(struct vnode *vp)
560 struct fifoinfo *fip = vp->v_fifoinfo;
562 printf(", fifo with %ld readers and %ld writers",
563 fip->fi_readers, fip->fi_writers);
568 * Print out the contents of a fifo vnode.
570 * fifo_print(struct vnode *a_vp)
573 fifo_print(struct vop_print_args *ap)
575 printf("tag VT_NON");
576 fifo_printinfo(ap->a_vp);
582 * Return POSIX pathconf information applicable to fifo's.
584 * fifo_pathconf(struct vnode *a_vp, int a_name, int *a_retval)
587 fifo_pathconf(struct vop_pathconf_args *ap)
589 switch (ap->a_name) {
591 *ap->a_retval = LINK_MAX;
594 *ap->a_retval = PIPE_BUF;
596 case _PC_CHOWN_RESTRICTED:
606 * Fifo advisory byte-level locks.
608 * fifo_advlock(struct vnode *a_vp, caddr_t a_id, int a_op, struct flock *a_fl,
613 fifo_advlock(struct vop_advlock_args *ap)
615 return (ap->a_flags & F_FLOCK ? EOPNOTSUPP : EINVAL);
624 panic("fifo_badop called");