[mirror_ubuntu-bionic-kernel.git] / include / rxrpc / packet.h

/* packet.h: Rx packet layout and definitions
 *
 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells (dhowells@redhat.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#ifndef _LINUX_RXRPC_PACKET_H
#define _LINUX_RXRPC_PACKET_H

typedef u32	rxrpc_seq_t;	/* Rx message sequence number */
typedef u32	rxrpc_serial_t;	/* Rx message serial number */
typedef __be32	rxrpc_seq_net_t; /* on-the-wire Rx message sequence number */
typedef __be32	rxrpc_serial_net_t; /* on-the-wire Rx message serial number */

/*****************************************************************************/
/*
 * on-the-wire Rx packet header
 * - all multibyte fields should be in network byte order
 */
struct rxrpc_wire_header {
	__be32		epoch;		/* client boot timestamp */
#define RXRPC_RANDOM_EPOCH	0x80000000	/* Random if set, date-based if not */

	__be32		cid;		/* connection and channel ID */
#define RXRPC_MAXCALLS		4			/* max active calls per conn */
#define RXRPC_CHANNELMASK	(RXRPC_MAXCALLS-1)	/* mask for channel ID */
#define RXRPC_CIDMASK		(~RXRPC_CHANNELMASK)	/* mask for connection ID */
#define RXRPC_CIDSHIFT		ilog2(RXRPC_MAXCALLS)	/* shift for connection ID */
#define RXRPC_CID_INC		(1 << RXRPC_CIDSHIFT)	/* connection ID increment */

	__be32		callNumber;	/* call ID (0 for connection-level packets) */
#define RXRPC_PROCESS_MAXCALLS	(1<<2)	/* maximum number of active calls per conn (power of 2) */

	__be32		seq;		/* sequence number of pkt in call stream */
	__be32		serial;		/* serial number of pkt sent to network */

	uint8_t		type;		/* packet type */
#define RXRPC_PACKET_TYPE_DATA		1	/* data */
#define RXRPC_PACKET_TYPE_ACK		2	/* ACK */
#define RXRPC_PACKET_TYPE_BUSY		3	/* call reject */
#define RXRPC_PACKET_TYPE_ABORT		4	/* call/connection abort */
#define RXRPC_PACKET_TYPE_ACKALL	5	/* ACK all outstanding packets on call */
#define RXRPC_PACKET_TYPE_CHALLENGE	6	/* connection security challenge (SRVR->CLNT) */
#define RXRPC_PACKET_TYPE_RESPONSE	7	/* connection secutity response (CLNT->SRVR) */
#define RXRPC_PACKET_TYPE_DEBUG		8	/* debug info request */
#define RXRPC_PACKET_TYPE_VERSION	13	/* version string request */
#define RXRPC_N_PACKET_TYPES		14	/* number of packet types (incl type 0) */

	uint8_t		flags;		/* packet flags */
#define RXRPC_CLIENT_INITIATED	0x01		/* signifies a packet generated by a client */
#define RXRPC_REQUEST_ACK	0x02		/* request an unconditional ACK of this packet */
#define RXRPC_LAST_PACKET	0x04		/* the last packet from this side for this call */
#define RXRPC_MORE_PACKETS	0x08		/* more packets to come */
#define RXRPC_JUMBO_PACKET	0x20		/* [DATA] this is a jumbo packet */
#define RXRPC_SLOW_START_OK	0x20		/* [ACK] slow start supported */

	uint8_t		userStatus;	/* app-layer defined status */
	uint8_t		securityIndex;	/* security protocol ID */
	union {
		__be16	_rsvd;		/* reserved */
		__be16	cksum;		/* kerberos security checksum */
	};
	__be16		serviceId;	/* service ID */

} __packed;

