Linux Audio

Check our new training course

Loading...
v5.9
   1/* SPDX-License-Identifier: GPL-2.0-or-later */
   2/* AF_RXRPC internal definitions
   3 *
   4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
   5 * Written by David Howells (dhowells@redhat.com)
   6 */
   7
   8#include <linux/atomic.h>
   9#include <linux/seqlock.h>
  10#include <linux/win_minmax.h>
  11#include <net/net_namespace.h>
  12#include <net/netns/generic.h>
  13#include <net/sock.h>
  14#include <net/af_rxrpc.h>
 
  15#include "protocol.h"
  16
  17#if 0
  18#define CHECK_SLAB_OKAY(X)				     \
  19	BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
  20	       (POISON_FREE << 8 | POISON_FREE))
  21#else
  22#define CHECK_SLAB_OKAY(X) do {} while (0)
  23#endif
  24
  25#define FCRYPT_BSIZE 8
  26struct rxrpc_crypt {
  27	union {
  28		u8	x[FCRYPT_BSIZE];
  29		__be32	n[2];
  30	};
  31} __attribute__((aligned(8)));
  32
  33#define rxrpc_queue_work(WS)	queue_work(rxrpc_workqueue, (WS))
  34#define rxrpc_queue_delayed_work(WS,D)	\
  35	queue_delayed_work(rxrpc_workqueue, (WS), (D))
  36
 
  37struct rxrpc_connection;
  38
  39/*
  40 * Mark applied to socket buffers in skb->mark.  skb->priority is used
  41 * to pass supplementary information.
  42 */
  43enum rxrpc_skb_mark {
  44	RXRPC_SKB_MARK_REJECT_BUSY,	/* Reject with BUSY */
  45	RXRPC_SKB_MARK_REJECT_ABORT,	/* Reject with ABORT (code in skb->priority) */
  46};
  47
  48/*
  49 * sk_state for RxRPC sockets
  50 */
  51enum {
  52	RXRPC_UNBOUND = 0,
  53	RXRPC_CLIENT_UNBOUND,		/* Unbound socket used as client */
  54	RXRPC_CLIENT_BOUND,		/* client local address bound */
  55	RXRPC_SERVER_BOUND,		/* server local address bound */
  56	RXRPC_SERVER_BOUND2,		/* second server local address bound */
  57	RXRPC_SERVER_LISTENING,		/* server listening for connections */
  58	RXRPC_SERVER_LISTEN_DISABLED,	/* server listening disabled */
  59	RXRPC_CLOSE,			/* socket is being closed */
  60};
  61
  62/*
  63 * Per-network namespace data.
  64 */
  65struct rxrpc_net {
  66	struct proc_dir_entry	*proc_net;	/* Subdir in /proc/net */
  67	u32			epoch;		/* Local epoch for detecting local-end reset */
  68	struct list_head	calls;		/* List of calls active in this namespace */
  69	rwlock_t		call_lock;	/* Lock for ->calls */
  70	atomic_t		nr_calls;	/* Count of allocated calls */
  71
  72	atomic_t		nr_conns;
  73	struct list_head	conn_proc_list;	/* List of conns in this namespace for proc */
  74	struct list_head	service_conns;	/* Service conns in this namespace */
  75	rwlock_t		conn_lock;	/* Lock for ->conn_proc_list, ->service_conns */
  76	struct work_struct	service_conn_reaper;
  77	struct timer_list	service_conn_reap_timer;
  78
  79	unsigned int		nr_client_conns;
  80	unsigned int		nr_active_client_conns;
  81	bool			kill_all_client_conns;
  82	bool			live;
 
 
 
  83	spinlock_t		client_conn_cache_lock; /* Lock for ->*_client_conns */
  84	spinlock_t		client_conn_discard_lock; /* Prevent multiple discarders */
  85	struct list_head	waiting_client_conns;
  86	struct list_head	active_client_conns;
  87	struct list_head	idle_client_conns;
  88	struct work_struct	client_conn_reaper;
  89	struct timer_list	client_conn_reap_timer;
  90
  91	struct list_head	local_endpoints;
  92	struct mutex		local_mutex;	/* Lock for ->local_endpoints */
  93
  94	DECLARE_HASHTABLE	(peer_hash, 10);
  95	spinlock_t		peer_hash_lock;	/* Lock for ->peer_hash */
  96
  97#define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
  98	u8			peer_keepalive_cursor;
  99	time64_t		peer_keepalive_base;
 100	struct list_head	peer_keepalive[32];
 101	struct list_head	peer_keepalive_new;
 102	struct timer_list	peer_keepalive_timer;
 103	struct work_struct	peer_keepalive_work;
 104};
 105
 106/*
 107 * Service backlog preallocation.
 108 *
 109 * This contains circular buffers of preallocated peers, connections and calls
 110 * for incoming service calls and their head and tail pointers.  This allows
 111 * calls to be set up in the data_ready handler, thereby avoiding the need to
 112 * shuffle packets around so much.
 113 */
 114struct rxrpc_backlog {
 115	unsigned short		peer_backlog_head;
 116	unsigned short		peer_backlog_tail;
 117	unsigned short		conn_backlog_head;
 118	unsigned short		conn_backlog_tail;
 119	unsigned short		call_backlog_head;
 120	unsigned short		call_backlog_tail;
 121#define RXRPC_BACKLOG_MAX	32
 122	struct rxrpc_peer	*peer_backlog[RXRPC_BACKLOG_MAX];
 123	struct rxrpc_connection	*conn_backlog[RXRPC_BACKLOG_MAX];
 124	struct rxrpc_call	*call_backlog[RXRPC_BACKLOG_MAX];
 125};
 126
 127/*
 128 * RxRPC socket definition
 129 */
 130struct rxrpc_sock {
 131	/* WARNING: sk has to be the first member */
 132	struct sock		sk;
 133	rxrpc_notify_new_call_t	notify_new_call; /* Func to notify of new call */
 134	rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
 135	struct rxrpc_local	*local;		/* local endpoint */
 136	struct rxrpc_backlog	*backlog;	/* Preallocation for services */
 137	spinlock_t		incoming_lock;	/* Incoming call vs service shutdown lock */
 138	struct list_head	sock_calls;	/* List of calls owned by this socket */
 139	struct list_head	to_be_accepted;	/* calls awaiting acceptance */
 140	struct list_head	recvmsg_q;	/* Calls awaiting recvmsg's attention  */
 141	rwlock_t		recvmsg_lock;	/* Lock for recvmsg_q */
 142	struct key		*key;		/* security for this socket */
 143	struct key		*securities;	/* list of server security descriptors */
 144	struct rb_root		calls;		/* User ID -> call mapping */
 145	unsigned long		flags;
 146#define RXRPC_SOCK_CONNECTED		0	/* connect_srx is set */
 147	rwlock_t		call_lock;	/* lock for calls */
 148	u32			min_sec_level;	/* minimum security level */
 149#define RXRPC_SECURITY_MAX	RXRPC_SECURITY_ENCRYPT
 150	bool			exclusive;	/* Exclusive connection for a client socket */
 151	u16			second_service;	/* Additional service bound to the endpoint */
 152	struct {
 153		/* Service upgrade information */
 154		u16		from;		/* Service ID to upgrade (if not 0) */
 155		u16		to;		/* service ID to upgrade to */
 156	} service_upgrade;
 157	sa_family_t		family;		/* Protocol family created with */
 158	struct sockaddr_rxrpc	srx;		/* Primary Service/local addresses */
 159	struct sockaddr_rxrpc	connect_srx;	/* Default client address from connect() */
 160};
 161
 162#define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
 163
 164/*
 165 * CPU-byteorder normalised Rx packet header.
 166 */
 167struct rxrpc_host_header {
 168	u32		epoch;		/* client boot timestamp */
 169	u32		cid;		/* connection and channel ID */
 170	u32		callNumber;	/* call ID (0 for connection-level packets) */
 171	u32		seq;		/* sequence number of pkt in call stream */
 172	u32		serial;		/* serial number of pkt sent to network */
 173	u8		type;		/* packet type */
 174	u8		flags;		/* packet flags */
 175	u8		userStatus;	/* app-layer defined status */
 176	u8		securityIndex;	/* security protocol ID */
 177	union {
 178		u16	_rsvd;		/* reserved */
 179		u16	cksum;		/* kerberos security checksum */
 180	};
 181	u16		serviceId;	/* service ID */
 182} __packed;
 183
 184/*
 185 * RxRPC socket buffer private variables
 186 * - max 48 bytes (struct sk_buff::cb)
 187 */
 188struct rxrpc_skb_priv {
 189	atomic_t	nr_ring_pins;		/* Number of rxtx ring pins */
 190	u8		nr_subpackets;		/* Number of subpackets */
 191	u8		rx_flags;		/* Received packet flags */
 192#define RXRPC_SKB_INCL_LAST	0x01		/* - Includes last packet */
 193#define RXRPC_SKB_TX_BUFFER	0x02		/* - Is transmit buffer */
 194	union {
 195		int		remain;		/* amount of space remaining for next write */
 196
 197		/* List of requested ACKs on subpackets */
 198		unsigned long	rx_req_ack[(RXRPC_MAX_NR_JUMBO + BITS_PER_LONG - 1) /
 199					   BITS_PER_LONG];
 200	};
 201
 202	struct rxrpc_host_header hdr;		/* RxRPC packet header from this packet */
 203};
 204
 205#define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
 206
 207/*
 208 * RxRPC security module interface
 209 */
 210struct rxrpc_security {
 211	const char		*name;		/* name of this service */
 212	u8			security_index;	/* security type provided */
 213	u32			no_key_abort;	/* Abort code indicating no key */
 214
 215	/* Initialise a security service */
 216	int (*init)(void);
 217
 218	/* Clean up a security service */
 219	void (*exit)(void);
 220
 
 
 
 
 
 
 
 
 
 
 
 
 221	/* initialise a connection's security */
 222	int (*init_connection_security)(struct rxrpc_connection *);
 
 223
 224	/* prime a connection's packet security */
 225	int (*prime_packet_security)(struct rxrpc_connection *);
 
 
 
 226
 227	/* impose security on a packet */
 228	int (*secure_packet)(struct rxrpc_call *,
 229			     struct sk_buff *,
 230			     size_t,
 231			     void *);
 232
 233	/* verify the security on a received packet */
 234	int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
 235			     unsigned int, unsigned int, rxrpc_seq_t, u16);
 236
 237	/* Free crypto request on a call */
 238	void (*free_call_crypto)(struct rxrpc_call *);
 239
 240	/* Locate the data in a received packet that has been verified. */
 241	void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
 242			    unsigned int *, unsigned int *);
 243
 244	/* issue a challenge */
 245	int (*issue_challenge)(struct rxrpc_connection *);
 246
 247	/* respond to a challenge */
 248	int (*respond_to_challenge)(struct rxrpc_connection *,
 249				    struct sk_buff *,
 250				    u32 *);
 251
 252	/* verify a response */
 253	int (*verify_response)(struct rxrpc_connection *,
 254			       struct sk_buff *,
 255			       u32 *);
 256
 257	/* clear connection security */
 258	void (*clear)(struct rxrpc_connection *);
 259};
 260
 261/*
 262 * RxRPC local transport endpoint description
 263 * - owned by a single AF_RXRPC socket
 264 * - pointed to by transport socket struct sk_user_data
 265 */
 266struct rxrpc_local {
 267	struct rcu_head		rcu;
 268	atomic_t		active_users;	/* Number of users of the local endpoint */
 269	atomic_t		usage;		/* Number of references to the structure */
 270	struct rxrpc_net	*rxnet;		/* The network ns in which this resides */
 271	struct list_head	link;
 272	struct socket		*socket;	/* my UDP socket */
 273	struct work_struct	processor;
 274	struct rxrpc_sock __rcu	*service;	/* Service(s) listening on this endpoint */
 275	struct rw_semaphore	defrag_sem;	/* control re-enablement of IP DF bit */
 276	struct sk_buff_head	reject_queue;	/* packets awaiting rejection */
 277	struct sk_buff_head	event_queue;	/* endpoint event packets awaiting processing */
 278	struct rb_root		client_conns;	/* Client connections by socket params */
 279	spinlock_t		client_conns_lock; /* Lock for client_conns */
 280	spinlock_t		lock;		/* access lock */
 281	rwlock_t		services_lock;	/* lock for services list */
 282	int			debug_id;	/* debug ID for printks */
 283	bool			dead;
 284	bool			service_closed;	/* Service socket closed */
 285	struct sockaddr_rxrpc	srx;		/* local address */
 286};
 287
 288/*
 289 * RxRPC remote transport endpoint definition
 290 * - matched by local endpoint, remote port, address and protocol type
 291 */
 292struct rxrpc_peer {
 293	struct rcu_head		rcu;		/* This must be first */
 294	atomic_t		usage;
 295	unsigned long		hash_key;
 296	struct hlist_node	hash_link;
 297	struct rxrpc_local	*local;
 298	struct hlist_head	error_targets;	/* targets for net error distribution */
 299	struct rb_root		service_conns;	/* Service connections */
 300	struct list_head	keepalive_link;	/* Link in net->peer_keepalive[] */
 301	time64_t		last_tx_at;	/* Last time packet sent here */
 302	seqlock_t		service_conn_lock;
 303	spinlock_t		lock;		/* access lock */
 304	unsigned int		if_mtu;		/* interface MTU for this peer */
 305	unsigned int		mtu;		/* network MTU for this peer */
 306	unsigned int		maxdata;	/* data size (MTU - hdrsize) */
 307	unsigned short		hdrsize;	/* header size (IP + UDP + RxRPC) */
 308	int			debug_id;	/* debug ID for printks */
 309	struct sockaddr_rxrpc	srx;		/* remote address */
 310
 311	/* calculated RTT cache */
 312#define RXRPC_RTT_CACHE_SIZE 32
 313	spinlock_t		rtt_input_lock;	/* RTT lock for input routine */
 314	ktime_t			rtt_last_req;	/* Time of last RTT request */
 315	unsigned int		rtt_count;	/* Number of samples we've got */
 316
 317	u32			srtt_us;	/* smoothed round trip time << 3 in usecs */
 318	u32			mdev_us;	/* medium deviation			*/
 319	u32			mdev_max_us;	/* maximal mdev for the last rtt period	*/
 320	u32			rttvar_us;	/* smoothed mdev_max			*/
 321	u32			rto_j;		/* Retransmission timeout in jiffies */
 322	u8			backoff;	/* Backoff timeout */
 323
 324	u8			cong_cwnd;	/* Congestion window size */
 325};
 326
 327/*
 328 * Keys for matching a connection.
 329 */
 330struct rxrpc_conn_proto {
 331	union {
 332		struct {
 333			u32	epoch;		/* epoch of this connection */
 334			u32	cid;		/* connection ID */
 335		};
 336		u64		index_key;
 337	};
 338};
 339
 340struct rxrpc_conn_parameters {
 341	struct rxrpc_local	*local;		/* Representation of local endpoint */
 342	struct rxrpc_peer	*peer;		/* Remote endpoint */
 343	struct key		*key;		/* Security details */
 344	bool			exclusive;	/* T if conn is exclusive */
 345	bool			upgrade;	/* T if service ID can be upgraded */
 346	u16			service_id;	/* Service ID for this connection */
 347	u32			security_level;	/* Security level selected */
 348};
 349
 350/*
 351 * Bits in the connection flags.
 352 */
 353enum rxrpc_conn_flag {
 354	RXRPC_CONN_HAS_IDR,		/* Has a client conn ID assigned */
 355	RXRPC_CONN_IN_SERVICE_CONNS,	/* Conn is in peer->service_conns */
 356	RXRPC_CONN_IN_CLIENT_CONNS,	/* Conn is in local->client_conns */
 357	RXRPC_CONN_EXPOSED,		/* Conn has extra ref for exposure */
 358	RXRPC_CONN_DONT_REUSE,		/* Don't reuse this connection */
 359	RXRPC_CONN_COUNTED,		/* Counted by rxrpc_nr_client_conns */
 360	RXRPC_CONN_PROBING_FOR_UPGRADE,	/* Probing for service upgrade */
 361	RXRPC_CONN_FINAL_ACK_0,		/* Need final ACK for channel 0 */
 362	RXRPC_CONN_FINAL_ACK_1,		/* Need final ACK for channel 1 */
 363	RXRPC_CONN_FINAL_ACK_2,		/* Need final ACK for channel 2 */
 364	RXRPC_CONN_FINAL_ACK_3,		/* Need final ACK for channel 3 */
 365};
 366
 367#define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) |	\
 368				   (1UL << RXRPC_CONN_FINAL_ACK_1) |	\
 369				   (1UL << RXRPC_CONN_FINAL_ACK_2) |	\
 370				   (1UL << RXRPC_CONN_FINAL_ACK_3))
 371
 372/*
 373 * Events that can be raised upon a connection.
 374 */
 375enum rxrpc_conn_event {
 376	RXRPC_CONN_EV_CHALLENGE,	/* Send challenge packet */
 377};
 378
 379/*
 380 * The connection cache state.
 381 */
 382enum rxrpc_conn_cache_state {
 383	RXRPC_CONN_CLIENT_INACTIVE,	/* Conn is not yet listed */
 384	RXRPC_CONN_CLIENT_WAITING,	/* Conn is on wait list, waiting for capacity */
 385	RXRPC_CONN_CLIENT_ACTIVE,	/* Conn is on active list, doing calls */
 386	RXRPC_CONN_CLIENT_UPGRADE,	/* Conn is on active list, probing for upgrade */
 387	RXRPC_CONN_CLIENT_CULLED,	/* Conn is culled and delisted, doing calls */
 388	RXRPC_CONN_CLIENT_IDLE,		/* Conn is on idle list, doing mostly nothing */
 389	RXRPC_CONN__NR_CACHE_STATES
 390};
 391
 392/*
 393 * The connection protocol state.
 394 */
 395enum rxrpc_conn_proto_state {
 396	RXRPC_CONN_UNUSED,		/* Connection not yet attempted */
 397	RXRPC_CONN_CLIENT,		/* Client connection */
 398	RXRPC_CONN_SERVICE_PREALLOC,	/* Service connection preallocation */
 399	RXRPC_CONN_SERVICE_UNSECURED,	/* Service unsecured connection */
 400	RXRPC_CONN_SERVICE_CHALLENGING,	/* Service challenging for security */
 401	RXRPC_CONN_SERVICE,		/* Service secured connection */
 402	RXRPC_CONN_REMOTELY_ABORTED,	/* Conn aborted by peer */
 403	RXRPC_CONN_LOCALLY_ABORTED,	/* Conn aborted locally */
 404	RXRPC_CONN__NR_STATES
 405};
 406
 407/*
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 408 * RxRPC connection definition
 409 * - matched by { local, peer, epoch, conn_id, direction }
 410 * - each connection can only handle four simultaneous calls
 411 */
 412struct rxrpc_connection {
 413	struct rxrpc_conn_proto	proto;
 414	struct rxrpc_conn_parameters params;
 415
 416	atomic_t		usage;
 417	struct rcu_head		rcu;
 418	struct list_head	cache_link;
 419
 420	spinlock_t		channel_lock;
 421	unsigned char		active_chans;	/* Mask of active channels */
 422#define RXRPC_ACTIVE_CHANS_MASK	((1 << RXRPC_MAXCALLS) - 1)
 423	struct list_head	waiting_calls;	/* Calls waiting for channels */
 424	struct rxrpc_channel {
 425		unsigned long		final_ack_at;	/* Time at which to issue final ACK */
 426		struct rxrpc_call __rcu	*call;		/* Active call */
 427		unsigned int		call_debug_id;	/* call->debug_id */
 428		u32			call_id;	/* ID of current call */
 429		u32			call_counter;	/* Call ID counter */
 430		u32			last_call;	/* ID of last call */
 431		u8			last_type;	/* Type of last packet */
 432		union {
 433			u32		last_seq;
 434			u32		last_abort;
 435		};
 436	} channels[RXRPC_MAXCALLS];
 437
 438	struct timer_list	timer;		/* Conn event timer */
 439	struct work_struct	processor;	/* connection event processor */
 440	union {
 441		struct rb_node	client_node;	/* Node in local->client_conns */
 442		struct rb_node	service_node;	/* Node in peer->service_conns */
 443	};
 444	struct list_head	proc_link;	/* link in procfs list */
 445	struct list_head	link;		/* link in master connection list */
 446	struct sk_buff_head	rx_queue;	/* received conn-level packets */
 
 447	const struct rxrpc_security *security;	/* applied security module */
 448	struct key		*server_key;	/* security for this service */
 449	struct crypto_sync_skcipher *cipher;	/* encryption handle */
 450	struct rxrpc_crypt	csum_iv;	/* packet checksum base */
 
 
 
 
 451	unsigned long		flags;
 452	unsigned long		events;
 453	unsigned long		idle_timestamp;	/* Time at which last became idle */
 454	spinlock_t		state_lock;	/* state-change lock */
 455	enum rxrpc_conn_cache_state cache_state;
 456	enum rxrpc_conn_proto_state state;	/* current state of connection */
 457	u32			abort_code;	/* Abort code of connection abort */
 458	int			debug_id;	/* debug ID for printks */
 459	atomic_t		serial;		/* packet serial number counter */
 460	unsigned int		hi_serial;	/* highest serial number received */
 461	u32			security_nonce;	/* response re-use preventer */
 462	u32			service_id;	/* Service ID, possibly upgraded */
 463	u8			size_align;	/* data size alignment (for security) */
 464	u8			security_size;	/* security header size */
 465	u8			security_ix;	/* security type */
 466	u8			out_clientflag;	/* RXRPC_CLIENT_INITIATED if we are client */
 
 467	short			error;		/* Local error code */
 468};
 469
 470static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
 471{
 472	return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
 473}
 474
 475static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
 476{
 477	return !rxrpc_to_server(sp);
 478}
 479
 480/*
 481 * Flags in call->flags.
 482 */
 483enum rxrpc_call_flag {
 484	RXRPC_CALL_RELEASED,		/* call has been released - no more message to userspace */
 485	RXRPC_CALL_HAS_USERID,		/* has a user ID attached */
 486	RXRPC_CALL_IS_SERVICE,		/* Call is service call */
 487	RXRPC_CALL_EXPOSED,		/* The call was exposed to the world */
 488	RXRPC_CALL_RX_LAST,		/* Received the last packet (at rxtx_top) */
 489	RXRPC_CALL_TX_LAST,		/* Last packet in Tx buffer (at rxtx_top) */
 490	RXRPC_CALL_SEND_PING,		/* A ping will need to be sent */
 491	RXRPC_CALL_RETRANS_TIMEOUT,	/* Retransmission due to timeout occurred */
 492	RXRPC_CALL_BEGAN_RX_TIMER,	/* We began the expect_rx_by timer */
 493	RXRPC_CALL_RX_HEARD,		/* The peer responded at least once to this call */
 494	RXRPC_CALL_RX_UNDERRUN,		/* Got data underrun */
 495	RXRPC_CALL_DISCONNECTED,	/* The call has been disconnected */
 
 
 496};
 497
 498/*
 499 * Events that can be raised on a call.
 500 */
 501enum rxrpc_call_event {
 502	RXRPC_CALL_EV_ACK,		/* need to generate ACK */
 503	RXRPC_CALL_EV_ABORT,		/* need to generate abort */
 504	RXRPC_CALL_EV_RESEND,		/* Tx resend required */
 505	RXRPC_CALL_EV_PING,		/* Ping send required */
 506	RXRPC_CALL_EV_EXPIRED,		/* Expiry occurred */
 507	RXRPC_CALL_EV_ACK_LOST,		/* ACK may be lost, send ping */
 508};
 509
 510/*
 511 * The states that a call can be in.
 512 */
 513enum rxrpc_call_state {
 514	RXRPC_CALL_UNINITIALISED,
 515	RXRPC_CALL_CLIENT_AWAIT_CONN,	/* - client waiting for connection to become available */
 516	RXRPC_CALL_CLIENT_SEND_REQUEST,	/* - client sending request phase */
 517	RXRPC_CALL_CLIENT_AWAIT_REPLY,	/* - client awaiting reply */
 518	RXRPC_CALL_CLIENT_RECV_REPLY,	/* - client receiving reply phase */
 519	RXRPC_CALL_SERVER_PREALLOC,	/* - service preallocation */
 520	RXRPC_CALL_SERVER_SECURING,	/* - server securing request connection */
 521	RXRPC_CALL_SERVER_RECV_REQUEST,	/* - server receiving request */
 522	RXRPC_CALL_SERVER_ACK_REQUEST,	/* - server pending ACK of request */
 523	RXRPC_CALL_SERVER_SEND_REPLY,	/* - server sending reply */
 524	RXRPC_CALL_SERVER_AWAIT_ACK,	/* - server awaiting final ACK */
 525	RXRPC_CALL_COMPLETE,		/* - call complete */
 526	NR__RXRPC_CALL_STATES
 527};
 528
 529/*
 530 * Call completion condition (state == RXRPC_CALL_COMPLETE).
 531 */
 532enum rxrpc_call_completion {
 533	RXRPC_CALL_SUCCEEDED,		/* - Normal termination */
 534	RXRPC_CALL_REMOTELY_ABORTED,	/* - call aborted by peer */
 535	RXRPC_CALL_LOCALLY_ABORTED,	/* - call aborted locally on error or close */
 536	RXRPC_CALL_LOCAL_ERROR,		/* - call failed due to local error */
 537	RXRPC_CALL_NETWORK_ERROR,	/* - call terminated by network error */
 538	NR__RXRPC_CALL_COMPLETIONS
 539};
 540
 541/*
 542 * Call Tx congestion management modes.
 543 */
 544enum rxrpc_congest_mode {
 545	RXRPC_CALL_SLOW_START,
 546	RXRPC_CALL_CONGEST_AVOIDANCE,
 547	RXRPC_CALL_PACKET_LOSS,
 548	RXRPC_CALL_FAST_RETRANSMIT,
 549	NR__RXRPC_CONGEST_MODES
 550};
 551
 552/*
 553 * RxRPC call definition
 554 * - matched by { connection, call_id }
 555 */
 556struct rxrpc_call {
 557	struct rcu_head		rcu;
 558	struct rxrpc_connection	*conn;		/* connection carrying call */
 559	struct rxrpc_peer	*peer;		/* Peer record for remote address */
 560	struct rxrpc_sock __rcu	*socket;	/* socket responsible */
 561	struct rxrpc_net	*rxnet;		/* Network namespace to which call belongs */
 562	const struct rxrpc_security *security;	/* applied security module */
 563	struct mutex		user_mutex;	/* User access mutex */
 564	unsigned long		ack_at;		/* When deferred ACK needs to happen */
 565	unsigned long		ack_lost_at;	/* When ACK is figured as lost */
 566	unsigned long		resend_at;	/* When next resend needs to happen */
 567	unsigned long		ping_at;	/* When next to send a ping */
 568	unsigned long		keepalive_at;	/* When next to send a keepalive ping */
 569	unsigned long		expect_rx_by;	/* When we expect to get a packet by */
 570	unsigned long		expect_req_by;	/* When we expect to get a request DATA packet by */
 571	unsigned long		expect_term_by;	/* When we expect call termination by */
 572	u32			next_rx_timo;	/* Timeout for next Rx packet (jif) */
 573	u32			next_req_timo;	/* Timeout for next Rx request packet (jif) */
 574	struct skcipher_request	*cipher_req;	/* Packet cipher request buffer */
 575	struct timer_list	timer;		/* Combined event timer */
 576	struct work_struct	processor;	/* Event processor */
 577	rxrpc_notify_rx_t	notify_rx;	/* kernel service Rx notification function */
 578	struct list_head	link;		/* link in master call list */
 579	struct list_head	chan_wait_link;	/* Link in conn->waiting_calls */
 580	struct hlist_node	error_link;	/* link in error distribution list */
 581	struct list_head	accept_link;	/* Link in rx->acceptq */
 582	struct list_head	recvmsg_link;	/* Link in rx->recvmsg_q */
 583	struct list_head	sock_link;	/* Link in rx->sock_calls */
 584	struct rb_node		sock_node;	/* Node in rx->calls */
 585	struct sk_buff		*tx_pending;	/* Tx socket buffer being filled */
 586	wait_queue_head_t	waitq;		/* Wait queue for channel or Tx */
 587	s64			tx_total_len;	/* Total length left to be transmitted (or -1) */
 588	__be32			crypto_buf[2];	/* Temporary packet crypto buffer */
 589	unsigned long		user_call_ID;	/* user-defined call ID */
 590	unsigned long		flags;
 591	unsigned long		events;
 592	spinlock_t		lock;
 593	spinlock_t		notify_lock;	/* Kernel notification lock */
 594	rwlock_t		state_lock;	/* lock for state transition */
 595	u32			abort_code;	/* Local/remote abort code */
 596	int			error;		/* Local error incurred */
 597	enum rxrpc_call_state	state;		/* current state of call */
 598	enum rxrpc_call_completion completion;	/* Call completion condition */
 599	atomic_t		usage;
 600	u16			service_id;	/* service ID */
 601	u8			security_ix;	/* Security type */
 602	enum rxrpc_interruptibility interruptibility; /* At what point call may be interrupted */
 603	u32			call_id;	/* call ID on connection  */
 604	u32			cid;		/* connection ID plus channel index */
 605	int			debug_id;	/* debug ID for printks */
 606	unsigned short		rx_pkt_offset;	/* Current recvmsg packet offset */
 607	unsigned short		rx_pkt_len;	/* Current recvmsg packet len */
 608	bool			rx_pkt_last;	/* Current recvmsg packet is last */
 609
 610	/* Rx/Tx circular buffer, depending on phase.
 611	 *
 612	 * In the Rx phase, packets are annotated with 0 or the number of the
 613	 * segment of a jumbo packet each buffer refers to.  There can be up to
 614	 * 47 segments in a maximum-size UDP packet.
 615	 *
 616	 * In the Tx phase, packets are annotated with which buffers have been
 617	 * acked.
 618	 */
 619#define RXRPC_RXTX_BUFF_SIZE	64
 620#define RXRPC_RXTX_BUFF_MASK	(RXRPC_RXTX_BUFF_SIZE - 1)
 621#define RXRPC_INIT_RX_WINDOW_SIZE 63
 622	struct sk_buff		**rxtx_buffer;
 623	u8			*rxtx_annotations;
 624#define RXRPC_TX_ANNO_ACK	0
 625#define RXRPC_TX_ANNO_UNACK	1
 626#define RXRPC_TX_ANNO_NAK	2
 627#define RXRPC_TX_ANNO_RETRANS	3
 628#define RXRPC_TX_ANNO_MASK	0x03
 629#define RXRPC_TX_ANNO_LAST	0x04
 630#define RXRPC_TX_ANNO_RESENT	0x08
 631
 632#define RXRPC_RX_ANNO_SUBPACKET	0x3f		/* Subpacket number in jumbogram */
 633#define RXRPC_RX_ANNO_VERIFIED	0x80		/* Set if verified and decrypted */
 634	rxrpc_seq_t		tx_hard_ack;	/* Dead slot in buffer; the first transmitted but
 635						 * not hard-ACK'd packet follows this.
 636						 */
 637	rxrpc_seq_t		tx_top;		/* Highest Tx slot allocated. */
 638	u16			tx_backoff;	/* Delay to insert due to Tx failure */
 639
 640	/* TCP-style slow-start congestion control [RFC5681].  Since the SMSS
 641	 * is fixed, we keep these numbers in terms of segments (ie. DATA
 642	 * packets) rather than bytes.
 643	 */
 644#define RXRPC_TX_SMSS		RXRPC_JUMBO_DATALEN
 645	u8			cong_cwnd;	/* Congestion window size */
 646	u8			cong_extra;	/* Extra to send for congestion management */
 647	u8			cong_ssthresh;	/* Slow-start threshold */
 648	enum rxrpc_congest_mode	cong_mode:8;	/* Congestion management mode */
 649	u8			cong_dup_acks;	/* Count of ACKs showing missing packets */
 650	u8			cong_cumul_acks; /* Cumulative ACK count */
 651	ktime_t			cong_tstamp;	/* Last time cwnd was changed */
 652
 653	rxrpc_seq_t		rx_hard_ack;	/* Dead slot in buffer; the first received but not
 654						 * consumed packet follows this.
 655						 */
 656	rxrpc_seq_t		rx_top;		/* Highest Rx slot allocated. */
 657	rxrpc_seq_t		rx_expect_next;	/* Expected next packet sequence number */
 658	rxrpc_serial_t		rx_serial;	/* Highest serial received for this call */
 659	u8			rx_winsize;	/* Size of Rx window */
 660	u8			tx_winsize;	/* Maximum size of Tx window */
 661	bool			tx_phase;	/* T if transmission phase, F if receive phase */
 662	u8			nr_jumbo_bad;	/* Number of jumbo dups/exceeds-windows */
 663
 664	spinlock_t		input_lock;	/* Lock for packet input to this call */
 665
 666	/* receive-phase ACK management */
 667	u8			ackr_reason;	/* reason to ACK */
 668	rxrpc_serial_t		ackr_serial;	/* serial of packet being ACK'd */
 669	rxrpc_serial_t		ackr_first_seq;	/* first sequence number received */
 670	rxrpc_seq_t		ackr_prev_seq;	/* previous sequence number received */
 671	rxrpc_seq_t		ackr_consumed;	/* Highest packet shown consumed */
 672	rxrpc_seq_t		ackr_seen;	/* Highest packet shown seen */
 673
 674	/* RTT management */
 675	rxrpc_serial_t		rtt_serial[4];	/* Serial number of DATA or PING sent */
 676	ktime_t			rtt_sent_at[4];	/* Time packet sent */
 677	unsigned long		rtt_avail;	/* Mask of available slots in bits 0-3,
 678						 * Mask of pending samples in 8-11 */
 679#define RXRPC_CALL_RTT_AVAIL_MASK	0xf
 680#define RXRPC_CALL_RTT_PEND_SHIFT	8
 681
 682	/* transmission-phase ACK management */
 683	ktime_t			acks_latest_ts;	/* Timestamp of latest ACK received */
 684	rxrpc_seq_t		acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
 685	rxrpc_seq_t		acks_lost_top;	/* tx_top at the time lost-ack ping sent */
 686	rxrpc_serial_t		acks_lost_ping;	/* Serial number of probe ACK */
 687};
 688
 689/*
 690 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
 691 */
 692struct rxrpc_ack_summary {
 693	u8			ack_reason;
 694	u8			nr_acks;		/* Number of ACKs in packet */
 695	u8			nr_nacks;		/* Number of NACKs in packet */
 696	u8			nr_new_acks;		/* Number of new ACKs in packet */
 697	u8			nr_new_nacks;		/* Number of new NACKs in packet */
 698	u8			nr_rot_new_acks;	/* Number of rotated new ACKs */
 699	bool			new_low_nack;		/* T if new low NACK found */
 700	bool			retrans_timeo;		/* T if reTx due to timeout happened */
 701	u8			flight_size;		/* Number of unreceived transmissions */
 702	/* Place to stash values for tracing */
 703	enum rxrpc_congest_mode	mode:8;
 704	u8			cwnd;
 705	u8			ssthresh;
 706	u8			dup_acks;
 707	u8			cumulative_acks;
 708};
 709
 710/*
 711 * sendmsg() cmsg-specified parameters.
 712 */
 713enum rxrpc_command {
 714	RXRPC_CMD_SEND_DATA,		/* send data message */
 715	RXRPC_CMD_SEND_ABORT,		/* request abort generation */
 716	RXRPC_CMD_REJECT_BUSY,		/* [server] reject a call as busy */
 717	RXRPC_CMD_CHARGE_ACCEPT,	/* [server] charge accept preallocation */
 718};
 719
 720struct rxrpc_call_params {
 721	s64			tx_total_len;	/* Total Tx data length (if send data) */
 722	unsigned long		user_call_ID;	/* User's call ID */
 723	struct {
 724		u32		hard;		/* Maximum lifetime (sec) */
 725		u32		idle;		/* Max time since last data packet (msec) */
 726		u32		normal;		/* Max time since last call packet (msec) */
 727	} timeouts;
 728	u8			nr_timeouts;	/* Number of timeouts specified */
 
 729	enum rxrpc_interruptibility interruptibility; /* How is interruptible is the call? */
 730};
 731
 732struct rxrpc_send_params {
 733	struct rxrpc_call_params call;
 734	u32			abort_code;	/* Abort code to Tx (if abort) */
 735	enum rxrpc_command	command : 8;	/* The command to implement */
 736	bool			exclusive;	/* Shared or exclusive call */
 737	bool			upgrade;	/* If the connection is upgradeable */
 738};
 739
 740#include <trace/events/rxrpc.h>
 741
 742/*
 743 * af_rxrpc.c
 744 */
 745extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
 746extern struct workqueue_struct *rxrpc_workqueue;
 747
 748/*
 749 * call_accept.c
 750 */
 751int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
 752void rxrpc_discard_prealloc(struct rxrpc_sock *);
 753struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
 754					   struct rxrpc_sock *,
 755					   struct sk_buff *);
 756void rxrpc_accept_incoming_calls(struct rxrpc_local *);
 757int rxrpc_user_charge_accept(struct rxrpc_sock *, unsigned long);
 758
 759/*
 760 * call_event.c
 761 */
 762void rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool, bool,
 763		       enum rxrpc_propose_ack_trace);
 764void rxrpc_process_call(struct work_struct *);
 765
 766static inline void rxrpc_reduce_call_timer(struct rxrpc_call *call,
 767					   unsigned long expire_at,
 768					   unsigned long now,
 769					   enum rxrpc_timer_trace why)
 770{
 771	trace_rxrpc_timer(call, why, now);
 772	timer_reduce(&call->timer, expire_at);
 773}
 774
 775/*
 776 * call_object.c
 777 */
 778extern const char *const rxrpc_call_states[];
 779extern const char *const rxrpc_call_completions[];
 780extern unsigned int rxrpc_max_call_lifetime;
 781extern struct kmem_cache *rxrpc_call_jar;
 782
 783struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
 784struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
 785struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
 786					 struct rxrpc_conn_parameters *,
 787					 struct sockaddr_rxrpc *,
 788					 struct rxrpc_call_params *, gfp_t,
 789					 unsigned int);
 790void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
 791			 struct sk_buff *);
 792void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
 793void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
 794bool __rxrpc_queue_call(struct rxrpc_call *);
 795bool rxrpc_queue_call(struct rxrpc_call *);
 796void rxrpc_see_call(struct rxrpc_call *);
 797void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
 798void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
 799void rxrpc_cleanup_call(struct rxrpc_call *);
 800void rxrpc_destroy_all_calls(struct rxrpc_net *);
 801
 802static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
 803{
 804	return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
 805}
 806
 807static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
 808{
 809	return !rxrpc_is_service_call(call);
 810}
 811
 812/*
 813 * conn_client.c
 814 */
 815extern unsigned int rxrpc_max_client_connections;
 816extern unsigned int rxrpc_reap_client_connections;
 817extern unsigned long rxrpc_conn_idle_client_expiry;
 818extern unsigned long rxrpc_conn_idle_client_fast_expiry;
 819extern struct idr rxrpc_client_conn_ids;
 820
 821void rxrpc_destroy_client_conn_ids(void);
 
 
 822int rxrpc_connect_call(struct rxrpc_sock *, struct rxrpc_call *,
 823		       struct rxrpc_conn_parameters *, struct sockaddr_rxrpc *,
 824		       gfp_t);
 825void rxrpc_expose_client_call(struct rxrpc_call *);
 826void rxrpc_disconnect_client_call(struct rxrpc_call *);
 827void rxrpc_put_client_conn(struct rxrpc_connection *);
 828void rxrpc_discard_expired_client_conns(struct work_struct *);
 829void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
 830void rxrpc_clean_up_local_conns(struct rxrpc_local *);
 831
 832/*
 833 * conn_event.c
 834 */
 835void rxrpc_process_connection(struct work_struct *);
 
 836
 837/*
 838 * conn_object.c
 839 */
 840extern unsigned int rxrpc_connection_expiry;
 841extern unsigned int rxrpc_closed_conn_expiry;
 842
 843struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
 844struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
 845						   struct sk_buff *,
 846						   struct rxrpc_peer **);
 847void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
 848void rxrpc_disconnect_call(struct rxrpc_call *);
 849void rxrpc_kill_connection(struct rxrpc_connection *);
 850bool rxrpc_queue_conn(struct rxrpc_connection *);
 851void rxrpc_see_connection(struct rxrpc_connection *);
 852void rxrpc_get_connection(struct rxrpc_connection *);
 853struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
 854void rxrpc_put_service_conn(struct rxrpc_connection *);
 855void rxrpc_service_connection_reaper(struct work_struct *);
 856void rxrpc_destroy_all_connections(struct rxrpc_net *);
 857
 858static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
 859{
 860	return conn->out_clientflag;
 861}
 862
 863static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
 864{
 865	return !rxrpc_conn_is_client(conn);
 866}
 867
 868static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
 869{
 870	if (!conn)
 871		return;
 872
 873	if (rxrpc_conn_is_client(conn))
 874		rxrpc_put_client_conn(conn);
 875	else
 876		rxrpc_put_service_conn(conn);
 877}
 878
 879static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
 880					   unsigned long expire_at)
 881{
 882	timer_reduce(&conn->timer, expire_at);
 883}
 884
 885/*
 886 * conn_service.c
 887 */
 888struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
 889						     struct sk_buff *);
 890struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
 891void rxrpc_new_incoming_connection(struct rxrpc_sock *, struct rxrpc_connection *,
 892				   const struct rxrpc_security *, struct key *,
 893				   struct sk_buff *);
 894void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
 895
 896/*
 897 * input.c
 898 */
 899int rxrpc_input_packet(struct sock *, struct sk_buff *);
 900
 901/*
 902 * insecure.c
 903 */
 904extern const struct rxrpc_security rxrpc_no_security;
 905
 906/*
 907 * key.c
 908 */
 909extern struct key_type key_type_rxrpc;
 910extern struct key_type key_type_rxrpc_s;
 911
 912int rxrpc_request_key(struct rxrpc_sock *, sockptr_t , int);
 913int rxrpc_server_keyring(struct rxrpc_sock *, sockptr_t, int);
 914int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
 915			      u32);
 916
 917/*
 918 * local_event.c
 919 */
 920extern void rxrpc_process_local_events(struct rxrpc_local *);
 921
 922/*
 923 * local_object.c
 924 */
 925struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
 926struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *);
 927struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *);
 928void rxrpc_put_local(struct rxrpc_local *);
 929struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *);
 930void rxrpc_unuse_local(struct rxrpc_local *);
 931void rxrpc_queue_local(struct rxrpc_local *);
 932void rxrpc_destroy_all_locals(struct rxrpc_net *);
 933
 934static inline bool __rxrpc_unuse_local(struct rxrpc_local *local)
 935{
 936	return atomic_dec_return(&local->active_users) == 0;
 937}
 938
 939static inline bool __rxrpc_use_local(struct rxrpc_local *local)
 940{
 941	return atomic_fetch_add_unless(&local->active_users, 1, 0) != 0;
 942}
 943
 944/*
 945 * misc.c
 946 */
 947extern unsigned int rxrpc_max_backlog __read_mostly;
 948extern unsigned long rxrpc_requested_ack_delay;
 949extern unsigned long rxrpc_soft_ack_delay;
 950extern unsigned long rxrpc_idle_ack_delay;
 951extern unsigned int rxrpc_rx_window_size;
 952extern unsigned int rxrpc_rx_mtu;
 953extern unsigned int rxrpc_rx_jumbo_max;
 954
 955extern const s8 rxrpc_ack_priority[];
 956
 957/*
 958 * net_ns.c
 959 */
 960extern unsigned int rxrpc_net_id;
 961extern struct pernet_operations rxrpc_net_ops;
 962
 963static inline struct rxrpc_net *rxrpc_net(struct net *net)
 964{
 965	return net_generic(net, rxrpc_net_id);
 966}
 967
 968/*
 969 * output.c
 970 */
 971int rxrpc_send_ack_packet(struct rxrpc_call *, bool, rxrpc_serial_t *);
 972int rxrpc_send_abort_packet(struct rxrpc_call *);
 973int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
 974void rxrpc_reject_packets(struct rxrpc_local *);
 975void rxrpc_send_keepalive(struct rxrpc_peer *);
 976
 977/*
 978 * peer_event.c
 979 */
 980void rxrpc_error_report(struct sock *);
 981void rxrpc_peer_keepalive_worker(struct work_struct *);
 982
 983/*
 984 * peer_object.c
 985 */
 986struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
 987					 const struct sockaddr_rxrpc *);
 988struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_sock *, struct rxrpc_local *,
 989				     struct sockaddr_rxrpc *, gfp_t);
 990struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
 991void rxrpc_new_incoming_peer(struct rxrpc_sock *, struct rxrpc_local *,
 992			     struct rxrpc_peer *);
 993void rxrpc_destroy_all_peers(struct rxrpc_net *);
 994struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *);
 995struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *);
 996void rxrpc_put_peer(struct rxrpc_peer *);
 997void rxrpc_put_peer_locked(struct rxrpc_peer *);
 998
 999/*
1000 * proc.c
1001 */
1002extern const struct seq_operations rxrpc_call_seq_ops;
1003extern const struct seq_operations rxrpc_connection_seq_ops;
1004extern const struct seq_operations rxrpc_peer_seq_ops;
1005
1006/*
1007 * recvmsg.c
1008 */
1009void rxrpc_notify_socket(struct rxrpc_call *);
1010bool __rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1011bool rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1012bool __rxrpc_call_completed(struct rxrpc_call *);
1013bool rxrpc_call_completed(struct rxrpc_call *);
1014bool __rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1015bool rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1016int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1017
1018/*
1019 * Abort a call due to a protocol error.
1020 */
1021static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
1022					struct sk_buff *skb,
1023					const char *eproto_why,
1024					const char *why,
1025					u32 abort_code)
1026{
1027	struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
1028
1029	trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
1030	return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
1031}
1032
1033#define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
1034	__rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
1035			     (abort_why), (abort_code))
1036
1037/*
1038 * rtt.c
1039 */
1040void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace, int,
1041			rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1042unsigned long rxrpc_get_rto_backoff(struct rxrpc_peer *, bool);
1043void rxrpc_peer_init_rtt(struct rxrpc_peer *);
1044
1045/*
1046 * rxkad.c
1047 */
1048#ifdef CONFIG_RXKAD
1049extern const struct rxrpc_security rxkad;
1050#endif
1051
1052/*
1053 * security.c
1054 */
1055int __init rxrpc_init_security(void);
 
