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#define FCRYPT_BSIZE 8
  19struct rxrpc_crypt {
  20	union {
  21		u8	x[FCRYPT_BSIZE];
  22		__be32	n[2];
  23	};
  24} __attribute__((aligned(8)));
  25
  26#define rxrpc_queue_work(WS)	queue_work(rxrpc_workqueue, (WS))
  27#define rxrpc_queue_delayed_work(WS,D)	\
  28	queue_delayed_work(rxrpc_workqueue, (WS), (D))
  29
  30struct key_preparsed_payload;
  31struct rxrpc_connection;
  32struct rxrpc_txbuf;
  33
  34/*
  35 * Mark applied to socket buffers in skb->mark.  skb->priority is used
  36 * to pass supplementary information.
  37 */
  38enum rxrpc_skb_mark {
  39	RXRPC_SKB_MARK_PACKET,		/* Received packet */
  40	RXRPC_SKB_MARK_ERROR,		/* Error notification */
  41	RXRPC_SKB_MARK_SERVICE_CONN_SECURED, /* Service connection response has been verified */
  42	RXRPC_SKB_MARK_REJECT_BUSY,	/* Reject with BUSY */
  43	RXRPC_SKB_MARK_REJECT_ABORT,	/* Reject with ABORT (code in skb->priority) */
  44};
  45
  46/*
  47 * sk_state for RxRPC sockets
  48 */
  49enum {
  50	RXRPC_UNBOUND = 0,
  51	RXRPC_CLIENT_UNBOUND,		/* Unbound socket used as client */
  52	RXRPC_CLIENT_BOUND,		/* client local address bound */
 
  53	RXRPC_SERVER_BOUND,		/* server local address bound */
  54	RXRPC_SERVER_BOUND2,		/* second server local address bound */
  55	RXRPC_SERVER_LISTENING,		/* server listening for connections */
  56	RXRPC_SERVER_LISTEN_DISABLED,	/* server listening disabled */
  57	RXRPC_CLOSE,			/* socket is being closed */
  58};
  59
  60/*
  61 * Per-network namespace data.
  62 */
  63struct rxrpc_net {
  64	struct proc_dir_entry	*proc_net;	/* Subdir in /proc/net */
  65	u32			epoch;		/* Local epoch for detecting local-end reset */
  66	struct list_head	calls;		/* List of calls active in this namespace */
  67	spinlock_t		call_lock;	/* Lock for ->calls */
  68	atomic_t		nr_calls;	/* Count of allocated calls */
  69
  70	atomic_t		nr_conns;
  71	struct list_head	conn_proc_list;	/* List of conns in this namespace for proc */
  72	struct list_head	service_conns;	/* Service conns in this namespace */
  73	rwlock_t		conn_lock;	/* Lock for ->conn_proc_list, ->service_conns */
  74	struct work_struct	service_conn_reaper;
  75	struct timer_list	service_conn_reap_timer;
  76
  77	bool			live;
  78
  79	atomic_t		nr_client_conns;
  80
  81	struct hlist_head	local_endpoints;
  82	struct mutex		local_mutex;	/* Lock for ->local_endpoints */
  83
  84	DECLARE_HASHTABLE	(peer_hash, 10);
  85	spinlock_t		peer_hash_lock;	/* Lock for ->peer_hash */
  86
  87#define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
  88	u8			peer_keepalive_cursor;
  89	time64_t		peer_keepalive_base;
  90	struct list_head	peer_keepalive[32];
  91	struct list_head	peer_keepalive_new;
  92	struct timer_list	peer_keepalive_timer;
  93	struct work_struct	peer_keepalive_work;
  94
  95	atomic_t		stat_tx_data;
  96	atomic_t		stat_tx_data_retrans;
  97	atomic_t		stat_tx_data_send;
  98	atomic_t		stat_tx_data_send_frag;
  99	atomic_t		stat_tx_data_send_fail;
 100	atomic_t		stat_tx_data_underflow;
 101	atomic_t		stat_tx_data_cwnd_reset;
 102	atomic_t		stat_rx_data;
 103	atomic_t		stat_rx_data_reqack;
 104	atomic_t		stat_rx_data_jumbo;
 105
 106	atomic_t		stat_tx_ack_fill;
 107	atomic_t		stat_tx_ack_send;
 108	atomic_t		stat_tx_ack_skip;
 109	atomic_t		stat_tx_acks[256];
 110	atomic_t		stat_rx_acks[256];
 111
 112	atomic_t		stat_why_req_ack[8];
 113
 114	atomic_t		stat_io_loop;
 115};
 116
 117/*
 118 * Service backlog preallocation.
 119 *
 120 * This contains circular buffers of preallocated peers, connections and calls
 121 * for incoming service calls and their head and tail pointers.  This allows
 122 * calls to be set up in the data_ready handler, thereby avoiding the need to
 123 * shuffle packets around so much.
 124 */
 125struct rxrpc_backlog {
 126	unsigned short		peer_backlog_head;
 127	unsigned short		peer_backlog_tail;
 128	unsigned short		conn_backlog_head;
 129	unsigned short		conn_backlog_tail;
 130	unsigned short		call_backlog_head;
 131	unsigned short		call_backlog_tail;
 132#define RXRPC_BACKLOG_MAX	32
 133	struct rxrpc_peer	*peer_backlog[RXRPC_BACKLOG_MAX];
 134	struct rxrpc_connection	*conn_backlog[RXRPC_BACKLOG_MAX];
 135	struct rxrpc_call	*call_backlog[RXRPC_BACKLOG_MAX];
 136};
 137
 138/*
 139 * RxRPC socket definition
 140 */
 141struct rxrpc_sock {
 142	/* WARNING: sk has to be the first member */
 143	struct sock		sk;
 144	rxrpc_notify_new_call_t	notify_new_call; /* Func to notify of new call */
 145	rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
 146	struct rxrpc_local	*local;		/* local endpoint */
 147	struct rxrpc_backlog	*backlog;	/* Preallocation for services */
 148	spinlock_t		incoming_lock;	/* Incoming call vs service shutdown lock */
 149	struct list_head	sock_calls;	/* List of calls owned by this socket */
 150	struct list_head	to_be_accepted;	/* calls awaiting acceptance */
 151	struct list_head	recvmsg_q;	/* Calls awaiting recvmsg's attention  */
 152	rwlock_t		recvmsg_lock;	/* Lock for recvmsg_q */
 153	struct key		*key;		/* security for this socket */
 154	struct key		*securities;	/* list of server security descriptors */
 155	struct rb_root		calls;		/* User ID -> call mapping */
 156	unsigned long		flags;
 157#define RXRPC_SOCK_CONNECTED		0	/* connect_srx is set */
 158	rwlock_t		call_lock;	/* lock for calls */
 159	u32			min_sec_level;	/* minimum security level */
 160#define RXRPC_SECURITY_MAX	RXRPC_SECURITY_ENCRYPT
 161	bool			exclusive;	/* Exclusive connection for a client socket */
 162	u16			second_service;	/* Additional service bound to the endpoint */
 163	struct {
 164		/* Service upgrade information */
 165		u16		from;		/* Service ID to upgrade (if not 0) */
 166		u16		to;		/* service ID to upgrade to */
 167	} service_upgrade;
 168	sa_family_t		family;		/* Protocol family created with */
 169	struct sockaddr_rxrpc	srx;		/* Primary Service/local addresses */
 170	struct sockaddr_rxrpc	connect_srx;	/* Default client address from connect() */
 171};
 172
 173#define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
 174
 175/*
 176 * CPU-byteorder normalised Rx packet header.
 177 */
 178struct rxrpc_host_header {
 179	u32		epoch;		/* client boot timestamp */
 180	u32		cid;		/* connection and channel ID */
 181	u32		callNumber;	/* call ID (0 for connection-level packets) */
 182	u32		seq;		/* sequence number of pkt in call stream */
 183	u32		serial;		/* serial number of pkt sent to network */
 184	u8		type;		/* packet type */
 185	u8		flags;		/* packet flags */
 186	u8		userStatus;	/* app-layer defined status */
 187	u8		securityIndex;	/* security protocol ID */
 188	union {
 189		u16	_rsvd;		/* reserved */
 190		u16	cksum;		/* kerberos security checksum */
 191	};
 192	u16		serviceId;	/* service ID */
 193} __packed;
 194
 195/*
 196 * RxRPC socket buffer private variables
 197 * - max 48 bytes (struct sk_buff::cb)
 198 */
 199struct rxrpc_skb_priv {
 200	struct rxrpc_connection *conn;	/* Connection referred to (poke packet) */
 201	u16		offset;		/* Offset of data */
 202	u16		len;		/* Length of data */
 203	u8		flags;
 204#define RXRPC_RX_VERIFIED	0x01
 
 
 
 205
 206	struct rxrpc_host_header hdr;	/* RxRPC packet header from this packet */
 207};
 208
 209#define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
 210
 
 
 
 
 
 
 
 211/*
 212 * RxRPC security module interface
 213 */
 214struct rxrpc_security {
 
 
 215	const char		*name;		/* name of this service */
 216	u8			security_index;	/* security type provided */
 217	u32			no_key_abort;	/* Abort code indicating no key */
 218
 219	/* Initialise a security service */
 220	int (*init)(void);
 221
 222	/* Clean up a security service */
 223	void (*exit)(void);
 224
 225	/* Parse the information from a server key */
 226	int (*preparse_server_key)(struct key_preparsed_payload *);
 227
 228	/* Clean up the preparse buffer after parsing a server key */
 229	void (*free_preparse_server_key)(struct key_preparsed_payload *);
 230
 231	/* Destroy the payload of a server key */
 232	void (*destroy_server_key)(struct key *);
 233
 234	/* Describe a server key */
 235	void (*describe_server_key)(const struct key *, struct seq_file *);
 236
 237	/* initialise a connection's security */
 238	int (*init_connection_security)(struct rxrpc_connection *,
 239					struct rxrpc_key_token *);
 240
 241	/* Work out how much data we can store in a packet, given an estimate
 242	 * of the amount of data remaining.
 243	 */
 244	int (*how_much_data)(struct rxrpc_call *, size_t,
 245			     size_t *, size_t *, size_t *);
 246
 247	/* impose security on a packet */
 248	int (*secure_packet)(struct rxrpc_call *, struct rxrpc_txbuf *);
 
 
 
 249
 250	/* verify the security on a received packet */
 251	int (*verify_packet)(struct rxrpc_call *, struct sk_buff *);
 252
 253	/* Free crypto request on a call */
 254	void (*free_call_crypto)(struct rxrpc_call *);
 255
 256	/* issue a challenge */
 257	int (*issue_challenge)(struct rxrpc_connection *);
 258
 259	/* respond to a challenge */
 260	int (*respond_to_challenge)(struct rxrpc_connection *,
 261				    struct sk_buff *);
 
 262
 263	/* verify a response */
 264	int (*verify_response)(struct rxrpc_connection *,
 265			       struct sk_buff *);
 
 266
 267	/* clear connection security */
 268	void (*clear)(struct rxrpc_connection *);
 269};
 270
 271/*
 272 * RxRPC local transport endpoint description
 273 * - owned by a single AF_RXRPC socket
 274 * - pointed to by transport socket struct sk_user_data
 275 */
 276struct rxrpc_local {
 277	struct rcu_head		rcu;
 278	atomic_t		active_users;	/* Number of users of the local endpoint */
 279	refcount_t		ref;		/* Number of references to the structure */
 280	struct net		*net;		/* The network namespace */
 281	struct rxrpc_net	*rxnet;		/* Our bits in the network namespace */
 282	struct hlist_node	link;
 283	struct socket		*socket;	/* my UDP socket */
 284	struct task_struct	*io_thread;
 285	struct completion	io_thread_ready; /* Indication that the I/O thread started */
 286	struct rxrpc_sock	*service;	/* Service(s) listening on this endpoint */
 
 
 287	struct rw_semaphore	defrag_sem;	/* control re-enablement of IP DF bit */
 288	struct sk_buff_head	rx_queue;	/* Received packets */
 289	struct list_head	conn_attend_q;	/* Conns requiring immediate attention */
 290	struct list_head	call_attend_q;	/* Calls requiring immediate attention */
 291
 292	struct rb_root		client_bundles;	/* Client connection bundles by socket params */
 293	spinlock_t		client_bundles_lock; /* Lock for client_bundles */
 294	bool			kill_all_client_conns;
 295	struct list_head	idle_client_conns;
 296	struct timer_list	client_conn_reap_timer;
 297	unsigned long		client_conn_flags;
 298#define RXRPC_CLIENT_CONN_REAP_TIMER	0	/* The client conn reap timer expired */
 299
 300	spinlock_t		lock;		/* access lock */
 301	rwlock_t		services_lock;	/* lock for services list */
 
 302	int			debug_id;	/* debug ID for printks */
 303	bool			dead;
 304	bool			service_closed;	/* Service socket closed */
 305	struct idr		conn_ids;	/* List of connection IDs */
 306	struct list_head	new_client_calls; /* Newly created client calls need connection */
 307	spinlock_t		client_call_lock; /* Lock for ->new_client_calls */
 308	struct sockaddr_rxrpc	srx;		/* local address */
 309};
 310
 311/*
 312 * RxRPC remote transport endpoint definition
 313 * - matched by local endpoint, remote port, address and protocol type
 
 314 */
 315struct rxrpc_peer {
 316	struct rcu_head		rcu;		/* This must be first */
 317	refcount_t		ref;
 318	unsigned long		hash_key;
 319	struct hlist_node	hash_link;
 320	struct rxrpc_local	*local;
 321	struct hlist_head	error_targets;	/* targets for net error distribution */
 322	struct rb_root		service_conns;	/* Service connections */
 323	struct list_head	keepalive_link;	/* Link in net->peer_keepalive[] */
 324	time64_t		last_tx_at;	/* Last time packet sent here */
 325	seqlock_t		service_conn_lock;
 326	spinlock_t		lock;		/* access lock */
 
 327	unsigned int		if_mtu;		/* interface MTU for this peer */
 328	unsigned int		mtu;		/* network MTU for this peer */
 329	unsigned int		maxdata;	/* data size (MTU - hdrsize) */
 330	unsigned short		hdrsize;	/* header size (IP + UDP + RxRPC) */
 331	int			debug_id;	/* debug ID for printks */
 
 332	struct sockaddr_rxrpc	srx;		/* remote address */
 333
 334	/* calculated RTT cache */
 335#define RXRPC_RTT_CACHE_SIZE 32
 336	spinlock_t		rtt_input_lock;	/* RTT lock for input routine */
 337	ktime_t			rtt_last_req;	/* Time of last RTT request */
 338	unsigned int		rtt_count;	/* Number of samples we've got */
 339
 340	u32			srtt_us;	/* smoothed round trip time << 3 in usecs */
 341	u32			mdev_us;	/* medium deviation			*/
 342	u32			mdev_max_us;	/* maximal mdev for the last rtt period	*/
 343	u32			rttvar_us;	/* smoothed mdev_max			*/
 344	u32			rto_j;		/* Retransmission timeout in jiffies */
 345	u8			backoff;	/* Backoff timeout */
 346
 347	u8			cong_ssthresh;	/* Congestion slow-start threshold */
 348};
 349
 350/*
 351 * Keys for matching a connection.
 352 */
 353struct rxrpc_conn_proto {
 354	union {
 355		struct {
 356			u32	epoch;		/* epoch of this connection */
 357			u32	cid;		/* connection ID */
 358		};
 359		u64		index_key;
 360	};
 361};
 362
 363struct rxrpc_conn_parameters {
 364	struct rxrpc_local	*local;		/* Representation of local endpoint */
 365	struct key		*key;		/* Security details */
 366	bool			exclusive;	/* T if conn is exclusive */
 367	bool			upgrade;	/* T if service ID can be upgraded */
 368	u16			service_id;	/* Service ID for this connection */
 369	u32			security_level;	/* Security level selected */
 370};
 371
 372/*
 373 * Call completion condition (state == RXRPC_CALL_COMPLETE).
 374 */
 375enum rxrpc_call_completion {
 376	RXRPC_CALL_SUCCEEDED,		/* - Normal termination */
 377	RXRPC_CALL_REMOTELY_ABORTED,	/* - call aborted by peer */
 378	RXRPC_CALL_LOCALLY_ABORTED,	/* - call aborted locally on error or close */
 379	RXRPC_CALL_LOCAL_ERROR,		/* - call failed due to local error */
 380	RXRPC_CALL_NETWORK_ERROR,	/* - call terminated by network error */
 381	NR__RXRPC_CALL_COMPLETIONS
 382};
 383
 384/*
 385 * Bits in the connection flags.
 386 */
 387enum rxrpc_conn_flag {
 388	RXRPC_CONN_IN_SERVICE_CONNS,	/* Conn is in peer->service_conns */
 389	RXRPC_CONN_DONT_REUSE,		/* Don't reuse this connection */
 390	RXRPC_CONN_PROBING_FOR_UPGRADE,	/* Probing for service upgrade */
 391	RXRPC_CONN_FINAL_ACK_0,		/* Need final ACK for channel 0 */
 392	RXRPC_CONN_FINAL_ACK_1,		/* Need final ACK for channel 1 */
 393	RXRPC_CONN_FINAL_ACK_2,		/* Need final ACK for channel 2 */
 394	RXRPC_CONN_FINAL_ACK_3,		/* Need final ACK for channel 3 */
 395};
 396
 397#define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) |	\
 398				   (1UL << RXRPC_CONN_FINAL_ACK_1) |	\
 399				   (1UL << RXRPC_CONN_FINAL_ACK_2) |	\
 400				   (1UL << RXRPC_CONN_FINAL_ACK_3))
 401
 402/*
 403 * Events that can be raised upon a connection.
 404 */
 405enum rxrpc_conn_event {
 406	RXRPC_CONN_EV_CHALLENGE,	/* Send challenge packet */
 407	RXRPC_CONN_EV_ABORT_CALLS,	/* Abort attached calls */
 408};
 409
 410/*
 411 * The connection protocol state.
 412 */
 413enum rxrpc_conn_proto_state {
 414	RXRPC_CONN_UNUSED,		/* Connection not yet attempted */
 415	RXRPC_CONN_CLIENT_UNSECURED,	/* Client connection needs security init */
 416	RXRPC_CONN_CLIENT,		/* Client connection */
 417	RXRPC_CONN_SERVICE_PREALLOC,	/* Service connection preallocation */
 418	RXRPC_CONN_SERVICE_UNSECURED,	/* Service unsecured connection */
 419	RXRPC_CONN_SERVICE_CHALLENGING,	/* Service challenging for security */
 420	RXRPC_CONN_SERVICE,		/* Service secured connection */
 421	RXRPC_CONN_ABORTED,		/* Conn aborted */
 422	RXRPC_CONN__NR_STATES
 423};
 424
 425/*
 426 * RxRPC client connection bundle.
 
 427 */
 428struct rxrpc_bundle {
 429	struct rxrpc_local	*local;		/* Representation of local endpoint */
 430	struct rxrpc_peer	*peer;		/* Remote endpoint */
 431	struct key		*key;		/* Security details */
 432	const struct rxrpc_security *security;	/* applied security module */
 433	refcount_t		ref;
 434	atomic_t		active;		/* Number of active users */
 435	unsigned int		debug_id;
 436	u32			security_level;	/* Security level selected */
 437	u16			service_id;	/* Service ID for this connection */
 438	bool			try_upgrade;	/* True if the bundle is attempting upgrade */
 439	bool			exclusive;	/* T if conn is exclusive */
 440	bool			upgrade;	/* T if service ID can be upgraded */
 441	unsigned short		alloc_error;	/* Error from last conn allocation */
 442	struct rb_node		local_node;	/* Node in local->client_conns */
 443	struct list_head	waiting_calls;	/* Calls waiting for channels */
 444	unsigned long		avail_chans;	/* Mask of available channels */
 445	struct rxrpc_connection	*conns[4];	/* The connections in the bundle (max 4) */
 446};
 447
 448/*
 449 * RxRPC connection definition
 450 * - matched by { local, peer, epoch, conn_id, direction }
 451 * - each connection can only handle four simultaneous calls
 452 */
 453struct rxrpc_connection {
 454	struct rxrpc_conn_proto	proto;
 455	struct rxrpc_local	*local;		/* Representation of local endpoint */
 456	struct rxrpc_peer	*peer;		/* Remote endpoint */
 457	struct rxrpc_net	*rxnet;		/* Network namespace to which call belongs */
 458	struct key		*key;		/* Security details */
 459	struct list_head	attend_link;	/* Link in local->conn_attend_q */
 460
 461	refcount_t		ref;
 462	atomic_t		active;		/* Active count for service conns */
 463	struct rcu_head		rcu;
 464	struct list_head	cache_link;
 465
 466	unsigned char		act_chans;	/* Mask of active channels */
 467	struct rxrpc_channel {
 468		unsigned long		final_ack_at;	/* Time at which to issue final ACK */
 469		struct rxrpc_call	*call;		/* Active call */
 470		unsigned int		call_debug_id;	/* call->debug_id */
 471		u32			call_id;	/* ID of current call */
 472		u32			call_counter;	/* Call ID counter */
 473		u32			last_call;	/* ID of last call */
 474		u8			last_type;	/* Type of last packet */
 475		union {
 476			u32		last_seq;
 477			u32		last_abort;
 478		};
 479	} channels[RXRPC_MAXCALLS];
 480
 481	struct timer_list	timer;		/* Conn event timer */
 482	struct work_struct	processor;	/* connection event processor */
 483	struct work_struct	destructor;	/* In-process-context destroyer */
 484	struct rxrpc_bundle	*bundle;	/* Client connection bundle */
 485	struct rb_node		service_node;	/* Node in peer->service_conns */
 486	struct list_head	proc_link;	/* link in procfs list */
 487	struct list_head	link;		/* link in master connection list */
 
 
 488	struct sk_buff_head	rx_queue;	/* received conn-level packets */
 489
 490	struct mutex		security_lock;	/* Lock for security management */
 491	const struct rxrpc_security *security;	/* applied security module */
 492	union {
 493		struct {
 494			struct crypto_sync_skcipher *cipher;	/* encryption handle */
 495			struct rxrpc_crypt csum_iv;	/* packet checksum base */
 496			u32	nonce;		/* response re-use preventer */
 497		} rxkad;
 498	};
 499	unsigned long		flags;
 500	unsigned long		events;
 501	unsigned long		idle_timestamp;	/* Time at which last became idle */
 
 
 502	spinlock_t		state_lock;	/* state-change lock */
 503	enum rxrpc_conn_proto_state state;	/* current state of connection */
 504	enum rxrpc_call_completion completion;	/* Completion condition */
 505	s32			abort_code;	/* Abort code of connection abort */
 
 
 
 
 
 
 
 
 
 
 506	int			debug_id;	/* debug ID for printks */
 
 507	atomic_t		serial;		/* packet serial number counter */
 508	unsigned int		hi_serial;	/* highest serial number received */
 509	u32			service_id;	/* Service ID, possibly upgraded */
 510	u32			security_level;	/* Security level selected */
 
 
 
 
 
 
 
 
 
 511	u8			security_ix;	/* security type */
 
 512	u8			out_clientflag;	/* RXRPC_CLIENT_INITIATED if we are client */
 513	u8			bundle_shift;	/* Index into bundle->avail_chans */
 514	bool			exclusive;	/* T if conn is exclusive */
 515	bool			upgrade;	/* T if service ID can be upgraded */
 516	u16			orig_service_id; /* Originally requested service ID */
 517	short			error;		/* Local error code */
 518};
 519
 520static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
 521{
 522	return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
 523}
 524
 525static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
 526{
 527	return !rxrpc_to_server(sp);
 528}
 529
 530/*
 531 * Flags in call->flags.
 532 */
 533enum rxrpc_call_flag {
 534	RXRPC_CALL_RELEASED,		/* call has been released - no more message to userspace */
 535	RXRPC_CALL_HAS_USERID,		/* has a user ID attached */
 536	RXRPC_CALL_IS_SERVICE,		/* Call is service call */
 537	RXRPC_CALL_EXPOSED,		/* The call was exposed to the world */
 538	RXRPC_CALL_RX_LAST,		/* Received the last packet (at rxtx_top) */
 539	RXRPC_CALL_TX_LAST,		/* Last packet in Tx buffer (at rxtx_top) */
 540	RXRPC_CALL_TX_ALL_ACKED,	/* Last packet has been hard-acked */
 541	RXRPC_CALL_SEND_PING,		/* A ping will need to be sent */
 542	RXRPC_CALL_RETRANS_TIMEOUT,	/* Retransmission due to timeout occurred */
 543	RXRPC_CALL_BEGAN_RX_TIMER,	/* We began the expect_rx_by timer */
 544	RXRPC_CALL_RX_HEARD,		/* The peer responded at least once to this call */
 545	RXRPC_CALL_DISCONNECTED,	/* The call has been disconnected */
 546	RXRPC_CALL_KERNEL,		/* The call was made by the kernel */
 547	RXRPC_CALL_UPGRADE,		/* Service upgrade was requested for the call */
 548	RXRPC_CALL_EXCLUSIVE,		/* The call uses a once-only connection */
 549	RXRPC_CALL_RX_IS_IDLE,		/* recvmsg() is idle - send an ACK */
 550	RXRPC_CALL_RECVMSG_READ_ALL,	/* recvmsg() read all of the received data */
 551};
 552
 553/*
 554 * Events that can be raised on a call.
 555 */
 556enum rxrpc_call_event {
 557	RXRPC_CALL_EV_ACK_LOST,		/* ACK may be lost, send ping */
 558	RXRPC_CALL_EV_INITIAL_PING,	/* Send initial ping for a new service call */
 559};
 560
 561/*
 562 * The states that a call can be in.
 563 */
 564enum rxrpc_call_state {
 565	RXRPC_CALL_UNINITIALISED,
 566	RXRPC_CALL_CLIENT_AWAIT_CONN,	/* - client waiting for connection to become available */
 567	RXRPC_CALL_CLIENT_SEND_REQUEST,	/* - client sending request phase */
 568	RXRPC_CALL_CLIENT_AWAIT_REPLY,	/* - client awaiting reply */
 569	RXRPC_CALL_CLIENT_RECV_REPLY,	/* - client receiving reply phase */
 570	RXRPC_CALL_SERVER_PREALLOC,	/* - service preallocation */
 571	RXRPC_CALL_SERVER_SECURING,	/* - server securing request connection */
 572	RXRPC_CALL_SERVER_RECV_REQUEST,	/* - server receiving request */
 573	RXRPC_CALL_SERVER_ACK_REQUEST,	/* - server pending ACK of request */
 574	RXRPC_CALL_SERVER_SEND_REPLY,	/* - server sending reply */
 575	RXRPC_CALL_SERVER_AWAIT_ACK,	/* - server awaiting final ACK */
 576	RXRPC_CALL_COMPLETE,		/* - call complete */
 577	NR__RXRPC_CALL_STATES
 578};
 579
 580/*
 581 * Call Tx congestion management modes.
 582 */
 583enum rxrpc_congest_mode {
 584	RXRPC_CALL_SLOW_START,
 585	RXRPC_CALL_CONGEST_AVOIDANCE,
 586	RXRPC_CALL_PACKET_LOSS,
 587	RXRPC_CALL_FAST_RETRANSMIT,
 588	NR__RXRPC_CONGEST_MODES
 589};
 590
 591/*
 592 * RxRPC call definition
 593 * - matched by { connection, call_id }
 594 */
 595struct rxrpc_call {
 596	struct rcu_head		rcu;
 597	struct rxrpc_connection	*conn;		/* connection carrying call */
 598	struct rxrpc_bundle	*bundle;	/* Connection bundle to use */
 599	struct rxrpc_peer	*peer;		/* Peer record for remote address */
 600	struct rxrpc_local	*local;		/* Representation of local endpoint */
 601	struct rxrpc_sock __rcu	*socket;	/* socket responsible */
 602	struct rxrpc_net	*rxnet;		/* Network namespace to which call belongs */
 603	struct key		*key;		/* Security details */
 604	const struct rxrpc_security *security;	/* applied security module */
 605	struct mutex		user_mutex;	/* User access mutex */
 606	struct sockaddr_rxrpc	dest_srx;	/* Destination address */
 607	unsigned long		delay_ack_at;	/* When DELAY ACK needs to happen */
 608	unsigned long		ack_lost_at;	/* When ACK is figured as lost */
 609	unsigned long		resend_at;	/* When next resend needs to happen */
 610	unsigned long		ping_at;	/* When next to send a ping */
 611	unsigned long		keepalive_at;	/* When next to send a keepalive ping */
 612	unsigned long		expect_rx_by;	/* When we expect to get a packet by */
 613	unsigned long		expect_req_by;	/* When we expect to get a request DATA packet by */
 614	unsigned long		expect_term_by;	/* When we expect call termination by */
 615	u32			next_rx_timo;	/* Timeout for next Rx packet (jif) */
 616	u32			next_req_timo;	/* Timeout for next Rx request packet (jif) */
 617	struct timer_list	timer;		/* Combined event timer */
 618	struct work_struct	destroyer;	/* In-process-context destroyer */
 619	rxrpc_notify_rx_t	notify_rx;	/* kernel service Rx notification function */
 620	struct list_head	link;		/* link in master call list */
 621	struct list_head	wait_link;	/* Link in local->new_client_calls */
 622	struct hlist_node	error_link;	/* link in error distribution list */
 623	struct list_head	accept_link;	/* Link in rx->acceptq */
 624	struct list_head	recvmsg_link;	/* Link in rx->recvmsg_q */
 625	struct list_head	sock_link;	/* Link in rx->sock_calls */
 626	struct rb_node		sock_node;	/* Node in rx->calls */
 627	struct list_head	attend_link;	/* Link in local->call_attend_q */
 628	struct rxrpc_txbuf	*tx_pending;	/* Tx buffer being filled */
 629	wait_queue_head_t	waitq;		/* Wait queue for channel or Tx */
 630	s64			tx_total_len;	/* Total length left to be transmitted (or -1) */
 631	unsigned long		user_call_ID;	/* user-defined call ID */
 
 632	unsigned long		flags;
 
 
 
 
 
 
 
 
 
 633	unsigned long		events;
 634	spinlock_t		notify_lock;	/* Kernel notification lock */
 635	unsigned int		send_abort_why; /* Why the abort [enum rxrpc_abort_reason] */
 636	s32			send_abort;	/* Abort code to be sent */
 637	short			send_abort_err;	/* Error to be associated with the abort */
 638	rxrpc_seq_t		send_abort_seq;	/* DATA packet that incurred the abort (or 0) */
 639	s32			abort_code;	/* Local/remote abort code */
 640	int			error;		/* Local error incurred */
 641	enum rxrpc_call_state	_state;		/* Current state of call (needs barrier) */
 642	enum rxrpc_call_completion completion;	/* Call completion condition */
 643	refcount_t		ref;
 644	u8			security_ix;	/* Security type */
 645	enum rxrpc_interruptibility interruptibility; /* At what point call may be interrupted */
 646	u32			call_id;	/* call ID on connection  */
 647	u32			cid;		/* connection ID plus channel index */
 648	u32			security_level;	/* Security level selected */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 649	int			debug_id;	/* debug ID for printks */
 650	unsigned short		rx_pkt_offset;	/* Current recvmsg packet offset */
 651	unsigned short		rx_pkt_len;	/* Current recvmsg packet len */
 652
 653	/* Transmitted data tracking. */
 654	spinlock_t		tx_lock;	/* Transmit queue lock */
 655	struct list_head	tx_sendmsg;	/* Sendmsg prepared packets */
 656	struct list_head	tx_buffer;	/* Buffer of transmissible packets */
 657	rxrpc_seq_t		tx_bottom;	/* First packet in buffer */
 658	rxrpc_seq_t		tx_transmitted;	/* Highest packet transmitted */
 659	rxrpc_seq_t		tx_prepared;	/* Highest Tx slot prepared. */
 660	rxrpc_seq_t		tx_top;		/* Highest Tx slot allocated. */
 661	u16			tx_backoff;	/* Delay to insert due to Tx failure */
 662	u8			tx_winsize;	/* Maximum size of Tx window */
 663#define RXRPC_TX_MAX_WINDOW	128
 664	ktime_t			tx_last_sent;	/* Last time a transmission occurred */
 665
 666	/* Received data tracking */
 667	struct sk_buff_head	recvmsg_queue;	/* Queue of packets ready for recvmsg() */
 668	struct sk_buff_head	rx_oos_queue;	/* Queue of out of sequence packets */
 669
 670	rxrpc_seq_t		rx_highest_seq;	/* Higest sequence number received */
 671	rxrpc_seq_t		rx_consumed;	/* Highest packet consumed */
 672	rxrpc_serial_t		rx_serial;	/* Highest serial received for this call */
 673	u8			rx_winsize;	/* Size of Rx window */
 674
 675	/* TCP-style slow-start congestion control [RFC5681].  Since the SMSS
 676	 * is fixed, we keep these numbers in terms of segments (ie. DATA
 677	 * packets) rather than bytes.
 678	 */
 679#define RXRPC_TX_SMSS		RXRPC_JUMBO_DATALEN
 680#define RXRPC_MIN_CWND		(RXRPC_TX_SMSS > 2190 ? 2 : RXRPC_TX_SMSS > 1095 ? 3 : 4)
 681	u8			cong_cwnd;	/* Congestion window size */
 682	u8			cong_extra;	/* Extra to send for congestion management */
 683	u8			cong_ssthresh;	/* Slow-start threshold */
 684	enum rxrpc_congest_mode	cong_mode:8;	/* Congestion management mode */
 685	u8			cong_dup_acks;	/* Count of ACKs showing missing packets */
 686	u8			cong_cumul_acks; /* Cumulative ACK count */
 687	ktime_t			cong_tstamp;	/* Last time cwnd was changed */
 688
 689	/* Receive-phase ACK management (ACKs we send). */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 690	u8			ackr_reason;	/* reason to ACK */
 691	rxrpc_serial_t		ackr_serial;	/* serial of packet being ACK'd */
 692	atomic64_t		ackr_window;	/* Base (in LSW) and top (in MSW) of SACK window */
 693	atomic_t		ackr_nr_unacked; /* Number of unacked packets */
 694	atomic_t		ackr_nr_consumed; /* Number of packets needing hard ACK */
 695	struct {
 696#define RXRPC_SACK_SIZE 256
 697		 /* SACK table for soft-acked packets */
 698		u8		ackr_sack_table[RXRPC_SACK_SIZE];
 699	} __aligned(8);
 700
 701	/* RTT management */
 702	rxrpc_serial_t		rtt_serial[4];	/* Serial number of DATA or PING sent */
 703	ktime_t			rtt_sent_at[4];	/* Time packet sent */
 704	unsigned long		rtt_avail;	/* Mask of available slots in bits 0-3,
 705						 * Mask of pending samples in 8-11 */
 706#define RXRPC_CALL_RTT_AVAIL_MASK	0xf
 707#define RXRPC_CALL_RTT_PEND_SHIFT	8
 708
 709	/* Transmission-phase ACK management (ACKs we've received). */
 710	ktime_t			acks_latest_ts;	/* Timestamp of latest ACK received */
 711	rxrpc_seq_t		acks_first_seq;	/* first sequence number received */
 712	rxrpc_seq_t		acks_prev_seq;	/* Highest previousPacket received */
 713	rxrpc_seq_t		acks_hard_ack;	/* Latest hard-ack point */
 714	rxrpc_seq_t		acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
 715	rxrpc_serial_t		acks_highest_serial; /* Highest serial number ACK'd */
 716};
 717
 718/*
 719 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
 720 */
 721struct rxrpc_ack_summary {
 722	u16			nr_acks;		/* Number of ACKs in packet */
 723	u16			nr_new_acks;		/* Number of new ACKs in packet */
 724	u16			nr_rot_new_acks;	/* Number of rotated new ACKs */
 725	u8			ack_reason;
 726	bool			saw_nacks;		/* Saw NACKs in packet */
 727	bool			new_low_nack;		/* T if new low NACK found */
 728	bool			retrans_timeo;		/* T if reTx due to timeout happened */
 729	u8			flight_size;		/* Number of unreceived transmissions */
 730	/* Place to stash values for tracing */
 731	enum rxrpc_congest_mode	mode:8;
 732	u8			cwnd;
 733	u8			ssthresh;
 734	u8			dup_acks;
 735	u8			cumulative_acks;
 736};
 737
 738/*
 739 * sendmsg() cmsg-specified parameters.
 740 */
 741enum rxrpc_command {
 742	RXRPC_CMD_SEND_DATA,		/* send data message */
 743	RXRPC_CMD_SEND_ABORT,		/* request abort generation */
 744	RXRPC_CMD_REJECT_BUSY,		/* [server] reject a call as busy */
 745	RXRPC_CMD_CHARGE_ACCEPT,	/* [server] charge accept preallocation */
 746};
 747
 748struct rxrpc_call_params {
 749	s64			tx_total_len;	/* Total Tx data length (if send data) */
 750	unsigned long		user_call_ID;	/* User's call ID */
 751	struct {
 752		u32		hard;		/* Maximum lifetime (sec) */
 753		u32		idle;		/* Max time since last data packet (msec) */
 754		u32		normal;		/* Max time since last call packet (msec) */
 755	} timeouts;
 756	u8			nr_timeouts;	/* Number of timeouts specified */
 757	bool			kernel;		/* T if kernel is making the call */
 758	enum rxrpc_interruptibility interruptibility; /* How is interruptible is the call? */
 759};
 760
 761struct rxrpc_send_params {
 762	struct rxrpc_call_params call;
 763	u32			abort_code;	/* Abort code to Tx (if abort) */
 764	enum rxrpc_command	command : 8;	/* The command to implement */
 765	bool			exclusive;	/* Shared or exclusive call */
 766	bool			upgrade;	/* If the connection is upgradeable */
 767};
 768
 769/*
 770 * Buffer of data to be output as a packet.
 771 */
 772struct rxrpc_txbuf {
 773	struct rcu_head		rcu;
 774	struct list_head	call_link;	/* Link in call->tx_sendmsg/tx_buffer */
 775	struct list_head	tx_link;	/* Link in live Enc queue or Tx queue */
 776	ktime_t			last_sent;	/* Time at which last transmitted */
 777	refcount_t		ref;
 778	rxrpc_seq_t		seq;		/* Sequence number of this packet */
 779	unsigned int		call_debug_id;
 780	unsigned int		debug_id;
 781	unsigned int		len;		/* Amount of data in buffer */
 782	unsigned int		space;		/* Remaining data space */
 783	unsigned int		offset;		/* Offset of fill point */
 784	unsigned long		flags;
 785#define RXRPC_TXBUF_LAST	0		/* Set if last packet in Tx phase */
 786#define RXRPC_TXBUF_RESENT	1		/* Set if has been resent */
 787	u8 /*enum rxrpc_propose_ack_trace*/ ack_why;	/* If ack, why */
 788	struct {
 789		/* The packet for encrypting and DMA'ing.  We align it such
 790		 * that data[] aligns correctly for any crypto blocksize.
 791		 */
 792		u8		pad[64 - sizeof(struct rxrpc_wire_header)];
 793		struct rxrpc_wire_header wire;	/* Network-ready header */
 794		union {
 795			u8	data[RXRPC_JUMBO_DATALEN]; /* Data packet */
 796			struct {
 797				struct rxrpc_ackpacket ack;
 798				u8 acks[0];
 799			};
 800		};
 801	} __aligned(64);
 802};
 803
 804static inline bool rxrpc_sending_to_server(const struct rxrpc_txbuf *txb)
 805{
 806	return txb->wire.flags & RXRPC_CLIENT_INITIATED;
 807}
 808
 809static inline bool rxrpc_sending_to_client(const struct rxrpc_txbuf *txb)
 810{
 811	return !rxrpc_sending_to_server(txb);
 812}
 813
 814#include <trace/events/rxrpc.h>
 815
 816/*
 817 * af_rxrpc.c
 818 */
 819extern atomic_t rxrpc_n_rx_skbs;
 
 
 820extern struct workqueue_struct *rxrpc_workqueue;
 821
 822/*
 823 * call_accept.c
 824 */
 825int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
 826void rxrpc_discard_prealloc(struct rxrpc_sock *);
 827bool rxrpc_new_incoming_call(struct rxrpc_local *local,
 828			     struct rxrpc_peer *peer,
 829			     struct rxrpc_connection *conn,
 830			     struct sockaddr_rxrpc *peer_srx,
 831			     struct sk_buff *skb);
 832void rxrpc_accept_incoming_calls(struct rxrpc_local *);
 833int rxrpc_user_charge_accept(struct rxrpc_sock *, unsigned long);
 834
 835/*
 836 * call_event.c
 837 */
 838void rxrpc_propose_ping(struct rxrpc_call *call, u32 serial,
 839			enum rxrpc_propose_ack_trace why);
 840void rxrpc_send_ACK(struct rxrpc_call *, u8, rxrpc_serial_t, enum rxrpc_propose_ack_trace);
 841void rxrpc_propose_delay_ACK(struct rxrpc_call *, rxrpc_serial_t,
 842			     enum rxrpc_propose_ack_trace);
 843void rxrpc_shrink_call_tx_buffer(struct rxrpc_call *);
 844void rxrpc_resend(struct rxrpc_call *call, struct sk_buff *ack_skb);
 845
 846void rxrpc_reduce_call_timer(struct rxrpc_call *call,
 847			     unsigned long expire_at,
 848			     unsigned long now,
 849			     enum rxrpc_timer_trace why);
 850
 851bool rxrpc_input_call_event(struct rxrpc_call *call, struct sk_buff *skb);
 
 
 
 
 
 
 
 
 
 
 
 
 852
 853/*
 854 * call_object.c
 855 */
 856extern const char *const rxrpc_call_states[];
 857extern const char *const rxrpc_call_completions[];
 858extern struct kmem_cache *rxrpc_call_jar;
 
 
 859
 860void rxrpc_poke_call(struct rxrpc_call *call, enum rxrpc_call_poke_trace what);
 861struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
 862struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
 863struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
 864					 struct rxrpc_conn_parameters *,
 865					 struct sockaddr_rxrpc *,
 866					 struct rxrpc_call_params *, gfp_t,
 867					 unsigned int);
 868void rxrpc_start_call_timer(struct rxrpc_call *call);
 869void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
 870			 struct sk_buff *);
 871void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
 872void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
 873void rxrpc_see_call(struct rxrpc_call *, enum rxrpc_call_trace);
 874struct rxrpc_call *rxrpc_try_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
 875void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
 876void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
 877void rxrpc_cleanup_call(struct rxrpc_call *);
 878void rxrpc_destroy_all_calls(struct rxrpc_net *);
 879
 880static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
 881{
 882	return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
 883}
 884
 885static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
 886{
 887	return !rxrpc_is_service_call(call);
 888}
 889
 890/*
 891 * call_state.c
 892 */
 893bool rxrpc_set_call_completion(struct rxrpc_call *call,
 894			       enum rxrpc_call_completion compl,
 895			       u32 abort_code,
 896			       int error);
 897bool rxrpc_call_completed(struct rxrpc_call *call);
 898bool rxrpc_abort_call(struct rxrpc_call *call, rxrpc_seq_t seq,
 899		      u32 abort_code, int error, enum rxrpc_abort_reason why);
 900void rxrpc_prefail_call(struct rxrpc_call *call, enum rxrpc_call_completion compl,
 901			int error);
 902
 903static inline void rxrpc_set_call_state(struct rxrpc_call *call,
 904					enum rxrpc_call_state state)
 905{
 906	/* Order write of completion info before write of ->state. */
 907	smp_store_release(&call->_state, state);
 908	wake_up(&call->waitq);
 909}
 910
 911static inline enum rxrpc_call_state __rxrpc_call_state(const struct rxrpc_call *call)
 912{
 913	return call->_state; /* Only inside I/O thread */
 914}
 915
 916static inline bool __rxrpc_call_is_complete(const struct rxrpc_call *call)
 917{
 918	return __rxrpc_call_state(call) == RXRPC_CALL_COMPLETE;
 919}
 920
 921static inline enum rxrpc_call_state rxrpc_call_state(const struct rxrpc_call *call)
 922{
 923	/* Order read ->state before read of completion info. */
 924	return smp_load_acquire(&call->_state);
 925}
 926
 927static inline bool rxrpc_call_is_complete(const struct rxrpc_call *call)
 928{
 929	return rxrpc_call_state(call) == RXRPC_CALL_COMPLETE;
 930}
 931
 932static inline bool rxrpc_call_has_failed(const struct rxrpc_call *call)
 933{
 934	return rxrpc_call_is_complete(call) && call->completion != RXRPC_CALL_SUCCEEDED;
 935}
 936
 937/*
 938 * conn_client.c
 939 */
 940extern unsigned int rxrpc_reap_client_connections;
 941extern unsigned long rxrpc_conn_idle_client_expiry;
 942extern unsigned long rxrpc_conn_idle_client_fast_expiry;
 943
 944void rxrpc_purge_client_connections(struct rxrpc_local *local);
 945struct rxrpc_bundle *rxrpc_get_bundle(struct rxrpc_bundle *, enum rxrpc_bundle_trace);
 946void rxrpc_put_bundle(struct rxrpc_bundle *, enum rxrpc_bundle_trace);
 947int rxrpc_look_up_bundle(struct rxrpc_call *call, gfp_t gfp);
 948void rxrpc_connect_client_calls(struct rxrpc_local *local);
 949void rxrpc_expose_client_call(struct rxrpc_call *);
 950void rxrpc_disconnect_client_call(struct rxrpc_bundle *, struct rxrpc_call *);
 951void rxrpc_deactivate_bundle(struct rxrpc_bundle *bundle);
 952void rxrpc_put_client_conn(struct rxrpc_connection *, enum rxrpc_conn_trace);
 953void rxrpc_discard_expired_client_conns(struct rxrpc_local *local);
 954void rxrpc_clean_up_local_conns(struct rxrpc_local *);
 955
 956/*
 957 * conn_event.c
 958 */
 959void rxrpc_conn_retransmit_call(struct rxrpc_connection *conn, struct sk_buff *skb,
 960				unsigned int channel);
 961int rxrpc_abort_conn(struct rxrpc_connection *conn, struct sk_buff *skb,
 962		     s32 abort_code, int err, enum rxrpc_abort_reason why);
 963void rxrpc_process_connection(struct work_struct *);
 964void rxrpc_process_delayed_final_acks(struct rxrpc_connection *, bool);
 965bool rxrpc_input_conn_packet(struct rxrpc_connection *conn, struct sk_buff *skb);
 966void rxrpc_input_conn_event(struct rxrpc_connection *conn, struct sk_buff *skb);
 967
 968static inline bool rxrpc_is_conn_aborted(const struct rxrpc_connection *conn)
 969{
 970	/* Order reading the abort info after the state check. */
 971	return smp_load_acquire(&conn->state) == RXRPC_CONN_ABORTED;
 972}
 973
 974/*
 975 * conn_object.c
 976 */
 977extern unsigned int rxrpc_connection_expiry;
 978extern unsigned int rxrpc_closed_conn_expiry;
 979
 980void rxrpc_poke_conn(struct rxrpc_connection *conn, enum rxrpc_conn_trace why);
 981struct rxrpc_connection *rxrpc_alloc_connection(struct rxrpc_net *, gfp_t);
 982struct rxrpc_connection *rxrpc_find_client_connection_rcu(struct rxrpc_local *,
 983							  struct sockaddr_rxrpc *,
 984							  struct sk_buff *);
 985void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
 986void rxrpc_disconnect_call(struct rxrpc_call *);
 987void rxrpc_kill_client_conn(struct rxrpc_connection *);
 988void rxrpc_queue_conn(struct rxrpc_connection *, enum rxrpc_conn_trace);
 989void rxrpc_see_connection(struct rxrpc_connection *, enum rxrpc_conn_trace);
 990struct rxrpc_connection *rxrpc_get_connection(struct rxrpc_connection *,
 991					      enum rxrpc_conn_trace);
 992struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *,
 993						    enum rxrpc_conn_trace);
 994void rxrpc_put_connection(struct rxrpc_connection *, enum rxrpc_conn_trace);
 995void rxrpc_service_connection_reaper(struct work_struct *);
 996void rxrpc_destroy_all_connections(struct rxrpc_net *);
 997
 998static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
 999{
1000	return conn->out_clientflag;
1001}
1002
1003static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
1004{
1005	return !rxrpc_conn_is_client(conn);
1006}
1007
1008static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
1009					   unsigned long expire_at)
1010{
1011	timer_reduce(&conn->timer, expire_at);
1012}
1013
1014/*
1015 * conn_service.c
1016 */
1017struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
1018						     struct sk_buff *);
1019struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
1020void rxrpc_new_incoming_connection(struct rxrpc_sock *, struct rxrpc_connection *,
1021				   const struct rxrpc_security *, struct sk_buff *);
1022void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
1023
1024/*
1025 * input.c
1026 */
1027void rxrpc_congestion_degrade(struct rxrpc_call *);
1028void rxrpc_input_call_packet(struct rxrpc_call *, struct sk_buff *);
1029void rxrpc_implicit_end_call(struct rxrpc_call *, struct sk_buff *);
1030
1031/*
1032 * io_thread.c
1033 */
1034int rxrpc_encap_rcv(struct sock *, struct sk_buff *);
1035void rxrpc_error_report(struct sock *);
1036bool rxrpc_direct_abort(struct sk_buff *skb, enum rxrpc_abort_reason why,
1037			s32 abort_code, int err);
1038int rxrpc_io_thread(void *data);
1039static inline void rxrpc_wake_up_io_thread(struct rxrpc_local *local)
1040{
1041	wake_up_process(local->io_thread);
1042}
1043
1044static inline bool rxrpc_protocol_error(struct sk_buff *skb, enum rxrpc_abort_reason why)
1045{
1046	return rxrpc_direct_abort(skb, why, RX_PROTOCOL_ERROR, -EPROTO);
1047}
1048
1049/*
1050 * insecure.c
1051 */
1052extern const struct rxrpc_security rxrpc_no_security;
1053
1054/*
1055 * key.c
1056 */
1057extern struct key_type key_type_rxrpc;
 
