rpc: add rpc_queue_empty function
[linux-2.6.git] / include / linux / sunrpc / msg_prot.h
1 /*
2  * linux/include/linux/sunrpc/msg_prot.h
3  *
4  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
5  */
6
7 #ifndef _LINUX_SUNRPC_MSGPROT_H_
8 #define _LINUX_SUNRPC_MSGPROT_H_
9
10 #ifdef __KERNEL__ /* user programs should get these from the rpc header files */
11
12 #define RPC_VERSION 2
13
14 /* size of an XDR encoding unit in bytes, i.e. 32bit */
15 #define XDR_UNIT        (4)
16
17 /* spec defines authentication flavor as an unsigned 32 bit integer */
18 typedef u32     rpc_authflavor_t;
19
20 enum rpc_auth_flavors {
21         RPC_AUTH_NULL  = 0,
22         RPC_AUTH_UNIX  = 1,
23         RPC_AUTH_SHORT = 2,
24         RPC_AUTH_DES   = 3,
25         RPC_AUTH_KRB   = 4,
26         RPC_AUTH_GSS   = 6,
27         RPC_AUTH_MAXFLAVOR = 8,
28         /* pseudoflavors: */
29         RPC_AUTH_GSS_KRB5  = 390003,
30         RPC_AUTH_GSS_KRB5I = 390004,
31         RPC_AUTH_GSS_KRB5P = 390005,
32         RPC_AUTH_GSS_LKEY  = 390006,
33         RPC_AUTH_GSS_LKEYI = 390007,
34         RPC_AUTH_GSS_LKEYP = 390008,
35         RPC_AUTH_GSS_SPKM  = 390009,
36         RPC_AUTH_GSS_SPKMI = 390010,
37         RPC_AUTH_GSS_SPKMP = 390011,
38 };
39
40 /* Maximum size (in bytes) of an rpc credential or verifier */
41 #define RPC_MAX_AUTH_SIZE (400)
42
43 enum rpc_msg_type {
44         RPC_CALL = 0,
45         RPC_REPLY = 1
46 };
47
48 enum rpc_reply_stat {
49         RPC_MSG_ACCEPTED = 0,
50         RPC_MSG_DENIED = 1
51 };
52
53 enum rpc_accept_stat {
54         RPC_SUCCESS = 0,
55         RPC_PROG_UNAVAIL = 1,
56         RPC_PROG_MISMATCH = 2,
57         RPC_PROC_UNAVAIL = 3,
58         RPC_GARBAGE_ARGS = 4,
59         RPC_SYSTEM_ERR = 5,
60         /* internal use only */
61         RPC_DROP_REPLY = 60000,
62 };
63
64 enum rpc_reject_stat {
65         RPC_MISMATCH = 0,
66         RPC_AUTH_ERROR = 1
67 };
68
69 enum rpc_auth_stat {
70         RPC_AUTH_OK = 0,
71         RPC_AUTH_BADCRED = 1,
72         RPC_AUTH_REJECTEDCRED = 2,
73         RPC_AUTH_BADVERF = 3,
74         RPC_AUTH_REJECTEDVERF = 4,
75         RPC_AUTH_TOOWEAK = 5,
76         /* RPCSEC_GSS errors */
77         RPCSEC_GSS_CREDPROBLEM = 13,
78         RPCSEC_GSS_CTXPROBLEM = 14
79 };
80
81 #define RPC_MAXNETNAMELEN       256
82
83 /*
84  * From RFC 1831:
85  *
86  * "A record is composed of one or more record fragments.  A record
87  *  fragment is a four-byte header followed by 0 to (2**31) - 1 bytes of
88  *  fragment data.  The bytes encode an unsigned binary number; as with
89  *  XDR integers, the byte order is from highest to lowest.  The number
90  *  encodes two values -- a boolean which indicates whether the fragment
91  *  is the last fragment of the record (bit value 1 implies the fragment
92  *  is the last fragment) and a 31-bit unsigned binary value which is the
93  *  length in bytes of the fragment's data.  The boolean value is the
94  *  highest-order bit of the header; the length is the 31 low-order bits.
95  *  (Note that this record specification is NOT in XDR standard form!)"
96  *
97  * The Linux RPC client always sends its requests in a single record
98  * fragment, limiting the maximum payload size for stream transports to
99  * 2GB.
100  */
101
102 typedef __be32  rpc_fraghdr;
103
104 #define RPC_LAST_STREAM_FRAGMENT        (1U << 31)
105 #define RPC_FRAGMENT_SIZE_MASK          (~RPC_LAST_STREAM_FRAGMENT)
106 #define RPC_MAX_FRAGMENT_SIZE           ((1U << 31) - 1)
107
108 /*
109  * RPC call and reply header size as number of 32bit words (verifier
110  * size computed separately, see below)
111  */
112 #define RPC_CALLHDRSIZE         (6)
113 #define RPC_REPHDRSIZE          (4)
114
115
116 /*
117  * Maximum RPC header size, including authentication,
118  * as number of 32bit words (see RFCs 1831, 1832).
119  *
120  *      xid                         1 xdr unit = 4 bytes
121  *      mtype                       1
122  *      rpc_version                 1
123  *      program                     1
124  *      prog_version                1
125  *      procedure                   1
126  *      cred {
127  *          flavor                  1
128  *          length                  1
129  *          body<RPC_MAX_AUTH_SIZE> 100 xdr units = 400 bytes
130  *      }
131  *      verf {
132  *          flavor                  1
133  *          length                  1
134  *          body<RPC_MAX_AUTH_SIZE> 100 xdr units = 400 bytes
135  *      }
136  *      TOTAL                       210 xdr units = 840 bytes
137  */
138 #define RPC_MAX_HEADER_WITH_AUTH \
139         (RPC_CALLHDRSIZE + 2*(2+RPC_MAX_AUTH_SIZE/4))
140
141 /*
142  * RFC1833/RFC3530 rpcbind (v3+) well-known netid's.
143  */
144 #define RPCBIND_NETID_UDP       "udp"
145 #define RPCBIND_NETID_TCP       "tcp"
146 #define RPCBIND_NETID_UDP6      "udp6"
147 #define RPCBIND_NETID_TCP6      "tcp6"
148
149 /*
150  * Note that RFC 1833 does not put any size restrictions on the
151  * netid string, but all currently defined netid's fit in 4 bytes.
152  */
153 #define RPCBIND_MAXNETIDLEN     (4u)
154
155 /*
156  * Universal addresses are introduced in RFC 1833 and further spelled
157  * out in RFC 3530.  RPCBIND_MAXUADDRLEN defines a maximum byte length
158  * of a universal address for use in allocating buffers and character
159  * arrays.
160  *
161  * Quoting RFC 3530, section 2.2:
162  *
163  * For TCP over IPv4 and for UDP over IPv4, the format of r_addr is the
164  * US-ASCII string:
165  *
166  *      h1.h2.h3.h4.p1.p2
167  *
168  * The prefix, "h1.h2.h3.h4", is the standard textual form for
169  * representing an IPv4 address, which is always four octets long.
170  * Assuming big-endian ordering, h1, h2, h3, and h4, are respectively,
171  * the first through fourth octets each converted to ASCII-decimal.
172  * Assuming big-endian ordering, p1 and p2 are, respectively, the first
173  * and second octets each converted to ASCII-decimal.  For example, if a
174  * host, in big-endian order, has an address of 0x0A010307 and there is
175  * a service listening on, in big endian order, port 0x020F (decimal
176  * 527), then the complete universal address is "10.1.3.7.2.15".
177  *
178  * ...
179  *
180  * For TCP over IPv6 and for UDP over IPv6, the format of r_addr is the
181  * US-ASCII string:
182  *
183  *      x1:x2:x3:x4:x5:x6:x7:x8.p1.p2
184  *
185  * The suffix "p1.p2" is the service port, and is computed the same way
186  * as with universal addresses for TCP and UDP over IPv4.  The prefix,
187  * "x1:x2:x3:x4:x5:x6:x7:x8", is the standard textual form for
188  * representing an IPv6 address as defined in Section 2.2 of [RFC2373].
189  * Additionally, the two alternative forms specified in Section 2.2 of
190  * [RFC2373] are also acceptable.
191  */
192
193 #include <linux/inet.h>
194
195 /* Maximum size of the port number part of a universal address */
196 #define RPCBIND_MAXUADDRPLEN    sizeof(".255.255")
197
198 /* Maximum size of an IPv4 universal address */
199 #define RPCBIND_MAXUADDR4LEN    \
200                 (INET_ADDRSTRLEN + RPCBIND_MAXUADDRPLEN)
201
202 /* Maximum size of an IPv6 universal address */
203 #define RPCBIND_MAXUADDR6LEN    \
204                 (INET6_ADDRSTRLEN + RPCBIND_MAXUADDRPLEN)
205
206 /* Assume INET6_ADDRSTRLEN will always be larger than INET_ADDRSTRLEN... */
207 #define RPCBIND_MAXUADDRLEN     RPCBIND_MAXUADDR6LEN
208
209 #endif /* __KERNEL__ */
210 #endif /* _LINUX_SUNRPC_MSGPROT_H_ */