Return to nfsnode.h CVS log

Up to [Apple Darwin 0.x] / kernel / bsd / nfs

Annotation of kernel/bsd/nfs/nfsnode.h, revision 1.1

1.1     ! root        1: /*
        !             2:  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
        !             3:  *
        !             4:  * @APPLE_LICENSE_HEADER_START@
        !             5:  * 
        !             6:  * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
        !             7:  * Reserved.  This file contains Original Code and/or Modifications of
        !             8:  * Original Code as defined in and that are subject to the Apple Public
        !             9:  * Source License Version 1.1 (the "License").  You may not use this file
        !            10:  * except in compliance with the License.  Please obtain a copy of the
        !            11:  * License at http://www.apple.com/publicsource and read it before using
        !            12:  * this file.
        !            13:  * 
        !            14:  * The Original Code and all software distributed under the License are
        !            15:  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
        !            16:  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
        !            17:  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
        !            18:  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
        !            19:  * License for the specific language governing rights and limitations
        !            20:  * under the License.
        !            21:  * 
        !            22:  * @APPLE_LICENSE_HEADER_END@
        !            23:  */
        !            24: 
        !            25: /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
        !            26: /*
        !            27:  * Copyright (c) 1989, 1993
        !            28:  *     The Regents of the University of California.  All rights reserved.
        !            29:  *
        !            30:  * This code is derived from software contributed to Berkeley by
        !            31:  * Rick Macklem at The University of Guelph.
        !            32:  *
        !            33:  * Redistribution and use in source and binary forms, with or without
        !            34:  * modification, are permitted provided that the following conditions
        !            35:  * are met:
        !            36:  * 1. Redistributions of source code must retain the above copyright
        !            37:  *    notice, this list of conditions and the following disclaimer.
        !            38:  * 2. Redistributions in binary form must reproduce the above copyright
        !            39:  *    notice, this list of conditions and the following disclaimer in the
        !            40:  *    documentation and/or other materials provided with the distribution.
        !            41:  * 3. All advertising materials mentioning features or use of this software
        !            42:  *    must display the following acknowledgement:
        !            43:  *     This product includes software developed by the University of
        !            44:  *     California, Berkeley and its contributors.
        !            45:  * 4. Neither the name of the University nor the names of its contributors
        !            46:  *    may be used to endorse or promote products derived from this software
        !            47:  *    without specific prior written permission.
        !            48:  *
        !            49:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
        !            50:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        !            51:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        !            52:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
        !            53:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        !            54:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
        !            55:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
        !            56:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
        !            57:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
        !            58:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
        !            59:  * SUCH DAMAGE.
        !            60:  *
        !            61:  *     @(#)nfsnode.h   8.9 (Berkeley) 5/14/95
        !            62:  * FreeBSD-Id: nfsnode.h,v 1.24 1997/10/28 14:06:25 bde Exp $
        !            63:  */
        !            64: 
        !            65: 
        !            66: #ifndef _NFS_NFSNODE_H_
        !            67: #define _NFS_NFSNODE_H_
        !            68: 
        !            69: #ifndef _NFS_NFS_H_
        !            70: #include <nfs/nfs.h>
        !            71: #endif
        !            72: 
        !            73: /*
        !            74:  * Silly rename structure that hangs off the nfsnode until the name
        !            75:  * can be removed by nfs_inactive()
        !            76:  */
        !            77: struct sillyrename {
        !            78:        struct  ucred *s_cred;
        !            79:        struct  vnode *s_dvp;
        !            80:        long    s_namlen;
        !            81:        char    s_name[20];
        !            82: };
        !            83: 
        !            84: /*
        !            85:  * This structure is used to save the logical directory offset to
        !            86:  * NFS cookie mappings.
        !            87:  * The mappings are stored in a list headed
        !            88:  * by n_cookies, as required.
        !            89:  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
        !            90:  * stored in increasing logical offset byte order.
        !            91:  */
        !            92: #define NFSNUMCOOKIES          31
        !            93: 
        !            94: struct nfsdmap {
        !            95:        LIST_ENTRY(nfsdmap)     ndm_list;
        !            96:        int                     ndm_eocookie;
        !            97:        nfsuint64               ndm_cookies[NFSNUMCOOKIES];
        !            98: };
        !            99: 
        !           100: /*
        !           101:  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
        !           102:  * is purely coincidental.
        !           103:  * There is a unique nfsnode allocated for each active file,
        !           104:  * each current directory, each mounted-on file, text file, and the root.
        !           105:  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
        !           106:  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
        !           107:  * type definitions), file handles of > 32 bytes should probably be split out
        !           108:  * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
        !           109:  * changing the definition in sys/mount.h of NFS_SMALLFH.)
        !           110:  * NB: Hopefully the current order of the fields is such that everything will
        !           111:  *     be well aligned and, therefore, tightly packed.
        !           112:  */
        !           113: struct nfsnode {
        !           114:        LIST_ENTRY(nfsnode)     n_hash;         /* Hash chain */
        !           115:        CIRCLEQ_ENTRY(nfsnode)  n_timer;        /* Nqnfs timer chain */
        !           116:        u_quad_t                n_size;         /* Current size of file */
        !           117:        u_quad_t                n_brev;         /* Modify rev when cached */
        !           118:        u_quad_t                n_lrev;         /* Modify rev for lease */
        !           119:        struct vattr            n_vattr;        /* Vnode attribute cache */
        !           120:        time_t                  n_attrstamp;    /* Attr. cache timestamp */
        !           121:        time_t                  n_mtime;        /* Prev modify time. */
        !           122:        time_t                  n_ctime;        /* Prev create time. */
        !           123:        time_t                  n_expiry;       /* Lease expiry time */
        !           124:        nfsfh_t                 *n_fhp;         /* NFS File Handle */
        !           125:        struct vnode            *n_vnode;       /* associated vnode */
        !           126:        struct lockf            *n_lockf;       /* Locking record of file */
        !           127:        int                     n_error;        /* Save write error value */
        !           128:        union {
        !           129:                struct timespec nf_atim;        /* Special file times */
        !           130:                nfsuint64       nd_cookieverf;  /* Cookie verifier (dir only) */
        !           131:        } n_un1;
        !           132:        union {
        !           133:                struct timespec nf_mtim;
        !           134:                off_t           nd_direof;      /* Dir. EOF offset cache */
        !           135:        } n_un2;
        !           136:        union {
        !           137:                struct sillyrename *nf_silly;   /* Ptr to silly rename struct */
        !           138:                LIST_HEAD(, nfsdmap) nd_cook;   /* cookies */
        !           139:        } n_un3;
        !           140:        short                   n_fhsize;       /* size in bytes, of fh */
        !           141:        short                   n_flag;         /* Flag for locking.. */
        !           142:        nfsfh_t                 n_fh;           /* Small File Handle */
        !           143: };
        !           144: 
        !           145: #define n_atim         n_un1.nf_atim
        !           146: #define n_mtim         n_un2.nf_mtim
        !           147: #define n_sillyrename  n_un3.nf_silly
        !           148: #define n_cookieverf   n_un1.nd_cookieverf
        !           149: #define n_direofoffset n_un2.nd_direof
        !           150: #define n_cookies      n_un3.nd_cook
        !           151: 
        !           152: /*
        !           153:  * Flags for n_flag
        !           154:  */
        !           155: #define        NFLUSHWANT      0x0001  /* Want wakeup from a flush in prog. */
        !           156: #define        NFLUSHINPROG    0x0002  /* Avoid multiple calls to vinvalbuf() */
        !           157: #define        NMODIFIED       0x0004  /* Might have a modified buffer in bio */
        !           158: #define        NWRITEERR       0x0008  /* Flag write errors so close will know */
        !           159: #define        NQNFSNONCACHE   0x0020  /* Non-cachable lease */
        !           160: #define        NQNFSWRITE      0x0040  /* Write lease */
        !           161: #define        NQNFSEVICTED    0x0080  /* Has been evicted */
        !           162: #define        NACC            0x0100  /* Special file accessed */
        !           163: #define        NUPD            0x0200  /* Special file updated */
        !           164: #define        NCHG            0x0400  /* Special file times changed */
        !           165: #define NLOCKED                0x0800  /* node is locked */
        !           166: #define NWANTED                0x0100  /* someone wants to lock */
        !           167: 
        !           168: /*
        !           169:  * Convert between nfsnode pointers and vnode pointers
        !           170:  */
        !           171: #define VTONFS(vp)     ((struct nfsnode *)(vp)->v_data)
        !           172: #define NFSTOV(np)     ((struct vnode *)(np)->n_vnode)
        !           173: 
        !           174: /*
        !           175:  * Queue head for nfsiod's
        !           176:  */
        !           177: extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
        !           178: extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
        !           179: extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
        !           180: 
        !           181: #if defined(KERNEL) || defined(_KERNEL)
        !           182: typedef int     vop_t __P((void *));
        !           183: extern vop_t   **fifo_nfsv2nodeop_p;
        !           184: extern vop_t   **nfsv2_vnodeop_p;
        !           185: extern vop_t   **spec_nfsv2nodeop_p;
        !           186: 
        !           187: /*
        !           188:  * Prototypes for NFS vnode operations
        !           189:  */
        !           190: int    nfs_getpages __P((struct vop_getpages_args *));
        !           191: int    nfs_write __P((struct vop_write_args *));
        !           192: #define        nfs_lease_check ((int (*) __P((struct  vop_lease_args *)))nullop)
        !           193: #define nqnfs_vop_lease_check  lease_check
        !           194: int    nqnfs_vop_lease_check __P((struct vop_lease_args *));
        !           195: #define nfs_revoke vop_revoke
        !           196: #define nfs_seek ((int (*) __P((struct  vop_seek_args *)))nullop)
        !           197: int    nfs_abortop __P((struct vop_abortop_args *));
        !           198: int    nfs_inactive __P((struct vop_inactive_args *));
        !           199: int    nfs_reclaim __P((struct vop_reclaim_args *));
        !           200: #define nfs_lock ((int (*) __P((struct vop_lock_args *)))vop_nolock)
        !           201: #define nfs_unlock ((int (*) __P((struct vop_unlock_args *)))vop_nounlock)
        !           202: #define nfs_islocked ((int (*) __P((struct vop_islocked_args *)))vop_noislocked)
        !           203: #define nfs_reallocblks \
        !           204:        ((int (*) __P((struct  vop_reallocblks_args *)))eopnotsupp)
        !           205: 
        !           206: /* other stuff */
        !           207: int    nfs_removeit __P((struct sillyrename *));
        !           208: int    nfs_nget __P((struct mount *,nfsfh_t *,int,struct nfsnode **));
        !           209: nfsuint64 *nfs_getcookie __P((struct nfsnode *, off_t, int));
        !           210: void nfs_invaldir __P((struct vnode *));
        !           211: 
        !           212: #define nqnfs_lease_updatetime lease_updatetime
        !           213: 
        !           214: #endif /* KERNEL */
        !           215: 
        !           216: #endif

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.