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