mqueues: Port POSIX message queues from NetBSD.
[dragonfly.git] / sys / sys / file.h
CommitLineData
984263bc
MD
1/*
2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
20 *
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
31 * SUCH DAMAGE.
32 *
33 * @(#)file.h 8.3 (Berkeley) 1/9/95
34 * $FreeBSD: src/sys/sys/file.h,v 1.22.2.7 2002/11/21 23:39:24 sam Exp $
e7440b28 35 * $DragonFly: src/sys/sys/file.h,v 1.25 2007/01/12 06:06:58 dillon Exp $
984263bc
MD
36 */
37
38#ifndef _SYS_FILE_H_
39#define _SYS_FILE_H_
40
1bd40720
MD
41#ifndef _SYS_TYPES_H_
42#include <sys/types.h>
43#endif
44#ifndef _SYS_FCNTL_H_
984263bc 45#include <sys/fcntl.h>
1bd40720
MD
46#endif
47#ifndef _SYS_UNISTD_H_
984263bc
MD
48#include <sys/unistd.h>
49#endif
50
ec12abe0
MD
51#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
52
1bd40720 53#ifndef _SYS_QUEUE_H_
984263bc 54#include <sys/queue.h>
1bd40720 55#endif
85fceac1
MD
56#ifndef _SYS_SPINLOCK_H_
57#include <sys/spinlock.h>
58#endif
28623bf9
MD
59#ifndef _SYS_NAMECACHE_H_
60#include <sys/namecache.h>
61#endif
e7440b28
MD
62#ifndef _SYS_UIO_H_
63#include <sys/uio.h>
64#endif
984263bc
MD
65
66struct stat;
67struct proc;
dadab5e9 68struct thread;
984263bc
MD
69struct uio;
70struct knote;
f53ede20
MD
71struct file;
72struct ucred;
351b7b6d 73struct vnode;
f53ede20 74struct lwkt_port;
21739618 75struct namecache;
87baaf0c 76struct sysmsg;
f53ede20
MD
77
78struct fileops {
b2d248cb
MD
79 int (*fo_read) (struct file *fp, struct uio *uio,
80 struct ucred *cred, int flags);
81 int (*fo_write) (struct file *fp, struct uio *uio,
82 struct ucred *cred, int flags);
83 int (*fo_ioctl) (struct file *fp, u_long com, caddr_t data,
87baaf0c 84 struct ucred *cred, struct sysmsg *msg);
b2d248cb
MD
85 int (*fo_poll) (struct file *fp, int events,
86 struct ucred *cred);
87 int (*fo_kqfilter)(struct file *fp, struct knote *kn);
88 int (*fo_stat) (struct file *fp, struct stat *sb,
89 struct ucred *cred);
90 int (*fo_close) (struct file *fp);
91 int (*fo_shutdown)(struct file *fp, int how);
f53ede20
MD
92};
93
984263bc 94/*
2dd63755
MD
95 * Kernel descriptor table - One entry for each open kernel vnode and socket.
96 *
97 * (A) - (filehead_spin) - descriptor subsystems only (kern/kern_descrip.c)
98 * (U) - (unp_spin) - uipc subsystems only (kern/uipc_usrreq.c)
99 * (ro)- these fields may be read without holding a spinlock as long as you
100 * have (or know) that the reference to the fp is going to stay put.
101 * ? - remaining fields have to be spinlocked
984263bc
MD
102 */
103struct file {
2dd63755
MD
104 LIST_ENTRY(file) f_list;/* (A) list of active files */
105 short f_FILLER3;
106 short f_type; /* (ro) descriptor type */
984263bc 107 u_int f_flag; /* see fcntl.h */
2dd63755
MD
108 struct ucred *f_cred; /* (ro) creds associated with descriptor */
109 struct fileops *f_ops; /* (ro) operations vector */
984263bc
MD
110 int f_seqcount; /*
111 * count of sequential accesses -- cleared
112 * by most seek operations.
113 */
114 off_t f_nextoff; /*
115 * offset of next expected read or write
116 */
117 off_t f_offset;
fbb4eeab 118 void *f_data; /* vnode, pipe, socket, or kqueue */
984263bc 119 int f_count; /* reference count */
2dd63755 120 int f_msgcount; /* (U) reference count from message queue */
28623bf9 121 struct nchandle f_nchandle; /* namecache reference */
b8477cda 122 struct spinlock f_spin; /* NOT USED */
984263bc
MD
123};
124
2dd63755
MD
125#define DTYPE_VNODE 1 /* file */
126#define DTYPE_SOCKET 2 /* communications endpoint */
127#define DTYPE_PIPE 3 /* pipe */
128#define DTYPE_FIFO 4 /* fifo (named pipe) */
129#define DTYPE_KQUEUE 5 /* event queue */
130#define DTYPE_CRYPTO 6 /* crypto */
e143cb06 131#define DTYPE_SYSLINK 7 /* syslink */
f2df0f7c 132#define DTYPE_MQUEUE 8 /* message queue */
2dd63755 133
ec12abe0
MD
134LIST_HEAD(filelist, file);
135
136#endif
137
138#ifdef _KERNEL
139
984263bc
MD
140#ifdef MALLOC_DECLARE
141MALLOC_DECLARE(M_FILE);
142#endif
143
85fceac1 144extern void fhold(struct file *fp);
9f87144f 145extern int fdrop (struct file *fp);
39f91578 146extern int fp_open(const char *path, int flags, int mode, struct file **fpp);
351b7b6d 147extern int fp_vpopen(struct vnode *vp, int flags, struct file **fpp);
e7440b28
MD
148extern int fp_pread(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res, enum uio_seg);
149extern int fp_pwrite(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res, enum uio_seg);
150extern int fp_read(struct file *fp, void *buf, size_t nbytes, ssize_t *res, int all, enum uio_seg);
151extern int fp_write(struct file *fp, void *buf, size_t nbytes, ssize_t *res, enum uio_seg);
39f91578
MD
152extern int fp_stat(struct file *fp, struct stat *ub);
153extern int fp_mmap(void *addr, size_t size, int prot, int flags, struct file *fp, off_t pos, void **resp);
154
87de5057 155extern int nofo_shutdown(struct file *fp, int how);
004d2de5 156
39f91578 157extern int fp_close(struct file *fp);
004d2de5 158extern int fp_shutdown(struct file *fp, int how);
39f91578 159
fad57d0e
MD
160extern struct fileops vnode_fileops;
161extern struct fileops specvnode_fileops;
984263bc
MD
162extern struct fileops badfileops;
163extern int maxfiles; /* kernel limit on number of open files */
60ee93b9 164extern int maxfilesrootres; /* descriptors reserved for root use */
984263bc 165extern int maxfilesperproc; /* per process limit on number of open files */
984263bc 166
984263bc
MD
167#endif /* _KERNEL */
168
169#endif /* !SYS_FILE_H */