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