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