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