blob: 5fe1cecbf9f033ce0603639e771c1d82520599b0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Andy Adamson778be232011-01-25 15:38:01 +000010#include <linux/sunrpc/svc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
12#define NFS4_CALLBACK 0x40000000
13#define NFS4_CALLBACK_XDRSIZE 2048
14#define NFS4_CALLBACK_BUFSIZE (1024 + NFS4_CALLBACK_XDRSIZE)
15
16enum nfs4_callback_procnum {
17 CB_NULL = 0,
18 CB_COMPOUND = 1,
19};
20
21enum nfs4_callback_opnum {
22 OP_CB_GETATTR = 3,
23 OP_CB_RECALL = 4,
Benny Halevy45377b92009-04-01 09:23:21 -040024/* 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,
Benny Halevy34bc47c92009-04-01 09:23:22 -040034 OP_CB_NOTIFY_DEVICEID = 14,
Bryan Schumaker6b140b82013-06-05 11:15:02 -040035/* Callback operations new to NFSv4.2 */
36 OP_CB_OFFLOAD = 15,
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 OP_CB_ILLEGAL = 10044,
38};
39
Trond Myklebust810d82e2016-01-23 15:18:18 -050040struct nfs4_slot;
Andy Adamsonc36fca52011-01-06 02:04:32 +000041struct cb_process_state {
42 __be32 drc_status;
43 struct nfs_client *clp;
Trond Myklebust810d82e2016-01-23 15:18:18 -050044 struct nfs4_slot *slot;
Bryan Schumaker459de2e2013-06-05 11:15:01 -040045 u32 minorversion;
Stanislav Kinsburskyc7add9a2012-01-26 15:11:49 +040046 struct net *net;
Andy Adamsonc36fca52011-01-06 02:04:32 +000047};
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049struct cb_compound_hdr_arg {
Trond Myklebust2e42c3e2007-05-14 17:20:41 -040050 unsigned int taglen;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 const char *tag;
Benny Halevyb8f2ef82009-04-01 09:23:19 -040052 unsigned int minorversion;
Andy Adamsonc36fca52011-01-06 02:04:32 +000053 unsigned int cb_ident; /* v4.0 callback identifier */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 unsigned nops;
55};
56
57struct cb_compound_hdr_res {
Al Viro5704fde2006-10-19 23:28:51 -070058 __be32 *status;
Trond Myklebust2e42c3e2007-05-14 17:20:41 -040059 unsigned int taglen;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 const char *tag;
Al Viro5704fde2006-10-19 23:28:51 -070061 __be32 *nops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062};
63
64struct cb_getattrargs {
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 struct nfs_fh fh;
66 uint32_t bitmap[2];
67};
68
69struct cb_getattrres {
Al Viroe6f684f2006-10-19 23:28:50 -070070 __be32 status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 uint32_t bitmap[2];
72 uint64_t size;
73 uint64_t change_attr;
74 struct timespec ctime;
75 struct timespec mtime;
76};
77
78struct cb_recallargs {
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 struct nfs_fh fh;
80 nfs4_stateid stateid;
81 uint32_t truncate;
82};
83
Benny Halevy2d9b9ec2009-04-01 09:23:24 -040084#if defined(CONFIG_NFS_V4_1)
85
86struct referring_call {
87 uint32_t rc_sequenceid;
88 uint32_t rc_slotid;
89};
90
91struct referring_call_list {
92 struct nfs4_sessionid rcl_sessionid;
93 uint32_t rcl_nrefcalls;
94 struct referring_call *rcl_refcalls;
95};
96
97struct cb_sequenceargs {
Ricardo Labiaga65fc64e2009-04-01 09:23:30 -040098 struct sockaddr *csa_addr;
Benny Halevy2d9b9ec2009-04-01 09:23:24 -040099 struct nfs4_sessionid csa_sessionid;
100 uint32_t csa_sequenceid;
101 uint32_t csa_slotid;
102 uint32_t csa_highestslotid;
103 uint32_t csa_cachethis;
104 uint32_t csa_nrclists;
105 struct referring_call_list *csa_rclists;
106};
107
108struct cb_sequenceres {
Ricardo Labiaga65fc64e2009-04-01 09:23:30 -0400109 __be32 csr_status;
Benny Halevy2d9b9ec2009-04-01 09:23:24 -0400110 struct nfs4_sessionid csr_sessionid;
111 uint32_t csr_sequenceid;
112 uint32_t csr_slotid;
113 uint32_t csr_highestslotid;
114 uint32_t csr_target_highestslotid;
115};
116
Andy Adamsonc36fca52011-01-06 02:04:32 +0000117extern __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
118 struct cb_sequenceres *res,
119 struct cb_process_state *cps);
Benny Halevyd49433e2009-04-01 09:23:25 -0400120
Alexandros Batsakis31f09602009-12-05 13:27:02 -0500121#define RCA4_TYPE_MASK_RDATA_DLG 0
122#define RCA4_TYPE_MASK_WDATA_DLG 1
Alexandros Batsakis36840372011-01-06 11:36:31 +0000123#define RCA4_TYPE_MASK_DIR_DLG 2
124#define RCA4_TYPE_MASK_FILE_LAYOUT 3
125#define RCA4_TYPE_MASK_BLK_LAYOUT 4
126#define RCA4_TYPE_MASK_OBJ_LAYOUT_MIN 8
127#define RCA4_TYPE_MASK_OBJ_LAYOUT_MAX 9
128#define RCA4_TYPE_MASK_OTHER_LAYOUT_MIN 12
129#define RCA4_TYPE_MASK_OTHER_LAYOUT_MAX 15
130#define RCA4_TYPE_MASK_ALL 0xf31f
Alexandros Batsakis31f09602009-12-05 13:27:02 -0500131
132struct cb_recallanyargs {
Alexandros Batsakis31f09602009-12-05 13:27:02 -0500133 uint32_t craa_objs_to_keep;
134 uint32_t craa_type_mask;
135};
136
Andy Adamsonc36fca52011-01-06 02:04:32 +0000137extern __be32 nfs4_callback_recallany(struct cb_recallanyargs *args,
138 void *dummy,
139 struct cb_process_state *cps);
Andy Adamsonb9efa1b2010-01-20 16:06:27 -0500140
141struct cb_recallslotargs {
Trond Myklebustd5fb4ce2012-11-20 20:24:02 -0500142 uint32_t crsa_target_highest_slotid;
Andy Adamsonb9efa1b2010-01-20 16:06:27 -0500143};
Andy Adamsonc36fca52011-01-06 02:04:32 +0000144extern __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args,
145 void *dummy,
146 struct cb_process_state *cps);
Andy Adamsonb9efa1b2010-01-20 16:06:27 -0500147
Fred Isamanf2a62562011-01-06 11:36:29 +0000148struct cb_layoutrecallargs {
Fred Isamanf2a62562011-01-06 11:36:29 +0000149 uint32_t cbl_recall_type;
150 uint32_t cbl_layout_type;
151 uint32_t cbl_layoutchanged;
152 union {
153 struct {
154 struct nfs_fh cbl_fh;
155 struct pnfs_layout_range cbl_range;
156 nfs4_stateid cbl_stateid;
157 };
158 struct nfs_fsid cbl_fsid;
159 };
160};
161
Dan Carpenter0e0243d2012-01-12 10:06:05 +0300162extern __be32 nfs4_callback_layoutrecall(
Fred Isamanf2a62562011-01-06 11:36:29 +0000163 struct cb_layoutrecallargs *args,
164 void *dummy, struct cb_process_state *cps);
165
Marc Eshel1be56832011-05-22 19:47:09 +0300166struct cb_devicenotifyitem {
167 uint32_t cbd_notify_type;
168 uint32_t cbd_layout_type;
169 struct nfs4_deviceid cbd_dev_id;
170 uint32_t cbd_immediate;
171};
172
173struct cb_devicenotifyargs {
174 int ndevs;
175 struct cb_devicenotifyitem *devs;
176};
177
178extern __be32 nfs4_callback_devicenotify(
179 struct cb_devicenotifyargs *args,
180 void *dummy, struct cb_process_state *cps);
181
Benny Halevy2d9b9ec2009-04-01 09:23:24 -0400182#endif /* CONFIG_NFS_V4_1 */
Andy Adamson778be232011-01-25 15:38:01 +0000183extern int check_gss_callback_principal(struct nfs_client *, struct svc_rqst *);
Andy Adamsonc36fca52011-01-06 02:04:32 +0000184extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args,
185 struct cb_getattrres *res,
186 struct cb_process_state *cps);
187extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
188 struct cb_process_state *cps);
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400189#if IS_ENABLED(CONFIG_NFS_V4)
Benny Halevy71468512009-04-01 09:22:56 -0400190extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
Stanislav Kinsburskyc8ceb412012-08-20 18:00:06 +0400191extern void nfs_callback_down(int minorversion, struct net *net);
Andy Adamsone82dc222009-04-01 09:23:14 -0400192#endif /* CONFIG_NFS_V4 */
Ricardo Labiagaa43cde92009-04-01 09:23:08 -0400193/*
194 * nfs41: Callbacks are expected to not cause substantial latency,
195 * so we limit their concurrency to 1 by setting up the maximum number
196 * of slots for the backchannel.
197 */
198#define NFS41_BC_MIN_CALLBACKS 1
Benny Halevyd49433e2009-04-01 09:23:25 -0400199#define NFS41_BC_MAX_CALLBACKS 1
Ricardo Labiagaa43cde92009-04-01 09:23:08 -0400200
Trond Myklebusta72b4422006-01-03 09:55:41 +0100201extern unsigned int nfs_callback_set_tcpport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203#endif /* __LINUX_FS_NFS_CALLBACK_H */