1058
1059int rxrpc_request_key(struct rxrpc_sock *, sockptr_t , int);
1060int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
 
1061			      u32);
1062
1063/*
1064 * local_event.c
1065 */
1066void rxrpc_send_version_request(struct rxrpc_local *local,
1067				struct rxrpc_host_header *hdr,
1068				struct sk_buff *skb);
1069
1070/*
1071 * local_object.c
1072 */
1073struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
1074struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *, enum rxrpc_local_trace);
1075struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *, enum rxrpc_local_trace);
1076void rxrpc_put_local(struct rxrpc_local *, enum rxrpc_local_trace);
1077struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *, enum rxrpc_local_trace);
1078void rxrpc_unuse_local(struct rxrpc_local *, enum rxrpc_local_trace);
1079void rxrpc_destroy_local(struct rxrpc_local *local);
1080void rxrpc_destroy_all_locals(struct rxrpc_net *);
1081
1082static inline bool __rxrpc_use_local(struct rxrpc_local *local,
1083				     enum rxrpc_local_trace why)
1084{
1085	int r, u;
1086
1087	r = refcount_read(&local->ref);
1088	u = atomic_fetch_add_unless(&local->active_users, 1, 0);
1089	trace_rxrpc_local(local->debug_id, why, r, u);
1090	return u != 0;
1091}
1092
1093static inline void rxrpc_see_local(struct rxrpc_local *local,
1094				   enum rxrpc_local_trace why)
1095{
1096	int r, u;
1097
1098	r = refcount_read(&local->ref);
1099	u = atomic_read(&local->active_users);
1100	trace_rxrpc_local(local->debug_id, why, r, u);
1101}
1102
1103/*
1104 * misc.c
1105 */
1106extern unsigned int rxrpc_max_backlog __read_mostly;
1107extern unsigned long rxrpc_soft_ack_delay;
1108extern unsigned long rxrpc_idle_ack_delay;
1109extern unsigned int rxrpc_rx_window_size;
1110extern unsigned int rxrpc_rx_mtu;
1111extern unsigned int rxrpc_rx_jumbo_max;
1112
1113/*
1114 * net_ns.c
1115 */
1116extern unsigned int rxrpc_net_id;
1117extern struct pernet_operations rxrpc_net_ops;
1118
1119static inline struct rxrpc_net *rxrpc_net(struct net *net)
1120{
1121	return net_generic(net, rxrpc_net_id);
1122}
1123
1124/*
1125 * output.c
1126 */
1127int rxrpc_send_ack_packet(struct rxrpc_call *call, struct rxrpc_txbuf *txb);
1128int rxrpc_send_abort_packet(struct rxrpc_call *);
1129int rxrpc_send_data_packet(struct rxrpc_call *, struct rxrpc_txbuf *);
1130void rxrpc_send_conn_abort(struct rxrpc_connection *conn);
1131void rxrpc_reject_packet(struct rxrpc_local *local, struct sk_buff *skb);
1132void rxrpc_send_keepalive(struct rxrpc_peer *);
1133void rxrpc_transmit_one(struct rxrpc_call *call, struct rxrpc_txbuf *txb);
1134
1135/*
1136 * peer_event.c
1137 */
1138void rxrpc_input_error(struct rxrpc_local *, struct sk_buff *);
1139void rxrpc_peer_keepalive_worker(struct work_struct *);
1140
1141/*
1142 * peer_object.c
1143 */
1144struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1145					 const struct sockaddr_rxrpc *);
1146struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *local,
1147				     struct sockaddr_rxrpc *srx, gfp_t gfp);
1148struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t,
1149				    enum rxrpc_peer_trace);
1150void rxrpc_new_incoming_peer(struct rxrpc_local *local, struct rxrpc_peer *peer);
1151void rxrpc_destroy_all_peers(struct rxrpc_net *);
1152struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *, enum rxrpc_peer_trace);
1153struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *, enum rxrpc_peer_trace);
1154void rxrpc_put_peer(struct rxrpc_peer *, enum rxrpc_peer_trace);
1155
1156/*
1157 * proc.c
1158 */
1159extern const struct seq_operations rxrpc_call_seq_ops;
1160extern const struct seq_operations rxrpc_connection_seq_ops;
1161extern const struct seq_operations rxrpc_peer_seq_ops;
1162extern const struct seq_operations rxrpc_local_seq_ops;
1163
1164/*
1165 * recvmsg.c
1166 */
1167void rxrpc_notify_socket(struct rxrpc_call *);
1168int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1169
1170/*
1171 * Abort a call due to a protocol error.
1172 */
1173static inline int rxrpc_abort_eproto(struct rxrpc_call *call,
1174				     struct sk_buff *skb,
1175				     s32 abort_code,
1176				     enum rxrpc_abort_reason why)
1177{
1178	struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
1179
1180	rxrpc_abort_call(call, sp->hdr.seq, abort_code, -EPROTO, why);
1181	return -EPROTO;
1182}
1183
1184/*
1185 * rtt.c
1186 */
1187void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace, int,
1188			rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1189unsigned long rxrpc_get_rto_backoff(struct rxrpc_peer *, bool);
1190void rxrpc_peer_init_rtt(struct rxrpc_peer *);
1191
1192/*
1193 * rxkad.c
1194 */
1195#ifdef CONFIG_RXKAD
1196extern const struct rxrpc_security rxkad;
1197#endif
1198
1199/*
1200 * security.c
1201 */
1202int __init rxrpc_init_security(void);
1203const struct rxrpc_security *rxrpc_security_lookup(u8);
1204void rxrpc_exit_security(void);
1205int rxrpc_init_client_call_security(struct rxrpc_call *);
1206int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1207const struct rxrpc_security *rxrpc_get_incoming_security(struct rxrpc_sock *,
1208							 struct sk_buff *);
1209struct key *rxrpc_look_up_server_security(struct rxrpc_connection *,
1210					  struct sk_buff *, u32, u32);
 
