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