xref: /openbmc/linux/net/rxrpc/ar-internal.h (revision 2b77dcc5)
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 <net/net_namespace.h>
11 #include <net/netns/generic.h>
12 #include <net/sock.h>
13 #include <net/af_rxrpc.h>
14 #include "protocol.h"
15 
16 #if 0
17 #define CHECK_SLAB_OKAY(X)				     \
18 	BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
19 	       (POISON_FREE << 8 | POISON_FREE))
20 #else
21 #define CHECK_SLAB_OKAY(X) do {} while (0)
22 #endif
23 
24 #define FCRYPT_BSIZE 8
25 struct rxrpc_crypt {
26 	union {
27 		u8	x[FCRYPT_BSIZE];
28 		__be32	n[2];
29 	};
30 } __attribute__((aligned(8)));
31 
32 #define rxrpc_queue_work(WS)	queue_work(rxrpc_workqueue, (WS))
33 #define rxrpc_queue_delayed_work(WS,D)	\
34 	queue_delayed_work(rxrpc_workqueue, (WS), (D))
35 
36 struct rxrpc_connection;
37 
38 /*
39  * Mark applied to socket buffers in skb->mark.  skb->priority is used
40  * to pass supplementary information.
41  */
42 enum rxrpc_skb_mark {
43 	RXRPC_SKB_MARK_REJECT_BUSY,	/* Reject with BUSY */
44 	RXRPC_SKB_MARK_REJECT_ABORT,	/* Reject with ABORT (code in skb->priority) */
45 };
46 
47 /*
48  * sk_state for RxRPC sockets
49  */
50 enum {
51 	RXRPC_UNBOUND = 0,
52 	RXRPC_CLIENT_UNBOUND,		/* Unbound socket used as client */
53 	RXRPC_CLIENT_BOUND,		/* client local address bound */
54 	RXRPC_SERVER_BOUND,		/* server local address bound */
55 	RXRPC_SERVER_BOUND2,		/* second server local address bound */
56 	RXRPC_SERVER_LISTENING,		/* server listening for connections */
57 	RXRPC_SERVER_LISTEN_DISABLED,	/* server listening disabled */
58 	RXRPC_CLOSE,			/* socket is being closed */
59 };
60 
61 /*
62  * Per-network namespace data.
63  */
64 struct rxrpc_net {
65 	struct proc_dir_entry	*proc_net;	/* Subdir in /proc/net */
66 	u32			epoch;		/* Local epoch for detecting local-end reset */
67 	struct list_head	calls;		/* List of calls active in this namespace */
68 	rwlock_t		call_lock;	/* Lock for ->calls */
69 	atomic_t		nr_calls;	/* Count of allocated calls */
70 
71 	atomic_t		nr_conns;
72 	struct list_head	conn_proc_list;	/* List of conns in this namespace for proc */
73 	struct list_head	service_conns;	/* Service conns in this namespace */
74 	rwlock_t		conn_lock;	/* Lock for ->conn_proc_list, ->service_conns */
75 	struct work_struct	service_conn_reaper;
76 	struct timer_list	service_conn_reap_timer;
77 
78 	unsigned int		nr_client_conns;
79 	unsigned int		nr_active_client_conns;
80 	bool			kill_all_client_conns;
81 	bool			live;
82 	spinlock_t		client_conn_cache_lock; /* Lock for ->*_client_conns */
83 	spinlock_t		client_conn_discard_lock; /* Prevent multiple discarders */
84 	struct list_head	waiting_client_conns;
85 	struct list_head	active_client_conns;
86 	struct list_head	idle_client_conns;
87 	struct work_struct	client_conn_reaper;
88 	struct timer_list	client_conn_reap_timer;
89 
90 	struct list_head	local_endpoints;
91 	struct mutex		local_mutex;	/* Lock for ->local_endpoints */
92 
93 	DECLARE_HASHTABLE	(peer_hash, 10);
94 	spinlock_t		peer_hash_lock;	/* Lock for ->peer_hash */
95 
96 #define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
97 	u8			peer_keepalive_cursor;
98 	time64_t		peer_keepalive_base;
99 	struct list_head	peer_keepalive[32];
100 	struct list_head	peer_keepalive_new;
101 	struct timer_list	peer_keepalive_timer;
102 	struct work_struct	peer_keepalive_work;
103 };
104 
105 /*
106  * Service backlog preallocation.
107  *
108  * This contains circular buffers of preallocated peers, connections and calls
109  * for incoming service calls and their head and tail pointers.  This allows
110  * calls to be set up in the data_ready handler, thereby avoiding the need to
111  * shuffle packets around so much.
112  */
113 struct rxrpc_backlog {
114 	unsigned short		peer_backlog_head;
115 	unsigned short		peer_backlog_tail;
116 	unsigned short		conn_backlog_head;
117 	unsigned short		conn_backlog_tail;
118 	unsigned short		call_backlog_head;
119 	unsigned short		call_backlog_tail;
120 #define RXRPC_BACKLOG_MAX	32
121 	struct rxrpc_peer	*peer_backlog[RXRPC_BACKLOG_MAX];
122 	struct rxrpc_connection	*conn_backlog[RXRPC_BACKLOG_MAX];
123 	struct rxrpc_call	*call_backlog[RXRPC_BACKLOG_MAX];
124 };
125 
126 /*
127  * RxRPC socket definition
128  */
129 struct rxrpc_sock {
130 	/* WARNING: sk has to be the first member */
131 	struct sock		sk;
132 	rxrpc_notify_new_call_t	notify_new_call; /* Func to notify of new call */
133 	rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
134 	struct rxrpc_local	*local;		/* local endpoint */
135 	struct rxrpc_backlog	*backlog;	/* Preallocation for services */
136 	spinlock_t		incoming_lock;	/* Incoming call vs service shutdown lock */
137 	struct list_head	sock_calls;	/* List of calls owned by this socket */
138 	struct list_head	to_be_accepted;	/* calls awaiting acceptance */
139 	struct list_head	recvmsg_q;	/* Calls awaiting recvmsg's attention  */
140 	rwlock_t		recvmsg_lock;	/* Lock for recvmsg_q */
141 	struct key		*key;		/* security for this socket */
142 	struct key		*securities;	/* list of server security descriptors */
143 	struct rb_root		calls;		/* User ID -> call mapping */
144 	unsigned long		flags;
145 #define RXRPC_SOCK_CONNECTED		0	/* connect_srx is set */
146 	rwlock_t		call_lock;	/* lock for calls */
147 	u32			min_sec_level;	/* minimum security level */
148 #define RXRPC_SECURITY_MAX	RXRPC_SECURITY_ENCRYPT
149 	bool			exclusive;	/* Exclusive connection for a client socket */
150 	u16			second_service;	/* Additional service bound to the endpoint */
151 	struct {
152 		/* Service upgrade information */
153 		u16		from;		/* Service ID to upgrade (if not 0) */
154 		u16		to;		/* service ID to upgrade to */
155 	} service_upgrade;
156 	sa_family_t		family;		/* Protocol family created with */
157 	struct sockaddr_rxrpc	srx;		/* Primary Service/local addresses */
158 	struct sockaddr_rxrpc	connect_srx;	/* Default client address from connect() */
159 };
160 
161 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
162 
163 /*
164  * CPU-byteorder normalised Rx packet header.
165  */
166 struct rxrpc_host_header {
167 	u32		epoch;		/* client boot timestamp */
168 	u32		cid;		/* connection and channel ID */
169 	u32		callNumber;	/* call ID (0 for connection-level packets) */
170 	u32		seq;		/* sequence number of pkt in call stream */
171 	u32		serial;		/* serial number of pkt sent to network */
172 	u8		type;		/* packet type */
173 	u8		flags;		/* packet flags */
174 	u8		userStatus;	/* app-layer defined status */
175 	u8		securityIndex;	/* security protocol ID */
176 	union {
177 		u16	_rsvd;		/* reserved */
178 		u16	cksum;		/* kerberos security checksum */
179 	};
180 	u16		serviceId;	/* service ID */
181 } __packed;
182 
183 /*
184  * RxRPC socket buffer private variables
185  * - max 48 bytes (struct sk_buff::cb)
186  */
187 struct rxrpc_skb_priv {
188 	atomic_t	nr_ring_pins;		/* Number of rxtx ring pins */
189 	u8		nr_subpackets;		/* Number of subpackets */
190 	u8		rx_flags;		/* Received packet flags */
191 #define RXRPC_SKB_INCL_LAST	0x01		/* - Includes last packet */
192 #define RXRPC_SKB_TX_BUFFER	0x02		/* - Is transmit buffer */
193 	union {
194 		int		remain;		/* amount of space remaining for next write */
195 
196 		/* List of requested ACKs on subpackets */
197 		unsigned long	rx_req_ack[(RXRPC_MAX_NR_JUMBO + BITS_PER_LONG - 1) /
198 					   BITS_PER_LONG];
199 	};
200 
201 	struct rxrpc_host_header hdr;		/* RxRPC packet header from this packet */
202 };
203 
204 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
205 
206 /*
207  * RxRPC security module interface
208  */
209 struct rxrpc_security {
210 	const char		*name;		/* name of this service */
211 	u8			security_index;	/* security type provided */
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_conns;	/* Client connections by socket params */
277 	spinlock_t		client_conns_lock; /* Lock for client_conns */
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 	u64			rtt;		/* Current RTT estimate (in nS) */
314 	u64			rtt_sum;	/* Sum of cache contents */
315 	u64			rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* Determined RTT cache */
316 	u8			rtt_cursor;	/* next entry at which to insert */
317 	u8			rtt_usage;	/* amount of cache actually used */
318 
319 	u8			cong_cwnd;	/* Congestion window size */
320 };
321 
322 /*
323  * Keys for matching a connection.
324  */
325 struct rxrpc_conn_proto {
326 	union {
327 		struct {
328 			u32	epoch;		/* epoch of this connection */
329 			u32	cid;		/* connection ID */
330 		};
331 		u64		index_key;
332 	};
333 };
334 
335 struct rxrpc_conn_parameters {
336 	struct rxrpc_local	*local;		/* Representation of local endpoint */
337 	struct rxrpc_peer	*peer;		/* Remote endpoint */
338 	struct key		*key;		/* Security details */
339 	bool			exclusive;	/* T if conn is exclusive */
340 	bool			upgrade;	/* T if service ID can be upgraded */
341 	u16			service_id;	/* Service ID for this connection */
342 	u32			security_level;	/* Security level selected */
343 };
344 
345 /*
346  * Bits in the connection flags.
347  */
348 enum rxrpc_conn_flag {
349 	RXRPC_CONN_HAS_IDR,		/* Has a client conn ID assigned */
350 	RXRPC_CONN_IN_SERVICE_CONNS,	/* Conn is in peer->service_conns */
351 	RXRPC_CONN_IN_CLIENT_CONNS,	/* Conn is in local->client_conns */
352 	RXRPC_CONN_EXPOSED,		/* Conn has extra ref for exposure */
353 	RXRPC_CONN_DONT_REUSE,		/* Don't reuse this connection */
354 	RXRPC_CONN_COUNTED,		/* Counted by rxrpc_nr_client_conns */
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 cache state.
376  */
377 enum rxrpc_conn_cache_state {
378 	RXRPC_CONN_CLIENT_INACTIVE,	/* Conn is not yet listed */
379 	RXRPC_CONN_CLIENT_WAITING,	/* Conn is on wait list, waiting for capacity */
380 	RXRPC_CONN_CLIENT_ACTIVE,	/* Conn is on active list, doing calls */
381 	RXRPC_CONN_CLIENT_UPGRADE,	/* Conn is on active list, probing for upgrade */
382 	RXRPC_CONN_CLIENT_CULLED,	/* Conn is culled and delisted, doing calls */
383 	RXRPC_CONN_CLIENT_IDLE,		/* Conn is on idle list, doing mostly nothing */
384 	RXRPC_CONN__NR_CACHE_STATES
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 connection definition
404  * - matched by { local, peer, epoch, conn_id, direction }
405  * - each connection can only handle four simultaneous calls
406  */
407 struct rxrpc_connection {
408 	struct rxrpc_conn_proto	proto;
409 	struct rxrpc_conn_parameters params;
410 
411 	atomic_t		usage;
412 	struct rcu_head		rcu;
413 	struct list_head	cache_link;
414 
415 	spinlock_t		channel_lock;
416 	unsigned char		active_chans;	/* Mask of active channels */
417 #define RXRPC_ACTIVE_CHANS_MASK	((1 << RXRPC_MAXCALLS) - 1)
418 	struct list_head	waiting_calls;	/* Calls waiting for channels */
419 	struct rxrpc_channel {
420 		unsigned long		final_ack_at;	/* Time at which to issue final ACK */
421 		struct rxrpc_call __rcu	*call;		/* Active call */
422 		unsigned int		call_debug_id;	/* call->debug_id */
423 		u32			call_id;	/* ID of current call */
424 		u32			call_counter;	/* Call ID counter */
425 		u32			last_call;	/* ID of last call */
426 		u8			last_type;	/* Type of last packet */
427 		union {
428 			u32		last_seq;
429 			u32		last_abort;
430 		};
431 	} channels[RXRPC_MAXCALLS];
432 
433 	struct timer_list	timer;		/* Conn event timer */
434 	struct work_struct	processor;	/* connection event processor */
435 	union {
436 		struct rb_node	client_node;	/* Node in local->client_conns */
437 		struct rb_node	service_node;	/* Node in peer->service_conns */
438 	};
439 	struct list_head	proc_link;	/* link in procfs list */
440 	struct list_head	link;		/* link in master connection list */
441 	struct sk_buff_head	rx_queue;	/* received conn-level packets */
442 	const struct rxrpc_security *security;	/* applied security module */
443 	struct key		*server_key;	/* security for this service */
444 	struct crypto_sync_skcipher *cipher;	/* encryption handle */
445 	struct rxrpc_crypt	csum_iv;	/* packet checksum base */
446 	unsigned long		flags;
447 	unsigned long		events;
448 	unsigned long		idle_timestamp;	/* Time at which last became idle */
449 	spinlock_t		state_lock;	/* state-change lock */
450 	enum rxrpc_conn_cache_state cache_state;
451 	enum rxrpc_conn_proto_state state;	/* current state of connection */
452 	u32			abort_code;	/* Abort code of connection abort */
453 	int			debug_id;	/* debug ID for printks */
454 	atomic_t		serial;		/* packet serial number counter */
455 	unsigned int		hi_serial;	/* highest serial number received */
456 	u32			security_nonce;	/* response re-use preventer */
457 	u32			service_id;	/* Service ID, possibly upgraded */
458 	u8			size_align;	/* data size alignment (for security) */
459 	u8			security_size;	/* security header size */
460 	u8			security_ix;	/* security type */
461 	u8			out_clientflag;	/* RXRPC_CLIENT_INITIATED if we are client */
462 	short			error;		/* Local error code */
463 };
464 
465 static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
466 {
467 	return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
468 }
469 
470 static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
471 {
472 	return !rxrpc_to_server(sp);
473 }
474 
475 /*
476  * Flags in call->flags.
477  */
478 enum rxrpc_call_flag {
479 	RXRPC_CALL_RELEASED,		/* call has been released - no more message to userspace */
480 	RXRPC_CALL_HAS_USERID,		/* has a user ID attached */
481 	RXRPC_CALL_IS_SERVICE,		/* Call is service call */
482 	RXRPC_CALL_EXPOSED,		/* The call was exposed to the world */
483 	RXRPC_CALL_RX_LAST,		/* Received the last packet (at rxtx_top) */
484 	RXRPC_CALL_TX_LAST,		/* Last packet in Tx buffer (at rxtx_top) */
485 	RXRPC_CALL_SEND_PING,		/* A ping will need to be sent */
486 	RXRPC_CALL_PINGING,		/* Ping in process */
487 	RXRPC_CALL_RETRANS_TIMEOUT,	/* Retransmission due to timeout occurred */
488 	RXRPC_CALL_BEGAN_RX_TIMER,	/* We began the expect_rx_by timer */
489 	RXRPC_CALL_RX_HEARD,		/* The peer responded at least once to this call */
490 	RXRPC_CALL_RX_UNDERRUN,		/* Got data underrun */
491 	RXRPC_CALL_IS_INTR,		/* The call is interruptible */
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_ACCEPTING,	/* - server accepting request */
518 	RXRPC_CALL_SERVER_RECV_REQUEST,	/* - server receiving request */
519 	RXRPC_CALL_SERVER_ACK_REQUEST,	/* - server pending ACK of request */
520 	RXRPC_CALL_SERVER_SEND_REPLY,	/* - server sending reply */
521 	RXRPC_CALL_SERVER_AWAIT_ACK,	/* - server awaiting final ACK */
522 	RXRPC_CALL_COMPLETE,		/* - call complete */
523 	NR__RXRPC_CALL_STATES
524 };
525 
526 /*
527  * Call completion condition (state == RXRPC_CALL_COMPLETE).
528  */
529 enum rxrpc_call_completion {
530 	RXRPC_CALL_SUCCEEDED,		/* - Normal termination */
531 	RXRPC_CALL_REMOTELY_ABORTED,	/* - call aborted by peer */
532 	RXRPC_CALL_LOCALLY_ABORTED,	/* - call aborted locally on error or close */
533 	RXRPC_CALL_LOCAL_ERROR,		/* - call failed due to local error */
534 	RXRPC_CALL_NETWORK_ERROR,	/* - call terminated by network error */
535 	NR__RXRPC_CALL_COMPLETIONS
536 };
537 
538 /*
539  * Call Tx congestion management modes.
540  */
541 enum rxrpc_congest_mode {
542 	RXRPC_CALL_SLOW_START,
543 	RXRPC_CALL_CONGEST_AVOIDANCE,
544 	RXRPC_CALL_PACKET_LOSS,
545 	RXRPC_CALL_FAST_RETRANSMIT,
546 	NR__RXRPC_CONGEST_MODES
547 };
548 
549 /*
550  * RxRPC call definition
551  * - matched by { connection, call_id }
552  */
553 struct rxrpc_call {
554 	struct rcu_head		rcu;
555 	struct rxrpc_connection	*conn;		/* connection carrying call */
556 	struct rxrpc_peer	*peer;		/* Peer record for remote address */
557 	struct rxrpc_sock __rcu	*socket;	/* socket responsible */
558 	struct rxrpc_net	*rxnet;		/* Network namespace to which call belongs */
559 	const struct rxrpc_security *security;	/* applied security module */
560 	struct mutex		user_mutex;	/* User access mutex */
561 	unsigned long		ack_at;		/* When deferred ACK needs to happen */
562 	unsigned long		ack_lost_at;	/* When ACK is figured as lost */
563 	unsigned long		resend_at;	/* When next resend needs to happen */
564 	unsigned long		ping_at;	/* When next to send a ping */
565 	unsigned long		keepalive_at;	/* When next to send a keepalive ping */
566 	unsigned long		expect_rx_by;	/* When we expect to get a packet by */
567 	unsigned long		expect_req_by;	/* When we expect to get a request DATA packet by */
568 	unsigned long		expect_term_by;	/* When we expect call termination by */
569 	u32			next_rx_timo;	/* Timeout for next Rx packet (jif) */
570 	u32			next_req_timo;	/* Timeout for next Rx request packet (jif) */
571 	struct skcipher_request	*cipher_req;	/* Packet cipher request buffer */
572 	struct timer_list	timer;		/* Combined event timer */
573 	struct work_struct	processor;	/* Event processor */
574 	rxrpc_notify_rx_t	notify_rx;	/* kernel service Rx notification function */
575 	struct list_head	link;		/* link in master call list */
576 	struct list_head	chan_wait_link;	/* Link in conn->waiting_calls */
577 	struct hlist_node	error_link;	/* link in error distribution list */
578 	struct list_head	accept_link;	/* Link in rx->acceptq */
579 	struct list_head	recvmsg_link;	/* Link in rx->recvmsg_q */
580 	struct list_head	sock_link;	/* Link in rx->sock_calls */
581 	struct rb_node		sock_node;	/* Node in rx->calls */
582 	struct sk_buff		*tx_pending;	/* Tx socket buffer being filled */
583 	wait_queue_head_t	waitq;		/* Wait queue for channel or Tx */
584 	s64			tx_total_len;	/* Total length left to be transmitted (or -1) */
585 	__be32			crypto_buf[2];	/* Temporary packet crypto buffer */
586 	unsigned long		user_call_ID;	/* user-defined call ID */
587 	unsigned long		flags;
588 	unsigned long		events;
589 	spinlock_t		lock;
590 	spinlock_t		notify_lock;	/* Kernel notification lock */
591 	rwlock_t		state_lock;	/* lock for state transition */
592 	u32			abort_code;	/* Local/remote abort code */
593 	int			error;		/* Local error incurred */
594 	enum rxrpc_call_state	state;		/* current state of call */
595 	enum rxrpc_call_completion completion;	/* Call completion condition */
596 	atomic_t		usage;
597 	u16			service_id;	/* service ID */
598 	u8			security_ix;	/* Security type */
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 
605 	/* Rx/Tx circular buffer, depending on phase.
606 	 *
607 	 * In the Rx phase, packets are annotated with 0 or the number of the
608 	 * segment of a jumbo packet each buffer refers to.  There can be up to
609 	 * 47 segments in a maximum-size UDP packet.
610 	 *
611 	 * In the Tx phase, packets are annotated with which buffers have been
612 	 * acked.
613 	 */
614 #define RXRPC_RXTX_BUFF_SIZE	64
615 #define RXRPC_RXTX_BUFF_MASK	(RXRPC_RXTX_BUFF_SIZE - 1)
616 #define RXRPC_INIT_RX_WINDOW_SIZE 63
617 	struct sk_buff		**rxtx_buffer;
618 	u8			*rxtx_annotations;
619 #define RXRPC_TX_ANNO_ACK	0
620 #define RXRPC_TX_ANNO_UNACK	1
621 #define RXRPC_TX_ANNO_NAK	2
622 #define RXRPC_TX_ANNO_RETRANS	3
623 #define RXRPC_TX_ANNO_MASK	0x03
624 #define RXRPC_TX_ANNO_LAST	0x04
625 #define RXRPC_TX_ANNO_RESENT	0x08
626 
627 #define RXRPC_RX_ANNO_SUBPACKET	0x3f		/* Subpacket number in jumbogram */
628 #define RXRPC_RX_ANNO_VERIFIED	0x80		/* Set if verified and decrypted */
629 	rxrpc_seq_t		tx_hard_ack;	/* Dead slot in buffer; the first transmitted but
630 						 * not hard-ACK'd packet follows this.
631 						 */
632 	rxrpc_seq_t		tx_top;		/* Highest Tx slot allocated. */
633 	u16			tx_backoff;	/* Delay to insert due to Tx failure */
634 
635 	/* TCP-style slow-start congestion control [RFC5681].  Since the SMSS
636 	 * is fixed, we keep these numbers in terms of segments (ie. DATA
637 	 * packets) rather than bytes.
638 	 */
639 #define RXRPC_TX_SMSS		RXRPC_JUMBO_DATALEN
640 	u8			cong_cwnd;	/* Congestion window size */
641 	u8			cong_extra;	/* Extra to send for congestion management */
642 	u8			cong_ssthresh;	/* Slow-start threshold */
643 	enum rxrpc_congest_mode	cong_mode:8;	/* Congestion management mode */
644 	u8			cong_dup_acks;	/* Count of ACKs showing missing packets */
645 	u8			cong_cumul_acks; /* Cumulative ACK count */
646 	ktime_t			cong_tstamp;	/* Last time cwnd was changed */
647 
648 	rxrpc_seq_t		rx_hard_ack;	/* Dead slot in buffer; the first received but not
649 						 * consumed packet follows this.
650 						 */
651 	rxrpc_seq_t		rx_top;		/* Highest Rx slot allocated. */
652 	rxrpc_seq_t		rx_expect_next;	/* Expected next packet sequence number */
653 	rxrpc_serial_t		rx_serial;	/* Highest serial received for this call */
654 	u8			rx_winsize;	/* Size of Rx window */
655 	u8			tx_winsize;	/* Maximum size of Tx window */
656 	bool			tx_phase;	/* T if transmission phase, F if receive phase */
657 	u8			nr_jumbo_bad;	/* Number of jumbo dups/exceeds-windows */
658 
659 	spinlock_t		input_lock;	/* Lock for packet input to this call */
660 
661 	/* receive-phase ACK management */
662 	u8			ackr_reason;	/* reason to ACK */
663 	rxrpc_serial_t		ackr_serial;	/* serial of packet being ACK'd */
664 	rxrpc_serial_t		ackr_first_seq;	/* first sequence number received */
665 	rxrpc_seq_t		ackr_prev_seq;	/* previous sequence number received */
666 	rxrpc_seq_t		ackr_consumed;	/* Highest packet shown consumed */
667 	rxrpc_seq_t		ackr_seen;	/* Highest packet shown seen */
668 
669 	/* ping management */
670 	rxrpc_serial_t		ping_serial;	/* Last ping sent */
671 	ktime_t			ping_time;	/* Time last ping sent */
672 
673 	/* transmission-phase ACK management */
674 	ktime_t			acks_latest_ts;	/* Timestamp of latest ACK received */
675 	rxrpc_serial_t		acks_latest;	/* serial number of latest ACK received */
676 	rxrpc_seq_t		acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
677 	rxrpc_seq_t		acks_lost_top;	/* tx_top at the time lost-ack ping sent */
678 	rxrpc_serial_t		acks_lost_ping;	/* Serial number of probe ACK */
679 };
680 
681 /*
682  * Summary of a new ACK and the changes it made to the Tx buffer packet states.
683  */
684 struct rxrpc_ack_summary {
685 	u8			ack_reason;
686 	u8			nr_acks;		/* Number of ACKs in packet */
687 	u8			nr_nacks;		/* Number of NACKs in packet */
688 	u8			nr_new_acks;		/* Number of new ACKs in packet */
689 	u8			nr_new_nacks;		/* Number of new NACKs in packet */
690 	u8			nr_rot_new_acks;	/* Number of rotated new ACKs */
691 	bool			new_low_nack;		/* T if new low NACK found */
692 	bool			retrans_timeo;		/* T if reTx due to timeout happened */
693 	u8			flight_size;		/* Number of unreceived transmissions */
694 	/* Place to stash values for tracing */
695 	enum rxrpc_congest_mode	mode:8;
696 	u8			cwnd;
697 	u8			ssthresh;
698 	u8			dup_acks;
699 	u8			cumulative_acks;
700 };
701 
702 /*
703  * sendmsg() cmsg-specified parameters.
704  */
705 enum rxrpc_command {
706 	RXRPC_CMD_SEND_DATA,		/* send data message */
707 	RXRPC_CMD_SEND_ABORT,		/* request abort generation */
708 	RXRPC_CMD_ACCEPT,		/* [server] accept incoming call */
709 	RXRPC_CMD_REJECT_BUSY,		/* [server] reject a call as busy */
710 };
711 
712 struct rxrpc_call_params {
713 	s64			tx_total_len;	/* Total Tx data length (if send data) */
714 	unsigned long		user_call_ID;	/* User's call ID */
715 	struct {
716 		u32		hard;		/* Maximum lifetime (sec) */
717 		u32		idle;		/* Max time since last data packet (msec) */
718 		u32		normal;		/* Max time since last call packet (msec) */
719 	} timeouts;
720 	u8			nr_timeouts;	/* Number of timeouts specified */
721 	bool			intr;		/* The call is interruptible */
722 };
723 
724 struct rxrpc_send_params {
725 	struct rxrpc_call_params call;
726 	u32			abort_code;	/* Abort code to Tx (if abort) */
727 	enum rxrpc_command	command : 8;	/* The command to implement */
728 	bool			exclusive;	/* Shared or exclusive call */
729 	bool			upgrade;	/* If the connection is upgradeable */
730 };
731 
732 #include <trace/events/rxrpc.h>
733 
734 /*
735  * af_rxrpc.c
736  */
737 extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
738 extern struct workqueue_struct *rxrpc_workqueue;
739 
740 /*
741  * call_accept.c
742  */
743 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
744 void rxrpc_discard_prealloc(struct rxrpc_sock *);
745 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
746 					   struct rxrpc_sock *,
747 					   struct sk_buff *);
748 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
749 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
750 				     rxrpc_notify_rx_t);
751 int rxrpc_reject_call(struct rxrpc_sock *);
752 
753 /*
754  * call_event.c
755  */
756 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool, bool,
757 		       enum rxrpc_propose_ack_trace);
758 void rxrpc_process_call(struct work_struct *);
759 
760 static inline void rxrpc_reduce_call_timer(struct rxrpc_call *call,
761 					   unsigned long expire_at,
762 					   unsigned long now,
763 					   enum rxrpc_timer_trace why)
764 {
765 	trace_rxrpc_timer(call, why, now);
766 	timer_reduce(&call->timer, expire_at);
767 }
768 
769 /*
770  * call_object.c
771  */
772 extern const char *const rxrpc_call_states[];
773 extern const char *const rxrpc_call_completions[];
774 extern unsigned int rxrpc_max_call_lifetime;
775 extern struct kmem_cache *rxrpc_call_jar;
776 
777 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
778 struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
779 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
780 					 struct rxrpc_conn_parameters *,
781 					 struct sockaddr_rxrpc *,
782 					 struct rxrpc_call_params *, gfp_t,
783 					 unsigned int);
784 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
785 			 struct sk_buff *);
786 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
787 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
788 bool __rxrpc_queue_call(struct rxrpc_call *);
789 bool rxrpc_queue_call(struct rxrpc_call *);
790 void rxrpc_see_call(struct rxrpc_call *);
791 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
792 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
793 void rxrpc_cleanup_call(struct rxrpc_call *);
794 void rxrpc_destroy_all_calls(struct rxrpc_net *);
795 
796 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
797 {
798 	return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
799 }
800 
801 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
802 {
803 	return !rxrpc_is_service_call(call);
804 }
805 
806 /*
807  * Transition a call to the complete state.
808  */
809 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
810 					       enum rxrpc_call_completion compl,
811 					       u32 abort_code,
812 					       int error)
813 {
814 	if (call->state < RXRPC_CALL_COMPLETE) {
815 		call->abort_code = abort_code;
816 		call->error = error;
817 		call->completion = compl,
818 		call->state = RXRPC_CALL_COMPLETE;
819 		trace_rxrpc_call_complete(call);
820 		wake_up(&call->waitq);
821 		return true;
822 	}
823 	return false;
824 }
825 
826 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
827 					     enum rxrpc_call_completion compl,
828 					     u32 abort_code,
829 					     int error)
830 {
831 	bool ret;
832 
833 	write_lock_bh(&call->state_lock);
834 	ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
835 	write_unlock_bh(&call->state_lock);
836 	return ret;
837 }
838 
839 /*
840  * Record that a call successfully completed.
841  */
842 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
843 {
844 	return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
845 }
846 
847 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
848 {
849 	bool ret;
850 
851 	write_lock_bh(&call->state_lock);
852 	ret = __rxrpc_call_completed(call);
853 	write_unlock_bh(&call->state_lock);
854 	return ret;
855 }
856 
857 /*
858  * Record that a call is locally aborted.
859  */
860 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
861 				      rxrpc_seq_t seq,
862 				      u32 abort_code, int error)
863 {
864 	trace_rxrpc_abort(call->debug_id, why, call->cid, call->call_id, seq,
865 			  abort_code, error);
866 	return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
867 					   abort_code, error);
868 }
869 
870 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
871 				    rxrpc_seq_t seq, u32 abort_code, int error)
872 {
873 	bool ret;
874 
875 	write_lock_bh(&call->state_lock);
876 	ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
877 	write_unlock_bh(&call->state_lock);
878 	return ret;
879 }
880 
881 /*
882  * Abort a call due to a protocol error.
883  */
884 static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
885 					struct sk_buff *skb,
886 					const char *eproto_why,
887 					const char *why,
888 					u32 abort_code)
889 {
890 	struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
891 
892 	trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
893 	return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
894 }
895 
896 #define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
897 	__rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
898 			     (abort_why), (abort_code))
899 
900 /*
901  * conn_client.c
902  */
903 extern unsigned int rxrpc_max_client_connections;
904 extern unsigned int rxrpc_reap_client_connections;
905 extern unsigned long rxrpc_conn_idle_client_expiry;
906 extern unsigned long rxrpc_conn_idle_client_fast_expiry;
907 extern struct idr rxrpc_client_conn_ids;
908 
909 void rxrpc_destroy_client_conn_ids(void);
910 int rxrpc_connect_call(struct rxrpc_sock *, struct rxrpc_call *,
911 		       struct rxrpc_conn_parameters *, struct sockaddr_rxrpc *,
912 		       gfp_t);
913 void rxrpc_expose_client_call(struct rxrpc_call *);
914 void rxrpc_disconnect_client_call(struct rxrpc_call *);
915 void rxrpc_put_client_conn(struct rxrpc_connection *);
916 void rxrpc_discard_expired_client_conns(struct work_struct *);
917 void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
918 void rxrpc_clean_up_local_conns(struct rxrpc_local *);
919 
920 /*
921  * conn_event.c
922  */
923 void rxrpc_process_connection(struct work_struct *);
924 
925 /*
926  * conn_object.c
927  */
928 extern unsigned int rxrpc_connection_expiry;
929 extern unsigned int rxrpc_closed_conn_expiry;
930 
931 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
932 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
933 						   struct sk_buff *,
934 						   struct rxrpc_peer **);
935 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
936 void rxrpc_disconnect_call(struct rxrpc_call *);
937 void rxrpc_kill_connection(struct rxrpc_connection *);
938 bool rxrpc_queue_conn(struct rxrpc_connection *);
939 void rxrpc_see_connection(struct rxrpc_connection *);
940 void rxrpc_get_connection(struct rxrpc_connection *);
941 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
942 void rxrpc_put_service_conn(struct rxrpc_connection *);
943 void rxrpc_service_connection_reaper(struct work_struct *);
944 void rxrpc_destroy_all_connections(struct rxrpc_net *);
945 
946 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
947 {
948 	return conn->out_clientflag;
949 }
950 
951 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
952 {
953 	return !rxrpc_conn_is_client(conn);
954 }
955 
956 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
957 {
958 	if (!conn)
959 		return;
960 
961 	if (rxrpc_conn_is_client(conn))
962 		rxrpc_put_client_conn(conn);
963 	else
964 		rxrpc_put_service_conn(conn);
965 }
966 
967 static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
968 					   unsigned long expire_at)
969 {
970 	timer_reduce(&conn->timer, expire_at);
971 }
972 
973 /*
974  * conn_service.c
975  */
976 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
977 						     struct sk_buff *);
978 struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
979 void rxrpc_new_incoming_connection(struct rxrpc_sock *,
980 				   struct rxrpc_connection *, struct sk_buff *);
981 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
982 
983 /*
984  * input.c
985  */
986 int rxrpc_input_packet(struct sock *, struct sk_buff *);
987 
988 /*
989  * insecure.c
990  */
991 extern const struct rxrpc_security rxrpc_no_security;
992 
993 /*
994  * key.c
995  */
996 extern struct key_type key_type_rxrpc;
997 extern struct key_type key_type_rxrpc_s;
998 
999 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
1000 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
1001 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
1002 			      u32);
1003 
1004 /*
1005  * local_event.c
1006  */
1007 extern void rxrpc_process_local_events(struct rxrpc_local *);
1008 
1009 /*
1010  * local_object.c
1011  */
1012 struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
1013 struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *);
1014 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *);
1015 void rxrpc_put_local(struct rxrpc_local *);
1016 struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *);
1017 void rxrpc_unuse_local(struct rxrpc_local *);
1018 void rxrpc_queue_local(struct rxrpc_local *);
1019 void rxrpc_destroy_all_locals(struct rxrpc_net *);
1020 
1021 /*
1022  * misc.c
1023  */
1024 extern unsigned int rxrpc_max_backlog __read_mostly;
1025 extern unsigned long rxrpc_requested_ack_delay;
1026 extern unsigned long rxrpc_soft_ack_delay;
1027 extern unsigned long rxrpc_idle_ack_delay;
1028 extern unsigned int rxrpc_rx_window_size;
1029 extern unsigned int rxrpc_rx_mtu;
1030 extern unsigned int rxrpc_rx_jumbo_max;
1031 extern unsigned long rxrpc_resend_timeout;
1032 
1033 extern const s8 rxrpc_ack_priority[];
1034 
1035 /*
1036  * net_ns.c
1037  */
1038 extern unsigned int rxrpc_net_id;
1039 extern struct pernet_operations rxrpc_net_ops;
1040 
1041 static inline struct rxrpc_net *rxrpc_net(struct net *net)
1042 {
1043 	return net_generic(net, rxrpc_net_id);
1044 }
1045 
1046 /*
1047  * output.c
1048  */
1049 int rxrpc_send_ack_packet(struct rxrpc_call *, bool, rxrpc_serial_t *);
1050 int rxrpc_send_abort_packet(struct rxrpc_call *);
1051 int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
1052 void rxrpc_reject_packets(struct rxrpc_local *);
1053 void rxrpc_send_keepalive(struct rxrpc_peer *);
1054 
1055 /*
1056  * peer_event.c
1057  */
1058 void rxrpc_error_report(struct sock *);
1059 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace,
1060 			rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1061 void rxrpc_peer_keepalive_worker(struct work_struct *);
1062 
1063 /*
1064  * peer_object.c
1065  */
1066 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1067 					 const struct sockaddr_rxrpc *);
1068 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_sock *, struct rxrpc_local *,
1069 				     struct sockaddr_rxrpc *, gfp_t);
1070 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
1071 void rxrpc_new_incoming_peer(struct rxrpc_sock *, struct rxrpc_local *,
1072 			     struct rxrpc_peer *);
1073 void rxrpc_destroy_all_peers(struct rxrpc_net *);
1074 struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *);
1075 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *);
1076 void rxrpc_put_peer(struct rxrpc_peer *);
1077 void rxrpc_put_peer_locked(struct rxrpc_peer *);
1078 
1079 /*
1080  * proc.c
1081  */
1082 extern const struct seq_operations rxrpc_call_seq_ops;
1083 extern const struct seq_operations rxrpc_connection_seq_ops;
1084 extern const struct seq_operations rxrpc_peer_seq_ops;
1085 
1086 /*
1087  * recvmsg.c
1088  */
1089 void rxrpc_notify_socket(struct rxrpc_call *);
1090 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1091 
1092 /*
1093  * rxkad.c
1094  */
1095 #ifdef CONFIG_RXKAD
1096 extern const struct rxrpc_security rxkad;
1097 #endif
1098 
1099 /*
1100  * security.c
1101  */
1102 int __init rxrpc_init_security(void);
1103 void rxrpc_exit_security(void);
1104 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1105 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
1106 
1107 /*
1108  * sendmsg.c
1109  */
1110 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1111 
1112 /*
1113  * skbuff.c
1114  */
1115 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1116 void rxrpc_packet_destructor(struct sk_buff *);
1117 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1118 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1119 void rxrpc_eaten_skb(struct sk_buff *, enum rxrpc_skb_trace);
1120 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1121 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1122 void rxrpc_purge_queue(struct sk_buff_head *);
1123 
1124 /*
1125  * sysctl.c
1126  */
1127 #ifdef CONFIG_SYSCTL
1128 extern int __init rxrpc_sysctl_init(void);
1129 extern void rxrpc_sysctl_exit(void);
1130 #else
1131 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1132 static inline void rxrpc_sysctl_exit(void) {}
1133 #endif
1134 
1135 /*
1136  * utils.c
1137  */
1138 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1139 
1140 static inline bool before(u32 seq1, u32 seq2)
1141 {
1142         return (s32)(seq1 - seq2) < 0;
1143 }
1144 static inline bool before_eq(u32 seq1, u32 seq2)
1145 {
1146         return (s32)(seq1 - seq2) <= 0;
1147 }
1148 static inline bool after(u32 seq1, u32 seq2)
1149 {
1150         return (s32)(seq1 - seq2) > 0;
1151 }
1152 static inline bool after_eq(u32 seq1, u32 seq2)
1153 {
1154         return (s32)(seq1 - seq2) >= 0;
1155 }
1156 
1157 /*
1158  * debug tracing
1159  */
1160 extern unsigned int rxrpc_debug;
1161 
1162 #define dbgprintk(FMT,...) \
1163 	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1164 
1165 #define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1166 #define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1167 #define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
1168 #define kproto(FMT,...)	dbgprintk("### "FMT ,##__VA_ARGS__)
1169 #define knet(FMT,...)	dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1170 
1171 
1172 #if defined(__KDEBUG)
1173 #define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
1174 #define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
1175 #define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
1176 #define _proto(FMT,...)	kproto(FMT,##__VA_ARGS__)
1177 #define _net(FMT,...)	knet(FMT,##__VA_ARGS__)
1178 
1179 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1180 #define RXRPC_DEBUG_KENTER	0x01
1181 #define RXRPC_DEBUG_KLEAVE	0x02
1182 #define RXRPC_DEBUG_KDEBUG	0x04
1183 #define RXRPC_DEBUG_KPROTO	0x08
1184 #define RXRPC_DEBUG_KNET	0x10
1185 
1186 #define _enter(FMT,...)					\
1187 do {							\
1188 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER))	\
1189 		kenter(FMT,##__VA_ARGS__);		\
1190 } while (0)
1191 
1192 #define _leave(FMT,...)					\
1193 do {							\
1194 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE))	\
1195 		kleave(FMT,##__VA_ARGS__);		\
1196 } while (0)
1197 
1198 #define _debug(FMT,...)					\
1199 do {							\
1200 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG))	\
1201 		kdebug(FMT,##__VA_ARGS__);		\
1202 } while (0)
1203 
1204 #define _proto(FMT,...)					\
1205 do {							\
1206 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO))	\
1207 		kproto(FMT,##__VA_ARGS__);		\
1208 } while (0)
1209 
1210 #define _net(FMT,...)					\
1211 do {							\
1212 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))	\
1213 		knet(FMT,##__VA_ARGS__);		\
1214 } while (0)
1215 
1216 #else
1217 #define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1218 #define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1219 #define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
1220 #define _proto(FMT,...)	no_printk("### "FMT ,##__VA_ARGS__)
1221 #define _net(FMT,...)	no_printk("@@@ "FMT ,##__VA_ARGS__)
1222 #endif
1223 
1224 /*
1225  * debug assertion checking
1226  */
1227 #if 1 // defined(__KDEBUGALL)
1228 
1229 #define ASSERT(X)						\
1230 do {								\
1231 	if (unlikely(!(X))) {					\
1232 		pr_err("Assertion failed\n");			\
1233 		BUG();						\
1234 	}							\
1235 } while (0)
1236 
1237 #define ASSERTCMP(X, OP, Y)						\
1238 do {									\
1239 	__typeof__(X) _x = (X);						\
1240 	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1241 	if (unlikely(!(_x OP _y))) {					\
1242 		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1243 		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1244 		       (unsigned long)_y, (unsigned long)_y);		\
1245 		BUG();							\
1246 	}								\
1247 } while (0)
1248 
1249 #define ASSERTIF(C, X)						\
1250 do {								\
1251 	if (unlikely((C) && !(X))) {				\
1252 		pr_err("Assertion failed\n");			\
1253 		BUG();						\
1254 	}							\
1255 } while (0)
1256 
1257 #define ASSERTIFCMP(C, X, OP, Y)					\
1258 do {									\
1259 	__typeof__(X) _x = (X);						\
1260 	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1261 	if (unlikely((C) && !(_x OP _y))) {				\
1262 		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1263 		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1264 		       (unsigned long)_y, (unsigned long)_y);		\
1265 		BUG();							\
1266 	}								\
1267 } while (0)
1268 
1269 #else
1270 
1271 #define ASSERT(X)				\
1272 do {						\
1273 } while (0)
1274 
1275 #define ASSERTCMP(X, OP, Y)			\
1276 do {						\
1277 } while (0)
1278 
1279 #define ASSERTIF(C, X)				\
1280 do {						\
1281 } while (0)
1282 
1283 #define ASSERTIFCMP(C, X, OP, Y)		\
1284 do {						\
1285 } while (0)
1286 
1287 #endif /* __KDEBUGALL */
1288