1056void rxrpc_exit_security(void);
1057int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1058bool rxrpc_look_up_server_security(struct rxrpc_local *, struct rxrpc_sock *,
1059				   const struct rxrpc_security **, struct key **,
1060				   struct sk_buff *);
 
1061
1062/*
1063 * sendmsg.c
1064 */
1065int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
 
 
 
 
 
 
 
1066
1067/*
1068 * skbuff.c
1069 */
1070void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1071void rxrpc_packet_destructor(struct sk_buff *);
1072void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1073void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1074void rxrpc_eaten_skb(struct sk_buff *, enum rxrpc_skb_trace);
1075void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1076void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1077void rxrpc_purge_queue(struct sk_buff_head *);
1078
1079/*
1080 * sysctl.c
1081 */
1082#ifdef CONFIG_SYSCTL
1083extern int __init rxrpc_sysctl_init(void);
1084extern void rxrpc_sysctl_exit(void);
1085#else
1086static inline int __init rxrpc_sysctl_init(void) { return 0; }
1087static inline void rxrpc_sysctl_exit(void) {}
1088#endif
1089
1090/*
1091 * utils.c
1092 */
1093int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1094
1095static inline bool before(u32 seq1, u32 seq2)
1096{
1097        return (s32)(seq1 - seq2) < 0;
1098}
1099static inline bool before_eq(u32 seq1, u32 seq2)
1100{
1101        return (s32)(seq1 - seq2) <= 0;
1102}
1103static inline bool after(u32 seq1, u32 seq2)
1104{
1105        return (s32)(seq1 - seq2) > 0;
1106}
1107static inline bool after_eq(u32 seq1, u32 seq2)
1108{
1109        return (s32)(seq1 - seq2) >= 0;
1110}
1111
1112/*
1113 * debug tracing
1114 */
1115extern unsigned int rxrpc_debug;
1116
1117#define dbgprintk(FMT,...) \
1118	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1119
1120#define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1121#define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1122#define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
1123#define kproto(FMT,...)	dbgprintk("### "FMT ,##__VA_ARGS__)
1124#define knet(FMT,...)	dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1125
1126
1127#if defined(__KDEBUG)
1128#define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
1129#define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
1130#define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
1131#define _proto(FMT,...)	kproto(FMT,##__VA_ARGS__)
1132#define _net(FMT,...)	knet(FMT,##__VA_ARGS__)
1133
1134#elif defined(CONFIG_AF_RXRPC_DEBUG)
1135#define RXRPC_DEBUG_KENTER	0x01
1136#define RXRPC_DEBUG_KLEAVE	0x02
1137#define RXRPC_DEBUG_KDEBUG	0x04
1138#define RXRPC_DEBUG_KPROTO	0x08
1139#define RXRPC_DEBUG_KNET	0x10
1140
1141#define _enter(FMT,...)					\
1142do {							\
1143	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER))	\
1144		kenter(FMT,##__VA_ARGS__);		\
1145} while (0)
1146
1147#define _leave(FMT,...)					\
1148do {							\
1149	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE))	\
1150		kleave(FMT,##__VA_ARGS__);		\
1151} while (0)
1152
1153#define _debug(FMT,...)					\
1154do {							\
1155	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG))	\
1156		kdebug(FMT,##__VA_ARGS__);		\
1157} while (0)
1158
1159#define _proto(FMT,...)					\
1160do {							\
1161	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO))	\
1162		kproto(FMT,##__VA_ARGS__);		\
1163} while (0)
1164
1165#define _net(FMT,...)					\
1166do {							\
1167	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))	\
1168		knet(FMT,##__VA_ARGS__);		\
1169} while (0)
1170
1171#else
1172#define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1173#define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1174#define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
1175#define _proto(FMT,...)	no_printk("### "FMT ,##__VA_ARGS__)
1176#define _net(FMT,...)	no_printk("@@@ "FMT ,##__VA_ARGS__)
1177#endif
1178
1179/*
1180 * debug assertion checking
1181 */
1182#if 1 // defined(__KDEBUGALL)
1183
1184#define ASSERT(X)						\
1185do {								\
1186	if (unlikely(!(X))) {					\
1187		pr_err("Assertion failed\n");			\
1188		BUG();						\
1189	}							\
1190} while (0)
1191
1192#define ASSERTCMP(X, OP, Y)						\
1193do {									\
1194	__typeof__(X) _x = (X);						\
1195	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1196	if (unlikely(!(_x OP _y))) {					\
1197		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1198		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1199		       (unsigned long)_y, (unsigned long)_y);		\
1200		BUG();							\
1201	}								\
1202} while (0)
1203
1204#define ASSERTIF(C, X)						\
1205do {								\
1206	if (unlikely((C) && !(X))) {				\
1207		pr_err("Assertion failed\n");			\
1208		BUG();						\
1209	}							\
1210} while (0)
1211
1212#define ASSERTIFCMP(C, X, OP, Y)					\
1213do {									\
1214	__typeof__(X) _x = (X);						\
1215	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1216	if (unlikely((C) && !(_x OP _y))) {				\
1217		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1218		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1219		       (unsigned long)_y, (unsigned long)_y);		\
1220		BUG();							\
1221	}								\
1222} while (0)
1223
1224#else
1225
1226#define ASSERT(X)				\
1227do {						\
1228} while (0)
1229
1230#define ASSERTCMP(X, OP, Y)			\
1231do {						\
1232} while (0)
1233
1234#define ASSERTIF(C, X)				\
1235do {						\
1236} while (0)
1237
1238#define ASSERTIFCMP(C, X, OP, Y)		\
1239do {						\
1240} while (0)
1241
1242#endif /* __KDEBUGALL */
v5.14.15
   1/* SPDX-License-Identifier: GPL-2.0-or-later */
   2/* AF_RXRPC internal definitions
   3 *
   4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
   5 * Written by David Howells (dhowells@redhat.com)
   6 */
   7
   8#include <linux/atomic.h>
   9#include <linux/seqlock.h>
  10#include <linux/win_minmax.h>
  11#include <net/net_namespace.h>
  12#include <net/netns/generic.h>
  13#include <net/sock.h>
  14#include <net/af_rxrpc.h>
  15#include <keys/rxrpc-type.h>
  16#include "protocol.h"
  17
  18#if 0
  19#define CHECK_SLAB_OKAY(X)				     \
  20	BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
  21	       (POISON_FREE << 8 | POISON_FREE))
  22#else
  23#define CHECK_SLAB_OKAY(X) do {} while (0)
  24#endif
  25
  26#define FCRYPT_BSIZE 8
  27struct rxrpc_crypt {
  28	union {
  29		u8	x[FCRYPT_BSIZE];
  30		__be32	n[2];
  31	};
  32} __attribute__((aligned(8)));
  33
  34#define rxrpc_queue_work(WS)	queue_work(rxrpc_workqueue, (WS))
  35#define rxrpc_queue_delayed_work(WS,D)	\
  36	queue_delayed_work(rxrpc_workqueue, (WS), (D))
  37
  38struct key_preparsed_payload;
  39struct rxrpc_connection;
  40
  41/*
  42 * Mark applied to socket buffers in skb->mark.  skb->priority is used
  43 * to pass supplementary information.
  44 */
  45enum rxrpc_skb_mark {
  46	RXRPC_SKB_MARK_REJECT_BUSY,	/* Reject with BUSY */
  47	RXRPC_SKB_MARK_REJECT_ABORT,	/* Reject with ABORT (code in skb->priority) */
  48};
  49
  50/*
  51 * sk_state for RxRPC sockets
  52 */
  53enum {
  54	RXRPC_UNBOUND = 0,
  55	RXRPC_CLIENT_UNBOUND,		/* Unbound socket used as client */
  56	RXRPC_CLIENT_BOUND,		/* client local address bound */
  57	RXRPC_SERVER_BOUND,		/* server local address bound */
  58	RXRPC_SERVER_BOUND2,		/* second server local address bound */
  59	RXRPC_SERVER_LISTENING,		/* server listening for connections */
  60	RXRPC_SERVER_LISTEN_DISABLED,	/* server listening disabled */
  61	RXRPC_CLOSE,			/* socket is being closed */
  62};
  63
  64/*
  65 * Per-network namespace data.
  66 */
  67struct rxrpc_net {
  68	struct proc_dir_entry	*proc_net;	/* Subdir in /proc/net */
  69	u32			epoch;		/* Local epoch for detecting local-end reset */
  70	struct list_head	calls;		/* List of calls active in this namespace */
  71	rwlock_t		call_lock;	/* Lock for ->calls */
  72	atomic_t		nr_calls;	/* Count of allocated calls */
  73
  74	atomic_t		nr_conns;
  75	struct list_head	conn_proc_list;	/* List of conns in this namespace for proc */
  76	struct list_head	service_conns;	/* Service conns in this namespace */
  77	rwlock_t		conn_lock;	/* Lock for ->conn_proc_list, ->service_conns */
  78	struct work_struct	service_conn_reaper;
  79	struct timer_list	service_conn_reap_timer;
  80
 
 
 
  81	bool			live;
  82
  83	bool			kill_all_client_conns;
  84	atomic_t		nr_client_conns;
  85	spinlock_t		client_conn_cache_lock; /* Lock for ->*_client_conns */
  86	spinlock_t		client_conn_discard_lock; /* Prevent multiple discarders */
 
 
  87	struct list_head	idle_client_conns;
  88	struct work_struct	client_conn_reaper;
  89	struct timer_list	client_conn_reap_timer;
  90
  91	struct list_head	local_endpoints;
  92	struct mutex		local_mutex;	/* Lock for ->local_endpoints */
  93
  94	DECLARE_HASHTABLE	(peer_hash, 10);
  95	spinlock_t		peer_hash_lock;	/* Lock for ->peer_hash */
  96
  97#define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
  98	u8			peer_keepalive_cursor;
  99	time64_t		peer_keepalive_base;
 100	struct list_head	peer_keepalive[32];
 101	struct list_head	peer_keepalive_new;
 102	struct timer_list	peer_keepalive_timer;
 103	struct work_struct	peer_keepalive_work;
 104};
 105
 106/*
 107 * Service backlog preallocation.
 108 *
 109 * This contains circular buffers of preallocated peers, connections and calls
 110 * for incoming service calls and their head and tail pointers.  This allows
 111 * calls to be set up in the data_ready handler, thereby avoiding the need to
 112 * shuffle packets around so much.
 113 */
 114struct rxrpc_backlog {
 115	unsigned short		peer_backlog_head;
 116	unsigned short		peer_backlog_tail;
 117	unsigned short		conn_backlog_head;
 118	unsigned short		conn_backlog_tail;
 119	unsigned short		call_backlog_head;
 120	unsigned short		call_backlog_tail;
 121#define RXRPC_BACKLOG_MAX	32
 122	struct rxrpc_peer	*peer_backlog[RXRPC_BACKLOG_MAX];
 123	struct rxrpc_connection	*conn_backlog[RXRPC_BACKLOG_MAX];
 124	struct rxrpc_call	*call_backlog[RXRPC_BACKLOG_MAX];
 125};
 126
 127/*
 128 * RxRPC socket definition
 129 */
 130struct rxrpc_sock {
 131	/* WARNING: sk has to be the first member */
 132	struct sock		sk;
 133	rxrpc_notify_new_call_t	notify_new_call; /* Func to notify of new call */
 134	rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
 135	struct rxrpc_local	*local;		/* local endpoint */
 136	struct rxrpc_backlog	*backlog;	/* Preallocation for services */
 137	spinlock_t		incoming_lock;	/* Incoming call vs service shutdown lock */
 138	struct list_head	sock_calls;	/* List of calls owned by this socket */
 139	struct list_head	to_be_accepted;	/* calls awaiting acceptance */
 140	struct list_head	recvmsg_q;	/* Calls awaiting recvmsg's attention  */
 141	rwlock_t		recvmsg_lock;	/* Lock for recvmsg_q */
 142	struct key		*key;		/* security for this socket */
 143	struct key		*securities;	/* list of server security descriptors */
 144	struct rb_root		calls;		/* User ID -> call mapping */
 145	unsigned long		flags;
 146#define RXRPC_SOCK_CONNECTED		0	/* connect_srx is set */
 147	rwlock_t		call_lock;	/* lock for calls */
 148	u32			min_sec_level;	/* minimum security level */
 149#define RXRPC_SECURITY_MAX	RXRPC_SECURITY_ENCRYPT
 150	bool			exclusive;	/* Exclusive connection for a client socket */
 151	u16			second_service;	/* Additional service bound to the endpoint */
 152	struct {
 153		/* Service upgrade information */
 154		u16		from;		/* Service ID to upgrade (if not 0) */
 155		u16		to;		/* service ID to upgrade to */
 156	} service_upgrade;
 157	sa_family_t		family;		/* Protocol family created with */
 158	struct sockaddr_rxrpc	srx;		/* Primary Service/local addresses */
 159	struct sockaddr_rxrpc	connect_srx;	/* Default client address from connect() */
 160};
 161
 162#define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
 163
 164/*
 165 * CPU-byteorder normalised Rx packet header.
 166 */
 167struct rxrpc_host_header {
 168	u32		epoch;		/* client boot timestamp */
 169	u32		cid;		/* connection and channel ID */
 170	u32		callNumber;	/* call ID (0 for connection-level packets) */
 171	u32		seq;		/* sequence number of pkt in call stream */
 172	u32		serial;		/* serial number of pkt sent to network */
 173	u8		type;		/* packet type */
 174	u8		flags;		/* packet flags */
 175	u8		userStatus;	/* app-layer defined status */
 176	u8		securityIndex;	/* security protocol ID */
 177	union {
 178		u16	_rsvd;		/* reserved */
 179		u16	cksum;		/* kerberos security checksum */
 180	};
 181	u16		serviceId;	/* service ID */
 182} __packed;
 183
 184/*
 185 * RxRPC socket buffer private variables
 186 * - max 48 bytes (struct sk_buff::cb)
 187 */
 188struct rxrpc_skb_priv {
 189	atomic_t	nr_ring_pins;		/* Number of rxtx ring pins */
 190	u8		nr_subpackets;		/* Number of subpackets */
 191	u8		rx_flags;		/* Received packet flags */
 192#define RXRPC_SKB_INCL_LAST	0x01		/* - Includes last packet */
 193#define RXRPC_SKB_TX_BUFFER	0x02		/* - Is transmit buffer */
 194	union {
 195		int		remain;		/* amount of space remaining for next write */
 196
 197		/* List of requested ACKs on subpackets */
 198		unsigned long	rx_req_ack[(RXRPC_MAX_NR_JUMBO + BITS_PER_LONG - 1) /
 199					   BITS_PER_LONG];
 200	};
 201
 202	struct rxrpc_host_header hdr;		/* RxRPC packet header from this packet */
 203};
 204
 205#define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
 206
 207/*
 208 * RxRPC security module interface
 209 */
 210struct rxrpc_security {
 211	const char		*name;		/* name of this service */
 212	u8			security_index;	/* security type provided */
 213	u32			no_key_abort;	/* Abort code indicating no key */
 214
 215	/* Initialise a security service */
 216	int (*init)(void);
 217
 218	/* Clean up a security service */
 219	void (*exit)(void);
 220
 221	/* Parse the information from a server key */
 222	int (*preparse_server_key)(struct key_preparsed_payload *);
 223
 224	/* Clean up the preparse buffer after parsing a server key */
 225	void (*free_preparse_server_key)(struct key_preparsed_payload *);
 226
 227	/* Destroy the payload of a server key */
 228	void (*destroy_server_key)(struct key *);
 229
 230	/* Describe a server key */
 231	void (*describe_server_key)(const struct key *, struct seq_file *);
 232
 233	/* initialise a connection's security */
 234	int (*init_connection_security)(struct rxrpc_connection *,
 235					struct rxrpc_key_token *);
 236
 237	/* Work out how much data we can store in a packet, given an estimate
 238	 * of the amount of data remaining.
 239	 */
 240	int (*how_much_data)(struct rxrpc_call *, size_t,
 241			     size_t *, size_t *, size_t *);
 242
 243	/* impose security on a packet */
 244	int (*secure_packet)(struct rxrpc_call *, struct sk_buff *, size_t);
 
 
 
 245
 246	/* verify the security on a received packet */
 247	int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
 248			     unsigned int, unsigned int, rxrpc_seq_t, u16);
 249
 250	/* Free crypto request on a call */
 251	void (*free_call_crypto)(struct rxrpc_call *);
 252
 253	/* Locate the data in a received packet that has been verified. */
 254	void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
 255			    unsigned int *, unsigned int *);
 256
 257	/* issue a challenge */
 258	int (*issue_challenge)(struct rxrpc_connection *);
 259
 260	/* respond to a challenge */
 261	int (*respond_to_challenge)(struct rxrpc_connection *,
 262				    struct sk_buff *,
 263				    u32 *);
 264
 265	/* verify a response */
 266	int (*verify_response)(struct rxrpc_connection *,
 267			       struct sk_buff *,
 268			       u32 *);
 269
 270	/* clear connection security */
 271	void (*clear)(struct rxrpc_connection *);
 272};
 273
 274/*
 275 * RxRPC local transport endpoint description
 276 * - owned by a single AF_RXRPC socket
 277 * - pointed to by transport socket struct sk_user_data
 278 */
 279struct rxrpc_local {
 280	struct rcu_head		rcu;
 281	atomic_t		active_users;	/* Number of users of the local endpoint */
 282	atomic_t		usage;		/* Number of references to the structure */
 283	struct rxrpc_net	*rxnet;		/* The network ns in which this resides */
 284	struct list_head	link;
 285	struct socket		*socket;	/* my UDP socket */
 286	struct work_struct	processor;
 287	struct rxrpc_sock __rcu	*service;	/* Service(s) listening on this endpoint */
 288	struct rw_semaphore	defrag_sem;	/* control re-enablement of IP DF bit */
 289	struct sk_buff_head	reject_queue;	/* packets awaiting rejection */
 290	struct sk_buff_head	event_queue;	/* endpoint event packets awaiting processing */
 291	struct rb_root		client_bundles;	/* Client connection bundles by socket params */
 292	spinlock_t		client_bundles_lock; /* Lock for client_bundles */
 293	spinlock_t		lock;		/* access lock */
 294	rwlock_t		services_lock;	/* lock for services list */
 295	int			debug_id;	/* debug ID for printks */
 296	bool			dead;
 297	bool			service_closed;	/* Service socket closed */
 298	struct sockaddr_rxrpc	srx;		/* local address */
 299};
 300
 301/*
 302 * RxRPC remote transport endpoint definition
 303 * - matched by local endpoint, remote port, address and protocol type
 304 */
 305struct rxrpc_peer {
 306	struct rcu_head		rcu;		/* This must be first */
 307	atomic_t		usage;
 308	unsigned long		hash_key;
 309	struct hlist_node	hash_link;
 310	struct rxrpc_local	*local;
 311	struct hlist_head	error_targets;	/* targets for net error distribution */
 312	struct rb_root		service_conns;	/* Service connections */
 313	struct list_head	keepalive_link;	/* Link in net->peer_keepalive[] */
 314	time64_t		last_tx_at;	/* Last time packet sent here */
 315	seqlock_t		service_conn_lock;
 316	spinlock_t		lock;		/* access lock */
 317	unsigned int		if_mtu;		/* interface MTU for this peer */
 318	unsigned int		mtu;		/* network MTU for this peer */
 319	unsigned int		maxdata;	/* data size (MTU - hdrsize) */
 320	unsigned short		hdrsize;	/* header size (IP + UDP + RxRPC) */
 321	int			debug_id;	/* debug ID for printks */
 322	struct sockaddr_rxrpc	srx;		/* remote address */
 323
 324	/* calculated RTT cache */
 325#define RXRPC_RTT_CACHE_SIZE 32
 326	spinlock_t		rtt_input_lock;	/* RTT lock for input routine */
 327	ktime_t			rtt_last_req;	/* Time of last RTT request */
 328	unsigned int		rtt_count;	/* Number of samples we've got */
 329
 330	u32			srtt_us;	/* smoothed round trip time << 3 in usecs */
 331	u32			mdev_us;	/* medium deviation			*/
 332	u32			mdev_max_us;	/* maximal mdev for the last rtt period	*/
 333	u32			rttvar_us;	/* smoothed mdev_max			*/
 334	u32			rto_j;		/* Retransmission timeout in jiffies */
 335	u8			backoff;	/* Backoff timeout */
 336
 337	u8			cong_cwnd;	/* Congestion window size */
 338};
 339
 340/*
 341 * Keys for matching a connection.
 342 */
 343struct rxrpc_conn_proto {
 344	union {
 345		struct {
 346			u32	epoch;		/* epoch of this connection */
 347			u32	cid;		/* connection ID */
 348		};
 349		u64		index_key;
 350	};
 351};
 352
 353struct rxrpc_conn_parameters {
 354	struct rxrpc_local	*local;		/* Representation of local endpoint */
 355	struct rxrpc_peer	*peer;		/* Remote endpoint */
 356	struct key		*key;		/* Security details */
 357	bool			exclusive;	/* T if conn is exclusive */
 358	bool			upgrade;	/* T if service ID can be upgraded */
 359	u16			service_id;	/* Service ID for this connection */
 360	u32			security_level;	/* Security level selected */
 361};
 362
 363/*
 364 * Bits in the connection flags.
 365 */
 366enum rxrpc_conn_flag {
 367	RXRPC_CONN_HAS_IDR,		/* Has a client conn ID assigned */
 368	RXRPC_CONN_IN_SERVICE_CONNS,	/* Conn is in peer->service_conns */
 
 
 369	RXRPC_CONN_DONT_REUSE,		/* Don't reuse this connection */
 
 370	RXRPC_CONN_PROBING_FOR_UPGRADE,	/* Probing for service upgrade */
 371	RXRPC_CONN_FINAL_ACK_0,		/* Need final ACK for channel 0 */
 372	RXRPC_CONN_FINAL_ACK_1,		/* Need final ACK for channel 1 */
 373	RXRPC_CONN_FINAL_ACK_2,		/* Need final ACK for channel 2 */
 374	RXRPC_CONN_FINAL_ACK_3,		/* Need final ACK for channel 3 */
 375};
 376
 377#define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) |	\
 378				   (1UL << RXRPC_CONN_FINAL_ACK_1) |	\
 379				   (1UL << RXRPC_CONN_FINAL_ACK_2) |	\
 380				   (1UL << RXRPC_CONN_FINAL_ACK_3))
 381
 382/*
 383 * Events that can be raised upon a connection.
 384 */
 385enum rxrpc_conn_event {
 386	RXRPC_CONN_EV_CHALLENGE,	/* Send challenge packet */
 387};
 388
 389/*
 
 
 
 
 
 
 
 
 
 
 
 
 
 390 * The connection protocol state.
 391 */
 392enum rxrpc_conn_proto_state {
 393	RXRPC_CONN_UNUSED,		/* Connection not yet attempted */
 394	RXRPC_CONN_CLIENT,		/* Client connection */
 395	RXRPC_CONN_SERVICE_PREALLOC,	/* Service connection preallocation */
 396	RXRPC_CONN_SERVICE_UNSECURED,	/* Service unsecured connection */
 397	RXRPC_CONN_SERVICE_CHALLENGING,	/* Service challenging for security */
 398	RXRPC_CONN_SERVICE,		/* Service secured connection */
 399	RXRPC_CONN_REMOTELY_ABORTED,	/* Conn aborted by peer */
 400	RXRPC_CONN_LOCALLY_ABORTED,	/* Conn aborted locally */
 401	RXRPC_CONN__NR_STATES
 402};
 403
 404/*
 405 * RxRPC client connection bundle.
 406 */
 407struct rxrpc_bundle {
 408	struct rxrpc_conn_parameters params;
 409	atomic_t		usage;
 410	unsigned int		debug_id;
 411	bool			try_upgrade;	/* True if the bundle is attempting upgrade */
 412	bool			alloc_conn;	/* True if someone's getting a conn */
 413	short			alloc_error;	/* Error from last conn allocation */
 414	spinlock_t		channel_lock;
 415	struct rb_node		local_node;	/* Node in local->client_conns */
 416	struct list_head	waiting_calls;	/* Calls waiting for channels */
 417	unsigned long		avail_chans;	/* Mask of available channels */
 418	struct rxrpc_connection	*conns[4];	/* The connections in the bundle (max 4) */
 419};
 420
 421/*
 422 * RxRPC connection definition
 423 * - matched by { local, peer, epoch, conn_id, direction }
 424 * - each connection can only handle four simultaneous calls
 425 */
 426struct rxrpc_connection {
 427	struct rxrpc_conn_proto	proto;
 428	struct rxrpc_conn_parameters params;
 429
 430	atomic_t		usage;
 431	struct rcu_head		rcu;
 432	struct list_head	cache_link;
 433
 434	unsigned char		act_chans;	/* Mask of active channels */
 
 
 
 435	struct rxrpc_channel {
 436		unsigned long		final_ack_at;	/* Time at which to issue final ACK */
 437		struct rxrpc_call __rcu	*call;		/* Active call */
 438		unsigned int		call_debug_id;	/* call->debug_id */
 439		u32			call_id;	/* ID of current call */
 440		u32			call_counter;	/* Call ID counter */
 441		u32			last_call;	/* ID of last call */
 442		u8			last_type;	/* Type of last packet */
 443		union {
 444			u32		last_seq;
 445			u32		last_abort;
 446		};
 447	} channels[RXRPC_MAXCALLS];
 448
 449	struct timer_list	timer;		/* Conn event timer */
 450	struct work_struct	processor;	/* connection event processor */
 451	struct rxrpc_bundle	*bundle;	/* Client connection bundle */
 452	struct rb_node		service_node;	/* Node in peer->service_conns */
 
 
 453	struct list_head	proc_link;	/* link in procfs list */
 454	struct list_head	link;		/* link in master connection list */
 455	struct sk_buff_head	rx_queue;	/* received conn-level packets */
 456
 457	const struct rxrpc_security *security;	/* applied security module */
 458	union {
 459		struct {
 460			struct crypto_sync_skcipher *cipher;	/* encryption handle */
 461			struct rxrpc_crypt csum_iv;	/* packet checksum base */
 462			u32	nonce;		/* response re-use preventer */
 463		} rxkad;
 464	};
 465	unsigned long		flags;
 466	unsigned long		events;
 467	unsigned long		idle_timestamp;	/* Time at which last became idle */
 468	spinlock_t		state_lock;	/* state-change lock */
 
 469	enum rxrpc_conn_proto_state state;	/* current state of connection */
 470	u32			abort_code;	/* Abort code of connection abort */
 471	int			debug_id;	/* debug ID for printks */
 472	atomic_t		serial;		/* packet serial number counter */
 473	unsigned int		hi_serial;	/* highest serial number received */
 
 474	u32			service_id;	/* Service ID, possibly upgraded */
 
 
 475	u8			security_ix;	/* security type */
 476	u8			out_clientflag;	/* RXRPC_CLIENT_INITIATED if we are client */
 477	u8			bundle_shift;	/* Index into bundle->avail_chans */
 478	short			error;		/* Local error code */
 479};
 480
 481static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
 482{
 483	return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
 484}
 485
 486static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
 487{
 488	return !rxrpc_to_server(sp);
 489}
 490
 491/*
 492 * Flags in call->flags.
 493 */
 494enum rxrpc_call_flag {
 495	RXRPC_CALL_RELEASED,		/* call has been released - no more message to userspace */
 496	RXRPC_CALL_HAS_USERID,		/* has a user ID attached */
 497	RXRPC_CALL_IS_SERVICE,		/* Call is service call */
 498	RXRPC_CALL_EXPOSED,		/* The call was exposed to the world */
 499	RXRPC_CALL_RX_LAST,		/* Received the last packet (at rxtx_top) */
 500	RXRPC_CALL_TX_LAST,		/* Last packet in Tx buffer (at rxtx_top) */
 501	RXRPC_CALL_SEND_PING,		/* A ping will need to be sent */
 502	RXRPC_CALL_RETRANS_TIMEOUT,	/* Retransmission due to timeout occurred */
 503	RXRPC_CALL_BEGAN_RX_TIMER,	/* We began the expect_rx_by timer */
 504	RXRPC_CALL_RX_HEARD,		/* The peer responded at least once to this call */
 505	RXRPC_CALL_RX_UNDERRUN,		/* Got data underrun */
 506	RXRPC_CALL_DISCONNECTED,	/* The call has been disconnected */
 507	RXRPC_CALL_KERNEL,		/* The call was made by the kernel */
 508	RXRPC_CALL_UPGRADE,		/* Service upgrade was requested for the call */
 509};
 510
 511/*
 512 * Events that can be raised on a call.
 513 */
 514enum rxrpc_call_event {
 515	RXRPC_CALL_EV_ACK,		/* need to generate ACK */
 516	RXRPC_CALL_EV_ABORT,		/* need to generate abort */
 517	RXRPC_CALL_EV_RESEND,		/* Tx resend required */
 518	RXRPC_CALL_EV_PING,		/* Ping send required */
 519	RXRPC_CALL_EV_EXPIRED,		/* Expiry occurred */
 520	RXRPC_CALL_EV_ACK_LOST,		/* ACK may be lost, send ping */
 521};
 522
 523/*
 524 * The states that a call can be in.
 525 */
 526enum rxrpc_call_state {
 527	RXRPC_CALL_UNINITIALISED,
 528	RXRPC_CALL_CLIENT_AWAIT_CONN,	/* - client waiting for connection to become available */
 529	RXRPC_CALL_CLIENT_SEND_REQUEST,	/* - client sending request phase */
 530	RXRPC_CALL_CLIENT_AWAIT_REPLY,	/* - client awaiting reply */
 531	RXRPC_CALL_CLIENT_RECV_REPLY,	/* - client receiving reply phase */
 532	RXRPC_CALL_SERVER_PREALLOC,	/* - service preallocation */
 533	RXRPC_CALL_SERVER_SECURING,	/* - server securing request connection */
 534	RXRPC_CALL_SERVER_RECV_REQUEST,	/* - server receiving request */
 535	RXRPC_CALL_SERVER_ACK_REQUEST,	/* - server pending ACK of request */
 536	RXRPC_CALL_SERVER_SEND_REPLY,	/* - server sending reply */
 537	RXRPC_CALL_SERVER_AWAIT_ACK,	/* - server awaiting final ACK */
 538	RXRPC_CALL_COMPLETE,		/* - call complete */
 539	NR__RXRPC_CALL_STATES
 540};
 541
 542/*
 543 * Call completion condition (state == RXRPC_CALL_COMPLETE).
 544 */
 545enum rxrpc_call_completion {
 546	RXRPC_CALL_SUCCEEDED,		/* - Normal termination */
 547	RXRPC_CALL_REMOTELY_ABORTED,	/* - call aborted by peer */
 548	RXRPC_CALL_LOCALLY_ABORTED,	/* - call aborted locally on error or close */
 549	RXRPC_CALL_LOCAL_ERROR,		/* - call failed due to local error */
 550	RXRPC_CALL_NETWORK_ERROR,	/* - call terminated by network error */
 551	NR__RXRPC_CALL_COMPLETIONS
 552};
 553
 554/*
 555 * Call Tx congestion management modes.
 556 */
 557enum rxrpc_congest_mode {
 558	RXRPC_CALL_SLOW_START,
 559	RXRPC_CALL_CONGEST_AVOIDANCE,
 560	RXRPC_CALL_PACKET_LOSS,
 561	RXRPC_CALL_FAST_RETRANSMIT,
 562	NR__RXRPC_CONGEST_MODES
 563};
 564
 565/*
 566 * RxRPC call definition
 567 * - matched by { connection, call_id }
 568 */
 569struct rxrpc_call {
 570	struct rcu_head		rcu;
 571	struct rxrpc_connection	*conn;		/* connection carrying call */
 572	struct rxrpc_peer	*peer;		/* Peer record for remote address */
 573	struct rxrpc_sock __rcu	*socket;	/* socket responsible */
 574	struct rxrpc_net	*rxnet;		/* Network namespace to which call belongs */
 575	const struct rxrpc_security *security;	/* applied security module */
 576	struct mutex		user_mutex;	/* User access mutex */
 577	unsigned long		ack_at;		/* When deferred ACK needs to happen */
 578	unsigned long		ack_lost_at;	/* When ACK is figured as lost */
 579	unsigned long		resend_at;	/* When next resend needs to happen */
 580	unsigned long		ping_at;	/* When next to send a ping */
 581	unsigned long		keepalive_at;	/* When next to send a keepalive ping */
 582	unsigned long		expect_rx_by;	/* When we expect to get a packet by */
 583	unsigned long		expect_req_by;	/* When we expect to get a request DATA packet by */
 584	unsigned long		expect_term_by;	/* When we expect call termination by */
 585	u32			next_rx_timo;	/* Timeout for next Rx packet (jif) */
 586	u32			next_req_timo;	/* Timeout for next Rx request packet (jif) */
 587	struct skcipher_request	*cipher_req;	/* Packet cipher request buffer */
 588	struct timer_list	timer;		/* Combined event timer */
 589	struct work_struct	processor;	/* Event processor */
 590	rxrpc_notify_rx_t	notify_rx;	/* kernel service Rx notification function */
 591	struct list_head	link;		/* link in master call list */
 592	struct list_head	chan_wait_link;	/* Link in conn->bundle->waiting_calls */
 593	struct hlist_node	error_link;	/* link in error distribution list */
 594	struct list_head	accept_link;	/* Link in rx->acceptq */
 595	struct list_head	recvmsg_link;	/* Link in rx->recvmsg_q */
 596	struct list_head	sock_link;	/* Link in rx->sock_calls */
 597	struct rb_node		sock_node;	/* Node in rx->calls */
 598	struct sk_buff		*tx_pending;	/* Tx socket buffer being filled */
 599	wait_queue_head_t	waitq;		/* Wait queue for channel or Tx */
 600	s64			tx_total_len;	/* Total length left to be transmitted (or -1) */
 601	__be32			crypto_buf[2];	/* Temporary packet crypto buffer */
 602	unsigned long		user_call_ID;	/* user-defined call ID */
 603	unsigned long		flags;
 604	unsigned long		events;
 605	spinlock_t		lock;
 606	spinlock_t		notify_lock;	/* Kernel notification lock */
 607	rwlock_t		state_lock;	/* lock for state transition */
 608	u32			abort_code;	/* Local/remote abort code */
 609	int			error;		/* Local error incurred */
 610	enum rxrpc_call_state	state;		/* current state of call */
 611	enum rxrpc_call_completion completion;	/* Call completion condition */
 612	atomic_t		usage;
 613	u16			service_id;	/* service ID */
 614	u8			security_ix;	/* Security type */
 615	enum rxrpc_interruptibility interruptibility; /* At what point call may be interrupted */
 616	u32			call_id;	/* call ID on connection  */
 617	u32			cid;		/* connection ID plus channel index */
 618	int			debug_id;	/* debug ID for printks */
 619	unsigned short		rx_pkt_offset;	/* Current recvmsg packet offset */
 620	unsigned short		rx_pkt_len;	/* Current recvmsg packet len */
 621	bool			rx_pkt_last;	/* Current recvmsg packet is last */
 622
 623	/* Rx/Tx circular buffer, depending on phase.
 624	 *
 625	 * In the Rx phase, packets are annotated with 0 or the number of the
 626	 * segment of a jumbo packet each buffer refers to.  There can be up to
 627	 * 47 segments in a maximum-size UDP packet.
 628	 *
 629	 * In the Tx phase, packets are annotated with which buffers have been
 630	 * acked.
 631	 */
 632#define RXRPC_RXTX_BUFF_SIZE	64
 633#define RXRPC_RXTX_BUFF_MASK	(RXRPC_RXTX_BUFF_SIZE - 1)
 634#define RXRPC_INIT_RX_WINDOW_SIZE 63
 635	struct sk_buff		**rxtx_buffer;
 636	u8			*rxtx_annotations;
 637#define RXRPC_TX_ANNO_ACK	0
 638#define RXRPC_TX_ANNO_UNACK	1
 639#define RXRPC_TX_ANNO_NAK	2
 640#define RXRPC_TX_ANNO_RETRANS	3
 641#define RXRPC_TX_ANNO_MASK	0x03
 642#define RXRPC_TX_ANNO_LAST	0x04
 643#define RXRPC_TX_ANNO_RESENT	0x08
 644
 645#define RXRPC_RX_ANNO_SUBPACKET	0x3f		/* Subpacket number in jumbogram */
 646#define RXRPC_RX_ANNO_VERIFIED	0x80		/* Set if verified and decrypted */
 647	rxrpc_seq_t		tx_hard_ack;	/* Dead slot in buffer; the first transmitted but
 648						 * not hard-ACK'd packet follows this.
 649						 */
 650	rxrpc_seq_t		tx_top;		/* Highest Tx slot allocated. */
 651	u16			tx_backoff;	/* Delay to insert due to Tx failure */
 652
 653	/* TCP-style slow-start congestion control [RFC5681].  Since the SMSS
 654	 * is fixed, we keep these numbers in terms of segments (ie. DATA
 655	 * packets) rather than bytes.
 656	 */
 657#define RXRPC_TX_SMSS		RXRPC_JUMBO_DATALEN
 658	u8			cong_cwnd;	/* Congestion window size */
 659	u8			cong_extra;	/* Extra to send for congestion management */
 660	u8			cong_ssthresh;	/* Slow-start threshold */
 661	enum rxrpc_congest_mode	cong_mode:8;	/* Congestion management mode */
 662	u8			cong_dup_acks;	/* Count of ACKs showing missing packets */
 663	u8			cong_cumul_acks; /* Cumulative ACK count */
 664	ktime_t			cong_tstamp;	/* Last time cwnd was changed */
 665
 666	rxrpc_seq_t		rx_hard_ack;	/* Dead slot in buffer; the first received but not
 667						 * consumed packet follows this.
 668						 */
 669	rxrpc_seq_t		rx_top;		/* Highest Rx slot allocated. */
 670	rxrpc_seq_t		rx_expect_next;	/* Expected next packet sequence number */
 671	rxrpc_serial_t		rx_serial;	/* Highest serial received for this call */
 672	u8			rx_winsize;	/* Size of Rx window */
 673	u8			tx_winsize;	/* Maximum size of Tx window */
 674	bool			tx_phase;	/* T if transmission phase, F if receive phase */
 675	u8			nr_jumbo_bad;	/* Number of jumbo dups/exceeds-windows */
 676
 677	spinlock_t		input_lock;	/* Lock for packet input to this call */
 678
 679	/* receive-phase ACK management */
 680	u8			ackr_reason;	/* reason to ACK */
 681	rxrpc_serial_t		ackr_serial;	/* serial of packet being ACK'd */
 682	rxrpc_serial_t		ackr_first_seq;	/* first sequence number received */
 683	rxrpc_seq_t		ackr_prev_seq;	/* previous sequence number received */
 684	rxrpc_seq_t		ackr_consumed;	/* Highest packet shown consumed */
 685	rxrpc_seq_t		ackr_seen;	/* Highest packet shown seen */
 686
 687	/* RTT management */
 688	rxrpc_serial_t		rtt_serial[4];	/* Serial number of DATA or PING sent */
 689	ktime_t			rtt_sent_at[4];	/* Time packet sent */
 690	unsigned long		rtt_avail;	/* Mask of available slots in bits 0-3,
 691						 * Mask of pending samples in 8-11 */
 692#define RXRPC_CALL_RTT_AVAIL_MASK	0xf
 693#define RXRPC_CALL_RTT_PEND_SHIFT	8
 694
 695	/* transmission-phase ACK management */
 696	ktime_t			acks_latest_ts;	/* Timestamp of latest ACK received */
 697	rxrpc_seq_t		acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
 698	rxrpc_seq_t		acks_lost_top;	/* tx_top at the time lost-ack ping sent */
 699	rxrpc_serial_t		acks_lost_ping;	/* Serial number of probe ACK */
 700};
 701
 702/*
 703 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
 704 */
 705struct rxrpc_ack_summary {
 706	u8			ack_reason;
 707	u8			nr_acks;		/* Number of ACKs in packet */
 708	u8			nr_nacks;		/* Number of NACKs in packet */
 709	u8			nr_new_acks;		/* Number of new ACKs in packet */
 710	u8			nr_new_nacks;		/* Number of new NACKs in packet */
 711	u8			nr_rot_new_acks;	/* Number of rotated new ACKs */
 712	bool			new_low_nack;		/* T if new low NACK found */
 713	bool			retrans_timeo;		/* T if reTx due to timeout happened */
 714	u8			flight_size;		/* Number of unreceived transmissions */
 715	/* Place to stash values for tracing */
 716	enum rxrpc_congest_mode	mode:8;
 717	u8			cwnd;
 718	u8			ssthresh;
 719	u8			dup_acks;
 720	u8			cumulative_acks;
 721};
 722
 723/*
 724 * sendmsg() cmsg-specified parameters.
 725 */
 726enum rxrpc_command {
 727	RXRPC_CMD_SEND_DATA,		/* send data message */
 728	RXRPC_CMD_SEND_ABORT,		/* request abort generation */
 729	RXRPC_CMD_REJECT_BUSY,		/* [server] reject a call as busy */
 730	RXRPC_CMD_CHARGE_ACCEPT,	/* [server] charge accept preallocation */
 731};
 732
 733struct rxrpc_call_params {
 734	s64			tx_total_len;	/* Total Tx data length (if send data) */
 735	unsigned long		user_call_ID;	/* User's call ID */
 736	struct {
 737		u32		hard;		/* Maximum lifetime (sec) */
 738		u32		idle;		/* Max time since last data packet (msec) */
 739		u32		normal;		/* Max time since last call packet (msec) */
 740	} timeouts;
 741	u8			nr_timeouts;	/* Number of timeouts specified */
 742	bool			kernel;		/* T if kernel is making the call */
 743	enum rxrpc_interruptibility interruptibility; /* How is interruptible is the call? */
 744};
 745
 746struct rxrpc_send_params {
 747	struct rxrpc_call_params call;
 748	u32			abort_code;	/* Abort code to Tx (if abort) */
 749	enum rxrpc_command	command : 8;	/* The command to implement */
 750	bool			exclusive;	/* Shared or exclusive call */
 751	bool			upgrade;	/* If the connection is upgradeable */
 752};
 753
 754#include <trace/events/rxrpc.h>
 755
 756/*
 757 * af_rxrpc.c
 758 */
 759extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
 760extern struct workqueue_struct *rxrpc_workqueue;
 761
 762/*
 763 * call_accept.c
 764 */
 765int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
 766void rxrpc_discard_prealloc(struct rxrpc_sock *);
 767struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
 768					   struct rxrpc_sock *,
 769					   struct sk_buff *);
 770void rxrpc_accept_incoming_calls(struct rxrpc_local *);
 771int rxrpc_user_charge_accept(struct rxrpc_sock *, unsigned long);
 772
 773/*
 774 * call_event.c
 775 */
 776void rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool, bool,
 777		       enum rxrpc_propose_ack_trace);
 778void rxrpc_process_call(struct work_struct *);
 779
 780static inline void rxrpc_reduce_call_timer(struct rxrpc_call *call,
 781					   unsigned long expire_at,
 782					   unsigned long now,
 783					   enum rxrpc_timer_trace why)
 784{
 785	trace_rxrpc_timer(call, why, now);
 786	timer_reduce(&call->timer, expire_at);
 787}
 788
 789/*
 790 * call_object.c
 791 */
 792extern const char *const rxrpc_call_states[];
 793extern const char *const rxrpc_call_completions[];
 794extern unsigned int rxrpc_max_call_lifetime;
 795extern struct kmem_cache *rxrpc_call_jar;
 796
 797struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
 798struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
 799struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
 800					 struct rxrpc_conn_parameters *,
 801					 struct sockaddr_rxrpc *,
 802					 struct rxrpc_call_params *, gfp_t,
 803					 unsigned int);
 804void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
 805			 struct sk_buff *);
 806void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
 807void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
 808bool __rxrpc_queue_call(struct rxrpc_call *);
 809bool rxrpc_queue_call(struct rxrpc_call *);
 810void rxrpc_see_call(struct rxrpc_call *);
 811void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
 812void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
 813void rxrpc_cleanup_call(struct rxrpc_call *);
 814void rxrpc_destroy_all_calls(struct rxrpc_net *);
 815
 816static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
 817{
 818	return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
 819}
 820
 821static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
 822{
 823	return !rxrpc_is_service_call(call);
 824}
 825
 826/*
 827 * conn_client.c
 828 */
 
 829extern unsigned int rxrpc_reap_client_connections;
 830extern unsigned long rxrpc_conn_idle_client_expiry;
 831extern unsigned long rxrpc_conn_idle_client_fast_expiry;
 832extern struct idr rxrpc_client_conn_ids;
 833
 834void rxrpc_destroy_client_conn_ids(void);
 835struct rxrpc_bundle *rxrpc_get_bundle(struct rxrpc_bundle *);
 836void rxrpc_put_bundle(struct rxrpc_bundle *);
 837int rxrpc_connect_call(struct rxrpc_sock *, struct rxrpc_call *,
 838		       struct rxrpc_conn_parameters *, struct sockaddr_rxrpc *,
 839		       gfp_t);
 840void rxrpc_expose_client_call(struct rxrpc_call *);
 841void rxrpc_disconnect_client_call(struct rxrpc_bundle *, struct rxrpc_call *);
 842void rxrpc_put_client_conn(struct rxrpc_connection *);
 843void rxrpc_discard_expired_client_conns(struct work_struct *);
 844void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
 845void rxrpc_clean_up_local_conns(struct rxrpc_local *);
 846
 847/*
 848 * conn_event.c
 849 */
 850void rxrpc_process_connection(struct work_struct *);
 851void rxrpc_process_delayed_final_acks(struct rxrpc_connection *, bool);
 852
 853/*
 854 * conn_object.c
 855 */
 856extern unsigned int rxrpc_connection_expiry;
 857extern unsigned int rxrpc_closed_conn_expiry;
 858
 859struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
 860struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
 861						   struct sk_buff *,
 862						   struct rxrpc_peer **);
 863void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
 864void rxrpc_disconnect_call(struct rxrpc_call *);
 865void rxrpc_kill_connection(struct rxrpc_connection *);
 866bool rxrpc_queue_conn(struct rxrpc_connection *);
 867void rxrpc_see_connection(struct rxrpc_connection *);
 868struct rxrpc_connection *rxrpc_get_connection(struct rxrpc_connection *);
 869struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
 870void rxrpc_put_service_conn(struct rxrpc_connection *);
 871void rxrpc_service_connection_reaper(struct work_struct *);
 872void rxrpc_destroy_all_connections(struct rxrpc_net *);
 873
 874static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
 875{
 876	return conn->out_clientflag;
 877}
 878
 879static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
 880{
 881	return !rxrpc_conn_is_client(conn);
 882}
 883
 884static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
 885{
 886	if (!conn)
 887		return;
 888
 889	if (rxrpc_conn_is_client(conn))
 890		rxrpc_put_client_conn(conn);
 891	else
 892		rxrpc_put_service_conn(conn);
 893}
 894
 895static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
 896					   unsigned long expire_at)
 897{
 898	timer_reduce(&conn->timer, expire_at);
 899}
 900
 901/*
 902 * conn_service.c
 903 */
 904struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
 905						     struct sk_buff *);
 906struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
 907void rxrpc_new_incoming_connection(struct rxrpc_sock *, struct rxrpc_connection *,
 908				   const struct rxrpc_security *, struct sk_buff *);
 
 909void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
 910
 911/*
 912 * input.c
 913 */
 914int rxrpc_input_packet(struct sock *, struct sk_buff *);
 915
 916/*
 917 * insecure.c
 918 */
 919extern const struct rxrpc_security rxrpc_no_security;
 920
 921/*
 922 * key.c
 923 */
 924extern struct key_type key_type_rxrpc;
 
 925
 926int rxrpc_request_key(struct rxrpc_sock *, sockptr_t , int);
 
 927int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
 928			      u32);
 929
 930/*
 931 * local_event.c
 932 */
 933extern void rxrpc_process_local_events(struct rxrpc_local *);
 934
 935/*
 936 * local_object.c
 937 */
 938struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
 939struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *);
 940struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *);
 941void rxrpc_put_local(struct rxrpc_local *);
 942struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *);
 943void rxrpc_unuse_local(struct rxrpc_local *);
 944void rxrpc_queue_local(struct rxrpc_local *);
 945void rxrpc_destroy_all_locals(struct rxrpc_net *);
 946
 947static inline bool __rxrpc_unuse_local(struct rxrpc_local *local)
 948{
 949	return atomic_dec_return(&local->active_users) == 0;
 950}
 951
 952static inline bool __rxrpc_use_local(struct rxrpc_local *local)
 953{
 954	return atomic_fetch_add_unless(&local->active_users, 1, 0) != 0;
 955}
 956
 957/*
 958 * misc.c
 959 */
 960extern unsigned int rxrpc_max_backlog __read_mostly;
 961extern unsigned long rxrpc_requested_ack_delay;
 962extern unsigned long rxrpc_soft_ack_delay;
 963extern unsigned long rxrpc_idle_ack_delay;
 964extern unsigned int rxrpc_rx_window_size;
 965extern unsigned int rxrpc_rx_mtu;
 966extern unsigned int rxrpc_rx_jumbo_max;
 967
 968extern const s8 rxrpc_ack_priority[];
 969
 970/*
 971 * net_ns.c
 972 */
 973extern unsigned int rxrpc_net_id;
 974extern struct pernet_operations rxrpc_net_ops;
 975
 976static inline struct rxrpc_net *rxrpc_net(struct net *net)
 977{
 978	return net_generic(net, rxrpc_net_id);
 979}
 980
 981/*
 982 * output.c
 983 */
 984int rxrpc_send_ack_packet(struct rxrpc_call *, bool, rxrpc_serial_t *);
 985int rxrpc_send_abort_packet(struct rxrpc_call *);
 986int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
 987void rxrpc_reject_packets(struct rxrpc_local *);
 988void rxrpc_send_keepalive(struct rxrpc_peer *);
 989
 990/*
 991 * peer_event.c
 992 */
 993void rxrpc_error_report(struct sock *);
 994void rxrpc_peer_keepalive_worker(struct work_struct *);
 995
 996/*
 997 * peer_object.c
 998 */
 999struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1000					 const struct sockaddr_rxrpc *);
