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 u32 slotid; 42 u32 minorversion; 43 struct net *net; 44 }; 45 46 struct cb_compound_hdr_arg { 47 unsigned int taglen; 48 const char *tag; 49 unsigned int minorversion; 50 unsigned int cb_ident; /* v4.0 callback identifier */ 51 unsigned nops; 52 }; 53 54 struct cb_compound_hdr_res { 55 __be32 *status; 56 unsigned int taglen; 57 const char *tag; 58 __be32 *nops; 59 }; 60 61 struct cb_getattrargs { 62 struct sockaddr *addr; 63 struct nfs_fh fh; 64 uint32_t bitmap[2]; 65 }; 66 67 struct cb_getattrres { 68 __be32 status; 69 uint32_t bitmap[2]; 70 uint64_t size; 71 uint64_t change_attr; 72 struct timespec ctime; 73 struct timespec mtime; 74 }; 75 76 struct cb_recallargs { 77 struct sockaddr *addr; 78 struct nfs_fh fh; 79 nfs4_stateid stateid; 80 uint32_t truncate; 81 }; 82 83 #if defined(CONFIG_NFS_V4_1) 84 85 struct referring_call { 86 uint32_t rc_sequenceid; 87 uint32_t rc_slotid; 88 }; 89 90 struct referring_call_list { 91 struct nfs4_sessionid rcl_sessionid; 92 uint32_t rcl_nrefcalls; 93 struct referring_call *rcl_refcalls; 94 }; 95 96 struct cb_sequenceargs { 97 struct sockaddr *csa_addr; 98 struct nfs4_sessionid csa_sessionid; 99 uint32_t csa_sequenceid; 100 uint32_t csa_slotid; 101 uint32_t csa_highestslotid; 102 uint32_t csa_cachethis; 103 uint32_t csa_nrclists; 104 struct referring_call_list *csa_rclists; 105 }; 106 107 struct cb_sequenceres { 108 __be32 csr_status; 109 struct nfs4_sessionid csr_sessionid; 110 uint32_t csr_sequenceid; 111 uint32_t csr_slotid; 112 uint32_t csr_highestslotid; 113 uint32_t csr_target_highestslotid; 114 }; 115 116 extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args, 117 struct cb_sequenceres *res, 118 struct cb_process_state *cps); 119 120 extern int nfs41_validate_delegation_stateid(struct nfs_delegation *delegation, 121 const nfs4_stateid *stateid); 122 123 #define RCA4_TYPE_MASK_RDATA_DLG 0 124 #define RCA4_TYPE_MASK_WDATA_DLG 1 125 #define RCA4_TYPE_MASK_DIR_DLG 2 126 #define RCA4_TYPE_MASK_FILE_LAYOUT 3 127 #define RCA4_TYPE_MASK_BLK_LAYOUT 4 128 #define RCA4_TYPE_MASK_OBJ_LAYOUT_MIN 8 129 #define RCA4_TYPE_MASK_OBJ_LAYOUT_MAX 9 130 #define RCA4_TYPE_MASK_OTHER_LAYOUT_MIN 12 131 #define RCA4_TYPE_MASK_OTHER_LAYOUT_MAX 15 132 #define RCA4_TYPE_MASK_ALL 0xf31f 133 134 struct cb_recallanyargs { 135 struct sockaddr *craa_addr; 136 uint32_t craa_objs_to_keep; 137 uint32_t craa_type_mask; 138 }; 139 140 extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args, 141 void *dummy, 142 struct cb_process_state *cps); 143 144 struct cb_recallslotargs { 145 struct sockaddr *crsa_addr; 146 uint32_t crsa_target_highest_slotid; 147 }; 148 extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args, 149 void *dummy, 150 struct cb_process_state *cps); 151 152 struct cb_layoutrecallargs { 153 struct sockaddr *cbl_addr; 154 uint32_t cbl_recall_type; 155 uint32_t cbl_layout_type; 156 uint32_t cbl_layoutchanged; 157 union { 158 struct { 159 struct nfs_fh cbl_fh; 160 struct pnfs_layout_range cbl_range; 161 nfs4_stateid cbl_stateid; 162 }; 163 struct nfs_fsid cbl_fsid; 164 }; 165 }; 166 167 extern __be32 nfs4_callback_layoutrecall( 168 struct cb_layoutrecallargs *args, 169 void *dummy, struct cb_process_state *cps); 170 171 struct cb_devicenotifyitem { 172 uint32_t cbd_notify_type; 173 uint32_t cbd_layout_type; 174 struct nfs4_deviceid cbd_dev_id; 175 uint32_t cbd_immediate; 176 }; 177 178 struct cb_devicenotifyargs { 179 int ndevs; 180 struct cb_devicenotifyitem *devs; 181 }; 182 183 extern __be32 nfs4_callback_devicenotify( 184 struct cb_devicenotifyargs *args, 185 void *dummy, struct cb_process_state *cps); 186 187 #endif /* CONFIG_NFS_V4_1 */ 188 extern int check_gss_callback_principal(struct nfs_client *, struct svc_rqst *); 189 extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args, 190 struct cb_getattrres *res, 191 struct cb_process_state *cps); 192 extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy, 193 struct cb_process_state *cps); 194 #if IS_ENABLED(CONFIG_NFS_V4) 195 extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt); 196 extern void nfs_callback_down(int minorversion, struct net *net); 197 extern int nfs4_validate_delegation_stateid(struct nfs_delegation *delegation, 198 const nfs4_stateid *stateid); 199 extern int nfs4_set_callback_sessionid(struct nfs_client *clp); 200 #endif /* CONFIG_NFS_V4 */ 201 /* 202 * nfs41: Callbacks are expected to not cause substantial latency, 203 * so we limit their concurrency to 1 by setting up the maximum number 204 * of slots for the backchannel. 205 */ 206 #define NFS41_BC_MIN_CALLBACKS 1 207 #define NFS41_BC_MAX_CALLBACKS 1 208 209 extern unsigned int nfs_callback_set_tcpport; 210 extern unsigned short nfs_callback_tcpport; 211 212 #endif /* __LINUX_FS_NFS_CALLBACK_H */ 213