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