#define RXRPC_SUPPORTED_PACKET_TYPES (			\
		(1 << RXRPC_PACKET_TYPE_DATA) |		\
		(1 << RXRPC_PACKET_TYPE_ACK) |		\
		(1 << RXRPC_PACKET_TYPE_BUSY) |		\
		(1 << RXRPC_PACKET_TYPE_ABORT) |	\
		(1 << RXRPC_PACKET_TYPE_ACKALL) |	\
		(1 << RXRPC_PACKET_TYPE_CHALLENGE) |	\
		(1 << RXRPC_PACKET_TYPE_RESPONSE) |	\
		/*(1 << RXRPC_PACKET_TYPE_DEBUG) | */	\
		(1 << RXRPC_PACKET_TYPE_VERSION))

/*****************************************************************************/
/*
 * jumbo packet secondary header
 * - can be mapped to read header by:
 *   - new_serial = serial + 1
 *   - new_seq = seq + 1
 *   - new_flags = j_flags
 *   - new__rsvd = j__rsvd
 *   - duplicating all other fields
 */
struct rxrpc_jumbo_header {
	uint8_t		flags;		/* packet flags (as per rxrpc_header) */
	uint8_t		pad;
	__be16		_rsvd;		/* reserved (used by kerberos security as cksum) */
};

#define RXRPC_JUMBO_DATALEN	1412	/* non-terminal jumbo packet data length */

/*****************************************************************************/
/*
 * on-the-wire Rx ACK packet data payload
 * - all multibyte fields should be in network byte order
 */
struct rxrpc_ackpacket {
	__be16		bufferSpace;	/* number of packet buffers available */
	__be16		maxSkew;	/* diff between serno being ACK'd and highest serial no
					 * received */
	__be32		firstPacket;	/* sequence no of first ACK'd packet in attached list */
	__be32		previousPacket;	/* sequence no of previous packet received */
	__be32		serial;		/* serial no of packet that prompted this ACK */

	uint8_t		reason;		/* reason for ACK */
#define RXRPC_ACK_REQUESTED		1	/* ACK was requested on packet */
#define RXRPC_ACK_DUPLICATE		2	/* duplicate packet received */
#define RXRPC_ACK_OUT_OF_SEQUENCE	3	/* out of sequence packet received */
#define RXRPC_ACK_EXCEEDS_WINDOW	4	/* packet received beyond end of ACK window */
#define RXRPC_ACK_NOSPACE		5	/* packet discarded due to lack of buffer space */
#define RXRPC_ACK_PING			6	/* keep alive ACK */
#define RXRPC_ACK_PING_RESPONSE		7	/* response to RXRPC_ACK_PING */
#define RXRPC_ACK_DELAY			8	/* nothing happened since received packet */
#define RXRPC_ACK_IDLE			9	/* ACK due to fully received ACK window */

	uint8_t		nAcks;		/* number of ACKs */
#define RXRPC_MAXACKS	255

	uint8_t		acks[0];	/* list of ACK/NAKs */
#define RXRPC_ACK_TYPE_NACK		0
#define RXRPC_ACK_TYPE_ACK		1

} __packed;

/*
 * ACK packets can have a further piece of information tagged on the end
 */
struct rxrpc_ackinfo {
	__be32		rxMTU;		/* maximum Rx MTU size (bytes) [AFS 3.3] */
	__be32		maxMTU;		/* maximum interface MTU size (bytes) [AFS 3.3] */
	__be32		rwind;		/* Rx window size (packets) [AFS 3.4] */
	__be32		jumbo_max;	/* max packets to stick into a jumbo packet [AFS 3.5] */
};

/*****************************************************************************/
/*
 * Kerberos security type-2 challenge packet
 */
struct rxkad_challenge {
	__be32		version;	/* version of this challenge type */
	__be32		nonce;		/* encrypted random number */
	__be32		min_level;	/* minimum security level */
	__be32		__padding;	/* padding to 8-byte boundary */
} __packed;

/*****************************************************************************/
/*
 * Kerberos security type-2 response packet
 */