1001struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_sock *, struct rxrpc_local *,
1002				     struct sockaddr_rxrpc *, gfp_t);
1003struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
1004void rxrpc_new_incoming_peer(struct rxrpc_sock *, struct rxrpc_local *,
1005			     struct rxrpc_peer *);
1006void rxrpc_destroy_all_peers(struct rxrpc_net *);
1007struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *);
1008struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *);
1009void rxrpc_put_peer(struct rxrpc_peer *);
1010void rxrpc_put_peer_locked(struct rxrpc_peer *);
1011
1012/*
1013 * proc.c
1014 */
1015extern const struct seq_operations rxrpc_call_seq_ops;
1016extern const struct seq_operations rxrpc_connection_seq_ops;
1017extern const struct seq_operations rxrpc_peer_seq_ops;
1018
1019/*
1020 * recvmsg.c
1021 */
1022void rxrpc_notify_socket(struct rxrpc_call *);
1023bool __rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1024bool rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1025bool __rxrpc_call_completed(struct rxrpc_call *);
1026bool rxrpc_call_completed(struct rxrpc_call *);
1027bool __rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1028bool rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1029int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1030
1031/*
1032 * Abort a call due to a protocol error.
1033 */
1034static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
1035					struct sk_buff *skb,
1036					const char *eproto_why,
1037					const char *why,
1038					u32 abort_code)
1039{
1040	struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
1041
1042	trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
1043	return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
1044}
1045
1046#define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
1047	__rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
1048			     (abort_why), (abort_code))
1049
1050/*
1051 * rtt.c
1052 */
1053void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace, int,
1054			rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1055unsigned long rxrpc_get_rto_backoff(struct rxrpc_peer *, bool);
1056void rxrpc_peer_init_rtt(struct rxrpc_peer *);
1057
1058/*
1059 * rxkad.c
1060 */
1061#ifdef CONFIG_RXKAD
1062extern const struct rxrpc_security rxkad;
1063#endif
1064
1065/*
1066 * security.c
1067 */
1068int __init rxrpc_init_security(void);
1069const struct rxrpc_security *rxrpc_security_lookup(u8);
1070void rxrpc_exit_security(void);
1071int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1072const struct rxrpc_security *rxrpc_get_incoming_security(struct rxrpc_sock *,
1073							 struct sk_buff *);
1074struct key *rxrpc_look_up_server_security(struct rxrpc_connection *,
1075					  struct sk_buff *, u32, u32);
1076
1077/*
1078 * sendmsg.c
1079 */
1080int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1081
1082/*
1083 * server_key.c
1084 */
1085extern struct key_type key_type_rxrpc_s;
1086
1087int rxrpc_server_keyring(struct rxrpc_sock *, sockptr_t, int);
1088
1089/*
1090 * skbuff.c
1091 */
1092void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1093void rxrpc_packet_destructor(struct sk_buff *);
1094void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1095void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1096void rxrpc_eaten_skb(struct sk_buff *, enum rxrpc_skb_trace);
1097void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1098void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1099void rxrpc_purge_queue(struct sk_buff_head *);
1100
1101/*
1102 * sysctl.c
1103 */
1104#ifdef CONFIG_SYSCTL
1105extern int __init rxrpc_sysctl_init(void);
1106extern void rxrpc_sysctl_exit(void);
1107#else
1108static inline int __init rxrpc_sysctl_init(void) { return 0; }
1109static inline void rxrpc_sysctl_exit(void) {}
1110#endif
1111
1112/*
1113 * utils.c
1114 */
1115int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1116
1117static inline bool before(u32 seq1, u32 seq2)
1118{
1119        return (s32)(seq1 - seq2) < 0;
1120}
1121static inline bool before_eq(u32 seq1, u32 seq2)
1122{
1123        return (s32)(seq1 - seq2) <= 0;
1124}
1125static inline bool after(u32 seq1, u32 seq2)
1126{
1127        return (s32)(seq1 - seq2) > 0;
1128}
1129static inline bool after_eq(u32 seq1, u32 seq2)
1130{
1131        return (s32)(seq1 - seq2) >= 0;
1132}
1133
1134/*
1135 * debug tracing
1136 */
1137extern unsigned int rxrpc_debug;
1138
1139#define dbgprintk(FMT,...) \
1140	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1141
1142#define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1143#define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1144#define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
1145#define kproto(FMT,...)	dbgprintk("### "FMT ,##__VA_ARGS__)
1146#define knet(FMT,...)	dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1147
1148
1149#if defined(__KDEBUG)
1150#define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
1151#define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
1152#define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
1153#define _proto(FMT,...)	kproto(FMT,##__VA_ARGS__)
1154#define _net(FMT,...)	knet(FMT,##__VA_ARGS__)
1155
1156#elif defined(CONFIG_AF_RXRPC_DEBUG)
1157#define RXRPC_DEBUG_KENTER	0x01
1158#define RXRPC_DEBUG_KLEAVE	0x02
1159#define RXRPC_DEBUG_KDEBUG	0x04
1160#define RXRPC_DEBUG_KPROTO	0x08
1161#define RXRPC_DEBUG_KNET	0x10
1162
1163#define _enter(FMT,...)					\
1164do {							\
1165	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER))	\
1166		kenter(FMT,##__VA_ARGS__);		\
1167} while (0)
1168
1169#define _leave(FMT,...)					\
1170do {							\
1171	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE))	\
1172		kleave(FMT,##__VA_ARGS__);		\
1173} while (0)
1174
1175#define _debug(FMT,...)					\
1176do {							\
1177	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG))	\
1178		kdebug(FMT,##__VA_ARGS__);		\
1179} while (0)
1180
1181#define _proto(FMT,...)					\
1182do {							\
1183	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO))	\
1184		kproto(FMT,##__VA_ARGS__);		\
1185} while (0)
1186
1187#define _net(FMT,...)					\
1188do {							\
1189	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))	\
1190		knet(FMT,##__VA_ARGS__);		\
1191} while (0)
1192
1193#else
1194#define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1195#define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1196#define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
1197#define _proto(FMT,...)	no_printk("### "FMT ,##__VA_ARGS__)
1198#define _net(FMT,...)	no_printk("@@@ "FMT ,##__VA_ARGS__)
1199#endif
1200
1201/*
1202 * debug assertion checking
1203 */
1204#if 1 // defined(__KDEBUGALL)
1205
1206#define ASSERT(X)						\
1207do {								\
1208	if (unlikely(!(X))) {					\
1209		pr_err("Assertion failed\n");			\
1210		BUG();						\
1211	}							\
1212} while (0)
1213
1214#define ASSERTCMP(X, OP, Y)						\
1215do {									\
1216	__typeof__(X) _x = (X);						\
1217	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1218	if (unlikely(!(_x OP _y))) {					\
1219		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1220		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1221		       (unsigned long)_y, (unsigned long)_y);		\
1222		BUG();							\
1223	}								\
1224} while (0)
1225
1226#define ASSERTIF(C, X)						\
1227do {								\
1228	if (unlikely((C) && !(X))) {				\
1229		pr_err("Assertion failed\n");			\
1230		BUG();						\
1231	}							\
1232} while (0)
1233
1234#define ASSERTIFCMP(C, X, OP, Y)					\
1235do {									\
1236	__typeof__(X) _x = (X);						\
1237	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1238	if (unlikely((C) && !(_x OP _y))) {				\
1239		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1240		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1241		       (unsigned long)_y, (unsigned long)_y);		\
1242		BUG();							\
1243	}								\
1244} while (0)
1245
1246#else
1247
1248#define ASSERT(X)				\
1249do {						\
1250} while (0)
1251
1252#define ASSERTCMP(X, OP, Y)			\
1253do {						\
1254} while (0)
1255
1256#define ASSERTIF(C, X)				\
1257do {						\
1258} while (0)
1259
1260#define ASSERTIFCMP(C, X, OP, Y)		\
1261do {						\
1262} while (0)
1263
1264#endif /* __KDEBUGALL */