blob: 07baa8254ca1407a6342e80bc3e545c34868161e [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
10
11#define NFS4_CALLBACK 0x40000000
12#define NFS4_CALLBACK_XDRSIZE 2048
13#define NFS4_CALLBACK_BUFSIZE (1024 + NFS4_CALLBACK_XDRSIZE)
14
15enum nfs4_callback_procnum {
16 CB_NULL = 0,
17 CB_COMPOUND = 1,
18};
19
20enum nfs4_callback_opnum {
21 OP_CB_GETATTR = 3,
22 OP_CB_RECALL = 4,
Benny Halevy45377b92009-04-01 09:23:21 -040023/* 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 Halevy34bc47c92009-04-01 09:23:22 -040033 OP_CB_NOTIFY_DEVICEID = 14,
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 OP_CB_ILLEGAL = 10044,
35};
36
37struct cb_compound_hdr_arg {
Trond Myklebust2e42c3e2007-05-14 17:20:41 -040038 unsigned int taglen;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 const char *tag;
Benny Halevyb8f2ef82009-04-01 09:23:19 -040040 unsigned int minorversion;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 unsigned nops;
42};
43
44struct cb_compound_hdr_res {
Al Viro5704fde2006-10-19 23:28:51 -070045 __be32 *status;
Trond Myklebust2e42c3e2007-05-14 17:20:41 -040046 unsigned int taglen;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 const char *tag;
Al Viro5704fde2006-10-19 23:28:51 -070048 __be32 *nops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049};
50
51struct cb_getattrargs {
Chuck Lever671beed2007-12-10 14:58:22 -050052 struct sockaddr *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 struct nfs_fh fh;
54 uint32_t bitmap[2];
55};
56
57struct cb_getattrres {
Al Viroe6f684f2006-10-19 23:28:50 -070058 __be32 status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 uint32_t bitmap[2];
60 uint64_t size;
61 uint64_t change_attr;
62 struct timespec ctime;
63 struct timespec mtime;
64};
65
66struct cb_recallargs {
Chuck Leverc1d35862007-12-10 14:58:29 -050067 struct sockaddr *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 struct nfs_fh fh;
69 nfs4_stateid stateid;
70 uint32_t truncate;
71};
72
Benny Halevy2d9b9ec2009-04-01 09:23:24 -040073#if defined(CONFIG_NFS_V4_1)
74
75struct referring_call {
76 uint32_t rc_sequenceid;
77 uint32_t rc_slotid;
78};
79
80struct referring_call_list {
81 struct nfs4_sessionid rcl_sessionid;
82 uint32_t rcl_nrefcalls;
83 struct referring_call *rcl_refcalls;
84};
85
86struct cb_sequenceargs {
Ricardo Labiaga65fc64e2009-04-01 09:23:30 -040087 struct sockaddr *csa_addr;
Benny Halevy2d9b9ec2009-04-01 09:23:24 -040088 struct nfs4_sessionid csa_sessionid;
89 uint32_t csa_sequenceid;
90 uint32_t csa_slotid;
91 uint32_t csa_highestslotid;
92 uint32_t csa_cachethis;
93 uint32_t csa_nrclists;
94 struct referring_call_list *csa_rclists;
95};
96
97struct cb_sequenceres {
Ricardo Labiaga65fc64e2009-04-01 09:23:30 -040098 __be32 csr_status;
Benny Halevy2d9b9ec2009-04-01 09:23:24 -040099 struct nfs4_sessionid csr_sessionid;
100 uint32_t csr_sequenceid;
101 uint32_t csr_slotid;
102 uint32_t csr_highestslotid;
103 uint32_t csr_target_highestslotid;
104};
105
Benny Halevyd49433e2009-04-01 09:23:25 -0400106extern unsigned nfs4_callback_sequence(struct cb_sequenceargs *args,
107 struct cb_sequenceres *res);
108
Benny Halevy2d9b9ec2009-04-01 09:23:24 -0400109#endif /* CONFIG_NFS_V4_1 */
110
Al Viroe6f684f2006-10-19 23:28:50 -0700111extern __be32 nfs4_callback_getattr(struct cb_getattrargs *args, struct cb_getattrres *res);
112extern __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
David Howells5ae1fbc2006-08-22 20:06:08 -0400114#ifdef CONFIG_NFS_V4
Benny Halevy71468512009-04-01 09:22:56 -0400115extern int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt);
Andy Adamsone82dc222009-04-01 09:23:14 -0400116extern void nfs_callback_down(int minorversion);
117#endif /* CONFIG_NFS_V4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Ricardo Labiagaa43cde92009-04-01 09:23:08 -0400119/*
120 * nfs41: Callbacks are expected to not cause substantial latency,
121 * so we limit their concurrency to 1 by setting up the maximum number
122 * of slots for the backchannel.
123 */
124#define NFS41_BC_MIN_CALLBACKS 1
Benny Halevyd49433e2009-04-01 09:23:25 -0400125#define NFS41_BC_MAX_CALLBACKS 1
Ricardo Labiagaa43cde92009-04-01 09:23:08 -0400126
Trond Myklebusta72b4422006-01-03 09:55:41 +0100127extern unsigned int nfs_callback_set_tcpport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128extern unsigned short nfs_callback_tcpport;
Chuck Leverf738f512009-03-18 20:48:06 -0400129extern unsigned short nfs_callback_tcpport6;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131#endif /* __LINUX_FS_NFS_CALLBACK_H */