1211
1212/*
1213 * sendmsg.c
1214 */
1215bool rxrpc_propose_abort(struct rxrpc_call *call, s32 abort_code, int error,
1216			 enum rxrpc_abort_reason why);
1217int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1218
1219/*
1220 * server_key.c
1221 */
1222extern struct key_type key_type_rxrpc_s;
1223
1224int rxrpc_server_keyring(struct rxrpc_sock *, sockptr_t, int);
1225
1226/*
1227 * skbuff.c
1228 */
1229void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1230void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1231void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1232void rxrpc_eaten_skb(struct sk_buff *, enum rxrpc_skb_trace);
1233void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1234void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1235void rxrpc_purge_queue(struct sk_buff_head *);
1236
1237/*
1238 * stats.c
1239 */
1240int rxrpc_stats_show(struct seq_file *seq, void *v);
1241int rxrpc_stats_clear(struct file *file, char *buf, size_t size);
1242
1243#define rxrpc_inc_stat(rxnet, s) atomic_inc(&(rxnet)->s)
1244#define rxrpc_dec_stat(rxnet, s) atomic_dec(&(rxnet)->s)
1245
1246/*
1247 * sysctl.c
1248 */
1249#ifdef CONFIG_SYSCTL
1250extern int __init rxrpc_sysctl_init(void);
1251extern void rxrpc_sysctl_exit(void);
1252#else
1253static inline int __init rxrpc_sysctl_init(void) { return 0; }
1254static inline void rxrpc_sysctl_exit(void) {}
1255#endif
1256
1257/*
1258 * txbuf.c
1259 */
1260extern atomic_t rxrpc_nr_txbuf;
1261struct rxrpc_txbuf *rxrpc_alloc_txbuf(struct rxrpc_call *call, u8 packet_type,
1262				      gfp_t gfp);
1263void rxrpc_get_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1264void rxrpc_see_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1265void rxrpc_put_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1266
1267/*
1268 * utils.c
1269 */
1270int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1271
1272static inline bool before(u32 seq1, u32 seq2)
1273{
1274        return (s32)(seq1 - seq2) < 0;
1275}
1276static inline bool before_eq(u32 seq1, u32 seq2)
1277{
1278        return (s32)(seq1 - seq2) <= 0;
1279}
1280static inline bool after(u32 seq1, u32 seq2)
1281{
1282        return (s32)(seq1 - seq2) > 0;
1283}
1284static inline bool after_eq(u32 seq1, u32 seq2)
1285{
1286        return (s32)(seq1 - seq2) >= 0;
1287}
1288
1289/*
1290 * debug tracing
1291 */
1292extern unsigned int rxrpc_debug;
1293
1294#define dbgprintk(FMT,...) \
1295	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1296
1297#define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1298#define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1299#define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
 
 
1300
1301
1302#if defined(__KDEBUG)
1303#define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
1304#define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
1305#define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
 
 
1306
1307#elif defined(CONFIG_AF_RXRPC_DEBUG)
1308#define RXRPC_DEBUG_KENTER	0x01
1309#define RXRPC_DEBUG_KLEAVE	0x02
1310#define RXRPC_DEBUG_KDEBUG	0x04
 
 
1311
1312#define _enter(FMT,...)					\
1313do {							\
1314	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER))	\
1315		kenter(FMT,##__VA_ARGS__);		\
1316} while (0)
1317
1318#define _leave(FMT,...)					\
1319do {							\
1320	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE))	\
1321		kleave(FMT,##__VA_ARGS__);		\
1322} while (0)
1323
1324#define _debug(FMT,...)					\
1325do {							\
1326	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG))	\
1327		kdebug(FMT,##__VA_ARGS__);		\
1328} while (0)
1329
 
 
 
 
 
 
 
 
 
 
 
 
1330#else
1331#define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1332#define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1333#define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
 
 
1334#endif
1335
1336/*
1337 * debug assertion checking
1338 */
1339#if 1 // defined(__KDEBUGALL)
1340
1341#define ASSERT(X)						\
1342do {								\
1343	if (unlikely(!(X))) {					\
1344		pr_err("Assertion failed\n");			\
 
1345		BUG();						\
1346	}							\
1347} while (0)
1348
1349#define ASSERTCMP(X, OP, Y)						\
1350do {									\
1351	__typeof__(X) _x = (X);						\
1352	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1353	if (unlikely(!(_x OP _y))) {					\
1354		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1355		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1356		       (unsigned long)_y, (unsigned long)_y);		\
 
1357		BUG();							\
1358	}								\
1359} while (0)
1360
1361#define ASSERTIF(C, X)						\
1362do {								\
1363	if (unlikely((C) && !(X))) {				\
1364		pr_err("Assertion failed\n");			\
 
1365		BUG();						\
1366	}							\
1367} while (0)
1368
1369#define ASSERTIFCMP(C, X, OP, Y)					\
1370do {									\
1371	__typeof__(X) _x = (X);						\
1372	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1373	if (unlikely((C) && !(_x OP _y))) {				\
1374		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1375		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1376		       (unsigned long)_y, (unsigned long)_y);		\
 
1377		BUG();							\
1378	}								\
1379} while (0)
1380
1381#else
1382
1383#define ASSERT(X)				\
1384do {						\
1385} while (0)
1386
1387#define ASSERTCMP(X, OP, Y)			\
1388do {						\
1389} while (0)
1390
1391#define ASSERTIF(C, X)				\
1392do {						\
1393} while (0)
1394
1395#define ASSERTIFCMP(C, X, OP, Y)		\
1396do {						\
1397} while (0)
1398
1399#endif /* __KDEBUGALL */