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