VFS messaging/interfacing work stage 5/99. Start work on the new
[dragonfly.git] / sys / sys / vfsops.h
1 /*
2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
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  * 
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
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $DragonFly: src/sys/sys/vfsops.h,v 1.4 2004/09/26 01:24:54 dillon Exp $
35  */
36
37 /*
38  * The vop_ops structure vectors all access to a filesystem.  It contains a
39  * fixed set of vectors which are 'compiled' by the vnodeopv_entry_desc
40  * array that is typically declared in "vfs/blah/blah_vnops.c".
41  *
42  * In DragonFly the ultimate goal is to thread the VFS, which means that
43  * the dispatch functions will eventually be called from the context of 
44  * a management thread rather then directly called by a process.  This
45  * requires us to divorce direct process dependancies (in particular ioctl
46  * and UIO's).  In addition, it is our intention to implement kernel
47  * level cache management and coherency in the vop_*() interfacing
48  * layer.
49  *
50  * The number of management threads will depend on the VFS.  The idea is
51  * to give a high performance VFS such as UFS at least one thread per cpu,
52  * and a low performance VFS such as CD9660 perhaps just one thread period.
53  * Blocking issues within the management thread are up to the VFS itself,
54  * but DragonFly will introduce a layer above the VFS to handle cacheable
55  * requests without having to enter the VFS (e.g. by making attribute
56  * and VM object information a permanent fixture of the vnode structure
57  * and accessing them directly).
58  *
59  * THE VOPOPS VECTORS SHOULD NEVER BE CALLED DIRECTLY!  Instead always use
60  * the kernel helper procedures vop_*() to call a vopop.  The kernel
61  * helper procedure will be responsible for handling the DragonFly messaging
62  * conversion when it occurs.
63  */
64
65 #ifndef _SYS_VFSOPS_H_
66 #define _SYS_VFSOPS_H_
67
68 #ifndef _SYS_ACL_H_
69 #include <sys/acl.h>
70 #endif
71
72 struct vnode;
73 struct thread;
74 struct namecache;
75 struct componentname;
76 struct vattr;
77 struct ucred;
78 struct uio;
79 struct knote;
80 struct vm_object;
81 struct vm_page;
82 struct vfscache;
83
84 struct vop_generic_args {
85         struct vnodeop_desc *a_desc;    /* command descriptor for the call */
86         struct vop_ops *a_ops;          /* operations vector for the call */
87         int a_reserved[4];
88 };
89
90 struct vop_islocked_args {
91         struct vop_generic_args a_head;
92         struct vnode *a_vp;
93         struct thread *a_td;
94 };
95
96 struct vop_lookup_args {
97         struct vop_generic_args a_head;
98         struct vnode *a_dvp;
99         struct namecache *a_par;
100         struct vnode **a_vpp;
101         struct namecache **a_ncpp;
102         struct componentname *a_cnp;
103 };
104
105 struct vop_cachedlookup_args {
106         struct vop_generic_args a_head;
107         struct vnode *a_dvp;
108         struct vnode **a_vpp;
109         struct componentname *a_cnp;
110 };
111
112 struct vop_create_args {
113         struct vop_generic_args a_head;
114         struct vnode *a_dvp;
115         struct namecache *a_par;
116         struct vnode **a_vpp;
117         struct componentname *a_cnp;
118         struct vattr *a_vap;
119 };
120
121 struct vop_whiteout_args {
122         struct vop_generic_args a_head;
123         struct vnode *a_dvp;
124         struct namecache *a_par;
125         struct componentname *a_cnp;
126         int a_flags;
127 };
128
129 struct vop_mknod_args {
130         struct vop_generic_args a_head;
131         struct vnode *a_dvp;
132         struct namecache *a_par;
133         struct vnode **a_vpp;
134         struct componentname *a_cnp;
135         struct vattr *a_vap;
136 };
137
138 struct vop_open_args {
139         struct vop_generic_args a_head;
140         struct vnode *a_vp;
141         int a_mode;
142         struct ucred *a_cred;
143         struct thread *a_td;
144 };
145
146 struct vop_close_args {
147         struct vop_generic_args a_head;
148         struct vnode *a_vp;
149         int a_fflag;
150         struct thread *a_td;
151 };
152
153 struct vop_access_args {
154         struct vop_generic_args a_head;
155         struct vnode *a_vp;
156         int a_mode;
157         struct ucred *a_cred;
158         struct thread *a_td;
159 };
160
161 struct vop_getattr_args {
162         struct vop_generic_args a_head;
163         struct vnode *a_vp;
164         struct vattr *a_vap;
165         struct thread *a_td;
166 };
167
168 struct vop_setattr_args {
169         struct vop_generic_args a_head;
170         struct vnode *a_vp;
171         struct vattr *a_vap;
172         struct ucred *a_cred;
173         struct thread *a_td;
174 };
175
176 struct vop_read_args {
177         struct vop_generic_args a_head;
178         struct vnode *a_vp;
179         struct uio *a_uio;
180         int a_ioflag;
181         struct ucred *a_cred;
182 };
183
184 struct vop_write_args {
185         struct vop_generic_args a_head;
186         struct vnode *a_vp;
187         struct uio *a_uio;
188         int a_ioflag;
189         struct ucred *a_cred;
190 };
191
192 struct vop_lease_args {
193         struct vop_generic_args a_head;
194         struct vnode *a_vp;
195         struct thread *a_td;
196         struct ucred *a_cred;
197         int a_flag;
198 };
199
200 struct vop_ioctl_args {
201         struct vop_generic_args a_head;
202         struct vnode *a_vp;
203         u_long a_command;
204         caddr_t a_data;
205         int a_fflag;
206         struct ucred *a_cred;
207         struct thread *a_td;
208 };
209
210 struct vop_poll_args {
211         struct vop_generic_args a_head;
212         struct vnode *a_vp;
213         int a_events;
214         struct ucred *a_cred;
215         struct thread *a_td;
216 };
217
218 struct vop_kqfilter_args {
219         struct vop_generic_args a_head;
220         struct vnode *a_vp;
221         struct knote *a_kn;
222 };
223
224 struct vop_revoke_args {
225         struct vop_generic_args a_head;
226         struct vnode *a_vp;
227         int a_flags;
228 };
229
230 struct vop_mmap_args {
231         struct vop_generic_args a_head;
232         struct vnode *a_vp;
233         int a_fflags;
234         struct ucred *a_cred;
235         struct thread *a_td;
236 };
237
238 struct vop_fsync_args {
239         struct vop_generic_args a_head;
240         struct vnode *a_vp;
241         int a_waitfor;
242         struct thread *a_td;
243 };
244
245 struct vop_remove_args {
246         struct vop_generic_args a_head;
247         struct vnode *a_dvp;
248         struct namecache *a_par;
249         struct vnode *a_vp;
250         struct componentname *a_cnp;
251 };
252
253 struct vop_link_args {
254         struct vop_generic_args a_head;
255         struct vnode *a_tdvp;
256         struct namecache *a_par;
257         struct vnode *a_vp;
258         struct componentname *a_cnp;
259 };
260
261 struct vop_rename_args {
262         struct vop_generic_args a_head;
263         struct vnode *a_fdvp;
264         struct namecache *a_fpar;
265         struct vnode *a_fvp;
266         struct componentname *a_fcnp;
267         struct vnode *a_tdvp;
268         struct namecache *a_tpar;
269         struct vnode *a_tvp;
270         struct componentname *a_tcnp;
271 };
272
273 struct vop_mkdir_args {
274         struct vop_generic_args a_head;
275         struct vnode *a_dvp;
276         struct namecache *a_par;
277         struct vnode **a_vpp;
278         struct componentname *a_cnp;
279         struct vattr *a_vap;
280 };
281
282 struct vop_rmdir_args {
283         struct vop_generic_args a_head;
284         struct vnode *a_dvp;
285         struct namecache *a_par;
286         struct vnode *a_vp;
287         struct componentname *a_cnp;
288 };
289
290 struct vop_symlink_args {
291         struct vop_generic_args a_head;
292         struct vnode *a_dvp;
293         struct namecache *a_par;
294         struct vnode **a_vpp;
295         struct componentname *a_cnp;
296         struct vattr *a_vap;
297         char *a_target;
298 };
299
300 struct vop_readdir_args {
301         struct vop_generic_args a_head;
302         struct vnode *a_vp;
303         struct uio *a_uio;
304         struct ucred *a_cred;
305         int *a_eofflag;
306         int *a_ncookies;
307         u_long **a_cookies;
308 };
309
310 struct vop_readlink_args {
311         struct vop_generic_args a_head;
312         struct vnode *a_vp;
313         struct uio *a_uio;
314         struct ucred *a_cred;
315 };
316
317 struct vop_inactive_args {
318         struct vop_generic_args a_head;
319         struct vnode *a_vp;
320         struct thread *a_td;
321 };
322
323 struct vop_reclaim_args {
324         struct vop_generic_args a_head;
325         struct vnode *a_vp;
326         struct thread *a_td;
327 };
328
329 struct vop_lock_args {
330         struct vop_generic_args a_head;
331         struct vnode *a_vp;
332         struct lwkt_tokref *a_vlock;
333         int a_flags;
334         struct thread *a_td;
335 };
336
337 struct vop_unlock_args {
338         struct vop_generic_args a_head;
339         struct vnode *a_vp;
340         struct lwkt_tokref *a_vlock;
341         int a_flags;
342         struct thread *a_td;
343 };
344
345 struct vop_bmap_args {
346         struct vop_generic_args a_head;
347         struct vnode *a_vp;
348         daddr_t a_bn;
349         struct vnode **a_vpp;
350         daddr_t *a_bnp;
351         int *a_runp;
352         int *a_runb;
353 };
354
355 struct vop_strategy_args {
356         struct vop_generic_args a_head;
357         struct vnode *a_vp;
358         struct buf *a_bp;
359 };
360
361 struct vop_print_args {
362         struct vop_generic_args a_head;
363         struct vnode *a_vp;
364 };
365
366 struct vop_pathconf_args {
367         struct vop_generic_args a_head;
368         struct vnode *a_vp;
369         int a_name;
370         register_t *a_retval;
371 };
372
373 struct vop_advlock_args {
374         struct vop_generic_args a_head;
375         struct vnode *a_vp;
376         caddr_t a_id;
377         int a_op;
378         struct flock *a_fl;
379         int a_flags;
380 };
381
382 struct vop_balloc_args {
383         struct vop_generic_args a_head;
384         struct vnode *a_vp;
385         off_t a_startoffset;
386         int a_size;
387         struct ucred *a_cred;
388         int a_flags;
389         struct buf **a_bpp;
390 };
391
392 struct vop_reallocblks_args {
393         struct vop_generic_args a_head;
394         struct vnode *a_vp;
395         struct cluster_save *a_buflist;
396 };
397
398 struct vop_getpages_args {
399         struct vop_generic_args a_head;
400         struct vnode *a_vp;
401         struct vm_page **a_m;
402         int a_count;
403         int a_reqpage;
404         vm_ooffset_t a_offset;
405 };
406
407 struct vop_putpages_args {
408         struct vop_generic_args a_head;
409         struct vnode *a_vp;
410         struct vm_page **a_m;
411         int a_count;
412         int a_sync;
413         int *a_rtvals;
414         vm_ooffset_t a_offset;
415 };
416
417 struct vop_freeblks_args {
418         struct vop_generic_args a_head;
419         struct vnode *a_vp;
420         daddr_t a_addr;
421         daddr_t a_length;
422 };
423
424 struct vop_bwrite_args {
425         struct vop_generic_args a_head;
426         struct vnode *a_vp;
427         struct buf *a_bp;
428 };
429
430 struct vop_getacl_args {
431         struct vop_generic_args a_head;
432         struct vnode *a_vp;
433         acl_type_t a_type;
434         struct acl *a_aclp;
435         struct ucred *a_cred;
436         struct thread *a_td;
437 };
438
439 struct vop_setacl_args {
440         struct vop_generic_args a_head;
441         struct vnode *a_vp;
442         acl_type_t a_type;
443         struct acl *a_aclp;
444         struct ucred *a_cred;
445         struct thread *a_td;
446 };
447
448 struct vop_aclcheck_args {
449         struct vop_generic_args a_head;
450         struct vnode *a_vp;
451         acl_type_t a_type;
452         struct acl *a_aclp;
453         struct ucred *a_cred;
454         struct thread *a_td;
455 };
456
457 struct vop_getextattr_args {
458         struct vop_generic_args a_head;
459         struct vnode *a_vp;
460         char *a_name;
461         struct uio *a_uio;
462         struct ucred *a_cred;
463         struct thread *a_td;
464 };
465
466 struct vop_setextattr_args {
467         struct vop_generic_args a_head;
468         struct vnode *a_vp;
469         char *a_name;
470         struct uio *a_uio;
471         struct ucred *a_cred;
472         struct thread *a_td;
473 };
474
475 struct vop_createvobject_args {
476         struct vop_generic_args a_head;
477         struct vnode *a_vp;
478         struct thread *a_td;
479 };
480
481 struct vop_destroyvobject_args {
482         struct vop_generic_args a_head;
483         struct vnode *a_vp;
484 };
485
486 struct vop_getvobject_args {
487         struct vop_generic_args a_head;
488         struct vnode *a_vp;
489         struct vm_object **a_objpp;
490 };
491
492 struct vop_vfsset_args {
493         struct vop_generic_args a_head;
494         int a_op;
495         const char *a_opstr;
496 };
497
498 /*
499  * This structure is the post-compiled VOP operations vector.  vop_ops are
500  * typically per-mount entities.  The first section is used by our vop_*()
501  * function wrappers to implement hooks for per-mount management functions
502  * such as journaling and cache coherency protocols.  The second section is
503  * the function dispatch for the VFSs.  The functions are supposed to run
504  * in the context of the VFS's thread (if it has one) and should not be 
505  * directly called from random kernel code.  Note that VOCALL()s are direct
506  * calls used for chaining vop_ops structures from a VFS context.
507  */
508 struct vop_ops {
509         struct vop_ops  *vv_new;        /* vfs_recalc_vnodeops() only */
510         struct mount    *vv_mount;      /* may be NULL */
511         int             vv_refs;
512         int             vv_flags;       /* see VVF_* flags below */
513
514         struct vop_ops  *vv_jops;       /* VVF_JOURNAL_HOOK */
515         struct vop_ops  *vv_cops;       /* VVF_CCOHERENCY_HOOK */
516
517         /* XXX Journaling control */
518         /* XXX Cache Coherency functions (local/remote/clustered) */
519         /* XXX Other */
520         int             vv_reserved[62]; /* (temporary) reduce recompile pain */
521
522 #define vop_ops_first_field     vop_default
523         int     (*vop_default)(struct vop_generic_args *);
524         int     (*vop_islocked)(struct vop_islocked_args *);
525         int     (*vop_lookup)(struct vop_lookup_args *);
526         int     (*vop_cachedlookup)(struct vop_cachedlookup_args *);
527         int     (*vop_create)(struct vop_create_args *);
528         int     (*vop_whiteout)(struct vop_whiteout_args *);
529         int     (*vop_mknod)(struct vop_mknod_args *);
530         int     (*vop_open)(struct vop_open_args *);
531         int     (*vop_close)(struct vop_close_args *);
532         int     (*vop_access)(struct vop_access_args *);
533         int     (*vop_getattr)(struct vop_getattr_args *);
534         int     (*vop_setattr)(struct vop_setattr_args *);
535         int     (*vop_read)(struct vop_read_args *);
536         int     (*vop_write)(struct vop_write_args *);
537         int     (*vop_lease)(struct vop_lease_args *);
538         int     (*vop_ioctl)(struct vop_ioctl_args *);
539         int     (*vop_poll)(struct vop_poll_args *);
540         int     (*vop_kqfilter)(struct vop_kqfilter_args *);
541         int     (*vop_revoke)(struct vop_revoke_args *);
542         int     (*vop_mmap)(struct vop_mmap_args *);
543         int     (*vop_fsync)(struct vop_fsync_args *);
544         int     (*vop_remove)(struct vop_remove_args *);
545         int     (*vop_link)(struct vop_link_args *);
546         int     (*vop_rename)(struct vop_rename_args *);
547         int     (*vop_mkdir)(struct vop_mkdir_args *);
548         int     (*vop_rmdir)(struct vop_rmdir_args *);
549         int     (*vop_symlink)(struct vop_symlink_args *);
550         int     (*vop_readdir)(struct vop_readdir_args *);
551         int     (*vop_readlink)(struct vop_readlink_args *);
552         int     (*vop_inactive)(struct vop_inactive_args *);
553         int     (*vop_reclaim)(struct vop_reclaim_args *);
554         int     (*vop_lock)(struct vop_lock_args *);
555         int     (*vop_unlock)(struct vop_unlock_args *);
556         int     (*vop_bmap)(struct vop_bmap_args *);
557         int     (*vop_strategy)(struct vop_strategy_args *);
558         int     (*vop_print)(struct vop_print_args *);
559         int     (*vop_pathconf)(struct vop_pathconf_args *);
560         int     (*vop_advlock)(struct vop_advlock_args *);
561         int     (*vop_balloc)(struct vop_balloc_args *);
562         int     (*vop_reallocblks)(struct vop_reallocblks_args *);
563         int     (*vop_getpages)(struct vop_getpages_args *);
564         int     (*vop_putpages)(struct vop_putpages_args *);
565         int     (*vop_freeblks)(struct vop_freeblks_args *);
566         int     (*vop_bwrite)(struct vop_bwrite_args *);
567         int     (*vop_getacl)(struct vop_getacl_args *);
568         int     (*vop_setacl)(struct vop_setacl_args *);
569         int     (*vop_aclcheck)(struct vop_aclcheck_args *);
570         int     (*vop_getextattr)(struct vop_getextattr_args *);
571         int     (*vop_setextattr)(struct vop_setextattr_args *);
572         int     (*vop_createvobject)(struct vop_createvobject_args *);
573         int     (*vop_destroyvobject)(struct vop_destroyvobject_args *);
574         int     (*vop_getvobject)(struct vop_getvobject_args *);
575         int     (*vop_vfsset)(struct vop_vfsset_args *);
576 #define vop_ops_last_field      vop_vfsset
577 };
578
579 #define VVF_JOURNAL_HOOK        0x0001          /* FUTURE */
580 #define VVF_CCOHERENCY_HOOK     0x0002          /* FUTURE */
581 #define VVF_UNUSED_04           0x0004
582 #define VVF_UNUSED_08           0x0008
583 #define VVF_NOATIME             0x0010          /* FUTURE */
584 #define VVF_RDONLY              0x0020          /* FUTURE */
585 #define VVF_NOCLUSTER           0x0040          /* FUTURE */
586 #define VVF_SUIDDIR             0x0080          /* FUTURE */
587
588 #define VVF_HOOK_MASK           (VVF_JOURNAL_HOOK|VVF_CCOHERENCY_HOOK)
589
590 /*
591  * vop_vfsset() operations
592  */
593 #define VFSSET_DETACH           0
594 #define VFSSET_ATTACH           1
595
596 /*
597  * Kernel VOP arguments union, suitable for malloc / embedding in other
598  * structures.  The vop_args_union can hold any VOP call argument structure.
599  * Note that vu_head is broken out.
600  */
601 union vop_args_union {
602         struct vop_generic_args vu_head;
603         struct vop_generic_args vu_default;
604         struct vop_islocked_args vu_islocked;
605         struct vop_lookup_args vu_lookup;
606         struct vop_cachedlookup_args vu_cachedlookup;
607         struct vop_create_args vu_create;
608         struct vop_whiteout_args vu_whiteout;
609         struct vop_mknod_args vu_mknod;
610         struct vop_open_args vu_open;
611         struct vop_close_args vu_close;
612         struct vop_access_args vu_access;
613         struct vop_getattr_args vu_getattr;
614         struct vop_setattr_args vu_setattr;
615         struct vop_read_args vu_read;
616         struct vop_write_args vu_write;
617         struct vop_lease_args vu_lease;
618         struct vop_ioctl_args vu_ioctl;
619         struct vop_poll_args vu_poll;
620         struct vop_kqfilter_args vu_kqfilter;
621         struct vop_revoke_args vu_revoke;
622         struct vop_mmap_args vu_mmap;
623         struct vop_fsync_args vu_fsync;
624         struct vop_remove_args vu_remove;
625         struct vop_link_args vu_link;
626         struct vop_rename_args vu_rename;
627         struct vop_mkdir_args vu_mkdir;
628         struct vop_rmdir_args vu_rmdir;
629         struct vop_symlink_args vu_symlink;
630         struct vop_readdir_args vu_readdir;
631         struct vop_readlink_args vu_readlink;
632         struct vop_inactive_args vu_inactive;
633         struct vop_reclaim_args vu_reclaim;
634         struct vop_lock_args vu_lock;
635         struct vop_unlock_args vu_unlock;
636         struct vop_bmap_args vu_bmap;
637         struct vop_strategy_args vu_strategy;
638         struct vop_print_args vu_print;
639         struct vop_pathconf_args vu_pathconf;
640         struct vop_advlock_args vu_advlock;
641         struct vop_balloc_args vu_balloc;
642         struct vop_reallocblks_args vu_reallocblks;
643         struct vop_getpages_args vu_getpages;
644         struct vop_putpages_args vu_putpages;
645         struct vop_freeblks_args vu_freeblks;
646         struct vop_bwrite_args vu_bwrite;
647         struct vop_getacl_args vu_getacl;
648         struct vop_setacl_args vu_setacl;
649         struct vop_aclcheck_args vu_aclcheck;
650         struct vop_getextattr_args vu_getextattr;
651         struct vop_setextattr_args vu_setextattr;
652         struct vop_createvobject_args vu_createvobject;
653         struct vop_destroyvobject_args vu_destroyvobject;
654         struct vop_getvobject_args vu_getvobject;
655         struct vop_vfsset_args vu_vfsset;
656 };
657
658 #ifdef _KERNEL
659
660 /*
661  * Kernel VOP call wrappers.  These wrappers are responsible for wrapping
662  * the arguments in the appropriate VOP arguments structure, sending the
663  * message, and waiting for a reply.  All kernel and VFS code should generally
664  * call these wrappers rather then attempt to call the operations vector
665  * routine directly in order to allow DragonFly to properly wrap the operation
666  * in a message and dispatch it to the correct thread.
667  */
668 int vop_islocked(struct vop_ops *ops, struct vnode *vp, struct thread *td);
669 int vop_lookup(struct vop_ops *ops, struct vnode *dvp, struct namecache *par,
670                 struct vnode **vpp, struct namecache **ncpp,
671                 struct componentname *cnp);
672 int vop_cachedlookup(struct vop_ops *ops, struct vnode *dvp, 
673                 struct vnode **vpp, struct componentname *cnp);
674 int vop_create(struct vop_ops *ops, struct vnode *dvp, struct namecache *par,
675                 struct vnode **vpp, struct componentname *cnp,
676                 struct vattr *vap);
677 int vop_whiteout(struct vop_ops *ops, struct vnode *dvp, struct namecache *par,
678                 struct componentname *cnp, int flags);
679 int vop_mknod(struct vop_ops *ops, struct vnode *dvp, struct namecache *par,
680                 struct vnode **vpp, struct componentname *cnp,
681                 struct vattr *vap);
682 int vop_open(struct vop_ops *ops, struct vnode *vp, int mode,
683                 struct ucred *cred, struct thread *td);
684 int vop_close(struct vop_ops *ops, struct vnode *vp,
685                 int fflag, struct thread *td);
686 int vop_access(struct vop_ops *ops, struct vnode *vp, int mode,
687                 struct ucred *cred, struct thread *td);
688 int vop_getattr(struct vop_ops *ops, struct vnode *vp, struct vattr *vap,
689                 struct thread *td);
690 int vop_setattr(struct vop_ops *ops, struct vnode *vp, struct vattr *vap,
691                 struct ucred *cred, struct thread *td);
692 int vop_read(struct vop_ops *ops, struct vnode *vp, struct uio *uio,
693                 int ioflag, struct ucred *cred);
694 int vop_write(struct vop_ops *ops, struct vnode *vp, struct uio *uio,
695                 int ioflag, struct ucred *cred);
696 int vop_lease(struct vop_ops *ops, struct vnode *vp, struct thread *td,
697                 struct ucred *cred, int flag);
698 int vop_ioctl(struct vop_ops *ops, struct vnode *vp, u_long command,
699                 caddr_t data, int fflag,
700                 struct ucred *cred, struct thread *td);
701 int vop_poll(struct vop_ops *ops, struct vnode *vp, int events,
702                 struct ucred *cred, struct thread *td);
703 int vop_kqfilter(struct vop_ops *ops, struct vnode *vp, struct knote *kn);
704 int vop_revoke(struct vop_ops *ops, struct vnode *vp, int flags);
705 int vop_mmap(struct vop_ops *ops, struct vnode *vp, int fflags,
706                 struct ucred *cred, struct thread *td);
707 int vop_fsync(struct vop_ops *ops, struct vnode *vp, int waitfor,
708                 struct thread *td);
709 int vop_remove(struct vop_ops *ops, struct vnode *dvp, struct namecache *par,
710                 struct vnode *vp, struct componentname *cnp);
711 int vop_link(struct vop_ops *ops, struct vnode *tdvp, struct namecache *par,
712                 struct vnode *vp, struct componentname *cnp);
713 int vop_rename(struct vop_ops *ops, struct vnode *fdvp, struct namecache *fpar,
714                 struct vnode *fvp, struct componentname *fcnp,
715                 struct vnode *tdvp, struct namecache *tpar,
716                 struct vnode *tvp, struct componentname *tcnp);
717 int vop_mkdir(struct vop_ops *ops, struct vnode *dvp, struct namecache *par,
718                 struct vnode **vpp, struct componentname *cnp,
719                 struct vattr *vap);
720 int vop_rmdir(struct vop_ops *ops, struct vnode *dvp, struct namecache *par,
721                 struct vnode *vp, struct componentname *cnp);
722 int vop_symlink(struct vop_ops *ops, struct vnode *dvp, struct namecache *par,
723                 struct vnode **vpp, struct componentname *cnp,
724                 struct vattr *vap, char *target);
725 int vop_readdir(struct vop_ops *ops, struct vnode *vp, struct uio *uio,
726                 struct ucred *cred, int *eofflag, 
727                 int *ncookies, u_long **cookies);
728 int vop_readlink(struct vop_ops *ops, struct vnode *vp, struct uio *uio,
729                 struct ucred *cred);
730 int vop_inactive(struct vop_ops *ops, struct vnode *vp, struct thread *td);
731 int vop_reclaim(struct vop_ops *ops, struct vnode *vp, struct thread *td);
732 int vop_lock(struct vop_ops *ops, struct vnode *vp,
733                 struct lwkt_tokref *vlock, int flags, struct thread *td);
734 int vop_unlock(struct vop_ops *ops, struct vnode *vp,
735                 struct lwkt_tokref *vlock, int flags, struct thread *td);
736 int vop_bmap(struct vop_ops *ops, struct vnode *vp, daddr_t bn,
737                 struct vnode **vpp, daddr_t *bnp, int *runp, int *runb);
738 int vop_strategy(struct vop_ops *ops, struct vnode *vp, struct buf *bp);
739 int vop_print(struct vop_ops *ops, struct vnode *vp);
740 int vop_pathconf(struct vop_ops *ops, struct vnode *vp, int name,
741                 register_t *retval);
742 int vop_advlock(struct vop_ops *ops, struct vnode *vp, caddr_t id, int op,
743                 struct flock *fl, int flags);
744 int vop_balloc(struct vop_ops *ops, struct vnode *vp, off_t startoffset,
745                 int size, struct ucred *cred, int flags,
746                 struct buf **bpp);
747 int vop_reallocblks(struct vop_ops *ops, struct vnode *vp,
748                 struct cluster_save *buflist);
749 int vop_getpages(struct vop_ops *ops, struct vnode *vp, struct vm_page **m,
750                 int count, int reqpage, vm_ooffset_t offset);
751 int vop_putpages(struct vop_ops *ops, struct vnode *vp, struct vm_page **m,
752                 int count, int sync, int *rtvals, vm_ooffset_t offset);
753 int vop_freeblks(struct vop_ops *ops, struct vnode *vp,
754                 daddr_t addr, daddr_t length);
755 int vop_bwrite(struct vop_ops *ops, struct vnode *vp, struct buf *bp);
756 int vop_getacl(struct vop_ops *ops, struct vnode *vp, acl_type_t type,
757                 struct acl *aclp, struct ucred *cred, struct thread *td);
758 int vop_setacl(struct vop_ops *ops, struct vnode *vp, acl_type_t type,
759                 struct acl *aclp, struct ucred *cred, struct thread *td);
760 int vop_aclcheck(struct vop_ops *ops, struct vnode *vp, acl_type_t type,
761                 struct acl *aclp, struct ucred *cred, struct thread *td);
762 int vop_getextattr(struct vop_ops *ops, struct vnode *vp, char *name, 
763                 struct uio *uio, struct ucred *cred, struct thread *td);
764 int vop_setextattr(struct vop_ops *ops, struct vnode *vp, char *name, 
765                 struct uio *uio, struct ucred *cred, struct thread *td);
766 int vop_createvobject(struct vop_ops *ops,
767                 struct vnode *vp, struct thread *td);
768 int vop_destroyvobject(struct vop_ops *ops, struct vnode *vp);
769 int vop_getvobject(struct vop_ops *ops,
770                 struct vnode *vp, struct vm_object **objpp);
771 int vop_vfsset(struct vop_ops *ops, int op, const char *opstr);
772
773 /*
774  * Kernel VOP forwarding wrappers.  These are called when a VFS such as
775  * nullfs or unionfs needs to push down into another VFS, changing the 
776  * a_ops pointer and consequentially necessitating additional 
777  * cache management.
778  *
779  * Note that this is different from vop_ops chaining within the same
780  * filesystem.  When a filesystem chains a vop_ops it just uses VOCALLs.
781  */
782 int vop_vnoperate_ap(struct vop_generic_args *ap);
783 int vop_islocked_ap(struct vop_islocked_args *ap);
784 int vop_lookup_ap(struct vop_lookup_args *ap);
785 int vop_cachedlookup_ap(struct vop_cachedlookup_args *ap);
786 int vop_create_ap(struct vop_create_args *ap);
787 int vop_whiteout_ap(struct vop_whiteout_args *ap);
788 int vop_mknod_ap(struct vop_mknod_args *ap);
789 int vop_open_ap(struct vop_open_args *ap);
790 int vop_close_ap(struct vop_close_args *ap);
791 int vop_access_ap(struct vop_access_args *ap);
792 int vop_getattr_ap(struct vop_getattr_args *ap);
793 int vop_setattr_ap(struct vop_setattr_args *ap);
794 int vop_read_ap(struct vop_read_args *ap);
795 int vop_write_ap(struct vop_write_args *ap);
796 int vop_lease_ap(struct vop_lease_args *ap);
797 int vop_ioctl_ap(struct vop_ioctl_args *ap);
798 int vop_poll_ap(struct vop_poll_args *ap);
799 int vop_kqfilter_ap(struct vop_kqfilter_args *ap);
800 int vop_revoke_ap(struct vop_revoke_args *ap);
801 int vop_mmap_ap(struct vop_mmap_args *ap);
802 int vop_fsync_ap(struct vop_fsync_args *ap);
803 int vop_remove_ap(struct vop_remove_args *ap);
804 int vop_link_ap(struct vop_link_args *ap);
805 int vop_rename_ap(struct vop_rename_args *ap);
806 int vop_mkdir_ap(struct vop_mkdir_args *ap);
807 int vop_rmdir_ap(struct vop_rmdir_args *ap);
808 int vop_symlink_ap(struct vop_symlink_args *ap);
809 int vop_readdir_ap(struct vop_readdir_args *ap);
810 int vop_readlink_ap(struct vop_readlink_args *ap);
811 int vop_inactive_ap(struct vop_inactive_args *ap);
812 int vop_reclaim_ap(struct vop_reclaim_args *ap);
813 int vop_lock_ap(struct vop_lock_args *ap);
814 int vop_unlock_ap(struct vop_unlock_args *ap);
815 int vop_bmap_ap(struct vop_bmap_args *ap);
816 int vop_strategy_ap(struct vop_strategy_args *ap);
817 int vop_print_ap(struct vop_print_args *ap);
818 int vop_pathconf_ap(struct vop_pathconf_args *ap);
819 int vop_advlock_ap(struct vop_advlock_args *ap);
820 int vop_balloc_ap(struct vop_balloc_args *ap);
821 int vop_reallocblks_ap(struct vop_reallocblks_args *ap);
822 int vop_getpages_ap(struct vop_getpages_args *ap);
823 int vop_putpages_ap(struct vop_putpages_args *ap);
824 int vop_freeblks_ap(struct vop_freeblks_args *ap);
825 int vop_bwrite_ap(struct vop_bwrite_args *ap);
826 int vop_getacl_ap(struct vop_getacl_args *ap);
827 int vop_setacl_ap(struct vop_setacl_args *ap);
828 int vop_aclcheck_ap(struct vop_aclcheck_args *ap);
829 int vop_getextattr_ap(struct vop_getextattr_args *ap);
830 int vop_setextattr_ap(struct vop_setextattr_args *ap);
831 int vop_createvobject_ap(struct vop_createvobject_args *ap);
832 int vop_destroyvobject_ap(struct vop_destroyvobject_args *ap);
833 int vop_getvobject_ap(struct vop_getvobject_args *ap);
834 int vop_vfsset_ap(struct vop_vfsset_args *ap);
835
836 /*
837  * VOP operations descriptor.  This is used by the vop_ops compiler
838  * to convert VFS vector arrays (typically in vfs/blah/blah_vnops.c)
839  * into a vop_ops operations vector.
840  */
841 extern struct vnodeop_desc vop_default_desc;
842 extern struct vnodeop_desc vop_islocked_desc;
843 extern struct vnodeop_desc vop_lookup_desc;
844 extern struct vnodeop_desc vop_cachedlookup_desc;
845 extern struct vnodeop_desc vop_create_desc;
846 extern struct vnodeop_desc vop_whiteout_desc;
847 extern struct vnodeop_desc vop_mknod_desc;
848 extern struct vnodeop_desc vop_open_desc;
849 extern struct vnodeop_desc vop_close_desc;
850 extern struct vnodeop_desc vop_access_desc;
851 extern struct vnodeop_desc vop_getattr_desc;
852 extern struct vnodeop_desc vop_setattr_desc;
853 extern struct vnodeop_desc vop_read_desc;
854 extern struct vnodeop_desc vop_write_desc;
855 extern struct vnodeop_desc vop_lease_desc;
856 extern struct vnodeop_desc vop_ioctl_desc;
857 extern struct vnodeop_desc vop_poll_desc;
858 extern struct vnodeop_desc vop_kqfilter_desc;
859 extern struct vnodeop_desc vop_revoke_desc;
860 extern struct vnodeop_desc vop_mmap_desc;
861 extern struct vnodeop_desc vop_fsync_desc;
862 extern struct vnodeop_desc vop_remove_desc;
863 extern struct vnodeop_desc vop_link_desc;
864 extern struct vnodeop_desc vop_rename_desc;
865 extern struct vnodeop_desc vop_mkdir_desc;
866 extern struct vnodeop_desc vop_rmdir_desc;
867 extern struct vnodeop_desc vop_symlink_desc;
868 extern struct vnodeop_desc vop_readdir_desc;
869 extern struct vnodeop_desc vop_readlink_desc;
870 extern struct vnodeop_desc vop_inactive_desc;
871 extern struct vnodeop_desc vop_reclaim_desc;
872 extern struct vnodeop_desc vop_lock_desc;
873 extern struct vnodeop_desc vop_unlock_desc;
874 extern struct vnodeop_desc vop_bmap_desc;
875 extern struct vnodeop_desc vop_strategy_desc;
876 extern struct vnodeop_desc vop_print_desc;
877 extern struct vnodeop_desc vop_pathconf_desc;
878 extern struct vnodeop_desc vop_advlock_desc;
879 extern struct vnodeop_desc vop_balloc_desc;
880 extern struct vnodeop_desc vop_reallocblks_desc;
881 extern struct vnodeop_desc vop_getpages_desc;
882 extern struct vnodeop_desc vop_putpages_desc;
883 extern struct vnodeop_desc vop_freeblks_desc;
884 extern struct vnodeop_desc vop_bwrite_desc;
885 extern struct vnodeop_desc vop_getacl_desc;
886 extern struct vnodeop_desc vop_setacl_desc;
887 extern struct vnodeop_desc vop_aclcheck_desc;
888 extern struct vnodeop_desc vop_getextattr_desc;
889 extern struct vnodeop_desc vop_setextattr_desc;
890 extern struct vnodeop_desc vop_createvobject_desc;
891 extern struct vnodeop_desc vop_destroyvobject_desc;
892 extern struct vnodeop_desc vop_getvobject_desc;
893 extern struct vnodeop_desc vop_vfsset_desc;
894
895 #endif
896
897 /*
898  * VOP_ macro compatibility.  Remove these as we get rid of the VOP macros.
899  * We have to convert the VOP macros into the vop_*() version that requires
900  * the appropriate v_ops structure pointer for the first arg.
901  */
902 #define VOP_ISLOCKED(vp, td)                            \
903         vop_islocked((vp)->v_ops, vp, td)
904 #define VOP_LOOKUP(dvp, par, vpp, ncpp, cnp)            \
905         vop_lookup((dvp)->v_ops, dvp, par, vpp, ncpp, cnp)
906 #define VOP_CACHEDLOOKUP(dvp, vpp, cnp) \
907         vop_cachedlookup((dvp)->v_ops, dvp, vpp, cnp)
908 #define VOP_CREATE(dvp, par, vpp, cnp, vap)             \
909         vop_create((dvp)->v_ops, dvp, par, vpp, cnp, vap)
910 #define VOP_WHITEOUT(dvp, par, cnp, flags)              \
911         vop_whiteout((dvp)->v_ops, dvp, par, cnp, flags)
912 #define VOP_MKNOD(dvp, par, vpp, cnp, vap)              \
913         vop_mknod((dvp)->v_ops, dvp, par, vpp, cnp, vap)
914 #define VOP_OPEN(vp, mode, cred, td)                    \
915         vop_open((vp)->v_ops, vp, mode, cred, td)
916 #define VOP_CLOSE(vp, fflag, td)                        \
917         vop_close((vp)->v_ops, vp, fflag, td)
918 #define VOP_ACCESS(vp, mode, cred, td)                  \
919         vop_access((vp)->v_ops, vp, mode, cred, td)
920 #define VOP_GETATTR(vp, vap, td)                        \
921         vop_getattr((vp)->v_ops, vp, vap, td)
922 #define VOP_SETATTR(vp, vap, cred, td)                  \
923         vop_setattr((vp)->v_ops, vp, vap, cred, td)
924 #define VOP_READ(vp, uio, ioflag, cred)                 \
925         vop_read((vp)->v_ops, vp, uio, ioflag, cred)
926 #define VOP_WRITE(vp, uio, ioflag, cred)                \
927         vop_write((vp)->v_ops, vp, uio, ioflag, cred)
928 #define VOP_LEASE(vp, td, cred, flag)                   \
929         vop_lease((vp)->v_ops, vp, td, cred, flag)
930 #define VOP_IOCTL(vp, command, data, fflag, cred, td)   \
931         vop_ioctl((vp)->v_ops, vp, command, data, fflag, cred, td)
932 #define VOP_POLL(vp, events, cred, td)                  \
933         vop_poll((vp)->v_ops, vp, events, cred, td)
934 #define VOP_KQFILTER(vp, kn)                            \
935         vop_kqfilter((vp)->v_ops, vp, kn)
936 #define VOP_REVOKE(vp, flags)                           \
937         vop_revoke((vp)->v_ops, vp, flags)
938 #define VOP_MMAP(vp, fflags, cred, td)                  \
939         vop_mmap((vp)->v_ops, vp, fflags, cred, td)
940 #define VOP_FSYNC(vp, waitfor, td)                      \
941         vop_fsync((vp)->v_ops, vp, waitfor, td)
942 #define VOP_REMOVE(dvp, par, vp, cnp)                   \
943         vop_remove((dvp)->v_ops, dvp, par, vp, cnp)
944 #define VOP_LINK(tdvp, par, vp, cnp)                    \
945         vop_link((tdvp)->v_ops, tdvp, par, vp, cnp)
946 #define VOP_RENAME(fdvp, fpar, fvp, fcnp, tdvp, tpar, tvp, tcnp)        \
947         vop_rename((fdvp)->v_ops, fdvp, fpar, fvp, fcnp, tdvp, tpar, tvp, tcnp)
948 #define VOP_MKDIR(dvp, par, vpp, cnp, vap)              \
949         vop_mkdir((dvp)->v_ops, dvp, par, vpp, cnp, vap)
950 #define VOP_RMDIR(dvp, par, vp, cnp)                    \
951         vop_rmdir((dvp)->v_ops, dvp, par, vp, cnp)
952 #define VOP_SYMLINK(dvp, par, vpp, cnp, vap, target)    \
953         vop_symlink((dvp)->v_ops, dvp, par, vpp, cnp, vap, target)
954 #define VOP_READDIR(vp, uio, cred, eofflag, ncookies, cookies)          \
955         vop_readdir((vp)->v_ops, vp, uio, cred, eofflag, ncookies, cookies)
956 #define VOP_READLINK(vp, uio, cred)                     \
957         vop_readlink((vp)->v_ops, vp, uio, cred)
958 #define VOP_INACTIVE(vp, td)                            \
959         vop_inactive((vp)->v_ops, vp, td)
960 #define VOP_RECLAIM(vp, td)                             \
961         vop_reclaim((vp)->v_ops, vp, td)
962 #define VOP_LOCK(vp, vlock, flags, td)                  \
963         vop_lock((vp)->v_ops, vp, vlock, flags, td)
964 #define VOP_UNLOCK(vp, vlock, flags, td)                \
965         vop_unlock((vp)->v_ops, vp, vlock, flags, td)
966 #define VOP_BMAP(vp, bn, vpp, bnp, runp, runb)          \
967         vop_bmap((vp)->v_ops, vp, bn, vpp, bnp, runp, runb)
968 #define VOP_STRATEGY(vp, bp)                            \
969         vop_strategy((vp)->v_ops, vp, bp)
970 #define VOP_PRINT(vp)                                   \
971         vop_print((vp)->v_ops, vp)
972 #define VOP_PATHCONF(vp, name, retval)                  \
973         vop_pathconf((vp)->v_ops, vp, name, retval)
974 #define VOP_ADVLOCK(vp, id, op, fl, flags)              \
975         vop_advlock((vp)->v_ops, vp, id, op, fl, flags)
976 #define VOP_BALLOC(vp, offset, size, cred, flags, bpp)  \
977         vop_balloc((vp)->v_ops, vp, offset, size, cred, flags, bpp)
978 #define VOP_REALLOCBLKS(vp, buflist)                    \
979         vop_reallocblks((vp)->v_ops, vp, buflist)
980 #define VOP_GETPAGES(vp, m, count, reqpage, off)        \
981         vop_getpages((vp)->v_ops, vp, m, count, reqpage, off)
982 #define VOP_PUTPAGES(vp, m, count, sync, rtvals, off)   \
983         vop_putpages((vp)->v_ops, vp, m, count, sync, rtvals, off)
984 #define VOP_FREEBLKS(vp, addr, length)                  \
985         vop_freeblks((vp)->v_ops, vp, addr, length)
986 #define VOP_BWRITE(vp, bp)                              \
987         vop_bwrite((vp)->v_ops, vp, bp)
988 #define VOP_GETACL(vp, type, aclp, cred, td)            \
989         vop_getacl((vp)->v_ops, vp, type, aclp, cred, td)
990 #define VOP_SETACL(vp, type, aclp, cred, td)            \
991         vop_setacl((vp)->v_ops, vp, type, aclp, cred, td)
992 #define VOP_ACLCHECK(vp, type, aclp, cred, td)          \
993         vop_aclcheck((vp)->v_ops, vp, type, aclp, cred, td)
994 #define VOP_GETEXTATTR(vp, name, uio, cred, td)         \
995         vop_getextattr((vp)->v_ops, vp, name, uio, cred, td)
996 #define VOP_SETEXTATTR(vp, name, uio, cred, td)         \
997         vop_setextattr((vp)->v_ops, vp, name, uio, cred, td)
998 #define VOP_CREATEVOBJECT(vp, td)                       \
999         vop_createvobject((vp)->v_ops, vp, td)
1000 #define VOP_DESTROYVOBJECT(vp)                          \
1001         vop_destroyvobject((vp)->v_ops, vp)
1002 #define VOP_GETVOBJECT(vp, objpp)                       \
1003         vop_getvobject((vp)->v_ops, vp, objpp)
1004 /* no VOP_VFSSET() */
1005
1006 #endif
1007