usr/src/uts/common/nfs/export.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright 2015 Nexenta Systems, Inc.  All rights reserved.
  24  * Copyright (c) 1989, 2010, Oracle and/or its affiliates. All rights reserved.
  25  */
  26
  27 /*      Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
  28 /*        All Rights Reserved   */
  29
  30 #ifndef _NFS_EXPORT_H
  31 #define _NFS_EXPORT_H
  32
  33 #include <nfs/nfs_sec.h>
  34 #include <nfs/auth.h>
  35 #include <sys/vnode.h>
  36 #include <nfs/nfs4.h>
  37 #include <sys/kiconv.h>
  38 #include <sys/avl.h>
  39
  40 #ifdef  __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /*
  45  * nfs pseudo flavor number is owned by IANA. Need to make sure the
  46  * Solaris specific NFS_FLAVOR_NOMAP number will not overlap with any
  47  * new IANA defined pseudo flavor numbers. The chance for the overlap
  48  * is very small since the growth of new flavor numbers is expected
  49  * to be limited.
  50  */
  51 #define NFS_FLAVOR_NOMAP        999999  /* no nfs flavor mapping */
  52
  53 /*
  54  * As duplicate flavors can be passed into exportfs in the arguments, we
  55  * allocate a cleaned up array with non duplicate flavors on the stack.
  56  * So we need to know how much to allocate.
  57  */
  58 #define MAX_FLAVORS             6       /* none, sys, dh, krb5, krb5i krb5p */
  59
  60 /*
  61  * Note: exported_lock is currently used to ensure the integrity of
  62  * the secinfo fields.
  63  */
  64 struct secinfo {
  65         seconfig_t      s_secinfo;      /* /etc/nfssec.conf entry */
  66         unsigned int    s_flags;        /* flags (see below) */
  67         int32_t         s_refcnt;       /* reference count for tracking */
  68                                         /* how many children (self included) */
  69                                         /* use this flavor. */
  70         int             s_window;       /* window */
  71         uint_t          s_rootid;       /* UID to use for authorized roots */
  72         int             s_rootcnt;      /* count of root names */
  73         caddr_t         *s_rootnames;   /* array of root names */
  74                                         /* they are strings for AUTH_DES and */
  75                                         /* rpc_gss_principal_t for RPCSEC_GSS */
  76 };
  77
  78 #ifdef _SYSCALL32
  79 struct secinfo32 {
  80         seconfig32_t    s_secinfo;      /* /etc/nfssec.conf entry */
  81         uint32_t        s_flags;        /* flags (see below) */
  82         int32_t         s_refcnt;       /* reference count for tracking */
  83                                         /* how many children (self included) */
  84                                         /* use this flavor. */
  85         int32_t         s_window;       /* window */
  86         uint32_t        s_rootid;       /* UID to use for authorized roots */
  87         int32_t         s_rootcnt;      /* count of root names */
  88         caddr32_t       s_rootnames;    /* array of root names */
  89                                         /* they are strings for AUTH_DES and */
  90                                         /* rpc_gss_principal_t for RPCSEC_GSS */
  91 };
  92 #endif /* _SYSCALL32 */
  93
  94 /*
  95  * security negotiation related
  96  */
  97
  98 #define SEC_QUERY       0x01    /* query sec modes */
  99
 100 struct sec_ol {
 101         int             sec_flags;      /* security nego flags */
 102         uint_t          sec_index;      /* index into sec flavor array */
 103 };
 104
 105 /*
 106  * Per-mode flags (secinfo.s_flags)
 107  */
 108 #define M_RO            0x01    /* exported ro to all */
 109 #define M_ROL           0x02    /* exported ro to all listed */
 110 #define M_RW            0x04    /* exported rw to all */
 111 #define M_RWL           0x08    /* exported ro to all listed */
 112 #define M_ROOT          0x10    /* root list is defined */
 113 #define M_4SEC_EXPORTED 0x20    /* this is an explicitly shared flavor */
 114 #define M_NONE          0x40    /* none list is defined */
 115 #define M_MAP           0x80    /* uidmap and/or gidmap is defined */
 116
 117 /* invalid secinfo reference count */
 118 #define SEC_REF_INVALID(p) ((p)->s_refcnt < 1)
 119
 120 /* last secinfo reference */
 121 #define SEC_REF_LAST(p) ((p)->s_refcnt == 1)
 122
 123 /* sec flavor explicitly shared for the exported node */
 124 #define SEC_REF_EXPORTED(p) ((p)->s_flags & M_4SEC_EXPORTED)
 125
 126 /* the only reference count left is for referring itself */
 127 #define SEC_REF_SELF(p) (SEC_REF_LAST(p) && SEC_REF_EXPORTED(p))
 128
 129 /*
 130  * The export information passed to exportfs() (Version 2)
 131  */
 132 #define EX_CURRENT_VERSION 2    /* current version of exportdata struct */
 133
 134 struct exportdata {
 135         int             ex_version;     /* structure version */
 136         char            *ex_path;       /* exported path */
 137         size_t          ex_pathlen;     /* path length */
 138         int             ex_flags;       /* flags */
 139         unsigned int    ex_anon;        /* uid for unauthenticated requests */
 140         int             ex_seccnt;      /* count of security modes */
 141         struct secinfo  *ex_secinfo;    /* security mode info */
 142         char            *ex_index;      /* index file for public filesystem */
 143         char            *ex_log_buffer; /* path to logging buffer file */
 144         size_t          ex_log_bufferlen;       /* buffer file path len */
 145         char            *ex_tag;        /* tag used to identify log config */
 146         size_t          ex_taglen;      /* tag length */
 147 };
 148
 149 #ifdef _SYSCALL32
 150 struct exportdata32 {
 151         int32_t         ex_version;     /* structure version */
 152         caddr32_t       ex_path;        /* exported path */
 153         int32_t         ex_pathlen;     /* path length */
 154         int32_t         ex_flags;       /* flags */
 155         uint32_t        ex_anon;        /* uid for unauthenticated requests */
 156         int32_t         ex_seccnt;      /* count of security modes */
 157         caddr32_t       ex_secinfo;     /* security mode info */
 158         caddr32_t       ex_index;       /* index file for public filesystem */
 159         caddr32_t       ex_log_buffer;  /* path to logging buffer file */
 160         int32_t         ex_log_bufferlen;       /* buffer file path len */
 161         caddr32_t       ex_tag;         /* tag used to identify log config */
 162         int32_t         ex_taglen;      /* tag length */
 163 };
 164 #endif /* _SYSCALL32 */
 165
 166 /*
 167  * exported vfs flags.
 168  */
 169
 170 #define EX_NOSUID       0x01    /* exported with unsetable set[ug]ids */
 171 #define EX_ACLOK        0x02    /* exported with maximal access if acl exists */
 172 #define EX_PUBLIC       0x04    /* exported with public filehandle */
 173 #define EX_NOSUB        0x08    /* no nfs_getfh or MCL below export point */
 174 #define EX_INDEX        0x10    /* exported with index file specified */
 175 #define EX_LOG          0x20    /* logging enabled */
 176 #define EX_LOG_ALLOPS   0x40    /* logging of all RPC operations enabled */
 177                                 /* by default only operations which affect */
 178                                 /* transaction logging are enabled */
 179 #define EX_PSEUDO       0x80    /* pseudo filesystem export */
 180 #ifdef VOLATILE_FH_TEST
 181 #define EX_VOLFH        0x100   /* XXX nfsv4 fh may expire anytime */
 182 #define EX_VOLRNM       0x200   /* XXX nfsv4 fh expire at rename */
 183 #define EX_VOLMIG       0x400   /* XXX nfsv4 fh expire at migration */
 184 #define EX_NOEXPOPEN    0x800   /* XXX nfsv4 fh no expire with open */
 185 #endif /* VOLATILE_FH_TEST */
 186
 187 #define EX_CHARMAP      0x1000  /* NFS may need a character set conversion */
 188 #define EX_NOACLFAB     0x2000  /* If set, NFSv2 and v3 servers doesn't */
 189                                 /* fabricate ACL for VOP_GETSECATTR OTW call */
 190
 191 #ifdef  _KERNEL
 192
 193 #define RPC_IDEMPOTENT  0x1     /* idempotent or not */
 194 /*
 195  * Be very careful about which NFS procedures get the RPC_ALLOWANON bit.
 196  * Right now, if this bit is on, we ignore the results of per NFS request
 197  * access control.
 198  */
 199 #define RPC_ALLOWANON   0x2     /* allow anonymous access */
 200 #define RPC_MAPRESP     0x4     /* use mapped response buffer */
 201 #define RPC_AVOIDWORK   0x8     /* do work avoidance for dups */
 202 #define RPC_PUBLICFH_OK 0x10    /* allow use of public filehandle */
 203
 204 /*
 205  * RPC_ALL is an or of all above bits to be used with "don't care"
 206  * nfsv4 ops. The flags of an nfsv4 request is the bit-AND of the
 207  * per-op flags.
 208  */
 209 #define RPC_ALL (RPC_IDEMPOTENT|RPC_ALLOWANON|RPC_AVOIDWORK|RPC_PUBLICFH_OK)
 210
 211
 212 #ifdef VOLATILE_FH_TEST
 213 struct ex_vol_rename {
 214         nfs_fh4_fmt_t vrn_fh_fmt;
 215         struct ex_vol_rename *vrn_next;
 216 };
 217 #endif /* VOLATILE_FH_TEST */
 218
 219 /*
 220  * An auth cache client entry.  This is the umbrella structure and contains all
 221  * related auth_cache entries in the authc_tree AVL tree.
 222  */
 223 struct auth_cache_clnt {
 224         avl_node_t              authc_link;
 225         struct netbuf           authc_addr;     /* address of the client */
 226         krwlock_t               authc_lock;     /* protects authc_tree */
 227         avl_tree_t              authc_tree;     /* auth_cache entries */
 228 };
 229
 230 /*
 231  * An auth cache entry can exist in 6 states.
 232  *
 233  * A NEW entry was recently allocated and added to the cache.  It does not
 234  * contain the valid auth state yet.
 235  *
 236  * A WAITING entry is one which is actively engaging the user land mountd code
 237  * to authenticate or re-authenticate it.  The auth state might not be valid
 238  * yet.  The other threads should wait on auth_cv until the retrieving thread
 239  * finishes the retrieval and changes the auth cache entry to FRESH, or NEW (in
 240  * a case this entry had no valid auth state yet).
 241  *
 242  * A REFRESHING entry is one which is actively engaging the user land mountd
 243  * code to re-authenticate the cache entry.  There is currently no other thread
 244  * waiting for the results of the refresh.
 245  *
 246  * A FRESH entry is one which is valid (it is either newly retrieved or has
 247  * been refreshed at least once).
 248  *
 249  * A STALE entry is one which has been detected to be too old.  The transition
 250  * from FRESH to STALE prevents multiple threads from submitting refresh
 251  * requests.
 252  *
 253  * An INVALID entry is one which was either STALE or REFRESHING and was deleted
 254  * out of the encapsulating exi.  Since we can't delete it yet, we mark it as
 255  * INVALID, which lets the refresh thread know not to work on it and free it
 256  * instead.
 257  *
 258  * Note that the auth state of the entry is valid, even if the entry is STALE.
 259  * Just as you can eat stale bread, you can consume a stale cache entry. The
 260  * only time the contents change could be during the transition from REFRESHING
 261  * or WAITING to FRESH.
 262  *
 263  * Valid state transitions:
 264  *
 265  *          alloc
 266  *            |
 267  *            v
 268  *         +-----+
 269  *    +--->| NEW |------>free
 270  *    |    +-----+
 271  *    |       |
 272  *    |       v
 273  *    |  +---------+
 274  *    +<-| WAITING |
 275  *    ^  +---------+
 276  *    |       |
 277  *    |       v
 278  *    |       +<--------------------------+<---------------+
 279  *    |       |                           ^                |
 280  *    |       v                           |                |
 281  *    |   +-------+    +-------+    +------------+    +---------+
 282  *    +---| FRESH |--->| STALE |--->| REFRESHING |--->| WAITING |
 283  *        +-------+    +-------+    +------------+    +---------+
 284  *            |            |              |
 285  *            |            v              |
 286  *            v       +---------+         |
 287  *          free<-----| INVALID |<--------+
 288  *                    +---------+
 289  */
 290 typedef enum auth_state {
 291         NFS_AUTH_FRESH,
 292         NFS_AUTH_STALE,
 293         NFS_AUTH_REFRESHING,
 294         NFS_AUTH_INVALID,
 295         NFS_AUTH_NEW,
 296         NFS_AUTH_WAITING
 297 } auth_state_t;
 298
 299 /*
 300  * An authorization cache entry
 301  *
 302  * Either the state in auth_state will protect the
 303  * contents or auth_lock must be held.
 304  */
 305 struct auth_cache {
 306         avl_node_t              auth_link;
 307         struct auth_cache_clnt  *auth_clnt;
 308         int                     auth_flavor;
 309         uid_t                   auth_clnt_uid;
 310         gid_t                   auth_clnt_gid;
 311         uint_t                  auth_clnt_ngids;
 312         gid_t                   *auth_clnt_gids;
 313         uid_t                   auth_srv_uid;
 314         gid_t                   auth_srv_gid;
 315         uint_t                  auth_srv_ngids;
 316         gid_t                   *auth_srv_gids;
 317         int                     auth_access;
 318         time_t                  auth_time;
 319         time_t                  auth_freshness;
 320         auth_state_t            auth_state;
 321         kmutex_t                auth_lock;
 322         kcondvar_t              auth_cv;
 323 };
 324
 325 #define AUTH_TABLESIZE  32
 326
 327 /*
 328  * Structure containing log file meta-data.
 329  */
 330 struct log_file {
 331         unsigned int    lf_flags;       /* flags (see below) */
 332         int             lf_writers;     /* outstanding writers */
 333         int             lf_refcnt;      /* references to this struct */
 334         caddr_t         lf_path;        /* buffer file location */
 335         vnode_t         *lf_vp;         /* vnode for the buffer file */
 336         kmutex_t        lf_lock;
 337         kcondvar_t      lf_cv_waiters;
 338 };
 339
 340 /*
 341  * log_file and log_buffer flags.
 342  */
 343 #define L_WAITING       0x01            /* flush of in-core data to stable */
 344                                         /* storage in progress */
 345 #define L_PRINTED       0x02            /* error message printed to console */
 346 #define L_ERROR         0x04            /* error condition detected */
 347
 348 /*
 349  * The logging buffer information.
 350  * This structure may be shared by multiple exportinfo structures,
 351  * if they share the same buffer file.
 352  * This structure contains the basic information about the buffer, such
 353  * as it's location in the filesystem.
 354  *
 355  * 'lb_lock' protects all the fields in this structure except for 'lb_path',
 356  * and 'lb_next'.
 357  * 'lb_path' is a write-once/read-many field which needs no locking, it is
 358  * set before the structure is linked to any exportinfo structure.
 359  * 'lb_next' is protected by the log_buffer_list_lock.
 360  */
 361 struct log_buffer {
 362         unsigned int    lb_flags;       /* L_ONLIST set? */
 363         int             lb_refcnt;      /* references to this struct */
 364         unsigned int    lb_rec_id;      /* used to generate unique id */
 365         caddr_t         lb_path;        /* buffer file pathname */
 366         struct log_file *lb_logfile;    /* points to log_file structure */
 367         kmutex_t        lb_lock;
 368         struct log_buffer       *lb_next;
 369         kcondvar_t      lb_cv_waiters;
 370         caddr_t         lb_records;     /* linked list of records to write */
 371         int             lb_num_recs;    /* # of records to write */
 372         ssize_t         lb_size_queued; /* number of bytes queued for write */
 373 };
 374
 375 #define LOG_BUFFER_HOLD(lbp)    { \
 376         mutex_enter(&(lbp)->lb_lock); \
 377         (lbp)->lb_refcnt++; \
 378         mutex_exit(&(lbp)->lb_lock); \
 379 }
 380
 381 #define LOG_BUFFER_RELE(lbp)    { \
 382         log_buffer_rele(lbp); \
 383 }
 384
 385 /*
 386  * Structure for character set conversion mapping based on client address.
 387  */
 388 struct charset_cache {
 389         struct charset_cache *next;
 390         kiconv_t        inbound;
 391         kiconv_t        outbound;
 392         struct sockaddr client_addr;
 393 };
 394
 395 /* Forward declarations */
 396 struct exportinfo;
 397 struct exp_visible;
 398 struct svc_req;
 399
 400 /*
 401  * Treenodes are used to build tree representing every node which is part
 402  * of nfs server pseudo namespace. They are connected with both exportinfo
 403  * and exp_visible struct. They were introduced to avoid lookup of ".."
 404  * in the underlying file system during unshare, which was failing if the
 405  * file system was forcibly unmounted or if the directory was removed.
 406  * One exp_visible_t can be shared via several treenode_t, i.e.
 407  * different tree_vis can point to the same exp_visible_t.
 408  * This will happen if some directory is on two different shared paths:
 409  * E.g. after share /tmp/a/b1 and share /tmp/a/b2 there will be two treenodes
 410  * corresponding to /tmp/a and both will have same value in tree_vis.
 411  *
 412  *
 413  *
 414  *     NEW DATA STRUCT         ORIGINAL DATA STRUCT
 415  *
 416  * ns_root +---+               +----------+
 417  *         | / |               |PSEUDO EXP|-->+---+   +---+   +---+
 418  *         +---+---------  ----+----------+   | a |-->| k |-->| b |
 419  *          /\                                +---+   +---+   +---+
 420  *         /  \                                .       .       .
 421  *     +---+...\.........  .....................       .       .
 422  *    *| a |    \              +----------+            .       .
 423  *     +---+-----\-------  ----|REAL EXP a|            .       .
 424  *       /        \            +----------+            .       .
 425  *      /        +===+...  .............................       .
 426  *     /        *| k |         +----------+                    .
 427  *    /          +===+---  ----|REAL EXP k|                    .
 428  *   /                         +----------+                    .
 429  *  +===+................  .....................................
 430  * *| b |                      +----------+
 431  *  +===+----------------  ----|REAL EXP b|-->+---+
 432  *     \                       +----------+   | d |
 433  *     +===+.............  ...................+---+
 434  *     | d |                   +----------+
 435  *     +===+-------------  ----|PSEUDO EXP|-->+---+   +---+
 436  *     /                       +----------+   | e |-->| g |
 437  * +---+.................  ...................+---+   +---+
 438  * | e |                                              .
 439  * +---+                                              .
 440  *    \                                               .
 441  *    +---+..............  ............................
 442  *   *| g |                    +----------+
 443  *    +---+--------------  ----|REAL EXP g|
 444  *                             +----------+
 445  *
 446  *
 447  *
 448  * +===+               +---+                    +---+
 449  * | b |..mountpoint   | e |..directory/file   *| a |..node is shared
 450  * +===+  (VROOT)      +---+                    +---+
 451  *
 452  *
 453  * Bi-directional interconnect:
 454  * treenode_t::tree_exi ---------  exportinfo_t::exi_tree
 455  * One-way direction connection:
 456  * treenode_t::tree_vis .........> exp_visible_t
 457  */
 458 /* Access to treenode_t is under protection of exported_lock RW_LOCK */
 459 typedef struct treenode {
 460         /* support for generic n-ary trees */
 461         struct treenode *tree_parent;
 462         struct treenode *tree_child_first;
 463         struct treenode *tree_sibling; /* next sibling */
 464         /* private, nfs specific part */
 465         struct exportinfo  *tree_exi;
 466         struct exp_visible *tree_vis;
 467 } treenode_t;
 468
 469 /*
 470  * TREE_ROOT checks if the node corresponds to a filesystem root
 471  * TREE_EXPORTED checks if the node is explicitly shared
 472  */
 473
 474 #define TREE_ROOT(t) \
 475         ((t)->tree_exi && (t)->tree_exi->exi_vp->v_flag & VROOT)
 476
 477 #define TREE_EXPORTED(t) \
 478         ((t)->tree_exi && !PSEUDO((t)->tree_exi))
 479
 480 /* Root of nfs pseudo namespace */
 481 extern treenode_t *ns_root;
 482
 483 #define EXPTABLESIZE   256
 484
 485 struct exp_hash {
 486         struct exportinfo       *prev;  /* ptr to the previous exportinfo */
 487         struct exportinfo       *next;  /* ptr to the next exportinfo */
 488         struct exportinfo       **bckt; /* backpointer to the hash bucket */
 489 };
 490
 491 /*
 492  * A node associated with an export entry on the
 493  * list of exported filesystems.
 494  *
 495  * exi_count+exi_lock protects an individual exportinfo from being freed
 496  * when in use.
 497  *
 498  * You must have the writer lock on exported_lock to add/delete an exportinfo
 499  * structure to/from the list.
 500  *
 501  * exi_volatile_dev maps to VSW_VOLATILEDEV.  It means that the
 502  * underlying fs devno can change on each mount.  When set, the server
 503  * should not use va_fsid for a GETATTR(FATTR4_FSID) reply.  It must
 504  * use exi_fsid because it is guaranteed to be persistent.  This isn't
 505  * in any way related to NFS4 volatile filehandles.
 506  *
 507  * The exi_cache_lock protects the exi_cache AVL trees.
 508  */
 509 struct exportinfo {
 510         struct exportdata       exi_export;
 511         fsid_t                  exi_fsid;
 512         struct fid              exi_fid;
 513         struct exp_hash         fid_hash;
 514         struct exp_hash         path_hash;
 515         struct treenode         *exi_tree;
 516         fhandle_t               exi_fh;
 517         krwlock_t               exi_cache_lock;
 518         kmutex_t                exi_lock;
 519         uint_t                  exi_count;
 520         vnode_t                 *exi_vp;
 521         vnode_t                 *exi_dvp;
 522         avl_tree_t              *exi_cache[AUTH_TABLESIZE];
 523         struct log_buffer       *exi_logbuffer;
 524         struct exp_visible      *exi_visible;
 525         struct charset_cache    *exi_charset;
 526         unsigned                exi_volatile_dev:1;
 527         unsigned                exi_moved:1;
 528 #ifdef VOLATILE_FH_TEST
 529         uint32_t                exi_volatile_id;
 530         struct ex_vol_rename    *exi_vol_rename;
 531         kmutex_t                exi_vol_rename_lock;
 532 #endif /* VOLATILE_FH_TEST */
 533         int                     exi_id;
 534         avl_node_t              exi_id_link;
 535         struct exp_kstats       *exi_kstats;
 536 };
 537
 538 typedef struct exportinfo exportinfo_t;
 539 typedef struct exportdata exportdata_t;
 540 typedef struct secinfo secinfo_t;
 541
 542 /*
 543  * exp_visible is a visible list per filesystem. It is for filesystems
 544  * that may need a limited view of its contents. A pseudo export and
 545  * a real export at the mount point (VROOT) which has a subtree shared
 546  * has a visible list.
 547  *
 548  * The exi_visible field is NULL for normal, non=pseudo filesystems
 549  * which do not have any subtree exported. If the field is non-null,
 550  * it points to a list of visible entries, identified by vis_fid and/or
 551  * vis_ino. The presence of a "visible" list means that if this export
 552  * can only have a limited view, it can only view the entries in the
 553  * exp_visible list. The directories in the fid list comprise paths that
 554  * lead to exported directories.
 555  *
 556  * The vis_count field records the number of paths in this filesystem
 557  * that use this directory. The vis_exported field is non-zero if the
 558  * entry is an exported directory (leaf node).
 559  *
 560  * exp_visible itself is not reference counted. Each exp_visible is
 561  * referenced twice:
 562  * 1) from treenode::tree_vis
 563  * 2) linked from exportinfo::exi_visible
 564  * The 'owner' of exp_visible is the exportinfo structure. exp_visible should
 565  * be always freed only from exportinfo_t, never from treenode::tree_vis.
 566  */
 567
 568 struct exp_visible {
 569         vnode_t                 *vis_vp;
 570         fid_t                   vis_fid;
 571         u_longlong_t            vis_ino;
 572         int                     vis_count;
 573         int                     vis_exported;
 574         struct exp_visible      *vis_next;
 575         struct secinfo          *vis_secinfo;
 576         int                     vis_seccnt;
 577 };
 578 typedef struct exp_visible exp_visible_t;
 579
 580 #define PSEUDO(exi)     ((exi)->exi_export.ex_flags & EX_PSEUDO)
 581 #define EXP_LINKED(exi) ((exi)->fid_hash.bckt != NULL)
 582
 583 #define EQFSID(fsidp1, fsidp2)  \
 584         (((fsidp1)->val[0] == (fsidp2)->val[0]) && \
 585             ((fsidp1)->val[1] == (fsidp2)->val[1]))
 586
 587 #define EQFID(fidp1, fidp2)     \
 588         ((fidp1)->fid_len == (fidp2)->fid_len && \
 589             bcmp((char *)(fidp1)->fid_data, (char *)(fidp2)->fid_data, \
 590             (uint_t)(fidp1)->fid_len) == 0)
 591
 592 #define exportmatch(exi, fsid, fid)     \
 593         (EQFSID(&(exi)->exi_fsid, (fsid)) && EQFID(&(exi)->exi_fid, (fid)))
 594
 595 /*
 596  * Returns true iff exported filesystem is read-only to the given host.
 597  *
 598  * Note:  this macro should be as fast as possible since it's called
 599  * on each NFS modification request.
 600  */
 601 #define rdonly(ro, vp)  ((ro) || vn_is_readonly(vp))
 602 #define rdonly4(req, cs)  \
 603         (vn_is_readonly((cs)->vp) || \
 604             (nfsauth4_access((cs)->exi, (cs)->vp, (req), (cs)->basecr, NULL, \
 605             NULL, NULL, NULL) & (NFSAUTH_RO | NFSAUTH_LIMITED)))
 606
 607 extern int      nfsauth4_access(struct exportinfo *, vnode_t *,
 608     struct svc_req *, cred_t *, uid_t *, gid_t *, uint_t *, gid_t **);
 609 extern int      nfsauth4_secinfo_access(struct exportinfo *,
 610     struct svc_req *, int, int, cred_t *);
 611 extern int      nfsauth_cache_clnt_compar(const void *, const void *);
 612 extern int      nfs_fhbcmp(char *, char *, int);
 613 extern int      nfs_exportinit(void);
 614 extern void     nfs_exportfini(void);
 615 extern int      chk_clnt_sec(struct exportinfo *, struct svc_req *);
 616 extern int      makefh(fhandle_t *, struct vnode *, struct exportinfo *);
 617 extern int      makefh_ol(fhandle_t *, struct exportinfo *, uint_t);
 618 extern int      makefh3(nfs_fh3 *, struct vnode *, struct exportinfo *);
 619 extern int      makefh3_ol(nfs_fh3 *, struct exportinfo *, uint_t);
 620 extern vnode_t *nfs_fhtovp(fhandle_t *, struct exportinfo *);
 621 extern vnode_t *nfs3_fhtovp(nfs_fh3 *, struct exportinfo *);
 622 extern struct   exportinfo *checkexport(fsid_t *, struct fid *);
 623 extern struct   exportinfo *checkexport4(fsid_t *, struct fid *, vnode_t *);
 624 extern void     exi_hold(struct exportinfo *);
 625 extern void     exi_rele(struct exportinfo *);
 626 extern struct exportinfo *nfs_vptoexi(vnode_t *, vnode_t *, cred_t *, int *,
 627     int *, bool_t);
 628 extern int      nfs_check_vpexi(vnode_t *, vnode_t *, cred_t *,
 629                         struct exportinfo **);
 630 extern void     export_link(struct exportinfo *);
 631 extern void     export_unlink(struct exportinfo *);
 632 extern vnode_t *untraverse(vnode_t *);
 633 extern int      vn_is_nfs_reparse(vnode_t *, cred_t *);
 634 extern int      client_is_downrev(struct svc_req *);
 635 extern char    *build_symlink(vnode_t *, cred_t *, size_t *);
 636
 637 /*
 638  * Functions that handle the NFSv4 server namespace
 639  */
 640 extern exportinfo_t *vis2exi(treenode_t *);
 641 extern int      treeclimb_export(struct exportinfo *);
 642 extern void     treeclimb_unexport(struct exportinfo *);
 643 extern int      nfs_visible(struct exportinfo *, vnode_t *, int *);
 644 extern int      nfs_visible_inode(struct exportinfo *, ino64_t, int *);
 645 extern int      has_visible(struct exportinfo *, vnode_t *);
 646 extern void     free_visible(struct exp_visible *);
 647 extern int      nfs_exported(struct exportinfo *, vnode_t *);
 648 extern struct exportinfo *pseudo_exportfs(vnode_t *, fid_t *,
 649     struct exp_visible *, struct exportdata *);
 650 extern int      vop_fid_pseudo(vnode_t *, fid_t *);
 651 extern int      nfs4_vget_pseudo(struct exportinfo *, vnode_t **, fid_t *);
 652 /*
 653  * Functions that handle the NFSv4 server namespace security flavors
 654  * information.
 655  */
 656 extern void     srv_secinfo_exp2pseu(struct exportdata *, struct exportdata *);
 657 extern void     srv_secinfo_list_free(struct secinfo *, int);
 658
 659 /*
 660  * "public" and default (root) location for public filehandle
 661  */
 662 extern struct exportinfo *exi_public, *exi_root;
 663 extern fhandle_t nullfh2;       /* for comparing V2 filehandles */
 664 extern krwlock_t exported_lock;
 665 extern struct exportinfo *exptable[];
 666
 667 /*
 668  * exi_id support
 669  */
 670 extern avl_tree_t exi_id_tree;
 671 extern int exi_id_get_next(void);
 672
 673 /*
 674  * Two macros for identifying public filehandles.
 675  * A v2 public filehandle is 32 zero bytes.
 676  * A v3 public filehandle is zero length.
 677  */
 678 #define PUBLIC_FH2(fh) \
 679         ((fh)->fh_fsid.val[1] == 0 && \
 680         bcmp((fh), &nullfh2, sizeof (fhandle_t)) == 0)
 681
 682 #define PUBLIC_FH3(fh) \
 683         ((fh)->fh3_length == 0)
 684
 685 extern int      makefh4(nfs_fh4 *, struct vnode *, struct exportinfo *);
 686 extern vnode_t *nfs4_fhtovp(nfs_fh4 *, struct exportinfo *, nfsstat4 *);
 687
 688 #endif /* _KERNEL */
 689
 690 #ifdef  __cplusplus
 691 }
 692 #endif
 693
 694 #endif  /* _NFS_EXPORT_H */