2 * Copyright (c) 1990, 1993, 1995
3 * The Regents of the University of California.
4 * Copyright (c) 2005 Robert N. M. Watson
5 * Copyright (c) 2012 Giovanni Trematerra
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * @(#)fifo_vnops.c 8.10 (Berkeley) 5/27/95
36 #include <sys/param.h>
37 #include <sys/event.h>
39 #include <sys/filedesc.h>
40 #include <sys/filio.h>
41 #include <sys/fcntl.h>
42 #include <sys/kernel.h>
44 #include <sys/mutex.h>
45 #include <sys/malloc.h>
46 #include <sys/selinfo.h>
49 #include <sys/signalvar.h>
51 #include <sys/systm.h>
53 #include <sys/unistd.h>
54 #include <sys/vnode.h>
57 * This structure is associated with the FIFO vnode and stores
58 * the state associated with the FIFO.
59 * Notes about locking:
60 * - fi_pipe is invariant since init time.
61 * - fi_readers and fi_writers are protected by the vnode lock.
69 static vop_print_t fifo_print;
70 static vop_open_t fifo_open;
71 static vop_close_t fifo_close;
72 static vop_pathconf_t fifo_pathconf;
73 static vop_advlock_t fifo_advlock;
75 struct vop_vector fifo_specops = {
76 .vop_default = &default_vnodeops,
78 .vop_advlock = fifo_advlock,
79 .vop_close = fifo_close,
80 .vop_create = VOP_PANIC,
81 .vop_getattr = VOP_EBADF,
82 .vop_ioctl = VOP_PANIC,
83 .vop_kqfilter = VOP_PANIC,
84 .vop_link = VOP_PANIC,
85 .vop_mkdir = VOP_PANIC,
86 .vop_mknod = VOP_PANIC,
87 .vop_open = fifo_open,
88 .vop_pathconf = fifo_pathconf,
89 .vop_print = fifo_print,
90 .vop_read = VOP_PANIC,
91 .vop_readdir = VOP_PANIC,
92 .vop_readlink = VOP_PANIC,
93 .vop_reallocblks = VOP_PANIC,
94 .vop_reclaim = VOP_NULL,
95 .vop_remove = VOP_PANIC,
96 .vop_rename = VOP_PANIC,
97 .vop_rmdir = VOP_PANIC,
98 .vop_setattr = VOP_EBADF,
99 .vop_symlink = VOP_PANIC,
100 .vop_write = VOP_PANIC,
104 * Dispose of fifo resources.
107 fifo_cleanup(struct vnode *vp)
109 struct fifoinfo *fip;
111 ASSERT_VOP_ELOCKED(vp, "fifo_cleanup");
112 fip = vp->v_fifoinfo;
113 if (fip->fi_readers == 0 && fip->fi_writers == 0) {
114 vp->v_fifoinfo = NULL;
115 pipe_dtor(fip->fi_pipe);
121 * Open called to set up a new instance of a fifo or
122 * to find an active instance of a fifo.
127 struct vop_open_args /* {
130 struct ucred *a_cred;
138 struct fifoinfo *fip;
145 ASSERT_VOP_ELOCKED(vp, "fifo_open");
146 if (fp == NULL || (ap->a_mode & FEXEC) != 0)
148 if ((fip = vp->v_fifoinfo) == NULL) {
149 pipe_named_ctor(&fpipe, td);
150 fip = malloc(sizeof(*fip), M_VNODE, M_WAITOK);
151 fip->fi_pipe = fpipe;
152 fpipe->pipe_wgen = fip->fi_readers = fip->fi_writers = 0;
153 KASSERT(vp->v_fifoinfo == NULL, ("fifo_open: v_fifoinfo race"));
154 vp->v_fifoinfo = fip;
156 fpipe = fip->fi_pipe;
157 KASSERT(fpipe != NULL, ("fifo_open: pipe is NULL"));
160 * Use the pipe mutex here, in addition to the vnode lock,
161 * in order to allow vnode lock dropping before msleep() calls
162 * and still avoiding missed wakeups.
165 if (ap->a_mode & FREAD) {
167 if (fip->fi_readers == 1) {
168 fpipe->pipe_state &= ~PIPE_EOF;
169 if (fip->fi_writers > 0)
170 wakeup(&fip->fi_writers);
172 fp->f_seqcount = fpipe->pipe_wgen - fip->fi_writers;
174 if (ap->a_mode & FWRITE) {
175 if ((ap->a_mode & O_NONBLOCK) && fip->fi_readers == 0) {
177 if (fip->fi_writers == 0)
182 if (fip->fi_writers == 1) {
183 fpipe->pipe_state &= ~PIPE_EOF;
184 if (fip->fi_readers > 0)
185 wakeup(&fip->fi_readers);
188 if ((ap->a_mode & O_NONBLOCK) == 0) {
189 if ((ap->a_mode & FREAD) && fip->fi_writers == 0) {
191 error = msleep(&fip->fi_readers, PIPE_MTX(fpipe),
192 PDROP | PCATCH | PSOCK, "fifoor", 0);
193 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
196 if (fip->fi_readers == 0) {
198 fpipe->pipe_state |= PIPE_EOF;
199 if (fpipe->pipe_state & PIPE_WANTW)
208 * We must have got woken up because we had a writer.
209 * That (and not still having one) is the condition
210 * that we must wait for.
213 if ((ap->a_mode & FWRITE) && fip->fi_readers == 0) {
215 error = msleep(&fip->fi_writers, PIPE_MTX(fpipe),
216 PDROP | PCATCH | PSOCK, "fifoow", 0);
217 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
220 if (fip->fi_writers == 0) {
222 fpipe->pipe_state |= PIPE_EOF;
223 if (fpipe->pipe_state & PIPE_WANTR)
232 * We must have got woken up because we had
233 * a reader. That (and not still having one)
234 * is the condition that we must wait for.
240 KASSERT(fp != NULL, ("can't fifo/vnode bypass"));
241 KASSERT(fp->f_ops == &badfileops, ("not badfileops in fifo_open"));
242 finit(fp, fp->f_flag, DTYPE_FIFO, fpipe, &pipeops);
247 * Device close routine
252 struct vop_close_args /* {
255 struct ucred *a_cred;
260 struct fifoinfo *fip;
264 fip = vp->v_fifoinfo;
265 cpipe = fip->fi_pipe;
266 ASSERT_VOP_ELOCKED(vp, "fifo_close");
267 if (ap->a_fflag & FREAD) {
269 if (fip->fi_readers == 0) {
271 cpipe->pipe_state |= PIPE_EOF;
272 if ((cpipe->pipe_state & PIPE_WANTW)) {
273 cpipe->pipe_state &= ~PIPE_WANTW;
276 pipeselwakeup(cpipe);
280 if (ap->a_fflag & FWRITE) {
282 if (fip->fi_writers == 0) {
284 cpipe->pipe_state |= PIPE_EOF;
285 if ((cpipe->pipe_state & PIPE_WANTR)) {
286 cpipe->pipe_state &= ~PIPE_WANTR;
290 pipeselwakeup(cpipe);
299 * Print out internal contents of a fifo vnode.
305 register struct fifoinfo *fip = vp->v_fifoinfo;
308 printf(", NULL v_fifoinfo");
311 printf(", fifo with %ld readers and %ld writers",
312 fip->fi_readers, fip->fi_writers);
317 * Print out the contents of a fifo vnode.
321 struct vop_print_args /* {
326 fifo_printinfo(ap->a_vp);
332 * Return POSIX pathconf information applicable to fifo's.
336 struct vop_pathconf_args /* {
343 switch (ap->a_name) {
345 *ap->a_retval = LINK_MAX;
348 *ap->a_retval = PIPE_BUF;
350 case _PC_CHOWN_RESTRICTED:
360 * Fifo advisory byte-level locks.
365 struct vop_advlock_args /* {
374 return (ap->a_flags & F_FLOCK ? EOPNOTSUPP : EINVAL);