struct rxkad_response {
	__be32		version;	/* version of this response type */
	__be32		__pad;

	/* encrypted bit of the response */
	struct {
		__be32		epoch;		/* current epoch */
		__be32		cid;		/* parent connection ID */
		__be32		checksum;	/* checksum */
		__be32		securityIndex;	/* security type */
		__be32		call_id[4];	/* encrypted call IDs */
		__be32		inc_nonce;	/* challenge nonce + 1 */
		__be32		level;		/* desired level */
	} encrypted;

	__be32		kvno;		/* Kerberos key version number */
	__be32		ticket_len;	/* Kerberos ticket length  */
} __packed;

/*****************************************************************************/
/*
 * RxRPC-level abort codes
 */
#define RX_CALL_DEAD		-1	/* call/conn has been inactive and is shut down */
#define RX_INVALID_OPERATION	-2	/* invalid operation requested / attempted */
#define RX_CALL_TIMEOUT		-3	/* call timeout exceeded */
#define RX_EOF			-4	/* unexpected end of data on read op */
#define RX_PROTOCOL_ERROR	-5	/* low-level protocol error */
#define RX_USER_ABORT		-6	/* generic user abort */
#define RX_ADDRINUSE		-7	/* UDP port in use */
#define RX_DEBUGI_BADTYPE	-8	/* bad debugging packet type */

/*
 * (un)marshalling abort codes (rxgen)
 */
#define	RXGEN_CC_MARSHAL    -450
#define	RXGEN_CC_UNMARSHAL  -451
#define	RXGEN_SS_MARSHAL    -452
#define	RXGEN_SS_UNMARSHAL  -453
#define	RXGEN_DECODE	    -454
#define	RXGEN_OPCODE	    -455
#define	RXGEN_SS_XDRFREE    -456
#define	RXGEN_CC_XDRFREE    -457

/*
 * Rx kerberos security abort codes
 * - unfortunately we have no generalised security abort codes to say things
 *   like "unsupported security", so we have to use these instead and hope the
 *   other side understands
 */
#define RXKADINCONSISTENCY	19270400	/* security module structure inconsistent */
#define RXKADPACKETSHORT	19270401	/* packet too short for security challenge */
#define RXKADLEVELFAIL		19270402	/* security level negotiation failed */
#define RXKADTICKETLEN		19270403	/* ticket length too short or too long */
#define RXKADOUTOFSEQUENCE	19270404	/* packet had bad sequence number */
#define RXKADNOAUTH		19270405	/* caller not authorised */
#define RXKADBADKEY		19270406	/* illegal key: bad parity or weak */
#define RXKADBADTICKET		19270407	/* security object was passed a bad ticket */
#define RXKADUNKNOWNKEY		19270408	/* ticket contained unknown key version number */
#define RXKADEXPIRED		19270409	/* authentication expired */
#define RXKADSEALEDINCON	19270410	/* sealed data inconsistent */
#define RXKADDATALEN		19270411	/* user data too long */
#define RXKADILLEGALLEVEL	19270412	/* caller not authorised to use encrypted conns */

#endif /* _LINUX_RXRPC_PACKET_H */
Commit	Line	Data
1da177e4 LT	1	/* packet.h: Rx packet layout and definitions
1da177e4 LT	2	*
63b6be55	3	* Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
1da177e4 LT	4	* 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
63b6be55 DH	15	typedef u32 rxrpc_seq_t; /* Rx message sequence number */
	16	typedef u32 rxrpc_serial_t; /* Rx message serial number */
	17	typedef __be32 rxrpc_seq_net_t; /* on-the-wire Rx message sequence number */
	18	typedef __be32 rxrpc_serial_net_t; /* on-the-wire Rx message serial number */
1da177e4 LT	19
	20	/*****************************************************************************/
	21	/*
	22	* on-the-wire Rx packet header
	23	* - all multibyte fields should be in network byte order
	24	*/
