fs/nfs/callback.h

   1 /*
   2  * linux/fs/nfs/callback.h
   3  *
   4  * Copyright (C) 2004 Trond Myklebust
   5  *
   6  * NFSv4 callback definitions
   7  */
   8 #ifndef __LINUX_FS_NFS_CALLBACK_H
   9 #define __LINUX_FS_NFS_CALLBACK_H
  10 #include <linux/sunrpc/svc.h>
  11
  12 #define NFS4_CALLBACK 0x40000000
  13 #define NFS4_CALLBACK_XDRSIZE 2048
  14 #define NFS4_CALLBACK_BUFSIZE (1024 + NFS4_CALLBACK_XDRSIZE)
  15
  16 enum nfs4_callback_procnum {
  17         CB_NULL = 0,
  18         CB_COMPOUND = 1,
  19 };
  20
  21 enum nfs4_callback_opnum {
  22         OP_CB_GETATTR = 3,
  23         OP_CB_RECALL  = 4,
  24 /* Callback operations new to NFSv4.1 */
  25         OP_CB_LAYOUTRECALL  = 5,
  26         OP_CB_NOTIFY        = 6,
  27         OP_CB_PUSH_DELEG    = 7,
  28         OP_CB_RECALL_ANY    = 8,
  29         OP_CB_RECALLABLE_OBJ_AVAIL = 9,
  30         OP_CB_RECALL_SLOT   = 10,
  31         OP_CB_SEQUENCE      = 11,
  32         OP_CB_WANTS_CANCELLED = 12,
  33         OP_CB_NOTIFY_LOCK   = 13,
  34         OP_CB_NOTIFY_DEVICEID = 14,
  35         OP_CB_ILLEGAL = 10044,
  36 };
  37
  38 struct cb_process_state {
  39         __be32                  drc_status;
  40         struct nfs_client       *clp;
  41 };
  42
  43 struct cb_compound_hdr_arg {
  44         unsigned int taglen;
  45         const char *tag;
  46         unsigned int minorversion;
  47         unsigned int cb_ident; /* v4.0 callback identifier */
  48         unsigned nops;
  49 };
  50
  51 struct cb_compound_hdr_res {
  52         __be32 *status;
  53         unsigned int taglen;
  54         const char *tag;
  55         __be32 *nops;
  56 };
  57
  58 struct cb_getattrargs {
  59         struct sockaddr *addr;
  60         struct nfs_fh fh;
  61         uint32_t bitmap[2];
  62 };
  63
  64 struct cb_getattrres {
  65         __be32 status;
  66         uint32_t bitmap[2];
  67         uint64_t size;
  68         uint64_t change_attr;
  69         struct timespec ctime;
  70         struct timespec mtime;
  71 };
  72
  73 struct cb_recallargs {
  74         struct sockaddr *addr;
  75         struct nfs_fh fh;
  76         nfs4_stateid stateid;
  77         uint32_t truncate;
  78 };
  79
  80 #if defined(CONFIG_NFS_V4_1)
  81
  82 struct referring_call {
  83         uint32_t                        rc_sequenceid;
  84         uint32_t                        rc_slotid;
  85 };
  86
  87 struct referring_call_list {
  88         struct nfs4_sessionid           rcl_sessionid;
  89         uint32_t                        rcl_nrefcalls;
  90         struct referring_call           *rcl_refcalls;
  91 };
  92
  93 struct cb_sequenceargs {
  94         struct sockaddr                 *csa_addr;
  95         struct nfs4_sessionid           csa_sessionid;
  96         uint32_t                        csa_sequenceid;
  97         uint32_t                        csa_slotid;
  98         uint32_t                        csa_highestslotid;
  99         uint32_t                        csa_cachethis;
 100         uint32_t                        csa_nrclists;
 101         struct referring_call_list      *csa_rclists;
 102 };
 103
 104 struct cb_sequenceres {
 105         __be32                          csr_status;
 106         struct nfs4_sessionid           csr_sessionid;
 107         uint32_t                        csr_sequenceid;
 108         uint32_t                        csr_slotid;
 109         uint32_t                        csr_highestslotid;
 110         uint32_t                        csr_target_highestslotid;
 111 };
 112
 113 extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
 114                                        struct cb_sequenceres *res,
 115                                        struct cb_process_state *cps);
 116
 117 extern int nfs41_validate_delegation_stateid(struct nfs_delegation *delegation,
 118                                              const nfs4_stateid *stateid);
 119
 120 #define RCA4_TYPE_MASK_RDATA_DLG        0
 121 #define RCA4_TYPE_MASK_WDATA_DLG        1
 122 #define RCA4_TYPE_MASK_DIR_DLG         2
 123 #define RCA4_TYPE_MASK_FILE_LAYOUT     3
 124 #define RCA4_TYPE_MASK_BLK_LAYOUT      4
 125 #define RCA4_TYPE_MASK_OBJ_LAYOUT_MIN  8
 126 #define RCA4_TYPE_MASK_OBJ_LAYOUT_MAX  9
 127 #define RCA4_TYPE_MASK_OTHER_LAYOUT_MIN 12
 128 #define RCA4_TYPE_MASK_OTHER_LAYOUT_MAX 15
 129 #define RCA4_TYPE_MASK_ALL 0xf31f
 130
 131 struct cb_recallanyargs {
 132         struct sockaddr *craa_addr;
 133         uint32_t        craa_objs_to_keep;
 134         uint32_t        craa_type_mask;
 135 };
 136
 137 extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args,
 138                                         void *dummy,
 139                                         struct cb_process_state *cps);
 140
 141 struct cb_recallslotargs {
 142         struct sockaddr *crsa_addr;
 143         uint32_t        crsa_target_max_slots;
 144 };
 145 extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args,
 146                                          void *dummy,
 147                                          struct cb_process_state *cps);
 148
 149 struct cb_layoutrecallargs {
 150         struct sockaddr         *cbl_addr;
 151         uint32_t                cbl_recall_type;
 152         uint32_t                cbl_layout_type;
 153         uint32_t                cbl_layoutchanged;
 154         union {
 155                 struct {
 156                         struct nfs_fh           cbl_fh;
 157                         struct pnfs_layout_range cbl_range;
 158                         nfs4_stateid            cbl_stateid;
 159                 };
 160                 struct nfs_fsid         cbl_fsid;
 161         };
 162 };
 163
 164 extern unsigned nfs4_callback_layoutrecall(
 165         struct cb_layoutrecallargs *args,
 166         void *dummy, struct cb_process_state *cps);
 167
 168 extern void nfs4_check_drain_bc_complete(struct nfs4_session *ses);
 169 extern void nfs4_cb_take_slot(struct nfs_client *clp);
 170 #endif /* CONFIG_NFS_V4_1 */
 171 extern int check_gss_callback_principal(struct nfs_client *, struct svc_rqst *);
 172 extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args,
 173                                     struct cb_getattrres *res,
 174                                     struct cb_process_state *cps);
 175 extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
 176                                    struct cb_process_state *cps);
 177 #ifdef CONFIG_NFS_V4
 178 extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
 179 extern void nfs_callback_down(int minorversion);
 180 extern int nfs4_validate_delegation_stateid(struct nfs_delegation *delegation,
 181                                             const nfs4_stateid *stateid);
 182 extern int nfs4_set_callback_sessionid(struct nfs_client *clp);
 183 #endif /* CONFIG_NFS_V4 */
 184 /*
 185  * nfs41: Callbacks are expected to not cause substantial latency,
 186  * so we limit their concurrency to 1 by setting up the maximum number
 187  * of slots for the backchannel.
 188  */
 189 #define NFS41_BC_MIN_CALLBACKS 1
 190 #define NFS41_BC_MAX_CALLBACKS 1
 191
 192 extern unsigned int nfs_callback_set_tcpport;
 193 extern unsigned short nfs_callback_tcpport;
 194 extern unsigned short nfs_callback_tcpport6;
 195
 196 #endif /* __LINUX_FS_NFS_CALLBACK_H */