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