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