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