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