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