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