1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1982, 1986, 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _SYS_FILE_H_
33#define _SYS_FILE_H_
34
35#ifndef _KERNEL
36#include <sys/types.h> /* XXX */
37#include <sys/fcntl.h>
38#include <sys/unistd.h>
39#else
40#include <sys/errno.h>
41#include <sys/_lock.h>
42#include <sys/_mutex.h>
43#include <sys/_null.h>
44#include <sys/queue.h>
45#include <sys/refcount.h>
46#include <vm/vm.h>
47
48struct filedesc;
49struct proc;
50struct stat;
51struct thread;
52struct uio;
53struct knote;
54struct vnode;
55struct nameidata;
56
57#endif /* _KERNEL */
58
59#define DTYPE_NONE 0 /* not yet initialized */
60#define DTYPE_VNODE 1 /* file */
61#define DTYPE_SOCKET 2 /* communications endpoint */
62#define DTYPE_PIPE 3 /* pipe */
63#define DTYPE_FIFO 4 /* fifo (named pipe) */
64#define DTYPE_KQUEUE 5 /* event queue */
65#define DTYPE_CRYPTO 6 /* crypto */
66#define DTYPE_MQUEUE 7 /* posix message queue */
67#define DTYPE_SHM 8 /* swap-backed shared memory */
68#define DTYPE_SEM 9 /* posix semaphore */
69#define DTYPE_PTS 10 /* pseudo teletype master device */
70#define DTYPE_DEV 11 /* Device specific fd type */
71#define DTYPE_PROCDESC 12 /* process descriptor */
72#define DTYPE_EVENTFD 13 /* eventfd */
73#define DTYPE_TIMERFD 14 /* timerfd */
74#define DTYPE_INOTIFY 15 /* inotify descriptor */
75#define DTYPE_JAILDESC 16 /* jail descriptor */
76
77#ifdef _KERNEL
78
79struct file;
80struct filecaps;
81struct kaiocb;
82struct kinfo_file;
83struct ucred;
84
85#define FOF_OFFSET 0x01 /* Use the offset in uio argument */
86#define FOF_NOLOCK 0x02 /* Do not take FOFFSET_LOCK */
87#define FOF_NEXTOFF_R 0x04 /* Also update f_nextoff[UIO_READ] */
88#define FOF_NEXTOFF_W 0x08 /* Also update f_nextoff[UIO_WRITE] */
89#define FOF_NOUPDATE 0x10 /* Do not update f_offset */
90off_t foffset_lock(struct file *fp, int flags);
91void foffset_lock_pair(struct file *fp1, off_t *off1p, struct file *fp2,
92 off_t *off2p, int flags);
93void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
94void foffset_unlock(struct file *fp, off_t val, int flags);
95void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);
96
97static inline off_t
98foffset_get(struct file *fp)
99{
100
101 return (foffset_lock(fp, FOF_NOLOCK));
102}
103
104typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
105 struct ucred *active_cred, int flags,
106 struct thread *td);
107typedef int fo_truncate_t(struct file *fp, off_t length,
108 struct ucred *active_cred, struct thread *td);
109typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
110 struct ucred *active_cred, struct thread *td);
111typedef int fo_poll_t(struct file *fp, int events,
112 struct ucred *active_cred, struct thread *td);
113typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
114typedef int fo_stat_t(struct file *fp, struct stat *sb,
115 struct ucred *active_cred);
116typedef int fo_close_t(struct file *fp, struct thread *td);
117typedef int fo_chmod_t(struct file *fp, mode_t mode,
118 struct ucred *active_cred, struct thread *td);
119typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid,
120 struct ucred *active_cred, struct thread *td);
121typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio,
122 struct uio *trl_uio, off_t offset, size_t nbytes,
123 off_t *sent, int flags, struct thread *td);
124typedef int fo_seek_t(struct file *fp, off_t offset, int whence,
125 struct thread *td);
126typedef int fo_fill_kinfo_t(struct file *fp, struct kinfo_file *kif,
127 struct filedesc *fdp);
128typedef int fo_mmap_t(struct file *fp, vm_map_t map, vm_offset_t *addr,
129 vm_size_t size, vm_prot_t prot, vm_prot_t cap_maxprot,
130 int flags, vm_ooffset_t foff, struct thread *td);
131typedef int fo_aio_queue_t(struct file *fp, struct kaiocb *job);
132typedef int fo_add_seals_t(struct file *fp, int flags);
133typedef int fo_get_seals_t(struct file *fp, int *flags);
134typedef int fo_fallocate_t(struct file *fp, off_t offset, off_t len,
135 struct thread *td);
136typedef int fo_fspacectl_t(struct file *fp, int cmd,
137 off_t *offset, off_t *length, int flags,
138 struct ucred *active_cred, struct thread *td);
139typedef int fo_cmp_t(struct file *fp, struct file *fp1, struct thread *td);
140typedef int fo_spare_t(struct file *fp);
141typedef int fo_flags_t;
142
143struct fileops {
144 fo_rdwr_t *fo_read;
145 fo_rdwr_t *fo_write;
146 fo_truncate_t *fo_truncate;
147 fo_ioctl_t *fo_ioctl;
148 fo_poll_t *fo_poll;
149 fo_kqfilter_t *fo_kqfilter;
150 fo_stat_t *fo_stat;
151 fo_close_t *fo_close;
152 fo_chmod_t *fo_chmod;
153 fo_chown_t *fo_chown;
154 fo_sendfile_t *fo_sendfile;
155 fo_seek_t *fo_seek;
156 fo_fill_kinfo_t *fo_fill_kinfo;
157 fo_mmap_t *fo_mmap;
158 fo_aio_queue_t *fo_aio_queue;
159 fo_add_seals_t *fo_add_seals;
160 fo_get_seals_t *fo_get_seals;
161 fo_fallocate_t *fo_fallocate;
162 fo_fspacectl_t *fo_fspacectl;
163 fo_cmp_t *fo_cmp;
164 fo_spare_t *fo_spares[8]; /* Spare slots */
165 fo_flags_t fo_flags; /* DFLAG_* below */
166};
167
168#define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */
169#define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */
170#endif /* _KERNEL */
171
172#if defined(_KERNEL) || defined(_WANT_FILE)
173/*
174 * Kernel descriptor table.
175 * One entry for each open kernel vnode and socket.
176 *
177 * Below is the list of locks that protects members in struct file.
178 *
179 * (a) f_vnode lock required (shared allows both reads and writes)
180 * (f) updated with atomics and blocking on sleepq
181 * (d) cdevpriv_mtx
182 * none not locked
183 */
184
185#if __BSD_VISIBLE
186struct fadvise_info {
187 int fa_advice; /* (f) FADV_* type. */
188 off_t fa_start; /* (f) Region start. */
189 off_t fa_end; /* (f) Region end. */
190};
191
192struct file {
193 volatile u_int f_flag; /* see fcntl.h */
194 volatile u_int f_count; /* reference count */
195 void *f_data; /* file descriptor specific data */
196 const struct fileops *f_ops; /* File operations */
197 struct vnode *f_vnode; /* NULL or applicable vnode */
198 struct ucred *f_cred; /* associated credentials. */
199 short f_type; /* descriptor type */
200 short f_vflags; /* (f) Sleep lock flags for members */
201 /*
202 * DTYPE_VNODE specific fields.
203 */
204 union {
205 int16_t f_seqcount[2]; /* (a) Count of seq. reads and writes. */
206 int f_pipegen;
207 };
208 off_t f_nextoff[2]; /* next expected read/write offset. */
209 union {
210 struct cdev_privdata *fvn_cdevpriv;
211 /* (d) Private data for the cdev. */
212 struct fadvise_info *fvn_advice;
213 } f_vnun;
214 /*
215 * DFLAG_SEEKABLE specific fields
216 */
217 off_t f_offset;
218};
219
220#define f_cdevpriv f_vnun.fvn_cdevpriv
221#define f_advice f_vnun.fvn_advice
222
223#define FILE_V_FOFFSET_LOCKED 0x0001
224#define FILE_V_FOFFSET_LOCK_WAITING 0x0002
225#endif /* __BSD_VISIBLE */
226
227#endif /* _KERNEL || _WANT_FILE */
228
229/*
230 * Userland version of struct file, for sysctl
231 */
232#if __BSD_VISIBLE
233struct xfile {
234 ksize_t xf_size; /* size of struct xfile */
235 pid_t xf_pid; /* owning process */
236 uid_t xf_uid; /* effective uid of owning process */
237 int xf_fd; /* descriptor number */
238 int _xf_int_pad1;
239 kvaddr_t xf_file; /* address of struct file */
240 short xf_type; /* descriptor type */
241 short _xf_short_pad1;
242 int xf_count; /* reference count */
243 int xf_msgcount; /* references from message queue */
244 int _xf_int_pad2;
245 off_t xf_offset; /* file offset */
246 kvaddr_t xf_data; /* file descriptor specific data */
247 kvaddr_t xf_vnode; /* vnode pointer */
248 u_int xf_flag; /* flags (see fcntl.h) */
249 int _xf_int_pad3;
250 int64_t _xf_int64_pad[6];
251};
252#endif /* __BSD_VISIBLE */
253
254#ifdef _KERNEL
255
256extern const struct fileops vnops;
257extern const struct fileops badfileops;
258extern const struct fileops path_fileops;
259extern const struct fileops socketops;
260extern int maxfiles; /* kernel limit on number of open files */
261extern int maxfilesperproc; /* per process limit on number of open files */
262
263int fget(struct thread *td, int fd, const cap_rights_t *rightsp,
264 struct file **fpp);
265int fget_mmap(struct thread *td, int fd, const cap_rights_t *rightsp,
266 vm_prot_t *maxprotp, struct file **fpp);
267int fget_read(struct thread *td, int fd, const cap_rights_t *rightsp,
268 struct file **fpp);
269int fget_write(struct thread *td, int fd, const cap_rights_t *rightsp,
270 struct file **fpp);
271int fget_fcntl(struct thread *td, int fd, const cap_rights_t *rightsp,
272 int needfcntl, struct file **fpp);
273int _fdrop(struct file *fp, struct thread *td);
274int fget_remote(struct thread *td, struct proc *p, int fd, struct file **fpp);
275int fget_remote_foreach(struct thread *td, struct proc *p,
276 int (*fn)(struct proc *, int, struct file *, void *), void *arg);
277
278fo_rdwr_t invfo_rdwr;
279fo_truncate_t invfo_truncate;
280fo_ioctl_t invfo_ioctl;
281fo_poll_t invfo_poll;
282fo_kqfilter_t invfo_kqfilter;
283fo_chmod_t invfo_chmod;
284fo_chown_t invfo_chown;
285fo_sendfile_t invfo_sendfile;
286fo_stat_t vn_statfile;
287fo_sendfile_t vn_sendfile;
288fo_seek_t vn_seek;
289fo_fill_kinfo_t vn_fill_kinfo;
290fo_kqfilter_t vn_kqfilter_opath;
291int vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif);
292int file_kcmp_generic(struct file *fp1, struct file *fp2, struct thread *td);
293
294void finit(struct file *, u_int, short, void *, const struct fileops *);
295void finit_vnode(struct file *, u_int, void *, const struct fileops *);
296int fgetvp(struct thread *td, int fd, const cap_rights_t *rightsp,
297 struct vnode **vpp);
298int fgetvp_exec(struct thread *td, int fd, const cap_rights_t *rightsp,
299 struct vnode **vpp);
300int fgetvp_rights(struct thread *td, int fd, const cap_rights_t *needrightsp,
301 struct filecaps *havecaps, struct vnode **vpp);
302int fgetvp_read(struct thread *td, int fd, const cap_rights_t *rightsp,
303 struct vnode **vpp);
304int fgetvp_write(struct thread *td, int fd, const cap_rights_t *rightsp,
305 struct vnode **vpp);
306int fgetvp_lookup_smr(struct nameidata *ndp, struct vnode **vpp, int *flagsp);
307int fgetvp_lookup(struct nameidata *ndp, struct vnode **vpp);
308
309static __inline __result_use_check bool
310fhold(struct file *fp)
311{
312 return (refcount_acquire_checked(&fp->f_count));
313}
314
315#define fdrop(fp, td) ({ \
316 struct file *_fp; \
317 int _error; \
318 \
319 _error = 0; \
320 _fp = (fp); \
321 if (__predict_false(refcount_release(&_fp->f_count))) \
322 _error = _fdrop(_fp, td); \
323 _error; \
324})
325
326#define fdrop_close(fp, td) ({ \
327 struct file *_fp; \
328 int _error; \
329 \
330 _error = 0; \
331 _fp = (fp); \
332 if (__predict_true(refcount_release(&_fp->f_count))) \
333 _error = _fdrop(_fp, td); \
334 _error; \
335})
336
337static __inline fo_rdwr_t fo_read;
338static __inline fo_rdwr_t fo_write;
339static __inline fo_truncate_t fo_truncate;
340static __inline fo_ioctl_t fo_ioctl;
341static __inline fo_poll_t fo_poll;
342static __inline fo_kqfilter_t fo_kqfilter;
343static __inline fo_stat_t fo_stat;
344static __inline fo_close_t fo_close;
345static __inline fo_chmod_t fo_chmod;
346static __inline fo_chown_t fo_chown;
347static __inline fo_sendfile_t fo_sendfile;
348
349static __inline int
350fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
351 int flags, struct thread *td)
352{
353
354 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
355}
356
357static __inline int
358fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
359 int flags, struct thread *td)
360{
361
362 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
363}
364
365static __inline int
366fo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
367 struct thread *td)
368{
369
370 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
371}
372
373static __inline int
374fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
375 struct thread *td)
376{
377
378 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
379}
380
381static __inline int
382fo_poll(struct file *fp, int events, struct ucred *active_cred,
383 struct thread *td)
384{
385
386 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
387}
388
389static __inline int
390fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred)
391{
392
393 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred));
394}
395
396static __inline int
397fo_close(struct file *fp, struct thread *td)
398{
399
400 return ((*fp->f_ops->fo_close)(fp, td));
401}
402
403static __inline int
404fo_kqfilter(struct file *fp, struct knote *kn)
405{
406
407 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
408}
409
410static __inline int
411fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
412 struct thread *td)
413{
414
415 return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td));
416}
417
418static __inline int
419fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
420 struct thread *td)
421{
422
423 return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td));
424}
425
426static __inline int
427fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
428 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
429 struct thread *td)
430{
431
432 return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset,
433 nbytes, sent, flags, td));
434}
435
436static __inline int
437fo_seek(struct file *fp, off_t offset, int whence, struct thread *td)
438{
439
440 return ((*fp->f_ops->fo_seek)(fp, offset, whence, td));
441}
442
443static __inline int
444fo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
445{
446
447 return ((*fp->f_ops->fo_fill_kinfo)(fp, kif, fdp));
448}
449
450static __inline int
451fo_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t size,
452 vm_prot_t prot, vm_prot_t cap_maxprot, int flags, vm_ooffset_t foff,
453 struct thread *td)
454{
455
456 if (fp->f_ops->fo_mmap == NULL)
457 return (ENODEV);
458 return ((*fp->f_ops->fo_mmap)(fp, map, addr, size, prot, cap_maxprot,
459 flags, foff, td));
460}
461
462static __inline int
463fo_aio_queue(struct file *fp, struct kaiocb *job)
464{
465
466 return ((*fp->f_ops->fo_aio_queue)(fp, job));
467}
468
469static __inline int
470fo_add_seals(struct file *fp, int seals)
471{
472
473 if (fp->f_ops->fo_add_seals == NULL)
474 return (EINVAL);
475 return ((*fp->f_ops->fo_add_seals)(fp, seals));
476}
477
478static __inline int
479fo_get_seals(struct file *fp, int *seals)
480{
481
482 if (fp->f_ops->fo_get_seals == NULL)
483 return (EINVAL);
484 return ((*fp->f_ops->fo_get_seals)(fp, seals));
485}
486
487static __inline int
488fo_fallocate(struct file *fp, off_t offset, off_t len, struct thread *td)
489{
490
491 if (fp->f_ops->fo_fallocate == NULL)
492 return (ENODEV);
493 return ((*fp->f_ops->fo_fallocate)(fp, offset, len, td));
494}
495
496static __inline int
497fo_fspacectl(struct file *fp, int cmd, off_t *offset, off_t *length,
498 int flags, struct ucred *active_cred, struct thread *td)
499{
500
501 if (fp->f_ops->fo_fspacectl == NULL)
502 return (ENODEV);
503 return ((*fp->f_ops->fo_fspacectl)(fp, cmd, offset, length, flags,
504 active_cred, td));
505}
506
507static __inline int
508fo_cmp(struct file *fp1, struct file *fp2, struct thread *td)
509{
510
511 if (fp1->f_ops->fo_cmp == NULL)
512 return (ENODEV);
513 return ((*fp1->f_ops->fo_cmp)(fp1, fp2, td));
514}
515
516#endif /* _KERNEL */
517
518#endif /* !SYS_FILE_H */