0d12f8a4	25	struct rxrpc_wire_header {
1da177e4	26	__be32 epoch; /* client boot timestamp */
5f2d9c44	27	#define RXRPC_RANDOM_EPOCH 0x80000000 /* Random if set, date-based if not */
1da177e4 LT	28
	29	__be32 cid; /* connection and channel ID */
	30	#define RXRPC_MAXCALLS 4 /* max active calls per conn */
	31	#define RXRPC_CHANNELMASK (RXRPC_MAXCALLS-1) /* mask for channel ID */
	32	#define RXRPC_CIDMASK (~RXRPC_CHANNELMASK) /* mask for connection ID */
17926a79 DH	33	#define RXRPC_CIDSHIFT ilog2(RXRPC_MAXCALLS) /* shift for connection ID */
17926a79 DH	34	#define RXRPC_CID_INC (1 << RXRPC_CIDSHIFT) /* connection ID increment */
1da177e4 LT	35
	36	__be32 callNumber; /* call ID (0 for connection-level packets) */
	37	#define RXRPC_PROCESS_MAXCALLS (1<<2) /* maximum number of active calls per conn (power of 2) */
	38
	39	__be32 seq; /* sequence number of pkt in call stream */
	40	__be32 serial; /* serial number of pkt sent to network */
	41
	42	uint8_t type; /* packet type */
	43	#define RXRPC_PACKET_TYPE_DATA 1 /* data */
	44	#define RXRPC_PACKET_TYPE_ACK 2 /* ACK */
	45	#define RXRPC_PACKET_TYPE_BUSY 3 /* call reject */
	46	#define RXRPC_PACKET_TYPE_ABORT 4 /* call/connection abort */
	47	#define RXRPC_PACKET_TYPE_ACKALL 5 /* ACK all outstanding packets on call */
	48	#define RXRPC_PACKET_TYPE_CHALLENGE 6 /* connection security challenge (SRVR->CLNT) */
	49	#define RXRPC_PACKET_TYPE_RESPONSE 7 /* connection secutity response (CLNT->SRVR) */
	50	#define RXRPC_PACKET_TYPE_DEBUG 8 /* debug info request */
44ba0698 DH	51	#define RXRPC_PACKET_TYPE_VERSION 13 /* version string request */
44ba0698 DH	52	#define RXRPC_N_PACKET_TYPES 14 /* number of packet types (incl type 0) */
1da177e4 LT	53
	54	uint8_t flags; /* packet flags */
	55	#define RXRPC_CLIENT_INITIATED 0x01 /* signifies a packet generated by a client */
	56	#define RXRPC_REQUEST_ACK 0x02 /* request an unconditional ACK of this packet */
	57	#define RXRPC_LAST_PACKET 0x04 /* the last packet from this side for this call */
	58	#define RXRPC_MORE_PACKETS 0x08 /* more packets to come */
	59	#define RXRPC_JUMBO_PACKET 0x20 /* [DATA] this is a jumbo packet */
	60	#define RXRPC_SLOW_START_OK 0x20 /* [ACK] slow start supported */
	61
	62	uint8_t userStatus; /* app-layer defined status */
	63	uint8_t securityIndex; /* security protocol ID */
17926a79 DH	64	union {
	65	__be16 _rsvd; /* reserved */
	66	__be16 cksum; /* kerberos security checksum */
	67	};
1da177e4 LT	68	__be16 serviceId; /* service ID */
1da177e4 LT	69
bc10502d	70	} __packed;
1da177e4	71
351c1e64 DH	72	#define RXRPC_SUPPORTED_PACKET_TYPES ( \
	73	(1 << RXRPC_PACKET_TYPE_DATA) \| \
	74	(1 << RXRPC_PACKET_TYPE_ACK) \| \
	75	(1 << RXRPC_PACKET_TYPE_BUSY) \| \
	76	(1 << RXRPC_PACKET_TYPE_ABORT) \| \
	77	(1 << RXRPC_PACKET_TYPE_ACKALL) \| \
	78	(1 << RXRPC_PACKET_TYPE_CHALLENGE) \| \
	79	(1 << RXRPC_PACKET_TYPE_RESPONSE) \| \
	80	/(1 << RXRPC_PACKET_TYPE_DEBUG) \| / \
	81	(1 << RXRPC_PACKET_TYPE_VERSION))
	82
