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