xref: /openbmc/linux/net/rxrpc/ar-internal.h (revision a5af7e1f)
1 /* AF_RXRPC internal definitions
2  *
3  * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4  * Written by David Howells (dhowells@redhat.com)
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version
9  * 2 of the License, or (at your option) any later version.
10  */
11 
12 #include <linux/atomic.h>
13 #include <linux/seqlock.h>
14 #include <net/sock.h>
15 #include <net/af_rxrpc.h>
16 #include <rxrpc/packet.h>
17 
18 #if 0
19 #define CHECK_SLAB_OKAY(X)				     \
20 	BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
21 	       (POISON_FREE << 8 | POISON_FREE))
22 #else
23 #define CHECK_SLAB_OKAY(X) do {} while (0)
24 #endif
25 
26 #define FCRYPT_BSIZE 8
27 struct rxrpc_crypt {
28 	union {
29 		u8	x[FCRYPT_BSIZE];
30 		__be32	n[2];
31 	};
32 } __attribute__((aligned(8)));
33 
34 #define rxrpc_queue_work(WS)	queue_work(rxrpc_workqueue, (WS))
35 #define rxrpc_queue_delayed_work(WS,D)	\
36 	queue_delayed_work(rxrpc_workqueue, (WS), (D))
37 
38 struct rxrpc_connection;
39 
40 /*
41  * Mark applied to socket buffers.
42  */
43 enum rxrpc_skb_mark {
44 	RXRPC_SKB_MARK_DATA,		/* data message */
45 	RXRPC_SKB_MARK_FINAL_ACK,	/* final ACK received message */
46 	RXRPC_SKB_MARK_BUSY,		/* server busy message */
47 	RXRPC_SKB_MARK_REMOTE_ABORT,	/* remote abort message */
48 	RXRPC_SKB_MARK_LOCAL_ABORT,	/* local abort message */
49 	RXRPC_SKB_MARK_NET_ERROR,	/* network error message */
50 	RXRPC_SKB_MARK_LOCAL_ERROR,	/* local error message */
51 	RXRPC_SKB_MARK_NEW_CALL,	/* local error message */
52 };
53 
54 /*
55  * sk_state for RxRPC sockets
56  */
57 enum {
58 	RXRPC_UNBOUND = 0,
59 	RXRPC_CLIENT_UNBOUND,		/* Unbound socket used as client */
60 	RXRPC_CLIENT_BOUND,		/* client local address bound */
61 	RXRPC_SERVER_BOUND,		/* server local address bound */
62 	RXRPC_SERVER_LISTENING,		/* server listening for connections */
63 	RXRPC_CLOSE,			/* socket is being closed */
64 };
65 
66 /*
67  * Service backlog preallocation.
68  *
69  * This contains circular buffers of preallocated peers, connections and calls
70  * for incoming service calls and their head and tail pointers.  This allows
71  * calls to be set up in the data_ready handler, thereby avoiding the need to
72  * shuffle packets around so much.
73  */
74 struct rxrpc_backlog {
75 	unsigned short		peer_backlog_head;
76 	unsigned short		peer_backlog_tail;
77 	unsigned short		conn_backlog_head;
78 	unsigned short		conn_backlog_tail;
79 	unsigned short		call_backlog_head;
80 	unsigned short		call_backlog_tail;
81 #define RXRPC_BACKLOG_MAX	32
82 	struct rxrpc_peer	*peer_backlog[RXRPC_BACKLOG_MAX];
83 	struct rxrpc_connection	*conn_backlog[RXRPC_BACKLOG_MAX];
84 	struct rxrpc_call	*call_backlog[RXRPC_BACKLOG_MAX];
85 };
86 
87 /*
88  * RxRPC socket definition
89  */
90 struct rxrpc_sock {
91 	/* WARNING: sk has to be the first member */
92 	struct sock		sk;
93 	rxrpc_notify_new_call_t	notify_new_call; /* Func to notify of new call */
94 	rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
95 	struct rxrpc_local	*local;		/* local endpoint */
96 	struct rxrpc_backlog	*backlog;	/* Preallocation for services */
97 	spinlock_t		incoming_lock;	/* Incoming call vs service shutdown lock */
98 	struct list_head	sock_calls;	/* List of calls owned by this socket */
99 	struct list_head	to_be_accepted;	/* calls awaiting acceptance */
100 	struct list_head	recvmsg_q;	/* Calls awaiting recvmsg's attention  */
101 	rwlock_t		recvmsg_lock;	/* Lock for recvmsg_q */
102 	struct key		*key;		/* security for this socket */
103 	struct key		*securities;	/* list of server security descriptors */
104 	struct rb_root		calls;		/* User ID -> call mapping */
105 	unsigned long		flags;
106 #define RXRPC_SOCK_CONNECTED		0	/* connect_srx is set */
107 	rwlock_t		call_lock;	/* lock for calls */
108 	u32			min_sec_level;	/* minimum security level */
109 #define RXRPC_SECURITY_MAX	RXRPC_SECURITY_ENCRYPT
110 	bool			exclusive;	/* Exclusive connection for a client socket */
111 	sa_family_t		family;		/* Protocol family created with */
112 	struct sockaddr_rxrpc	srx;		/* local address */
113 	struct sockaddr_rxrpc	connect_srx;	/* Default client address from connect() */
114 };
115 
116 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
117 
118 /*
119  * CPU-byteorder normalised Rx packet header.
120  */
121 struct rxrpc_host_header {
122 	u32		epoch;		/* client boot timestamp */
123 	u32		cid;		/* connection and channel ID */
124 	u32		callNumber;	/* call ID (0 for connection-level packets) */
125 	u32		seq;		/* sequence number of pkt in call stream */
126 	u32		serial;		/* serial number of pkt sent to network */
127 	u8		type;		/* packet type */
128 	u8		flags;		/* packet flags */
129 	u8		userStatus;	/* app-layer defined status */
130 	u8		securityIndex;	/* security protocol ID */
131 	union {
132 		u16	_rsvd;		/* reserved */
133 		u16	cksum;		/* kerberos security checksum */
134 	};
135 	u16		serviceId;	/* service ID */
136 } __packed;
137 
138 /*
139  * RxRPC socket buffer private variables
140  * - max 48 bytes (struct sk_buff::cb)
141  */
142 struct rxrpc_skb_priv {
143 	union {
144 		u8		nr_jumbo;	/* Number of jumbo subpackets */
145 	};
146 	union {
147 		int		remain;		/* amount of space remaining for next write */
148 	};
149 
150 	struct rxrpc_host_header hdr;		/* RxRPC packet header from this packet */
151 };
152 
153 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
154 
155 /*
156  * RxRPC security module interface
157  */
158 struct rxrpc_security {
159 	const char		*name;		/* name of this service */
160 	u8			security_index;	/* security type provided */
161 
162 	/* Initialise a security service */
163 	int (*init)(void);
164 
165 	/* Clean up a security service */
166 	void (*exit)(void);
167 
168 	/* initialise a connection's security */
169 	int (*init_connection_security)(struct rxrpc_connection *);
170 
171 	/* prime a connection's packet security */
172 	int (*prime_packet_security)(struct rxrpc_connection *);
173 
174 	/* impose security on a packet */
175 	int (*secure_packet)(struct rxrpc_call *,
176 			     struct sk_buff *,
177 			     size_t,
178 			     void *);
179 
180 	/* verify the security on a received packet */
181 	int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
182 			     unsigned int, unsigned int, rxrpc_seq_t, u16);
183 
184 	/* Locate the data in a received packet that has been verified. */
185 	void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
186 			    unsigned int *, unsigned int *);
187 
188 	/* issue a challenge */
189 	int (*issue_challenge)(struct rxrpc_connection *);
190 
191 	/* respond to a challenge */
192 	int (*respond_to_challenge)(struct rxrpc_connection *,
193 				    struct sk_buff *,
194 				    u32 *);
195 
196 	/* verify a response */
197 	int (*verify_response)(struct rxrpc_connection *,
198 			       struct sk_buff *,
199 			       u32 *);
200 
201 	/* clear connection security */
202 	void (*clear)(struct rxrpc_connection *);
203 };
204 
205 /*
206  * RxRPC local transport endpoint description
207  * - owned by a single AF_RXRPC socket
208  * - pointed to by transport socket struct sk_user_data
209  */
210 struct rxrpc_local {
211 	struct rcu_head		rcu;
212 	atomic_t		usage;
213 	struct list_head	link;
214 	struct socket		*socket;	/* my UDP socket */
215 	struct work_struct	processor;
216 	struct rxrpc_sock __rcu	*service;	/* Service(s) listening on this endpoint */
217 	struct rw_semaphore	defrag_sem;	/* control re-enablement of IP DF bit */
218 	struct sk_buff_head	reject_queue;	/* packets awaiting rejection */
219 	struct sk_buff_head	event_queue;	/* endpoint event packets awaiting processing */
220 	struct rb_root		client_conns;	/* Client connections by socket params */
221 	spinlock_t		client_conns_lock; /* Lock for client_conns */
222 	spinlock_t		lock;		/* access lock */
223 	rwlock_t		services_lock;	/* lock for services list */
224 	int			debug_id;	/* debug ID for printks */
225 	bool			dead;
226 	struct sockaddr_rxrpc	srx;		/* local address */
227 };
228 
229 /*
230  * RxRPC remote transport endpoint definition
231  * - matched by local endpoint, remote port, address and protocol type
232  */
233 struct rxrpc_peer {
234 	struct rcu_head		rcu;		/* This must be first */
235 	atomic_t		usage;
236 	unsigned long		hash_key;
237 	struct hlist_node	hash_link;
238 	struct rxrpc_local	*local;
239 	struct hlist_head	error_targets;	/* targets for net error distribution */
240 	struct work_struct	error_distributor;
241 	struct rb_root		service_conns;	/* Service connections */
242 	seqlock_t		service_conn_lock;
243 	spinlock_t		lock;		/* access lock */
244 	unsigned int		if_mtu;		/* interface MTU for this peer */
245 	unsigned int		mtu;		/* network MTU for this peer */
246 	unsigned int		maxdata;	/* data size (MTU - hdrsize) */
247 	unsigned short		hdrsize;	/* header size (IP + UDP + RxRPC) */
248 	int			debug_id;	/* debug ID for printks */
249 	int			error_report;	/* Net (+0) or local (+1000000) to distribute */
250 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
251 	struct sockaddr_rxrpc	srx;		/* remote address */
252 
253 	/* calculated RTT cache */
254 #define RXRPC_RTT_CACHE_SIZE 32
255 	ktime_t			rtt_last_req;	/* Time of last RTT request */
256 	u64			rtt;		/* Current RTT estimate (in nS) */
257 	u64			rtt_sum;	/* Sum of cache contents */
258 	u64			rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* Determined RTT cache */
259 	u8			rtt_cursor;	/* next entry at which to insert */
260 	u8			rtt_usage;	/* amount of cache actually used */
261 };
262 
263 /*
264  * Keys for matching a connection.
265  */
266 struct rxrpc_conn_proto {
267 	union {
268 		struct {
269 			u32	epoch;		/* epoch of this connection */
270 			u32	cid;		/* connection ID */
271 		};
272 		u64		index_key;
273 	};
274 };
275 
276 struct rxrpc_conn_parameters {
277 	struct rxrpc_local	*local;		/* Representation of local endpoint */
278 	struct rxrpc_peer	*peer;		/* Remote endpoint */
279 	struct key		*key;		/* Security details */
280 	bool			exclusive;	/* T if conn is exclusive */
281 	u16			service_id;	/* Service ID for this connection */
282 	u32			security_level;	/* Security level selected */
283 };
284 
285 /*
286  * Bits in the connection flags.
287  */
288 enum rxrpc_conn_flag {
289 	RXRPC_CONN_HAS_IDR,		/* Has a client conn ID assigned */
290 	RXRPC_CONN_IN_SERVICE_CONNS,	/* Conn is in peer->service_conns */
291 	RXRPC_CONN_IN_CLIENT_CONNS,	/* Conn is in local->client_conns */
292 	RXRPC_CONN_EXPOSED,		/* Conn has extra ref for exposure */
293 	RXRPC_CONN_DONT_REUSE,		/* Don't reuse this connection */
294 	RXRPC_CONN_COUNTED,		/* Counted by rxrpc_nr_client_conns */
295 };
296 
297 /*
298  * Events that can be raised upon a connection.
299  */
300 enum rxrpc_conn_event {
301 	RXRPC_CONN_EV_CHALLENGE,	/* Send challenge packet */
302 };
303 
304 /*
305  * The connection cache state.
306  */
307 enum rxrpc_conn_cache_state {
308 	RXRPC_CONN_CLIENT_INACTIVE,	/* Conn is not yet listed */
309 	RXRPC_CONN_CLIENT_WAITING,	/* Conn is on wait list, waiting for capacity */
310 	RXRPC_CONN_CLIENT_ACTIVE,	/* Conn is on active list, doing calls */
311 	RXRPC_CONN_CLIENT_CULLED,	/* Conn is culled and delisted, doing calls */
312 	RXRPC_CONN_CLIENT_IDLE,		/* Conn is on idle list, doing mostly nothing */
313 	RXRPC_CONN__NR_CACHE_STATES
314 };
315 
316 /*
317  * The connection protocol state.
318  */
319 enum rxrpc_conn_proto_state {
320 	RXRPC_CONN_UNUSED,		/* Connection not yet attempted */
321 	RXRPC_CONN_CLIENT,		/* Client connection */
322 	RXRPC_CONN_SERVICE_PREALLOC,	/* Service connection preallocation */
323 	RXRPC_CONN_SERVICE_UNSECURED,	/* Service unsecured connection */
324 	RXRPC_CONN_SERVICE_CHALLENGING,	/* Service challenging for security */
325 	RXRPC_CONN_SERVICE,		/* Service secured connection */
326 	RXRPC_CONN_REMOTELY_ABORTED,	/* Conn aborted by peer */
327 	RXRPC_CONN_LOCALLY_ABORTED,	/* Conn aborted locally */
328 	RXRPC_CONN__NR_STATES
329 };
330 
331 /*
332  * RxRPC connection definition
333  * - matched by { local, peer, epoch, conn_id, direction }
334  * - each connection can only handle four simultaneous calls
335  */
336 struct rxrpc_connection {
337 	struct rxrpc_conn_proto	proto;
338 	struct rxrpc_conn_parameters params;
339 
340 	atomic_t		usage;
341 	struct rcu_head		rcu;
342 	struct list_head	cache_link;
343 
344 	spinlock_t		channel_lock;
345 	unsigned char		active_chans;	/* Mask of active channels */
346 #define RXRPC_ACTIVE_CHANS_MASK	((1 << RXRPC_MAXCALLS) - 1)
347 	struct list_head	waiting_calls;	/* Calls waiting for channels */
348 	struct rxrpc_channel {
349 		struct rxrpc_call __rcu	*call;		/* Active call */
350 		u32			call_id;	/* ID of current call */
351 		u32			call_counter;	/* Call ID counter */
352 		u32			last_call;	/* ID of last call */
353 		u8			last_type;	/* Type of last packet */
354 		u16			last_service_id;
355 		union {
356 			u32		last_seq;
357 			u32		last_abort;
358 		};
359 	} channels[RXRPC_MAXCALLS];
360 
361 	struct work_struct	processor;	/* connection event processor */
362 	union {
363 		struct rb_node	client_node;	/* Node in local->client_conns */
364 		struct rb_node	service_node;	/* Node in peer->service_conns */
365 	};
366 	struct list_head	proc_link;	/* link in procfs list */
367 	struct list_head	link;		/* link in master connection list */
368 	struct sk_buff_head	rx_queue;	/* received conn-level packets */
369 	const struct rxrpc_security *security;	/* applied security module */
370 	struct key		*server_key;	/* security for this service */
371 	struct crypto_skcipher	*cipher;	/* encryption handle */
372 	struct rxrpc_crypt	csum_iv;	/* packet checksum base */
373 	unsigned long		flags;
374 	unsigned long		events;
375 	unsigned long		idle_timestamp;	/* Time at which last became idle */
376 	spinlock_t		state_lock;	/* state-change lock */
377 	enum rxrpc_conn_cache_state cache_state;
378 	enum rxrpc_conn_proto_state state;	/* current state of connection */
379 	u32			local_abort;	/* local abort code */
380 	u32			remote_abort;	/* remote abort code */
381 	int			debug_id;	/* debug ID for printks */
382 	atomic_t		serial;		/* packet serial number counter */
383 	unsigned int		hi_serial;	/* highest serial number received */
384 	u32			security_nonce;	/* response re-use preventer */
385 	u8			size_align;	/* data size alignment (for security) */
386 	u8			security_size;	/* security header size */
387 	u8			security_ix;	/* security type */
388 	u8			out_clientflag;	/* RXRPC_CLIENT_INITIATED if we are client */
389 };
390 
391 /*
392  * Flags in call->flags.
393  */
394 enum rxrpc_call_flag {
395 	RXRPC_CALL_RELEASED,		/* call has been released - no more message to userspace */
396 	RXRPC_CALL_HAS_USERID,		/* has a user ID attached */
397 	RXRPC_CALL_IS_SERVICE,		/* Call is service call */
398 	RXRPC_CALL_EXPOSED,		/* The call was exposed to the world */
399 	RXRPC_CALL_RX_LAST,		/* Received the last packet (at rxtx_top) */
400 	RXRPC_CALL_TX_LAST,		/* Last packet in Tx buffer (at rxtx_top) */
401 	RXRPC_CALL_SEND_PING,		/* A ping will need to be sent */
402 	RXRPC_CALL_PINGING,		/* Ping in process */
403 	RXRPC_CALL_RETRANS_TIMEOUT,	/* Retransmission due to timeout occurred */
404 };
405 
406 /*
407  * Events that can be raised on a call.
408  */
409 enum rxrpc_call_event {
410 	RXRPC_CALL_EV_ACK,		/* need to generate ACK */
411 	RXRPC_CALL_EV_ABORT,		/* need to generate abort */
412 	RXRPC_CALL_EV_TIMER,		/* Timer expired */
413 	RXRPC_CALL_EV_RESEND,		/* Tx resend required */
414 	RXRPC_CALL_EV_PING,		/* Ping send required */
415 };
416 
417 /*
418  * The states that a call can be in.
419  */
420 enum rxrpc_call_state {
421 	RXRPC_CALL_UNINITIALISED,
422 	RXRPC_CALL_CLIENT_AWAIT_CONN,	/* - client waiting for connection to become available */
423 	RXRPC_CALL_CLIENT_SEND_REQUEST,	/* - client sending request phase */
424 	RXRPC_CALL_CLIENT_AWAIT_REPLY,	/* - client awaiting reply */
425 	RXRPC_CALL_CLIENT_RECV_REPLY,	/* - client receiving reply phase */
426 	RXRPC_CALL_SERVER_PREALLOC,	/* - service preallocation */
427 	RXRPC_CALL_SERVER_SECURING,	/* - server securing request connection */
428 	RXRPC_CALL_SERVER_ACCEPTING,	/* - server accepting request */
429 	RXRPC_CALL_SERVER_RECV_REQUEST,	/* - server receiving request */
430 	RXRPC_CALL_SERVER_ACK_REQUEST,	/* - server pending ACK of request */
431 	RXRPC_CALL_SERVER_SEND_REPLY,	/* - server sending reply */
432 	RXRPC_CALL_SERVER_AWAIT_ACK,	/* - server awaiting final ACK */
433 	RXRPC_CALL_COMPLETE,		/* - call complete */
434 	NR__RXRPC_CALL_STATES
435 };
436 
437 /*
438  * Call completion condition (state == RXRPC_CALL_COMPLETE).
439  */
440 enum rxrpc_call_completion {
441 	RXRPC_CALL_SUCCEEDED,		/* - Normal termination */
442 	RXRPC_CALL_REMOTELY_ABORTED,	/* - call aborted by peer */
443 	RXRPC_CALL_LOCALLY_ABORTED,	/* - call aborted locally on error or close */
444 	RXRPC_CALL_LOCAL_ERROR,		/* - call failed due to local error */
445 	RXRPC_CALL_NETWORK_ERROR,	/* - call terminated by network error */
446 	NR__RXRPC_CALL_COMPLETIONS
447 };
448 
449 /*
450  * Call Tx congestion management modes.
451  */
452 enum rxrpc_congest_mode {
453 	RXRPC_CALL_SLOW_START,
454 	RXRPC_CALL_CONGEST_AVOIDANCE,
455 	RXRPC_CALL_PACKET_LOSS,
456 	RXRPC_CALL_FAST_RETRANSMIT,
457 	NR__RXRPC_CONGEST_MODES
458 };
459 
460 /*
461  * RxRPC call definition
462  * - matched by { connection, call_id }
463  */
464 struct rxrpc_call {
465 	struct rcu_head		rcu;
466 	struct rxrpc_connection	*conn;		/* connection carrying call */
467 	struct rxrpc_peer	*peer;		/* Peer record for remote address */
468 	struct rxrpc_sock __rcu	*socket;	/* socket responsible */
469 	ktime_t			ack_at;		/* When deferred ACK needs to happen */
470 	ktime_t			resend_at;	/* When next resend needs to happen */
471 	ktime_t			ping_at;	/* When next to send a ping */
472 	ktime_t			expire_at;	/* When the call times out */
473 	struct timer_list	timer;		/* Combined event timer */
474 	struct work_struct	processor;	/* Event processor */
475 	rxrpc_notify_rx_t	notify_rx;	/* kernel service Rx notification function */
476 	struct list_head	link;		/* link in master call list */
477 	struct list_head	chan_wait_link;	/* Link in conn->waiting_calls */
478 	struct hlist_node	error_link;	/* link in error distribution list */
479 	struct list_head	accept_link;	/* Link in rx->acceptq */
480 	struct list_head	recvmsg_link;	/* Link in rx->recvmsg_q */
481 	struct list_head	sock_link;	/* Link in rx->sock_calls */
482 	struct rb_node		sock_node;	/* Node in rx->calls */
483 	struct sk_buff		*tx_pending;	/* Tx socket buffer being filled */
484 	wait_queue_head_t	waitq;		/* Wait queue for channel or Tx */
485 	__be32			crypto_buf[2];	/* Temporary packet crypto buffer */
486 	unsigned long		user_call_ID;	/* user-defined call ID */
487 	unsigned long		flags;
488 	unsigned long		events;
489 	spinlock_t		lock;
490 	rwlock_t		state_lock;	/* lock for state transition */
491 	u32			abort_code;	/* Local/remote abort code */
492 	int			error;		/* Local error incurred */
493 	enum rxrpc_call_state	state;		/* current state of call */
494 	enum rxrpc_call_completion completion;	/* Call completion condition */
495 	atomic_t		usage;
496 	u16			service_id;	/* service ID */
497 	u8			security_ix;	/* Security type */
498 	u32			call_id;	/* call ID on connection  */
499 	u32			cid;		/* connection ID plus channel index */
500 	int			debug_id;	/* debug ID for printks */
501 	unsigned short		rx_pkt_offset;	/* Current recvmsg packet offset */
502 	unsigned short		rx_pkt_len;	/* Current recvmsg packet len */
503 
504 	/* Rx/Tx circular buffer, depending on phase.
505 	 *
506 	 * In the Rx phase, packets are annotated with 0 or the number of the
507 	 * segment of a jumbo packet each buffer refers to.  There can be up to
508 	 * 47 segments in a maximum-size UDP packet.
509 	 *
510 	 * In the Tx phase, packets are annotated with which buffers have been
511 	 * acked.
512 	 */
513 #define RXRPC_RXTX_BUFF_SIZE	64
514 #define RXRPC_RXTX_BUFF_MASK	(RXRPC_RXTX_BUFF_SIZE - 1)
515 #define RXRPC_INIT_RX_WINDOW_SIZE 32
516 	struct sk_buff		**rxtx_buffer;
517 	u8			*rxtx_annotations;
518 #define RXRPC_TX_ANNO_ACK	0
519 #define RXRPC_TX_ANNO_UNACK	1
520 #define RXRPC_TX_ANNO_NAK	2
521 #define RXRPC_TX_ANNO_RETRANS	3
522 #define RXRPC_TX_ANNO_MASK	0x03
523 #define RXRPC_TX_ANNO_LAST	0x04
524 #define RXRPC_TX_ANNO_RESENT	0x08
525 
526 #define RXRPC_RX_ANNO_JUMBO	0x3f		/* Jumbo subpacket number + 1 if not zero */
527 #define RXRPC_RX_ANNO_JLAST	0x40		/* Set if last element of a jumbo packet */
528 #define RXRPC_RX_ANNO_VERIFIED	0x80		/* Set if verified and decrypted */
529 	rxrpc_seq_t		tx_hard_ack;	/* Dead slot in buffer; the first transmitted but
530 						 * not hard-ACK'd packet follows this.
531 						 */
532 	rxrpc_seq_t		tx_top;		/* Highest Tx slot allocated. */
533 
534 	/* TCP-style slow-start congestion control [RFC5681].  Since the SMSS
535 	 * is fixed, we keep these numbers in terms of segments (ie. DATA
536 	 * packets) rather than bytes.
537 	 */
538 #define RXRPC_TX_SMSS		RXRPC_JUMBO_DATALEN
539 	u8			cong_cwnd;	/* Congestion window size */
540 	u8			cong_extra;	/* Extra to send for congestion management */
541 	u8			cong_ssthresh;	/* Slow-start threshold */
542 	enum rxrpc_congest_mode	cong_mode:8;	/* Congestion management mode */
543 	u8			cong_dup_acks;	/* Count of ACKs showing missing packets */
544 	u8			cong_cumul_acks; /* Cumulative ACK count */
545 	ktime_t			cong_tstamp;	/* Last time cwnd was changed */
546 
547 	rxrpc_seq_t		rx_hard_ack;	/* Dead slot in buffer; the first received but not
548 						 * consumed packet follows this.
549 						 */
550 	rxrpc_seq_t		rx_top;		/* Highest Rx slot allocated. */
551 	rxrpc_seq_t		rx_expect_next;	/* Expected next packet sequence number */
552 	u8			rx_winsize;	/* Size of Rx window */
553 	u8			tx_winsize;	/* Maximum size of Tx window */
554 	bool			tx_phase;	/* T if transmission phase, F if receive phase */
555 	u8			nr_jumbo_bad;	/* Number of jumbo dups/exceeds-windows */
556 
557 	/* receive-phase ACK management */
558 	u8			ackr_reason;	/* reason to ACK */
559 	u16			ackr_skew;	/* skew on packet being ACK'd */
560 	rxrpc_serial_t		ackr_serial;	/* serial of packet being ACK'd */
561 	rxrpc_seq_t		ackr_prev_seq;	/* previous sequence number received */
562 	rxrpc_seq_t		ackr_consumed;	/* Highest packet shown consumed */
563 	rxrpc_seq_t		ackr_seen;	/* Highest packet shown seen */
564 
565 	/* ping management */
566 	rxrpc_serial_t		ping_serial;	/* Last ping sent */
567 	ktime_t			ping_time;	/* Time last ping sent */
568 
569 	/* transmission-phase ACK management */
570 	ktime_t			acks_latest_ts;	/* Timestamp of latest ACK received */
571 	rxrpc_serial_t		acks_latest;	/* serial number of latest ACK received */
572 	rxrpc_seq_t		acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
573 };
574 
575 /*
576  * Summary of a new ACK and the changes it made to the Tx buffer packet states.
577  */
578 struct rxrpc_ack_summary {
579 	u8			ack_reason;
580 	u8			nr_acks;		/* Number of ACKs in packet */
581 	u8			nr_nacks;		/* Number of NACKs in packet */
582 	u8			nr_new_acks;		/* Number of new ACKs in packet */
583 	u8			nr_new_nacks;		/* Number of new NACKs in packet */
584 	u8			nr_rot_new_acks;	/* Number of rotated new ACKs */
585 	bool			new_low_nack;		/* T if new low NACK found */
586 	bool			retrans_timeo;		/* T if reTx due to timeout happened */
587 	u8			flight_size;		/* Number of unreceived transmissions */
588 	/* Place to stash values for tracing */
589 	enum rxrpc_congest_mode	mode:8;
590 	u8			cwnd;
591 	u8			ssthresh;
592 	u8			dup_acks;
593 	u8			cumulative_acks;
594 };
595 
596 enum rxrpc_skb_trace {
597 	rxrpc_skb_rx_cleaned,
598 	rxrpc_skb_rx_freed,
599 	rxrpc_skb_rx_got,
600 	rxrpc_skb_rx_lost,
601 	rxrpc_skb_rx_received,
602 	rxrpc_skb_rx_rotated,
603 	rxrpc_skb_rx_purged,
604 	rxrpc_skb_rx_seen,
605 	rxrpc_skb_tx_cleaned,
606 	rxrpc_skb_tx_freed,
607 	rxrpc_skb_tx_got,
608 	rxrpc_skb_tx_new,
609 	rxrpc_skb_tx_rotated,
610 	rxrpc_skb_tx_seen,
611 	rxrpc_skb__nr_trace
612 };
613 
614 extern const char rxrpc_skb_traces[rxrpc_skb__nr_trace][7];
615 
616 enum rxrpc_conn_trace {
617 	rxrpc_conn_new_client,
618 	rxrpc_conn_new_service,
619 	rxrpc_conn_queued,
620 	rxrpc_conn_seen,
621 	rxrpc_conn_got,
622 	rxrpc_conn_put_client,
623 	rxrpc_conn_put_service,
624 	rxrpc_conn__nr_trace
625 };
626 
627 extern const char rxrpc_conn_traces[rxrpc_conn__nr_trace][4];
628 
629 enum rxrpc_client_trace {
630 	rxrpc_client_activate_chans,
631 	rxrpc_client_alloc,
632 	rxrpc_client_chan_activate,
633 	rxrpc_client_chan_disconnect,
634 	rxrpc_client_chan_pass,
635 	rxrpc_client_chan_unstarted,
636 	rxrpc_client_cleanup,
637 	rxrpc_client_count,
638 	rxrpc_client_discard,
639 	rxrpc_client_duplicate,
640 	rxrpc_client_exposed,
641 	rxrpc_client_replace,
642 	rxrpc_client_to_active,
643 	rxrpc_client_to_culled,
644 	rxrpc_client_to_idle,
645 	rxrpc_client_to_inactive,
646 	rxrpc_client_to_waiting,
647 	rxrpc_client_uncount,
648 	rxrpc_client__nr_trace
649 };
650 
651 extern const char rxrpc_client_traces[rxrpc_client__nr_trace][7];
652 extern const char rxrpc_conn_cache_states[RXRPC_CONN__NR_CACHE_STATES][5];
653 
654 enum rxrpc_call_trace {
655 	rxrpc_call_new_client,
656 	rxrpc_call_new_service,
657 	rxrpc_call_queued,
658 	rxrpc_call_queued_ref,
659 	rxrpc_call_seen,
660 	rxrpc_call_connected,
661 	rxrpc_call_release,
662 	rxrpc_call_got,
663 	rxrpc_call_got_userid,
664 	rxrpc_call_got_kernel,
665 	rxrpc_call_put,
666 	rxrpc_call_put_userid,
667 	rxrpc_call_put_kernel,
668 	rxrpc_call_put_noqueue,
669 	rxrpc_call_error,
670 	rxrpc_call__nr_trace
671 };
672 
673 extern const char rxrpc_call_traces[rxrpc_call__nr_trace][4];
674 
675 enum rxrpc_transmit_trace {
676 	rxrpc_transmit_wait,
677 	rxrpc_transmit_queue,
678 	rxrpc_transmit_queue_last,
679 	rxrpc_transmit_rotate,
680 	rxrpc_transmit_rotate_last,
681 	rxrpc_transmit_await_reply,
682 	rxrpc_transmit_end,
683 	rxrpc_transmit__nr_trace
684 };
685 
686 extern const char rxrpc_transmit_traces[rxrpc_transmit__nr_trace][4];
687 
688 enum rxrpc_receive_trace {
689 	rxrpc_receive_incoming,
690 	rxrpc_receive_queue,
691 	rxrpc_receive_queue_last,
692 	rxrpc_receive_front,
693 	rxrpc_receive_rotate,
694 	rxrpc_receive_end,
695 	rxrpc_receive__nr_trace
696 };
697 
698 extern const char rxrpc_receive_traces[rxrpc_receive__nr_trace][4];
699 
700 enum rxrpc_recvmsg_trace {
701 	rxrpc_recvmsg_enter,
702 	rxrpc_recvmsg_wait,
703 	rxrpc_recvmsg_dequeue,
704 	rxrpc_recvmsg_hole,
705 	rxrpc_recvmsg_next,
706 	rxrpc_recvmsg_cont,
707 	rxrpc_recvmsg_full,
708 	rxrpc_recvmsg_data_return,
709 	rxrpc_recvmsg_terminal,
710 	rxrpc_recvmsg_to_be_accepted,
711 	rxrpc_recvmsg_return,
712 	rxrpc_recvmsg__nr_trace
713 };
714 
715 extern const char rxrpc_recvmsg_traces[rxrpc_recvmsg__nr_trace][5];
716 
717 enum rxrpc_rtt_tx_trace {
718 	rxrpc_rtt_tx_ping,
719 	rxrpc_rtt_tx_data,
720 	rxrpc_rtt_tx__nr_trace
721 };
722 
723 extern const char rxrpc_rtt_tx_traces[rxrpc_rtt_tx__nr_trace][5];
724 
725 enum rxrpc_rtt_rx_trace {
726 	rxrpc_rtt_rx_ping_response,
727 	rxrpc_rtt_rx_requested_ack,
728 	rxrpc_rtt_rx__nr_trace
729 };
730 
731 extern const char rxrpc_rtt_rx_traces[rxrpc_rtt_rx__nr_trace][5];
732 
733 enum rxrpc_timer_trace {
734 	rxrpc_timer_begin,
735 	rxrpc_timer_init_for_reply,
736 	rxrpc_timer_expired,
737 	rxrpc_timer_set_for_ack,
738 	rxrpc_timer_set_for_ping,
739 	rxrpc_timer_set_for_resend,
740 	rxrpc_timer_set_for_send,
741 	rxrpc_timer__nr_trace
742 };
743 
744 extern const char rxrpc_timer_traces[rxrpc_timer__nr_trace][8];
745 
746 enum rxrpc_propose_ack_trace {
747 	rxrpc_propose_ack_client_tx_end,
748 	rxrpc_propose_ack_input_data,
749 	rxrpc_propose_ack_ping_for_lost_ack,
750 	rxrpc_propose_ack_ping_for_lost_reply,
751 	rxrpc_propose_ack_ping_for_params,
752 	rxrpc_propose_ack_respond_to_ack,
753 	rxrpc_propose_ack_respond_to_ping,
754 	rxrpc_propose_ack_retry_tx,
755 	rxrpc_propose_ack_rotate_rx,
756 	rxrpc_propose_ack_terminal_ack,
757 	rxrpc_propose_ack__nr_trace
758 };
759 
760 enum rxrpc_propose_ack_outcome {
761 	rxrpc_propose_ack_use,
762 	rxrpc_propose_ack_update,
763 	rxrpc_propose_ack_subsume,
764 	rxrpc_propose_ack__nr_outcomes
765 };
766 
767 extern const char rxrpc_propose_ack_traces[rxrpc_propose_ack__nr_trace][8];
768 extern const char *const rxrpc_propose_ack_outcomes[rxrpc_propose_ack__nr_outcomes];
769 
770 enum rxrpc_congest_change {
771 	rxrpc_cong_begin_retransmission,
772 	rxrpc_cong_cleared_nacks,
773 	rxrpc_cong_new_low_nack,
774 	rxrpc_cong_no_change,
775 	rxrpc_cong_progress,
776 	rxrpc_cong_retransmit_again,
777 	rxrpc_cong_rtt_window_end,
778 	rxrpc_cong_saw_nack,
779 	rxrpc_congest__nr_change
780 };
781 
782 extern const char rxrpc_congest_modes[NR__RXRPC_CONGEST_MODES][10];
783 extern const char rxrpc_congest_changes[rxrpc_congest__nr_change][9];
784 
785 extern const char *const rxrpc_pkts[];
786 extern const char rxrpc_ack_names[RXRPC_ACK__INVALID + 1][4];
787 
788 #include <trace/events/rxrpc.h>
789 
790 /*
791  * af_rxrpc.c
792  */
793 extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
794 extern u32 rxrpc_epoch;
795 extern atomic_t rxrpc_debug_id;
796 extern struct workqueue_struct *rxrpc_workqueue;
797 
798 /*
799  * call_accept.c
800  */
801 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
802 void rxrpc_discard_prealloc(struct rxrpc_sock *);
803 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
804 					   struct rxrpc_connection *,
805 					   struct sk_buff *);
806 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
807 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
808 				     rxrpc_notify_rx_t);
809 int rxrpc_reject_call(struct rxrpc_sock *);
810 
811 /*
812  * call_event.c
813  */
814 void rxrpc_set_timer(struct rxrpc_call *, enum rxrpc_timer_trace, ktime_t);
815 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool, bool,
816 		       enum rxrpc_propose_ack_trace);
817 void rxrpc_process_call(struct work_struct *);
818 
819 /*
820  * call_object.c
821  */
822 extern const char *const rxrpc_call_states[];
823 extern const char *const rxrpc_call_completions[];
824 extern unsigned int rxrpc_max_call_lifetime;
825 extern struct kmem_cache *rxrpc_call_jar;
826 extern struct list_head rxrpc_calls;
827 extern rwlock_t rxrpc_call_lock;
828 
829 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
830 struct rxrpc_call *rxrpc_alloc_call(gfp_t);
831 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
832 					 struct rxrpc_conn_parameters *,
833 					 struct sockaddr_rxrpc *,
834 					 unsigned long, gfp_t);
835 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
836 			 struct sk_buff *);
837 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
838 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
839 bool __rxrpc_queue_call(struct rxrpc_call *);
840 bool rxrpc_queue_call(struct rxrpc_call *);
841 void rxrpc_see_call(struct rxrpc_call *);
842 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
843 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
844 void rxrpc_cleanup_call(struct rxrpc_call *);
845 void __exit rxrpc_destroy_all_calls(void);
846 
847 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
848 {
849 	return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
850 }
851 
852 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
853 {
854 	return !rxrpc_is_service_call(call);
855 }
856 
857 /*
858  * Transition a call to the complete state.
859  */
860 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
861 					       enum rxrpc_call_completion compl,
862 					       u32 abort_code,
863 					       int error)
864 {
865 	if (call->state < RXRPC_CALL_COMPLETE) {
866 		call->abort_code = abort_code;
867 		call->error = error;
868 		call->completion = compl,
869 		call->state = RXRPC_CALL_COMPLETE;
870 		wake_up(&call->waitq);
871 		return true;
872 	}
873 	return false;
874 }
875 
876 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
877 					     enum rxrpc_call_completion compl,
878 					     u32 abort_code,
879 					     int error)
880 {
881 	bool ret;
882 
883 	write_lock_bh(&call->state_lock);
884 	ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
885 	write_unlock_bh(&call->state_lock);
886 	return ret;
887 }
888 
889 /*
890  * Record that a call successfully completed.
891  */
892 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
893 {
894 	return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
895 }
896 
897 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
898 {
899 	bool ret;
900 
901 	write_lock_bh(&call->state_lock);
902 	ret = __rxrpc_call_completed(call);
903 	write_unlock_bh(&call->state_lock);
904 	return ret;
905 }
906 
907 /*
908  * Record that a call is locally aborted.
909  */
910 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
911 				      rxrpc_seq_t seq,
912 				      u32 abort_code, int error)
913 {
914 	trace_rxrpc_abort(why, call->cid, call->call_id, seq,
915 			  abort_code, error);
916 	return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
917 					   abort_code, error);
918 }
919 
920 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
921 				    rxrpc_seq_t seq, u32 abort_code, int error)
922 {
923 	bool ret;
924 
925 	write_lock_bh(&call->state_lock);
926 	ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
927 	write_unlock_bh(&call->state_lock);
928 	return ret;
929 }
930 
931 /*
932  * conn_client.c
933  */
934 extern unsigned int rxrpc_max_client_connections;
935 extern unsigned int rxrpc_reap_client_connections;
936 extern unsigned int rxrpc_conn_idle_client_expiry;
937 extern unsigned int rxrpc_conn_idle_client_fast_expiry;
938 extern struct idr rxrpc_client_conn_ids;
939 
940 void rxrpc_destroy_client_conn_ids(void);
941 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
942 		       struct sockaddr_rxrpc *, gfp_t);
943 void rxrpc_expose_client_call(struct rxrpc_call *);
944 void rxrpc_disconnect_client_call(struct rxrpc_call *);
945 void rxrpc_put_client_conn(struct rxrpc_connection *);
946 void __exit rxrpc_destroy_all_client_connections(void);
947 
948 /*
949  * conn_event.c
950  */
951 void rxrpc_process_connection(struct work_struct *);
952 
953 /*
954  * conn_object.c
955  */
956 extern unsigned int rxrpc_connection_expiry;
957 extern struct list_head rxrpc_connections;
958 extern struct list_head rxrpc_connection_proc_list;
959 extern rwlock_t rxrpc_connection_lock;
960 
961 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
962 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
963 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
964 						   struct sk_buff *);
965 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
966 void rxrpc_disconnect_call(struct rxrpc_call *);
967 void rxrpc_kill_connection(struct rxrpc_connection *);
968 bool rxrpc_queue_conn(struct rxrpc_connection *);
969 void rxrpc_see_connection(struct rxrpc_connection *);
970 void rxrpc_get_connection(struct rxrpc_connection *);
971 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
972 void rxrpc_put_service_conn(struct rxrpc_connection *);
973 void __exit rxrpc_destroy_all_connections(void);
974 
975 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
976 {
977 	return conn->out_clientflag;
978 }
979 
980 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
981 {
982 	return !rxrpc_conn_is_client(conn);
983 }
984 
985 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
986 {
987 	if (!conn)
988 		return;
989 
990 	if (rxrpc_conn_is_client(conn))
991 		rxrpc_put_client_conn(conn);
992 	else
993 		rxrpc_put_service_conn(conn);
994 }
995 
996 /*
997  * conn_service.c
998  */
999 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
1000 						     struct sk_buff *);
1001 struct rxrpc_connection *rxrpc_prealloc_service_connection(gfp_t);
1002 void rxrpc_new_incoming_connection(struct rxrpc_connection *, struct sk_buff *);
1003 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
1004 
1005 /*
1006  * input.c
1007  */
1008 void rxrpc_data_ready(struct sock *);
1009 
1010 /*
1011  * insecure.c
1012  */
1013 extern const struct rxrpc_security rxrpc_no_security;
1014 
1015 /*
1016  * key.c
1017  */
1018 extern struct key_type key_type_rxrpc;
1019 extern struct key_type key_type_rxrpc_s;
1020 
1021 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
1022 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
1023 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
1024 			      u32);
1025 
1026 /*
1027  * local_event.c
1028  */
1029 extern void rxrpc_process_local_events(struct rxrpc_local *);
1030 
1031 /*
1032  * local_object.c
1033  */
1034 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
1035 void __rxrpc_put_local(struct rxrpc_local *);
1036 void __exit rxrpc_destroy_all_locals(void);
1037 
1038 static inline void rxrpc_get_local(struct rxrpc_local *local)
1039 {
1040 	atomic_inc(&local->usage);
1041 }
1042 
1043 static inline
1044 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
1045 {
1046 	return atomic_inc_not_zero(&local->usage) ? local : NULL;
1047 }
1048 
1049 static inline void rxrpc_put_local(struct rxrpc_local *local)
1050 {
1051 	if (local && atomic_dec_and_test(&local->usage))
1052 		__rxrpc_put_local(local);
1053 }
1054 
1055 static inline void rxrpc_queue_local(struct rxrpc_local *local)
1056 {
1057 	rxrpc_queue_work(&local->processor);
1058 }
1059 
1060 /*
1061  * misc.c
1062  */
1063 extern unsigned int rxrpc_max_backlog __read_mostly;
1064 extern unsigned int rxrpc_requested_ack_delay;
1065 extern unsigned int rxrpc_soft_ack_delay;
1066 extern unsigned int rxrpc_idle_ack_delay;
1067 extern unsigned int rxrpc_rx_window_size;
1068 extern unsigned int rxrpc_rx_mtu;
1069 extern unsigned int rxrpc_rx_jumbo_max;
1070 extern unsigned int rxrpc_resend_timeout;
1071 
1072 extern const s8 rxrpc_ack_priority[];
1073 
1074 /*
1075  * output.c
1076  */
1077 int rxrpc_send_ack_packet(struct rxrpc_call *, bool);
1078 int rxrpc_send_abort_packet(struct rxrpc_call *);
1079 int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
1080 void rxrpc_reject_packets(struct rxrpc_local *);
1081 
1082 /*
1083  * peer_event.c
1084  */
1085 void rxrpc_error_report(struct sock *);
1086 void rxrpc_peer_error_distributor(struct work_struct *);
1087 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace,
1088 			rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1089 
1090 /*
1091  * peer_object.c
1092  */
1093 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1094 					 const struct sockaddr_rxrpc *);
1095 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
1096 				     struct sockaddr_rxrpc *, gfp_t);
1097 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
1098 struct rxrpc_peer *rxrpc_lookup_incoming_peer(struct rxrpc_local *,
1099 					      struct rxrpc_peer *);
1100 
1101 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
1102 {
1103 	atomic_inc(&peer->usage);
1104 	return peer;
1105 }
1106 
1107 static inline
1108 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
1109 {
1110 	return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
1111 }
1112 
1113 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
1114 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
1115 {
1116 	if (peer && atomic_dec_and_test(&peer->usage))
1117 		__rxrpc_put_peer(peer);
1118 }
1119 
1120 /*
1121  * proc.c
1122  */
1123 extern const struct file_operations rxrpc_call_seq_fops;
1124 extern const struct file_operations rxrpc_connection_seq_fops;
1125 
1126 /*
1127  * recvmsg.c
1128  */
1129 void rxrpc_notify_socket(struct rxrpc_call *);
1130 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1131 
1132 /*
1133  * rxkad.c
1134  */
1135 #ifdef CONFIG_RXKAD
1136 extern const struct rxrpc_security rxkad;
1137 #endif
1138 
1139 /*
1140  * security.c
1141  */
1142 int __init rxrpc_init_security(void);
1143 void rxrpc_exit_security(void);
1144 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1145 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
1146 
1147 /*
1148  * sendmsg.c
1149  */
1150 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1151 
1152 /*
1153  * skbuff.c
1154  */
1155 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1156 void rxrpc_packet_destructor(struct sk_buff *);
1157 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1158 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1159 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1160 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1161 void rxrpc_lose_skb(struct sk_buff *, enum rxrpc_skb_trace);
1162 void rxrpc_purge_queue(struct sk_buff_head *);
1163 
1164 /*
1165  * sysctl.c
1166  */
1167 #ifdef CONFIG_SYSCTL
1168 extern int __init rxrpc_sysctl_init(void);
1169 extern void rxrpc_sysctl_exit(void);
1170 #else
1171 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1172 static inline void rxrpc_sysctl_exit(void) {}
1173 #endif
1174 
1175 /*
1176  * utils.c
1177  */
1178 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1179 
1180 static inline bool before(u32 seq1, u32 seq2)
1181 {
1182         return (s32)(seq1 - seq2) < 0;
1183 }
1184 static inline bool before_eq(u32 seq1, u32 seq2)
1185 {
1186         return (s32)(seq1 - seq2) <= 0;
1187 }
1188 static inline bool after(u32 seq1, u32 seq2)
1189 {
1190         return (s32)(seq1 - seq2) > 0;
1191 }
1192 static inline bool after_eq(u32 seq1, u32 seq2)
1193 {
1194         return (s32)(seq1 - seq2) >= 0;
1195 }
1196 
1197 /*
1198  * debug tracing
1199  */
1200 extern unsigned int rxrpc_debug;
1201 
1202 #define dbgprintk(FMT,...) \
1203 	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1204 
1205 #define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1206 #define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1207 #define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
1208 #define kproto(FMT,...)	dbgprintk("### "FMT ,##__VA_ARGS__)
1209 #define knet(FMT,...)	dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1210 
1211 
1212 #if defined(__KDEBUG)
1213 #define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
1214 #define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
1215 #define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
1216 #define _proto(FMT,...)	kproto(FMT,##__VA_ARGS__)
1217 #define _net(FMT,...)	knet(FMT,##__VA_ARGS__)
1218 
1219 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1220 #define RXRPC_DEBUG_KENTER	0x01
1221 #define RXRPC_DEBUG_KLEAVE	0x02
1222 #define RXRPC_DEBUG_KDEBUG	0x04
1223 #define RXRPC_DEBUG_KPROTO	0x08
1224 #define RXRPC_DEBUG_KNET	0x10
1225 
1226 #define _enter(FMT,...)					\
1227 do {							\
1228 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER))	\
1229 		kenter(FMT,##__VA_ARGS__);		\
1230 } while (0)
1231 
1232 #define _leave(FMT,...)					\
1233 do {							\
1234 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE))	\
1235 		kleave(FMT,##__VA_ARGS__);		\
1236 } while (0)
1237 
1238 #define _debug(FMT,...)					\
1239 do {							\
1240 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG))	\
1241 		kdebug(FMT,##__VA_ARGS__);		\
1242 } while (0)
1243 
1244 #define _proto(FMT,...)					\
1245 do {							\
1246 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO))	\
1247 		kproto(FMT,##__VA_ARGS__);		\
1248 } while (0)
1249 
1250 #define _net(FMT,...)					\
1251 do {							\
1252 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))	\
1253 		knet(FMT,##__VA_ARGS__);		\
1254 } while (0)
1255 
1256 #else
1257 #define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1258 #define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1259 #define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
1260 #define _proto(FMT,...)	no_printk("### "FMT ,##__VA_ARGS__)
1261 #define _net(FMT,...)	no_printk("@@@ "FMT ,##__VA_ARGS__)
1262 #endif
1263 
1264 /*
1265  * debug assertion checking
1266  */
1267 #if 1 // defined(__KDEBUGALL)
1268 
1269 #define ASSERT(X)						\
1270 do {								\
1271 	if (unlikely(!(X))) {					\
1272 		pr_err("Assertion failed\n");			\
1273 		BUG();						\
1274 	}							\
1275 } while (0)
1276 
1277 #define ASSERTCMP(X, OP, Y)						\
1278 do {									\
1279 	__typeof__(X) _x = (X);						\
1280 	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1281 	if (unlikely(!(_x OP _y))) {					\
1282 		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1283 		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1284 		       (unsigned long)_y, (unsigned long)_y);		\
1285 		BUG();							\
1286 	}								\
1287 } while (0)
1288 
1289 #define ASSERTIF(C, X)						\
1290 do {								\
1291 	if (unlikely((C) && !(X))) {				\
1292 		pr_err("Assertion failed\n");			\
1293 		BUG();						\
1294 	}							\
1295 } while (0)
1296 
1297 #define ASSERTIFCMP(C, X, OP, Y)					\
1298 do {									\
1299 	__typeof__(X) _x = (X);						\
1300 	__typeof__(Y) _y = (__typeof__(X))(Y);				\
1301 	if (unlikely((C) && !(_x OP _y))) {				\
1302 		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1303 		       (unsigned long)_x, (unsigned long)_x, #OP,	\
1304 		       (unsigned long)_y, (unsigned long)_y);		\
1305 		BUG();							\
1306 	}								\
1307 } while (0)
1308 
1309 #else
1310 
1311 #define ASSERT(X)				\
1312 do {						\
1313 } while (0)
1314 
1315 #define ASSERTCMP(X, OP, Y)			\
1316 do {						\
1317 } while (0)
1318 
1319 #define ASSERTIF(C, X)				\
1320 do {						\
1321 } while (0)
1322 
1323 #define ASSERTIFCMP(C, X, OP, Y)		\
1324 do {						\
1325 } while (0)
1326 
1327 #endif /* __KDEBUGALL */
1328