1da177e4 LT	83	/*****************************************************************************/
	84	/*
	85	* jumbo packet secondary header
	86	* - can be mapped to read header by:
	87	* - new_serial = serial + 1
	88	* - new_seq = seq + 1
	89	* - new_flags = j_flags
	90	* - new__rsvd = j__rsvd
	91	* - duplicating all other fields
	92	*/
63b6be55	93	struct rxrpc_jumbo_header {
1da177e4 LT	94	uint8_t flags; /* packet flags (as per rxrpc_header) */
	95	uint8_t pad;
	96	__be16 _rsvd; /* reserved (used by kerberos security as cksum) */
	97	};
	98
	99	#define RXRPC_JUMBO_DATALEN 1412 /* non-terminal jumbo packet data length */
	100
	101	/*****************************************************************************/
	102	/*
	103	* on-the-wire Rx ACK packet data payload
	104	* - all multibyte fields should be in network byte order
	105	*/
63b6be55	106	struct rxrpc_ackpacket {
1da177e4 LT	107	__be16 bufferSpace; /* number of packet buffers available */
	108	__be16 maxSkew; /* diff between serno being ACK'd and highest serial no
	109	* received */
	110	__be32 firstPacket; /* sequence no of first ACK'd packet in attached list */
	111	__be32 previousPacket; /* sequence no of previous packet received */
	112	__be32 serial; /* serial no of packet that prompted this ACK */
	113
	114	uint8_t reason; /* reason for ACK */
	115	#define RXRPC_ACK_REQUESTED 1 /* ACK was requested on packet */
	116	#define RXRPC_ACK_DUPLICATE 2 /* duplicate packet received */
	117	#define RXRPC_ACK_OUT_OF_SEQUENCE 3 /* out of sequence packet received */
	118	#define RXRPC_ACK_EXCEEDS_WINDOW 4 /* packet received beyond end of ACK window */
	119	#define RXRPC_ACK_NOSPACE 5 /* packet discarded due to lack of buffer space */
	120	#define RXRPC_ACK_PING 6 /* keep alive ACK */
	121	#define RXRPC_ACK_PING_RESPONSE 7 /* response to RXRPC_ACK_PING */
	122	#define RXRPC_ACK_DELAY 8 /* nothing happened since received packet */
	123	#define RXRPC_ACK_IDLE 9 /* ACK due to fully received ACK window */
	124
	125	uint8_t nAcks; /* number of ACKs */
	126	#define RXRPC_MAXACKS 255
	127
	128	uint8_t acks[0]; /* list of ACK/NAKs */
	129	#define RXRPC_ACK_TYPE_NACK 0
	130	#define RXRPC_ACK_TYPE_ACK 1
	131
bc10502d	132	} __packed;
1da177e4	133
17926a79 DH	134	/*
	135	* ACK packets can have a further piece of information tagged on the end
	136	*/
	137	struct rxrpc_ackinfo {
	138	__be32 rxMTU; /* maximum Rx MTU size (bytes) [AFS 3.3] */
	139	__be32 maxMTU; /* maximum interface MTU size (bytes) [AFS 3.3] */
	140	__be32 rwind; /* Rx window size (packets) [AFS 3.4] */
	141	__be32 jumbo_max; /* max packets to stick into a jumbo packet [AFS 3.5] */
	142	};
	143
	144	/*****************************************************************************/
	145	/*
	146	* Kerberos security type-2 challenge packet
	147	*/
	148	struct rxkad_challenge {
	149	__be32 version; /* version of this challenge type */
	150	__be32 nonce; /* encrypted random number */
	151	__be32 min_level; /* minimum security level */
	152	__be32 __padding; /* padding to 8-byte boundary */
bc10502d	153	} __packed;
17926a79 DH	154
	155	/*****************************************************************************/
	156	/*
	157	* Kerberos security type-2 response packet
	158	*/
	159	struct rxkad_response {
25985edc	160	__be32 version; /* version of this response type */
17926a79 DH	161	__be32 __pad;
	162
	163	/* encrypted bit of the response */
	164	struct {
	165	__be32 epoch; /* current epoch */
	166	__be32 cid; /* parent connection ID */
	167	__be32 checksum; /* checksum */
	168	__be32 securityIndex; /* security type */
	169	__be32 call_id[4]; /* encrypted call IDs */
	170	__be32 inc_nonce; /* challenge nonce + 1 */
	171	__be32 level; /* desired level */
	172	} encrypted;
	173
	174	__be32 kvno; /* Kerberos key version number */
	175	__be32 ticket_len; /* Kerberos ticket length */
bc10502d	176	} __packed;
17926a79 DH	177
	178	/*****************************************************************************/
	179	/*
	180	* RxRPC-level abort codes
	181	*/
	182	#define RX_CALL_DEAD -1 /* call/conn has been inactive and is shut down */
	183	#define RX_INVALID_OPERATION -2 /* invalid operation requested / attempted */
	184	#define RX_CALL_TIMEOUT -3 /* call timeout exceeded */
	185	#define RX_EOF -4 /* unexpected end of data on read op */
	186	#define RX_PROTOCOL_ERROR -5 /* low-level protocol error */
	187	#define RX_USER_ABORT -6 /* generic user abort */
	188	#define RX_ADDRINUSE -7 /* UDP port in use */
	189	#define RX_DEBUGI_BADTYPE -8 /* bad debugging packet type */
	190
