blob: 4dce116bfd80c81ab09aec171817e082723ad74e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* packet.h: Rx packet layout and definitions
2 *
David Howells63b6be52007-04-26 15:55:48 -07003 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
12#ifndef _LINUX_RXRPC_PACKET_H
13#define _LINUX_RXRPC_PACKET_H
14
David Howells63b6be52007-04-26 15:55:48 -070015typedef u32 rxrpc_seq_t; /* Rx message sequence number */
16typedef u32 rxrpc_serial_t; /* Rx message serial number */
17typedef __be32 rxrpc_seq_net_t; /* on-the-wire Rx message sequence number */
18typedef __be32 rxrpc_serial_net_t; /* on-the-wire Rx message serial number */
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20/*****************************************************************************/
21/*
22 * on-the-wire Rx packet header
23 * - all multibyte fields should be in network byte order
24 */
David Howells63b6be52007-04-26 15:55:48 -070025struct rxrpc_header {
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 __be32 epoch; /* client boot timestamp */
27
28 __be32 cid; /* connection and channel ID */
29#define RXRPC_MAXCALLS 4 /* max active calls per conn */
30#define RXRPC_CHANNELMASK (RXRPC_MAXCALLS-1) /* mask for channel ID */
31#define RXRPC_CIDMASK (~RXRPC_CHANNELMASK) /* mask for connection ID */
David Howells17926a72007-04-26 15:48:28 -070032#define RXRPC_CIDSHIFT ilog2(RXRPC_MAXCALLS) /* shift for connection ID */
33#define RXRPC_CID_INC (1 << RXRPC_CIDSHIFT) /* connection ID increment */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35 __be32 callNumber; /* call ID (0 for connection-level packets) */
36#define RXRPC_PROCESS_MAXCALLS (1<<2) /* maximum number of active calls per conn (power of 2) */
37
38 __be32 seq; /* sequence number of pkt in call stream */
39 __be32 serial; /* serial number of pkt sent to network */
40
41 uint8_t type; /* packet type */
42#define RXRPC_PACKET_TYPE_DATA 1 /* data */
43#define RXRPC_PACKET_TYPE_ACK 2 /* ACK */
44#define RXRPC_PACKET_TYPE_BUSY 3 /* call reject */
45#define RXRPC_PACKET_TYPE_ABORT 4 /* call/connection abort */
46#define RXRPC_PACKET_TYPE_ACKALL 5 /* ACK all outstanding packets on call */
47#define RXRPC_PACKET_TYPE_CHALLENGE 6 /* connection security challenge (SRVR->CLNT) */
48#define RXRPC_PACKET_TYPE_RESPONSE 7 /* connection secutity response (CLNT->SRVR) */
49#define RXRPC_PACKET_TYPE_DEBUG 8 /* debug info request */
David Howells44ba0692015-04-01 16:31:26 +010050#define RXRPC_PACKET_TYPE_VERSION 13 /* version string request */
51#define RXRPC_N_PACKET_TYPES 14 /* number of packet types (incl type 0) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53 uint8_t flags; /* packet flags */
54#define RXRPC_CLIENT_INITIATED 0x01 /* signifies a packet generated by a client */
55#define RXRPC_REQUEST_ACK 0x02 /* request an unconditional ACK of this packet */
56#define RXRPC_LAST_PACKET 0x04 /* the last packet from this side for this call */
57#define RXRPC_MORE_PACKETS 0x08 /* more packets to come */
58#define RXRPC_JUMBO_PACKET 0x20 /* [DATA] this is a jumbo packet */
59#define RXRPC_SLOW_START_OK 0x20 /* [ACK] slow start supported */
60
61 uint8_t userStatus; /* app-layer defined status */
62 uint8_t securityIndex; /* security protocol ID */
David Howells17926a72007-04-26 15:48:28 -070063 union {
64 __be16 _rsvd; /* reserved */
65 __be16 cksum; /* kerberos security checksum */
66 };
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 __be16 serviceId; /* service ID */
68
Eric Dumazetbc105022010-06-03 03:21:52 -070069} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71#define __rxrpc_header_off(X) offsetof(struct rxrpc_header,X)
72
73extern const char *rxrpc_pkts[];
74
75/*****************************************************************************/
76/*
77 * jumbo packet secondary header
78 * - can be mapped to read header by:
79 * - new_serial = serial + 1
80 * - new_seq = seq + 1
81 * - new_flags = j_flags
82 * - new__rsvd = j__rsvd
83 * - duplicating all other fields
84 */
David Howells63b6be52007-04-26 15:55:48 -070085struct rxrpc_jumbo_header {
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 uint8_t flags; /* packet flags (as per rxrpc_header) */
87 uint8_t pad;
88 __be16 _rsvd; /* reserved (used by kerberos security as cksum) */
89};
90
91#define RXRPC_JUMBO_DATALEN 1412 /* non-terminal jumbo packet data length */
92
93/*****************************************************************************/
94/*
95 * on-the-wire Rx ACK packet data payload
96 * - all multibyte fields should be in network byte order
97 */
David Howells63b6be52007-04-26 15:55:48 -070098struct rxrpc_ackpacket {
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 __be16 bufferSpace; /* number of packet buffers available */
100 __be16 maxSkew; /* diff between serno being ACK'd and highest serial no
101 * received */
102 __be32 firstPacket; /* sequence no of first ACK'd packet in attached list */
103 __be32 previousPacket; /* sequence no of previous packet received */
104 __be32 serial; /* serial no of packet that prompted this ACK */
105
106 uint8_t reason; /* reason for ACK */
107#define RXRPC_ACK_REQUESTED 1 /* ACK was requested on packet */
108#define RXRPC_ACK_DUPLICATE 2 /* duplicate packet received */
109#define RXRPC_ACK_OUT_OF_SEQUENCE 3 /* out of sequence packet received */
110#define RXRPC_ACK_EXCEEDS_WINDOW 4 /* packet received beyond end of ACK window */
111#define RXRPC_ACK_NOSPACE 5 /* packet discarded due to lack of buffer space */
112#define RXRPC_ACK_PING 6 /* keep alive ACK */
113#define RXRPC_ACK_PING_RESPONSE 7 /* response to RXRPC_ACK_PING */
114#define RXRPC_ACK_DELAY 8 /* nothing happened since received packet */
115#define RXRPC_ACK_IDLE 9 /* ACK due to fully received ACK window */
116
117 uint8_t nAcks; /* number of ACKs */
118#define RXRPC_MAXACKS 255
119
120 uint8_t acks[0]; /* list of ACK/NAKs */
121#define RXRPC_ACK_TYPE_NACK 0
122#define RXRPC_ACK_TYPE_ACK 1
123
Eric Dumazetbc105022010-06-03 03:21:52 -0700124} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
David Howells17926a72007-04-26 15:48:28 -0700126/*
127 * ACK packets can have a further piece of information tagged on the end
128 */
129struct rxrpc_ackinfo {
130 __be32 rxMTU; /* maximum Rx MTU size (bytes) [AFS 3.3] */
131 __be32 maxMTU; /* maximum interface MTU size (bytes) [AFS 3.3] */
132 __be32 rwind; /* Rx window size (packets) [AFS 3.4] */
133 __be32 jumbo_max; /* max packets to stick into a jumbo packet [AFS 3.5] */
134};
135
136/*****************************************************************************/
137/*
138 * Kerberos security type-2 challenge packet
139 */
140struct rxkad_challenge {
141 __be32 version; /* version of this challenge type */
142 __be32 nonce; /* encrypted random number */
143 __be32 min_level; /* minimum security level */
144 __be32 __padding; /* padding to 8-byte boundary */
Eric Dumazetbc105022010-06-03 03:21:52 -0700145} __packed;
David Howells17926a72007-04-26 15:48:28 -0700146
147/*****************************************************************************/
148/*
149 * Kerberos security type-2 response packet
150 */
151struct rxkad_response {
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300152 __be32 version; /* version of this response type */
David Howells17926a72007-04-26 15:48:28 -0700153 __be32 __pad;
154
155 /* encrypted bit of the response */
156 struct {
157 __be32 epoch; /* current epoch */
158 __be32 cid; /* parent connection ID */
159 __be32 checksum; /* checksum */
160 __be32 securityIndex; /* security type */
161 __be32 call_id[4]; /* encrypted call IDs */
162 __be32 inc_nonce; /* challenge nonce + 1 */
163 __be32 level; /* desired level */
164 } encrypted;
165
166 __be32 kvno; /* Kerberos key version number */
167 __be32 ticket_len; /* Kerberos ticket length */
Eric Dumazetbc105022010-06-03 03:21:52 -0700168} __packed;
David Howells17926a72007-04-26 15:48:28 -0700169
170/*****************************************************************************/
171/*
172 * RxRPC-level abort codes
173 */
174#define RX_CALL_DEAD -1 /* call/conn has been inactive and is shut down */
175#define RX_INVALID_OPERATION -2 /* invalid operation requested / attempted */
176#define RX_CALL_TIMEOUT -3 /* call timeout exceeded */
177#define RX_EOF -4 /* unexpected end of data on read op */
178#define RX_PROTOCOL_ERROR -5 /* low-level protocol error */
179#define RX_USER_ABORT -6 /* generic user abort */
180#define RX_ADDRINUSE -7 /* UDP port in use */
181#define RX_DEBUGI_BADTYPE -8 /* bad debugging packet type */
182
183/*
David Howells651350d2007-04-26 15:50:17 -0700184 * (un)marshalling abort codes (rxgen)
185 */
186#define RXGEN_CC_MARSHAL -450
187#define RXGEN_CC_UNMARSHAL -451
188#define RXGEN_SS_MARSHAL -452
189#define RXGEN_SS_UNMARSHAL -453
190#define RXGEN_DECODE -454
191#define RXGEN_OPCODE -455
192#define RXGEN_SS_XDRFREE -456
193#define RXGEN_CC_XDRFREE -457
194
195/*
David Howells17926a72007-04-26 15:48:28 -0700196 * Rx kerberos security abort codes
197 * - unfortunately we have no generalised security abort codes to say things
198 * like "unsupported security", so we have to use these instead and hope the
199 * other side understands
200 */
201#define RXKADINCONSISTENCY 19270400 /* security module structure inconsistent */
202#define RXKADPACKETSHORT 19270401 /* packet too short for security challenge */
203#define RXKADLEVELFAIL 19270402 /* security level negotiation failed */
204#define RXKADTICKETLEN 19270403 /* ticket length too short or too long */
205#define RXKADOUTOFSEQUENCE 19270404 /* packet had bad sequence number */
206#define RXKADNOAUTH 19270405 /* caller not authorised */
207#define RXKADBADKEY 19270406 /* illegal key: bad parity or weak */
208#define RXKADBADTICKET 19270407 /* security object was passed a bad ticket */
209#define RXKADUNKNOWNKEY 19270408 /* ticket contained unknown key version number */
210#define RXKADEXPIRED 19270409 /* authentication expired */
211#define RXKADSEALEDINCON 19270410 /* sealed data inconsistent */
212#define RXKADDATALEN 19270411 /* user data too long */
213#define RXKADILLEGALLEVEL 19270412 /* caller not authorised to use encrypted conns */
214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215#endif /* _LINUX_RXRPC_PACKET_H */