fs/nfs/nfs4_fs.h

   1 /*
   2  * linux/fs/nfs/nfs4_fs.h
   3  *
   4  * Copyright (C) 2005 Trond Myklebust
   5  *
   6  * NFSv4-specific filesystem definitions and declarations
   7  */
   8
   9 #ifndef __LINUX_FS_NFS_NFS4_FS_H
  10 #define __LINUX_FS_NFS_NFS4_FS_H
  11
  12 #ifdef CONFIG_NFS_V4
  13
  14 struct idmap;
  15
  16 /*
  17  * In a seqid-mutating op, this macro controls which error return
  18  * values trigger incrementation of the seqid.
  19  *
  20  * from rfc 3010:
  21  * The client MUST monotonically increment the sequence number for the
  22  * CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE
  23  * operations.  This is true even in the event that the previous
  24  * operation that used the sequence number received an error.  The only
  25  * exception to this rule is if the previous operation received one of
  26  * the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID,
  27  * NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR,
  28  * NFSERR_RESOURCE, NFSERR_NOFILEHANDLE.
  29  *
  30  */
  31 #define seqid_mutating_err(err)       \
  32 (((err) != NFSERR_STALE_CLIENTID) &&  \
  33  ((err) != NFSERR_STALE_STATEID)  &&  \
  34  ((err) != NFSERR_BAD_STATEID)    &&  \
  35  ((err) != NFSERR_BAD_SEQID)      &&  \
  36  ((err) != NFSERR_BAD_XDR)        &&  \
  37  ((err) != NFSERR_RESOURCE)       &&  \
  38  ((err) != NFSERR_NOFILEHANDLE))
  39
  40 enum nfs4_client_state {
  41         NFS4CLNT_MANAGER_RUNNING  = 0,
  42         NFS4CLNT_CHECK_LEASE,
  43         NFS4CLNT_LEASE_EXPIRED,
  44         NFS4CLNT_RECLAIM_REBOOT,
  45         NFS4CLNT_RECLAIM_NOGRACE,
  46         NFS4CLNT_DELEGRETURN,
  47         NFS4CLNT_LAYOUTRECALL,
  48         NFS4CLNT_SESSION_RESET,
  49         NFS4CLNT_RECALL_SLOT,
  50         NFS4CLNT_LEASE_CONFIRM,
  51         NFS4CLNT_SERVER_SCOPE_MISMATCH,
  52 };
  53
  54 enum nfs4_session_state {
  55         NFS4_SESSION_INITING,
  56         NFS4_SESSION_DRAINING,
  57 };
  58
  59 struct nfs4_minor_version_ops {
  60         u32     minor_version;
  61
  62         int     (*call_sync)(struct rpc_clnt *clnt,
  63                         struct nfs_server *server,
  64                         struct rpc_message *msg,
  65                         struct nfs4_sequence_args *args,
  66                         struct nfs4_sequence_res *res,
  67                         int cache_reply);
  68         int     (*validate_stateid)(struct nfs_delegation *,
  69                         const nfs4_stateid *);
  70         int     (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
  71                         struct nfs_fsinfo *);
  72         const struct nfs4_state_recovery_ops *reboot_recovery_ops;
  73         const struct nfs4_state_recovery_ops *nograce_recovery_ops;
  74         const struct nfs4_state_maintenance_ops *state_renewal_ops;
  75 };
  76
  77 /*
  78  * struct rpc_sequence ensures that RPC calls are sent in the exact
  79  * order that they appear on the list.
  80  */
  81 struct rpc_sequence {
  82         struct rpc_wait_queue   wait;   /* RPC call delay queue */
  83         spinlock_t lock;                /* Protects the list */
  84         struct list_head list;          /* Defines sequence of RPC calls */
  85 };
  86
  87 #define NFS_SEQID_CONFIRMED 1
  88 struct nfs_seqid_counter {
  89         struct rpc_sequence *sequence;
  90         int flags;
  91         u32 counter;
  92 };
  93
  94 struct nfs_seqid {
  95         struct nfs_seqid_counter *sequence;
  96         struct list_head list;
  97 };
  98
  99 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
 100 {
 101         if (seqid_mutating_err(-status))
 102                 seqid->flags |= NFS_SEQID_CONFIRMED;
 103 }
 104
 105 struct nfs_unique_id {
 106         struct rb_node rb_node;
 107         __u64 id;
 108 };
 109
 110 /*
 111  * NFS4 state_owners and lock_owners are simply labels for ordered
 112  * sequences of RPC calls. Their sole purpose is to provide once-only
 113  * semantics by allowing the server to identify replayed requests.
 114  */
 115 struct nfs4_state_owner {
 116         struct nfs_unique_id so_owner_id;
 117         struct nfs_server    *so_server;
 118         struct rb_node       so_server_node;
 119
 120         struct rpc_cred      *so_cred;   /* Associated cred */
 121
 122         spinlock_t           so_lock;
 123         atomic_t             so_count;
 124         unsigned long        so_flags;
 125         struct list_head     so_states;
 126         struct nfs_seqid_counter so_seqid;
 127         struct rpc_sequence  so_sequence;
 128 };
 129
 130 enum {
 131         NFS_OWNER_RECLAIM_REBOOT,
 132         NFS_OWNER_RECLAIM_NOGRACE
 133 };
 134
 135 #define NFS_LOCK_NEW            0
 136 #define NFS_LOCK_RECLAIM        1
 137 #define NFS_LOCK_EXPIRED        2
 138
 139 /*
 140  * struct nfs4_state maintains the client-side state for a given
 141  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 142  *
 143  * OPEN:
 144  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 145  * we need to know how many files are open for reading or writing on a
 146  * given inode. This information too is stored here.
 147  *
 148  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 149  */
 150
 151 struct nfs4_lock_owner {
 152         unsigned int lo_type;
 153 #define NFS4_ANY_LOCK_TYPE      (0U)
 154 #define NFS4_FLOCK_LOCK_TYPE    (1U << 0)
 155 #define NFS4_POSIX_LOCK_TYPE    (1U << 1)
 156         union {
 157                 fl_owner_t posix_owner;
 158                 pid_t flock_owner;
 159         } lo_u;
 160 };
 161
 162 struct nfs4_lock_state {
 163         struct list_head        ls_locks;       /* Other lock stateids */
 164         struct nfs4_state *     ls_state;       /* Pointer to open state */
 165 #define NFS_LOCK_INITIALIZED 1
 166         int                     ls_flags;
 167         struct nfs_seqid_counter        ls_seqid;
 168         struct rpc_sequence     ls_sequence;
 169         struct nfs_unique_id    ls_id;
 170         nfs4_stateid            ls_stateid;
 171         atomic_t                ls_count;
 172         struct nfs4_lock_owner  ls_owner;
 173 };
 174
 175 /* bits for nfs4_state->flags */
 176 enum {
 177         LK_STATE_IN_USE,
 178         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
 179         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
 180         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
 181         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
 182         NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
 183         NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
 184         NFS_STATE_POSIX_LOCKS,          /* Posix locks are supported */
 185 };
 186
 187 struct nfs4_state {
 188         struct list_head open_states;   /* List of states for the same state_owner */
 189         struct list_head inode_states;  /* List of states for the same inode */
 190         struct list_head lock_states;   /* List of subservient lock stateids */
 191
 192         struct nfs4_state_owner *owner; /* Pointer to the open owner */
 193         struct inode *inode;            /* Pointer to the inode */
 194
 195         unsigned long flags;            /* Do we hold any locks? */
 196         spinlock_t state_lock;          /* Protects the lock_states list */
 197
 198         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
 199         nfs4_stateid stateid;           /* Current stateid: may be delegation */
 200         nfs4_stateid open_stateid;      /* OPEN stateid */
 201
 202         /* The following 3 fields are protected by owner->so_lock */
 203         unsigned int n_rdonly;          /* Number of read-only references */
 204         unsigned int n_wronly;          /* Number of write-only references */
 205         unsigned int n_rdwr;            /* Number of read/write references */
 206         fmode_t state;                  /* State on the server (R,W, or RW) */
 207         atomic_t count;
 208 };
 209
 210
 211 struct nfs4_exception {
 212         long timeout;
 213         int retry;
 214         struct nfs4_state *state;
 215 };
 216
 217 struct nfs4_state_recovery_ops {
 218         int owner_flag_bit;
 219         int state_flag_bit;
 220         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
 221         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
 222         int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
 223         struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
 224         int (*reclaim_complete)(struct nfs_client *);
 225 };
 226
 227 struct nfs4_state_maintenance_ops {
 228         int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *);
 229         struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
 230         int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
 231 };
 232
 233 extern const struct dentry_operations nfs4_dentry_operations;
 234 extern const struct inode_operations nfs4_dir_inode_operations;
 235
 236 /* nfs4proc.c */
 237 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
 238 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
 239 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
 240 extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
 241 extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
 242 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
 243 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
 244 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait, bool roc);
 245 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
 246 extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
 247                 struct nfs4_fs_locations *fs_locations, struct page *page);
 248 extern void nfs4_release_lockowner(const struct nfs4_lock_state *);
 249 extern const struct xattr_handler *nfs4_xattr_handlers[];
 250
 251 #if defined(CONFIG_NFS_V4_1)
 252 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 253 {
 254         return server->nfs_client->cl_session;
 255 }
 256
 257 extern int nfs4_setup_sequence(const struct nfs_server *server,
 258                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 259                 int cache_reply, struct rpc_task *task);
 260 extern int nfs41_setup_sequence(struct nfs4_session *session,
 261                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 262                 int cache_reply, struct rpc_task *task);
 263 extern void nfs4_destroy_session(struct nfs4_session *session);
 264 extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
 265 extern int nfs4_proc_create_session(struct nfs_client *);
 266 extern int nfs4_proc_destroy_session(struct nfs4_session *);
 267 extern int nfs4_init_session(struct nfs_server *server);
 268 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
 269                 struct nfs_fsinfo *fsinfo);
 270 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
 271                                   bool sync);
 272
 273 static inline bool
 274 is_ds_only_client(struct nfs_client *clp)
 275 {
 276         return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
 277                 EXCHGID4_FLAG_USE_PNFS_DS;
 278 }
 279
 280 static inline bool
 281 is_ds_client(struct nfs_client *clp)
 282 {
 283         return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
 284 }
 285 #else /* CONFIG_NFS_v4_1 */
 286 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 287 {
 288         return NULL;
 289 }
 290
 291 static inline int nfs4_setup_sequence(const struct nfs_server *server,
 292                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 293                 int cache_reply, struct rpc_task *task)
 294 {
 295         return 0;
 296 }
 297
 298 static inline int nfs4_init_session(struct nfs_server *server)
 299 {
 300         return 0;
 301 }
 302
 303 static inline bool
 304 is_ds_only_client(struct nfs_client *clp)
 305 {
 306         return false;
 307 }
 308
 309 static inline bool
 310 is_ds_client(struct nfs_client *clp)
 311 {
 312         return false;
 313 }
 314 #endif /* CONFIG_NFS_V4_1 */
 315
 316 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
 317
 318 extern const u32 nfs4_fattr_bitmap[2];
 319 extern const u32 nfs4_statfs_bitmap[2];
 320 extern const u32 nfs4_pathconf_bitmap[2];
 321 extern const u32 nfs4_fsinfo_bitmap[3];
 322 extern const u32 nfs4_fs_locations_bitmap[2];
 323
 324 /* nfs4renewd.c */
 325 extern void nfs4_schedule_state_renewal(struct nfs_client *);
 326 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
 327 extern void nfs4_kill_renewd(struct nfs_client *);
 328 extern void nfs4_renew_state(struct work_struct *);
 329
 330 /* nfs4state.c */
 331 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
 332 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
 333 #if defined(CONFIG_NFS_V4_1)
 334 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
 335 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
 336 extern void nfs4_schedule_session_recovery(struct nfs4_session *);
 337 #else
 338 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session)
 339 {
 340 }
 341 #endif /* CONFIG_NFS_V4_1 */
 342
 343 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
 344 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
 345 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
 346 extern void nfs4_put_open_state(struct nfs4_state *);
 347 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
 348 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
 349 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
 350 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
 351 extern void nfs4_schedule_state_manager(struct nfs_client *);
 352 extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
 353 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
 354 extern void nfs41_handle_recall_slot(struct nfs_client *clp);
 355 extern void nfs41_handle_server_scope(struct nfs_client *,
 356                                       struct server_scope **);
 357 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
 358 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
 359 extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t, pid_t);
 360
 361 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
 362 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
 363 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
 364 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
 365 extern void nfs_release_seqid(struct nfs_seqid *seqid);
 366 extern void nfs_free_seqid(struct nfs_seqid *seqid);
 367
 368 extern const nfs4_stateid zero_stateid;
 369
 370 /* nfs4xdr.c */
 371 extern struct rpc_procinfo nfs4_procedures[];
 372
 373 struct nfs4_mount_data;
 374
 375 /* callback_xdr.c */
 376 extern struct svc_version nfs4_callback_version1;
 377 extern struct svc_version nfs4_callback_version4;
 378
 379 #else
 380
 381 #define nfs4_close_state(a, b) do { } while (0)
 382 #define nfs4_close_sync(a, b) do { } while (0)
 383
 384 #endif /* CONFIG_NFS_V4 */
 385 #endif /* __LINUX_FS_NFS_NFS4_FS.H */