651350d1 DH	191	/*
	192	* (un)marshalling abort codes (rxgen)
	193	*/
	194	#define RXGEN_CC_MARSHAL -450
	195	#define RXGEN_CC_UNMARSHAL -451
	196	#define RXGEN_SS_MARSHAL -452
	197	#define RXGEN_SS_UNMARSHAL -453
	198	#define RXGEN_DECODE -454
	199	#define RXGEN_OPCODE -455
	200	#define RXGEN_SS_XDRFREE -456
	201	#define RXGEN_CC_XDRFREE -457
	202
17926a79 DH	203	/*
	204	* Rx kerberos security abort codes
	205	* - unfortunately we have no generalised security abort codes to say things
	206	* like "unsupported security", so we have to use these instead and hope the
	207	* other side understands
	208	*/
	209	#define RXKADINCONSISTENCY 19270400 /* security module structure inconsistent */
	210	#define RXKADPACKETSHORT 19270401 /* packet too short for security challenge */
	211	#define RXKADLEVELFAIL 19270402 /* security level negotiation failed */
	212	#define RXKADTICKETLEN 19270403 /* ticket length too short or too long */
	213	#define RXKADOUTOFSEQUENCE 19270404 /* packet had bad sequence number */
	214	#define RXKADNOAUTH 19270405 /* caller not authorised */
	215	#define RXKADBADKEY 19270406 /* illegal key: bad parity or weak */
	216	#define RXKADBADTICKET 19270407 /* security object was passed a bad ticket */
	217	#define RXKADUNKNOWNKEY 19270408 /* ticket contained unknown key version number */
	218	#define RXKADEXPIRED 19270409 /* authentication expired */
	219	#define RXKADSEALEDINCON 19270410 /* sealed data inconsistent */
	220	#define RXKADDATALEN 19270411 /* user data too long */
	221	#define RXKADILLEGALLEVEL 19270412 /* caller not authorised to use encrypted conns */
	222
1da177e4	223	#endif /* _LINUX_RXRPC_PACKET_H */