^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-or-later */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /* packet.h: Rx packet layout and definitions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Written by David Howells (dhowells@redhat.com)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #ifndef _LINUX_RXRPC_PACKET_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #define _LINUX_RXRPC_PACKET_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) typedef u32 rxrpc_seq_t; /* Rx message sequence number */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) typedef u32 rxrpc_serial_t; /* Rx message serial number */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) typedef __be32 rxrpc_seq_net_t; /* on-the-wire Rx message sequence number */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) typedef __be32 rxrpc_serial_net_t; /* on-the-wire Rx message serial number */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) /*****************************************************************************/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) * on-the-wire Rx packet header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * - all multibyte fields should be in network byte order
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) struct rxrpc_wire_header {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) __be32 epoch; /* client boot timestamp */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define RXRPC_RANDOM_EPOCH 0x80000000 /* Random if set, date-based if not */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) __be32 cid; /* connection and channel ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define RXRPC_MAXCALLS 4 /* max active calls per conn */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define RXRPC_CHANNELMASK (RXRPC_MAXCALLS-1) /* mask for channel ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) #define RXRPC_CIDMASK (~RXRPC_CHANNELMASK) /* mask for connection ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) #define RXRPC_CIDSHIFT ilog2(RXRPC_MAXCALLS) /* shift for connection ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) #define RXRPC_CID_INC (1 << RXRPC_CIDSHIFT) /* connection ID increment */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) __be32 callNumber; /* call ID (0 for connection-level packets) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) __be32 seq; /* sequence number of pkt in call stream */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) __be32 serial; /* serial number of pkt sent to network */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) uint8_t type; /* packet type */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) #define RXRPC_PACKET_TYPE_DATA 1 /* data */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) #define RXRPC_PACKET_TYPE_ACK 2 /* ACK */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) #define RXRPC_PACKET_TYPE_BUSY 3 /* call reject */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) #define RXRPC_PACKET_TYPE_ABORT 4 /* call/connection abort */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) #define RXRPC_PACKET_TYPE_ACKALL 5 /* ACK all outstanding packets on call */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) #define RXRPC_PACKET_TYPE_CHALLENGE 6 /* connection security challenge (SRVR->CLNT) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) #define RXRPC_PACKET_TYPE_RESPONSE 7 /* connection secutity response (CLNT->SRVR) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) #define RXRPC_PACKET_TYPE_DEBUG 8 /* debug info request */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) #define RXRPC_PACKET_TYPE_PARAMS 9 /* Parameter negotiation (unspec'd, ignore) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) #define RXRPC_PACKET_TYPE_10 10 /* Ignored */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #define RXRPC_PACKET_TYPE_11 11 /* Ignored */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) #define RXRPC_PACKET_TYPE_VERSION 13 /* version string request */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) uint8_t flags; /* packet flags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) #define RXRPC_CLIENT_INITIATED 0x01 /* signifies a packet generated by a client */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) #define RXRPC_REQUEST_ACK 0x02 /* request an unconditional ACK of this packet */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) #define RXRPC_LAST_PACKET 0x04 /* the last packet from this side for this call */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) #define RXRPC_MORE_PACKETS 0x08 /* more packets to come */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) #define RXRPC_JUMBO_PACKET 0x20 /* [DATA] this is a jumbo packet */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) #define RXRPC_SLOW_START_OK 0x20 /* [ACK] slow start supported */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) uint8_t userStatus; /* app-layer defined status */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) #define RXRPC_USERSTATUS_SERVICE_UPGRADE 0x01 /* AuriStor service upgrade request */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) uint8_t securityIndex; /* security protocol ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) union {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) __be16 _rsvd; /* reserved */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) __be16 cksum; /* kerberos security checksum */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) __be16 serviceId; /* service ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) /*****************************************************************************/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) * jumbo packet secondary header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) * - can be mapped to read header by:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) * - new_serial = serial + 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) * - new_seq = seq + 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) * - new_flags = j_flags
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) * - new__rsvd = j__rsvd
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) * - duplicating all other fields
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) struct rxrpc_jumbo_header {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) uint8_t flags; /* packet flags (as per rxrpc_header) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) uint8_t pad;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) union {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) __be16 _rsvd; /* reserved */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) __be16 cksum; /* kerberos security checksum */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) #define RXRPC_JUMBO_DATALEN 1412 /* non-terminal jumbo packet data length */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) #define RXRPC_JUMBO_SUBPKTLEN (RXRPC_JUMBO_DATALEN + sizeof(struct rxrpc_jumbo_header))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) * The maximum number of subpackets that can possibly fit in a UDP packet is:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) * ((max_IP - IP_hdr - UDP_hdr) / RXRPC_JUMBO_SUBPKTLEN) + 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) * = ((65535 - 28 - 28) / 1416) + 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) * = 46 non-terminal packets and 1 terminal packet.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) #define RXRPC_MAX_NR_JUMBO 47
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) /*****************************************************************************/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) * on-the-wire Rx ACK packet data payload
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) * - all multibyte fields should be in network byte order
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) struct rxrpc_ackpacket {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) __be16 bufferSpace; /* number of packet buffers available */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) __be16 maxSkew; /* diff between serno being ACK'd and highest serial no
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) * received */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) __be32 firstPacket; /* sequence no of first ACK'd packet in attached list */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) __be32 previousPacket; /* sequence no of previous packet received */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) __be32 serial; /* serial no of packet that prompted this ACK */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) uint8_t reason; /* reason for ACK */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) #define RXRPC_ACK_REQUESTED 1 /* ACK was requested on packet */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) #define RXRPC_ACK_DUPLICATE 2 /* duplicate packet received */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) #define RXRPC_ACK_OUT_OF_SEQUENCE 3 /* out of sequence packet received */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) #define RXRPC_ACK_EXCEEDS_WINDOW 4 /* packet received beyond end of ACK window */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) #define RXRPC_ACK_NOSPACE 5 /* packet discarded due to lack of buffer space */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) #define RXRPC_ACK_PING 6 /* keep alive ACK */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #define RXRPC_ACK_PING_RESPONSE 7 /* response to RXRPC_ACK_PING */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) #define RXRPC_ACK_DELAY 8 /* nothing happened since received packet */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define RXRPC_ACK_IDLE 9 /* ACK due to fully received ACK window */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) #define RXRPC_ACK__INVALID 10 /* Representation of invalid ACK reason */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) uint8_t nAcks; /* number of ACKs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) #define RXRPC_MAXACKS 255
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) uint8_t acks[0]; /* list of ACK/NAKs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) #define RXRPC_ACK_TYPE_NACK 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) #define RXRPC_ACK_TYPE_ACK 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) /* Some ACKs refer to specific packets and some are general and can be updated. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) #define RXRPC_ACK_UPDATEABLE ((1 << RXRPC_ACK_REQUESTED) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) (1 << RXRPC_ACK_PING_RESPONSE) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) (1 << RXRPC_ACK_DELAY) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) (1 << RXRPC_ACK_IDLE))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) * ACK packets can have a further piece of information tagged on the end
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) struct rxrpc_ackinfo {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) __be32 rxMTU; /* maximum Rx MTU size (bytes) [AFS 3.3] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) __be32 maxMTU; /* maximum interface MTU size (bytes) [AFS 3.3] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) __be32 rwind; /* Rx window size (packets) [AFS 3.4] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) __be32 jumbo_max; /* max packets to stick into a jumbo packet [AFS 3.5] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) /*****************************************************************************/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) * Kerberos security type-2 challenge packet
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) struct rxkad_challenge {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) __be32 version; /* version of this challenge type */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) __be32 nonce; /* encrypted random number */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) __be32 min_level; /* minimum security level */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) __be32 __padding; /* padding to 8-byte boundary */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) /*****************************************************************************/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) * Kerberos security type-2 response packet
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) struct rxkad_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) __be32 version; /* version of this response type */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) __be32 __pad;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) /* encrypted bit of the response */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) struct {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) __be32 epoch; /* current epoch */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) __be32 cid; /* parent connection ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) __be32 checksum; /* checksum */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) __be32 securityIndex; /* security type */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) __be32 call_id[4]; /* encrypted call IDs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) __be32 inc_nonce; /* challenge nonce + 1 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) __be32 level; /* desired level */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) } encrypted;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) __be32 kvno; /* Kerberos key version number */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) __be32 ticket_len; /* Kerberos ticket length */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) #endif /* _LINUX_RXRPC_PACKET_H */