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