Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
| 11 | #define NFS4_CALLBACK 0x40000000 |
| 12 | #define NFS4_CALLBACK_XDRSIZE 2048 |
| 13 | #define NFS4_CALLBACK_BUFSIZE (1024 + NFS4_CALLBACK_XDRSIZE) |
| 14 | |
| 15 | enum nfs4_callback_procnum { |
| 16 | CB_NULL = 0, |
| 17 | CB_COMPOUND = 1, |
| 18 | }; |
| 19 | |
| 20 | enum nfs4_callback_opnum { |
| 21 | OP_CB_GETATTR = 3, |
| 22 | OP_CB_RECALL = 4, |
Benny Halevy | 45377b9 | 2009-04-01 09:23:21 -0400 | [diff] [blame] | 23 | /* Callback operations new to NFSv4.1 */ |
| 24 | OP_CB_LAYOUTRECALL = 5, |
| 25 | OP_CB_NOTIFY = 6, |
| 26 | OP_CB_PUSH_DELEG = 7, |
| 27 | OP_CB_RECALL_ANY = 8, |
| 28 | OP_CB_RECALLABLE_OBJ_AVAIL = 9, |
| 29 | OP_CB_RECALL_SLOT = 10, |
| 30 | OP_CB_SEQUENCE = 11, |
| 31 | OP_CB_WANTS_CANCELLED = 12, |
| 32 | OP_CB_NOTIFY_LOCK = 13, |
Benny Halevy | 34bc47c9 | 2009-04-01 09:23:22 -0400 | [diff] [blame] | 33 | OP_CB_NOTIFY_DEVICEID = 14, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 | OP_CB_ILLEGAL = 10044, |
| 35 | }; |
| 36 | |
Andy Adamson | c36fca5 | 2011-01-06 02:04:32 +0000 | [diff] [blame] | 37 | struct cb_process_state { |
| 38 | __be32 drc_status; |
| 39 | struct nfs_client *clp; |
| 40 | struct nfs4_sessionid *svc_sid; /* v4.1 callback service sessionid */ |
| 41 | }; |
| 42 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 43 | struct cb_compound_hdr_arg { |
Trond Myklebust | 2e42c3e | 2007-05-14 17:20:41 -0400 | [diff] [blame] | 44 | unsigned int taglen; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | const char *tag; |
Benny Halevy | b8f2ef8 | 2009-04-01 09:23:19 -0400 | [diff] [blame] | 46 | unsigned int minorversion; |
Andy Adamson | c36fca5 | 2011-01-06 02:04:32 +0000 | [diff] [blame] | 47 | unsigned int cb_ident; /* v4.0 callback identifier */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | unsigned nops; |
| 49 | }; |
| 50 | |
| 51 | struct cb_compound_hdr_res { |
Al Viro | 5704fde | 2006-10-19 23:28:51 -0700 | [diff] [blame] | 52 | __be32 *status; |
Trond Myklebust | 2e42c3e | 2007-05-14 17:20:41 -0400 | [diff] [blame] | 53 | unsigned int taglen; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 54 | const char *tag; |
Al Viro | 5704fde | 2006-10-19 23:28:51 -0700 | [diff] [blame] | 55 | __be32 *nops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | }; |
| 57 | |
| 58 | struct cb_getattrargs { |
Chuck Lever | 671beed | 2007-12-10 14:58:22 -0500 | [diff] [blame] | 59 | struct sockaddr *addr; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | struct nfs_fh fh; |
| 61 | uint32_t bitmap[2]; |
| 62 | }; |
| 63 | |
| 64 | struct cb_getattrres { |
Al Viro | e6f684f | 2006-10-19 23:28:50 -0700 | [diff] [blame] | 65 | __be32 status; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 { |
Chuck Lever | c1d3586 | 2007-12-10 14:58:29 -0500 | [diff] [blame] | 74 | struct sockaddr *addr; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | struct nfs_fh fh; |
| 76 | nfs4_stateid stateid; |
| 77 | uint32_t truncate; |
| 78 | }; |
| 79 | |
Benny Halevy | 2d9b9ec | 2009-04-01 09:23:24 -0400 | [diff] [blame] | 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 { |
Ricardo Labiaga | 65fc64e | 2009-04-01 09:23:30 -0400 | [diff] [blame] | 94 | struct sockaddr *csa_addr; |
Benny Halevy | 2d9b9ec | 2009-04-01 09:23:24 -0400 | [diff] [blame] | 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 { |
Ricardo Labiaga | 65fc64e | 2009-04-01 09:23:30 -0400 | [diff] [blame] | 105 | __be32 csr_status; |
Benny Halevy | 2d9b9ec | 2009-04-01 09:23:24 -0400 | [diff] [blame] | 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 | |
Andy Adamson | c36fca5 | 2011-01-06 02:04:32 +0000 | [diff] [blame] | 113 | extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args, |
| 114 | struct cb_sequenceres *res, |
| 115 | struct cb_process_state *cps); |
Benny Halevy | d49433e | 2009-04-01 09:23:25 -0400 | [diff] [blame] | 116 | |
Alexandros Batsakis | 2597641 | 2009-12-05 13:48:55 -0500 | [diff] [blame] | 117 | extern int nfs41_validate_delegation_stateid(struct nfs_delegation *delegation, |
| 118 | const nfs4_stateid *stateid); |
Alexandros Batsakis | 31f0960 | 2009-12-05 13:27:02 -0500 | [diff] [blame] | 119 | |
| 120 | #define RCA4_TYPE_MASK_RDATA_DLG 0 |
| 121 | #define RCA4_TYPE_MASK_WDATA_DLG 1 |
| 122 | |
| 123 | struct cb_recallanyargs { |
| 124 | struct sockaddr *craa_addr; |
| 125 | uint32_t craa_objs_to_keep; |
| 126 | uint32_t craa_type_mask; |
| 127 | }; |
| 128 | |
Andy Adamson | c36fca5 | 2011-01-06 02:04:32 +0000 | [diff] [blame] | 129 | extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args, |
| 130 | void *dummy, |
| 131 | struct cb_process_state *cps); |
Andy Adamson | b9efa1b | 2010-01-20 16:06:27 -0500 | [diff] [blame] | 132 | |
| 133 | struct cb_recallslotargs { |
| 134 | struct sockaddr *crsa_addr; |
| 135 | uint32_t crsa_target_max_slots; |
| 136 | }; |
Andy Adamson | c36fca5 | 2011-01-06 02:04:32 +0000 | [diff] [blame] | 137 | extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args, |
| 138 | void *dummy, |
| 139 | struct cb_process_state *cps); |
Andy Adamson | b9efa1b | 2010-01-20 16:06:27 -0500 | [diff] [blame] | 140 | |
Benny Halevy | 2d9b9ec | 2009-04-01 09:23:24 -0400 | [diff] [blame] | 141 | #endif /* CONFIG_NFS_V4_1 */ |
| 142 | |
Andy Adamson | c36fca5 | 2011-01-06 02:04:32 +0000 | [diff] [blame] | 143 | extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args, |
| 144 | struct cb_getattrres *res, |
| 145 | struct cb_process_state *cps); |
| 146 | extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy, |
| 147 | struct cb_process_state *cps); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 148 | |
David Howells | 5ae1fbc | 2006-08-22 20:06:08 -0400 | [diff] [blame] | 149 | #ifdef CONFIG_NFS_V4 |
Benny Halevy | 7146851 | 2009-04-01 09:22:56 -0400 | [diff] [blame] | 150 | extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt); |
Andy Adamson | e82dc22 | 2009-04-01 09:23:14 -0400 | [diff] [blame] | 151 | extern void nfs_callback_down(int minorversion); |
Alexandros Batsakis | 2597641 | 2009-12-05 13:48:55 -0500 | [diff] [blame] | 152 | extern int nfs4_validate_delegation_stateid(struct nfs_delegation *delegation, |
| 153 | const nfs4_stateid *stateid); |
Andy Adamson | 2c2618c | 2011-01-06 02:04:31 +0000 | [diff] [blame] | 154 | extern int nfs4_set_callback_sessionid(struct nfs_client *clp); |
Andy Adamson | e82dc22 | 2009-04-01 09:23:14 -0400 | [diff] [blame] | 155 | #endif /* CONFIG_NFS_V4 */ |
Ricardo Labiaga | a43cde9 | 2009-04-01 09:23:08 -0400 | [diff] [blame] | 156 | /* |
| 157 | * nfs41: Callbacks are expected to not cause substantial latency, |
| 158 | * so we limit their concurrency to 1 by setting up the maximum number |
| 159 | * of slots for the backchannel. |
| 160 | */ |
| 161 | #define NFS41_BC_MIN_CALLBACKS 1 |
Benny Halevy | d49433e | 2009-04-01 09:23:25 -0400 | [diff] [blame] | 162 | #define NFS41_BC_MAX_CALLBACKS 1 |
Ricardo Labiaga | a43cde9 | 2009-04-01 09:23:08 -0400 | [diff] [blame] | 163 | |
Trond Myklebust | a72b442 | 2006-01-03 09:55:41 +0100 | [diff] [blame] | 164 | extern unsigned int nfs_callback_set_tcpport; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | extern unsigned short nfs_callback_tcpport; |
Chuck Lever | f738f51 | 2009-03-18 20:48:06 -0400 | [diff] [blame] | 166 | extern unsigned short nfs_callback_tcpport6; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 167 | |
| 168 | #endif /* __LINUX_FS_NFS_CALLBACK_H */ |