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