xref: /openbmc/linux/net/rxrpc/ar-internal.h (revision 6c7c3245)
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 #define rxrpc_queue_call(CALL)	rxrpc_queue_work(&(CALL)->processor)
39 
40 struct rxrpc_connection;
41 
42 /*
43  * sk_state for RxRPC sockets
44  */
45 enum {
46 	RXRPC_UNBOUND = 0,
47 	RXRPC_CLIENT_UNBOUND,		/* Unbound socket used as client */
48 	RXRPC_CLIENT_BOUND,		/* client local address bound */
49 	RXRPC_SERVER_BOUND,		/* server local address bound */
50 	RXRPC_SERVER_LISTENING,		/* server listening for connections */
51 	RXRPC_CLOSE,			/* socket is being closed */
52 };
53 
54 /*
55  * RxRPC socket definition
56  */
57 struct rxrpc_sock {
58 	/* WARNING: sk has to be the first member */
59 	struct sock		sk;
60 	rxrpc_interceptor_t	interceptor;	/* kernel service Rx interceptor function */
61 	struct rxrpc_local	*local;		/* local endpoint */
62 	struct list_head	listen_link;	/* link in the local endpoint's listen list */
63 	struct list_head	secureq;	/* calls awaiting connection security clearance */
64 	struct list_head	acceptq;	/* calls awaiting acceptance */
65 	struct key		*key;		/* security for this socket */
66 	struct key		*securities;	/* list of server security descriptors */
67 	struct rb_root		calls;		/* outstanding calls on this socket */
68 	unsigned long		flags;
69 #define RXRPC_SOCK_CONNECTED		0	/* connect_srx is set */
70 	rwlock_t		call_lock;	/* lock for calls */
71 	u32			min_sec_level;	/* minimum security level */
72 #define RXRPC_SECURITY_MAX	RXRPC_SECURITY_ENCRYPT
73 	bool			exclusive;	/* Exclusive connection for a client socket */
74 	sa_family_t		family;		/* Protocol family created with */
75 	struct sockaddr_rxrpc	srx;		/* local address */
76 	struct sockaddr_rxrpc	connect_srx;	/* Default client address from connect() */
77 };
78 
79 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
80 
81 /*
82  * CPU-byteorder normalised Rx packet header.
83  */
84 struct rxrpc_host_header {
85 	u32		epoch;		/* client boot timestamp */
86 	u32		cid;		/* connection and channel ID */
87 	u32		callNumber;	/* call ID (0 for connection-level packets) */
88 	u32		seq;		/* sequence number of pkt in call stream */
89 	u32		serial;		/* serial number of pkt sent to network */
90 	u8		type;		/* packet type */
91 	u8		flags;		/* packet flags */
92 	u8		userStatus;	/* app-layer defined status */
93 	u8		securityIndex;	/* security protocol ID */
94 	union {
95 		u16	_rsvd;		/* reserved */
96 		u16	cksum;		/* kerberos security checksum */
97 	};
98 	u16		serviceId;	/* service ID */
99 } __packed;
100 
101 /*
102  * RxRPC socket buffer private variables
103  * - max 48 bytes (struct sk_buff::cb)
104  */
105 struct rxrpc_skb_priv {
106 	struct rxrpc_call	*call;		/* call with which associated */
107 	unsigned long		resend_at;	/* time in jiffies at which to resend */
108 	union {
109 		unsigned int	offset;		/* offset into buffer of next read */
110 		int		remain;		/* amount of space remaining for next write */
111 		u32		error;		/* network error code */
112 		bool		need_resend;	/* T if needs resending */
113 	};
114 
115 	struct rxrpc_host_header hdr;		/* RxRPC packet header from this packet */
116 };
117 
118 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
119 
120 enum rxrpc_command {
121 	RXRPC_CMD_SEND_DATA,		/* send data message */
122 	RXRPC_CMD_SEND_ABORT,		/* request abort generation */
123 	RXRPC_CMD_ACCEPT,		/* [server] accept incoming call */
124 	RXRPC_CMD_REJECT_BUSY,		/* [server] reject a call as busy */
125 };
126 
127 /*
128  * RxRPC security module interface
129  */
130 struct rxrpc_security {
131 	const char		*name;		/* name of this service */
132 	u8			security_index;	/* security type provided */
133 
134 	/* Initialise a security service */
135 	int (*init)(void);
136 
137 	/* Clean up a security service */
138 	void (*exit)(void);
139 
140 	/* initialise a connection's security */
141 	int (*init_connection_security)(struct rxrpc_connection *);
142 
143 	/* prime a connection's packet security */
144 	int (*prime_packet_security)(struct rxrpc_connection *);
145 
146 	/* impose security on a packet */
147 	int (*secure_packet)(struct rxrpc_call *,
148 			     struct sk_buff *,
149 			     size_t,
150 			     void *);
151 
152 	/* verify the security on a received packet */
153 	int (*verify_packet)(struct rxrpc_call *, struct sk_buff *, u32 *);
154 
155 	/* issue a challenge */
156 	int (*issue_challenge)(struct rxrpc_connection *);
157 
158 	/* respond to a challenge */
159 	int (*respond_to_challenge)(struct rxrpc_connection *,
160 				    struct sk_buff *,
161 				    u32 *);
162 
163 	/* verify a response */
164 	int (*verify_response)(struct rxrpc_connection *,
165 			       struct sk_buff *,
166 			       u32 *);
167 
168 	/* clear connection security */
169 	void (*clear)(struct rxrpc_connection *);
170 };
171 
172 /*
173  * RxRPC local transport endpoint description
174  * - owned by a single AF_RXRPC socket
175  * - pointed to by transport socket struct sk_user_data
176  */
177 struct rxrpc_local {
178 	struct rcu_head		rcu;
179 	atomic_t		usage;
180 	struct list_head	link;
181 	struct socket		*socket;	/* my UDP socket */
182 	struct work_struct	processor;
183 	struct list_head	services;	/* services listening on this endpoint */
184 	struct rw_semaphore	defrag_sem;	/* control re-enablement of IP DF bit */
185 	struct sk_buff_head	accept_queue;	/* incoming calls awaiting acceptance */
186 	struct sk_buff_head	reject_queue;	/* packets awaiting rejection */
187 	struct sk_buff_head	event_queue;	/* endpoint event packets awaiting processing */
188 	struct rb_root		client_conns;	/* Client connections by socket params */
189 	spinlock_t		client_conns_lock; /* Lock for client_conns */
190 	spinlock_t		lock;		/* access lock */
191 	rwlock_t		services_lock;	/* lock for services list */
192 	int			debug_id;	/* debug ID for printks */
193 	bool			dead;
194 	struct sockaddr_rxrpc	srx;		/* local address */
195 };
196 
197 /*
198  * RxRPC remote transport endpoint definition
199  * - matched by local endpoint, remote port, address and protocol type
200  */
201 struct rxrpc_peer {
202 	struct rcu_head		rcu;		/* This must be first */
203 	atomic_t		usage;
204 	unsigned long		hash_key;
205 	struct hlist_node	hash_link;
206 	struct rxrpc_local	*local;
207 	struct hlist_head	error_targets;	/* targets for net error distribution */
208 	struct work_struct	error_distributor;
209 	struct rb_root		service_conns;	/* Service connections */
210 	seqlock_t		service_conn_lock;
211 	spinlock_t		lock;		/* access lock */
212 	unsigned int		if_mtu;		/* interface MTU for this peer */
213 	unsigned int		mtu;		/* network MTU for this peer */
214 	unsigned int		maxdata;	/* data size (MTU - hdrsize) */
215 	unsigned short		hdrsize;	/* header size (IP + UDP + RxRPC) */
216 	int			debug_id;	/* debug ID for printks */
217 	int			error_report;	/* Net (+0) or local (+1000000) to distribute */
218 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
219 	struct sockaddr_rxrpc	srx;		/* remote address */
220 
221 	/* calculated RTT cache */
222 #define RXRPC_RTT_CACHE_SIZE 32
223 	suseconds_t		rtt;		/* current RTT estimate (in uS) */
224 	unsigned int		rtt_point;	/* next entry at which to insert */
225 	unsigned int		rtt_usage;	/* amount of cache actually used */
226 	suseconds_t		rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* calculated RTT cache */
227 };
228 
229 /*
230  * Keys for matching a connection.
231  */
232 struct rxrpc_conn_proto {
233 	union {
234 		struct {
235 			u32	epoch;		/* epoch of this connection */
236 			u32	cid;		/* connection ID */
237 		};
238 		u64		index_key;
239 	};
240 };
241 
242 struct rxrpc_conn_parameters {
243 	struct rxrpc_local	*local;		/* Representation of local endpoint */
244 	struct rxrpc_peer	*peer;		/* Remote endpoint */
245 	struct key		*key;		/* Security details */
246 	bool			exclusive;	/* T if conn is exclusive */
247 	u16			service_id;	/* Service ID for this connection */
248 	u32			security_level;	/* Security level selected */
249 };
250 
251 /*
252  * Bits in the connection flags.
253  */
254 enum rxrpc_conn_flag {
255 	RXRPC_CONN_HAS_IDR,		/* Has a client conn ID assigned */
256 	RXRPC_CONN_IN_SERVICE_CONNS,	/* Conn is in peer->service_conns */
257 	RXRPC_CONN_IN_CLIENT_CONNS,	/* Conn is in local->client_conns */
258 };
259 
260 /*
261  * Events that can be raised upon a connection.
262  */
263 enum rxrpc_conn_event {
264 	RXRPC_CONN_EV_CHALLENGE,	/* Send challenge packet */
265 };
266 
267 /*
268  * The connection protocol state.
269  */
270 enum rxrpc_conn_proto_state {
271 	RXRPC_CONN_UNUSED,		/* Connection not yet attempted */
272 	RXRPC_CONN_CLIENT,		/* Client connection */
273 	RXRPC_CONN_SERVICE_UNSECURED,	/* Service unsecured connection */
274 	RXRPC_CONN_SERVICE_CHALLENGING,	/* Service challenging for security */
275 	RXRPC_CONN_SERVICE,		/* Service secured connection */
276 	RXRPC_CONN_REMOTELY_ABORTED,	/* Conn aborted by peer */
277 	RXRPC_CONN_LOCALLY_ABORTED,	/* Conn aborted locally */
278 	RXRPC_CONN_NETWORK_ERROR,	/* Conn terminated by network error */
279 	RXRPC_CONN__NR_STATES
280 };
281 
282 /*
283  * RxRPC connection definition
284  * - matched by { local, peer, epoch, conn_id, direction }
285  * - each connection can only handle four simultaneous calls
286  */
287 struct rxrpc_connection {
288 	struct rxrpc_conn_proto	proto;
289 	struct rxrpc_conn_parameters params;
290 
291 	spinlock_t		channel_lock;
292 
293 	struct rxrpc_channel {
294 		struct rxrpc_call __rcu	*call;		/* Active call */
295 		u32			call_id;	/* ID of current call */
296 		u32			call_counter;	/* Call ID counter */
297 		u32			last_call;	/* ID of last call */
298 		u32			last_result;	/* Result of last call (0/abort) */
299 	} channels[RXRPC_MAXCALLS];
300 	wait_queue_head_t	channel_wq;	/* queue to wait for channel to become available */
301 
302 	struct rcu_head		rcu;
303 	struct work_struct	processor;	/* connection event processor */
304 	union {
305 		struct rb_node	client_node;	/* Node in local->client_conns */
306 		struct rb_node	service_node;	/* Node in peer->service_conns */
307 	};
308 	struct list_head	link;		/* link in master connection list */
309 	struct sk_buff_head	rx_queue;	/* received conn-level packets */
310 	const struct rxrpc_security *security;	/* applied security module */
311 	struct key		*server_key;	/* security for this service */
312 	struct crypto_skcipher	*cipher;	/* encryption handle */
313 	struct rxrpc_crypt	csum_iv;	/* packet checksum base */
314 	unsigned long		flags;
315 	unsigned long		events;
316 	unsigned long		put_time;	/* Time at which last put */
317 	spinlock_t		state_lock;	/* state-change lock */
318 	atomic_t		usage;
319 	enum rxrpc_conn_proto_state state : 8;	/* current state of connection */
320 	u32			local_abort;	/* local abort code */
321 	u32			remote_abort;	/* remote abort code */
322 	int			error;		/* local error incurred */
323 	int			debug_id;	/* debug ID for printks */
324 	atomic_t		serial;		/* packet serial number counter */
325 	atomic_t		hi_serial;	/* highest serial number received */
326 	atomic_t		avail_chans;	/* number of channels available */
327 	u8			size_align;	/* data size alignment (for security) */
328 	u8			header_size;	/* rxrpc + security header size */
329 	u8			security_size;	/* security header size */
330 	u32			security_nonce;	/* response re-use preventer */
331 	u8			security_ix;	/* security type */
332 	u8			out_clientflag;	/* RXRPC_CLIENT_INITIATED if we are client */
333 };
334 
335 /*
336  * Flags in call->flags.
337  */
338 enum rxrpc_call_flag {
339 	RXRPC_CALL_RELEASED,		/* call has been released - no more message to userspace */
340 	RXRPC_CALL_TERMINAL_MSG,	/* call has given the socket its final message */
341 	RXRPC_CALL_RCVD_LAST,		/* all packets received */
342 	RXRPC_CALL_RUN_RTIMER,		/* Tx resend timer started */
343 	RXRPC_CALL_TX_SOFT_ACK,		/* sent some soft ACKs */
344 	RXRPC_CALL_PROC_BUSY,		/* the processor is busy */
345 	RXRPC_CALL_INIT_ACCEPT,		/* acceptance was initiated */
346 	RXRPC_CALL_HAS_USERID,		/* has a user ID attached */
347 	RXRPC_CALL_EXPECT_OOS,		/* expect out of sequence packets */
348 };
349 
350 /*
351  * Events that can be raised on a call.
352  */
353 enum rxrpc_call_event {
354 	RXRPC_CALL_EV_RCVD_ACKALL,	/* ACKALL or reply received */
355 	RXRPC_CALL_EV_RCVD_BUSY,	/* busy packet received */
356 	RXRPC_CALL_EV_RCVD_ABORT,	/* abort packet received */
357 	RXRPC_CALL_EV_RCVD_ERROR,	/* network error received */
358 	RXRPC_CALL_EV_ACK_FINAL,	/* need to generate final ACK (and release call) */
359 	RXRPC_CALL_EV_ACK,		/* need to generate ACK */
360 	RXRPC_CALL_EV_REJECT_BUSY,	/* need to generate busy message */
361 	RXRPC_CALL_EV_ABORT,		/* need to generate abort */
362 	RXRPC_CALL_EV_CONN_ABORT,	/* local connection abort generated */
363 	RXRPC_CALL_EV_RESEND_TIMER,	/* Tx resend timer expired */
364 	RXRPC_CALL_EV_RESEND,		/* Tx resend required */
365 	RXRPC_CALL_EV_DRAIN_RX_OOS,	/* drain the Rx out of sequence queue */
366 	RXRPC_CALL_EV_LIFE_TIMER,	/* call's lifetimer ran out */
367 	RXRPC_CALL_EV_ACCEPTED,		/* incoming call accepted by userspace app */
368 	RXRPC_CALL_EV_SECURED,		/* incoming call's connection is now secure */
369 	RXRPC_CALL_EV_POST_ACCEPT,	/* need to post an "accept?" message to the app */
370 	RXRPC_CALL_EV_RELEASE,		/* need to release the call's resources */
371 };
372 
373 /*
374  * The states that a call can be in.
375  */
376 enum rxrpc_call_state {
377 	RXRPC_CALL_UNINITIALISED,
378 	RXRPC_CALL_CLIENT_AWAIT_CONN,	/* - client waiting for connection to become available */
379 	RXRPC_CALL_CLIENT_SEND_REQUEST,	/* - client sending request phase */
380 	RXRPC_CALL_CLIENT_AWAIT_REPLY,	/* - client awaiting reply */
381 	RXRPC_CALL_CLIENT_RECV_REPLY,	/* - client receiving reply phase */
382 	RXRPC_CALL_CLIENT_FINAL_ACK,	/* - client sending final ACK phase */
383 	RXRPC_CALL_SERVER_SECURING,	/* - server securing request connection */
384 	RXRPC_CALL_SERVER_ACCEPTING,	/* - server accepting request */
385 	RXRPC_CALL_SERVER_RECV_REQUEST,	/* - server receiving request */
386 	RXRPC_CALL_SERVER_ACK_REQUEST,	/* - server pending ACK of request */
387 	RXRPC_CALL_SERVER_SEND_REPLY,	/* - server sending reply */
388 	RXRPC_CALL_SERVER_AWAIT_ACK,	/* - server awaiting final ACK */
389 	RXRPC_CALL_COMPLETE,		/* - call completed */
390 	RXRPC_CALL_SERVER_BUSY,		/* - call rejected by busy server */
391 	RXRPC_CALL_REMOTELY_ABORTED,	/* - call aborted by peer */
392 	RXRPC_CALL_LOCALLY_ABORTED,	/* - call aborted locally on error or close */
393 	RXRPC_CALL_NETWORK_ERROR,	/* - call terminated by network error */
394 	RXRPC_CALL_DEAD,		/* - call is dead */
395 	NR__RXRPC_CALL_STATES
396 };
397 
398 /*
399  * RxRPC call definition
400  * - matched by { connection, call_id }
401  */
402 struct rxrpc_call {
403 	struct rcu_head		rcu;
404 	struct rxrpc_connection	*conn;		/* connection carrying call */
405 	struct rxrpc_sock	*socket;	/* socket responsible */
406 	struct timer_list	lifetimer;	/* lifetime remaining on call */
407 	struct timer_list	deadspan;	/* reap timer for re-ACK'ing, etc  */
408 	struct timer_list	ack_timer;	/* ACK generation timer */
409 	struct timer_list	resend_timer;	/* Tx resend timer */
410 	struct work_struct	destroyer;	/* call destroyer */
411 	struct work_struct	processor;	/* packet processor and ACK generator */
412 	struct list_head	link;		/* link in master call list */
413 	struct hlist_node	error_link;	/* link in error distribution list */
414 	struct list_head	accept_link;	/* calls awaiting acceptance */
415 	struct rb_node		sock_node;	/* node in socket call tree */
416 	struct sk_buff_head	rx_queue;	/* received packets */
417 	struct sk_buff_head	rx_oos_queue;	/* packets received out of sequence */
418 	struct sk_buff		*tx_pending;	/* Tx socket buffer being filled */
419 	wait_queue_head_t	tx_waitq;	/* wait for Tx window space to become available */
420 	__be32			crypto_buf[2];	/* Temporary packet crypto buffer */
421 	unsigned long		user_call_ID;	/* user-defined call ID */
422 	unsigned long		creation_jif;	/* time of call creation */
423 	unsigned long		flags;
424 	unsigned long		events;
425 	spinlock_t		lock;
426 	rwlock_t		state_lock;	/* lock for state transition */
427 	atomic_t		usage;
428 	atomic_t		skb_count;	/* Outstanding packets on this call */
429 	atomic_t		sequence;	/* Tx data packet sequence counter */
430 	u32			local_abort;	/* local abort code */
431 	u32			remote_abort;	/* remote abort code */
432 	int			error_report;	/* Network error (ICMP/local transport) */
433 	int			error;		/* Local error incurred */
434 	enum rxrpc_call_state	state : 8;	/* current state of call */
435 	int			debug_id;	/* debug ID for printks */
436 	u8			channel;	/* connection channel occupied by this call */
437 
438 	/* transmission-phase ACK management */
439 	u8			acks_head;	/* offset into window of first entry */
440 	u8			acks_tail;	/* offset into window of last entry */
441 	u8			acks_winsz;	/* size of un-ACK'd window */
442 	u8			acks_unacked;	/* lowest unacked packet in last ACK received */
443 	int			acks_latest;	/* serial number of latest ACK received */
444 	rxrpc_seq_t		acks_hard;	/* highest definitively ACK'd msg seq */
445 	unsigned long		*acks_window;	/* sent packet window
446 						 * - elements are pointers with LSB set if ACK'd
447 						 */
448 
449 	/* receive-phase ACK management */
450 	rxrpc_seq_t		rx_data_expect;	/* next data seq ID expected to be received */
451 	rxrpc_seq_t		rx_data_post;	/* next data seq ID expected to be posted */
452 	rxrpc_seq_t		rx_data_recv;	/* last data seq ID encountered by recvmsg */
453 	rxrpc_seq_t		rx_data_eaten;	/* last data seq ID consumed by recvmsg */
454 	rxrpc_seq_t		rx_first_oos;	/* first packet in rx_oos_queue (or 0) */
455 	rxrpc_seq_t		ackr_win_top;	/* top of ACK window (rx_data_eaten is bottom) */
456 	rxrpc_seq_t		ackr_prev_seq;	/* previous sequence number received */
457 	u8			ackr_reason;	/* reason to ACK */
458 	rxrpc_serial_t		ackr_serial;	/* serial of packet being ACK'd */
459 	atomic_t		ackr_not_idle;	/* number of packets in Rx queue */
460 
461 	/* received packet records, 1 bit per record */
462 #define RXRPC_ACKR_WINDOW_ASZ DIV_ROUND_UP(RXRPC_MAXACKS, BITS_PER_LONG)
463 	unsigned long		ackr_window[RXRPC_ACKR_WINDOW_ASZ + 1];
464 
465 	u8			in_clientflag;	/* Copy of conn->in_clientflag */
466 	struct rxrpc_local	*local;		/* Local endpoint. */
467 	u32			call_id;	/* call ID on connection  */
468 	u32			cid;		/* connection ID plus channel index */
469 	u32			epoch;		/* epoch of this connection */
470 	u16			service_id;	/* service ID */
471 };
472 
473 /*
474  * locally abort an RxRPC call
475  */
476 static inline void rxrpc_abort_call(struct rxrpc_call *call, u32 abort_code)
477 {
478 	write_lock_bh(&call->state_lock);
479 	if (call->state < RXRPC_CALL_COMPLETE) {
480 		call->local_abort = abort_code;
481 		call->state = RXRPC_CALL_LOCALLY_ABORTED;
482 		set_bit(RXRPC_CALL_EV_ABORT, &call->events);
483 	}
484 	write_unlock_bh(&call->state_lock);
485 }
486 
487 /*
488  * af_rxrpc.c
489  */
490 extern atomic_t rxrpc_n_skbs;
491 extern u32 rxrpc_epoch;
492 extern atomic_t rxrpc_debug_id;
493 extern struct workqueue_struct *rxrpc_workqueue;
494 
495 /*
496  * call_accept.c
497  */
498 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
499 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long);
500 int rxrpc_reject_call(struct rxrpc_sock *);
501 
502 /*
503  * call_event.c
504  */
505 void __rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool);
506 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool);
507 void rxrpc_process_call(struct work_struct *);
508 
509 /*
510  * call_object.c
511  */
512 extern unsigned int rxrpc_max_call_lifetime;
513 extern unsigned int rxrpc_dead_call_expiry;
514 extern struct kmem_cache *rxrpc_call_jar;
515 extern struct list_head rxrpc_calls;
516 extern rwlock_t rxrpc_call_lock;
517 
518 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
519 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
520 					 struct rxrpc_conn_parameters *,
521 					 struct sockaddr_rxrpc *,
522 					 unsigned long, gfp_t);
523 struct rxrpc_call *rxrpc_incoming_call(struct rxrpc_sock *,
524 				       struct rxrpc_connection *,
525 				       struct sk_buff *);
526 void rxrpc_release_call(struct rxrpc_call *);
527 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
528 void __rxrpc_put_call(struct rxrpc_call *);
529 void __exit rxrpc_destroy_all_calls(void);
530 
531 /*
532  * conn_client.c
533  */
534 extern struct idr rxrpc_client_conn_ids;
535 
536 void rxrpc_destroy_client_conn_ids(void);
537 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
538 		       struct sockaddr_rxrpc *, gfp_t);
539 void rxrpc_unpublish_client_conn(struct rxrpc_connection *);
540 
541 /*
542  * conn_event.c
543  */
544 void rxrpc_process_connection(struct work_struct *);
545 void rxrpc_reject_packet(struct rxrpc_local *, struct sk_buff *);
546 void rxrpc_reject_packets(struct rxrpc_local *);
547 
548 /*
549  * conn_object.c
550  */
551 extern unsigned int rxrpc_connection_expiry;
552 extern struct list_head rxrpc_connections;
553 extern rwlock_t rxrpc_connection_lock;
554 
555 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
556 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
557 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
558 						   struct sk_buff *);
559 void __rxrpc_disconnect_call(struct rxrpc_call *);
560 void rxrpc_disconnect_call(struct rxrpc_call *);
561 void rxrpc_put_connection(struct rxrpc_connection *);
562 void __exit rxrpc_destroy_all_connections(void);
563 
564 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
565 {
566 	return conn->out_clientflag;
567 }
568 
569 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
570 {
571 	return !rxrpc_conn_is_client(conn);
572 }
573 
574 static inline void rxrpc_get_connection(struct rxrpc_connection *conn)
575 {
576 	atomic_inc(&conn->usage);
577 }
578 
579 static inline
580 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *conn)
581 {
582 	return atomic_inc_not_zero(&conn->usage) ? conn : NULL;
583 }
584 
585 static inline bool rxrpc_queue_conn(struct rxrpc_connection *conn)
586 {
587 	if (!rxrpc_get_connection_maybe(conn))
588 		return false;
589 	if (!rxrpc_queue_work(&conn->processor))
590 		rxrpc_put_connection(conn);
591 	return true;
592 }
593 
594 /*
595  * conn_service.c
596  */
597 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
598 						     struct sk_buff *);
599 struct rxrpc_connection *rxrpc_incoming_connection(struct rxrpc_local *,
600 						   struct sockaddr_rxrpc *,
601 						   struct sk_buff *);
602 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
603 
604 /*
605  * input.c
606  */
607 void rxrpc_data_ready(struct sock *);
608 int rxrpc_queue_rcv_skb(struct rxrpc_call *, struct sk_buff *, bool, bool);
609 void rxrpc_fast_process_packet(struct rxrpc_call *, struct sk_buff *);
610 
611 /*
612  * insecure.c
613  */
614 extern const struct rxrpc_security rxrpc_no_security;
615 
616 /*
617  * key.c
618  */
619 extern struct key_type key_type_rxrpc;
620 extern struct key_type key_type_rxrpc_s;
621 
622 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
623 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
624 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
625 			      u32);
626 
627 /*
628  * local_event.c
629  */
630 extern void rxrpc_process_local_events(struct rxrpc_local *);
631 
632 /*
633  * local_object.c
634  */
635 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
636 void __rxrpc_put_local(struct rxrpc_local *);
637 void __exit rxrpc_destroy_all_locals(void);
638 
639 static inline void rxrpc_get_local(struct rxrpc_local *local)
640 {
641 	atomic_inc(&local->usage);
642 }
643 
644 static inline
645 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
646 {
647 	return atomic_inc_not_zero(&local->usage) ? local : NULL;
648 }
649 
650 static inline void rxrpc_put_local(struct rxrpc_local *local)
651 {
652 	if (local && atomic_dec_and_test(&local->usage))
653 		__rxrpc_put_local(local);
654 }
655 
656 static inline void rxrpc_queue_local(struct rxrpc_local *local)
657 {
658 	rxrpc_queue_work(&local->processor);
659 }
660 
661 /*
662  * misc.c
663  */
664 extern unsigned int rxrpc_max_backlog __read_mostly;
665 extern unsigned int rxrpc_requested_ack_delay;
666 extern unsigned int rxrpc_soft_ack_delay;
667 extern unsigned int rxrpc_idle_ack_delay;
668 extern unsigned int rxrpc_rx_window_size;
669 extern unsigned int rxrpc_rx_mtu;
670 extern unsigned int rxrpc_rx_jumbo_max;
671 
672 extern const char *const rxrpc_pkts[];
673 extern const s8 rxrpc_ack_priority[];
674 
675 extern const char *rxrpc_acks(u8 reason);
676 
677 /*
678  * output.c
679  */
680 extern unsigned int rxrpc_resend_timeout;
681 
682 int rxrpc_send_data_packet(struct rxrpc_connection *, struct sk_buff *);
683 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
684 
685 /*
686  * peer_event.c
687  */
688 void rxrpc_error_report(struct sock *);
689 void rxrpc_peer_error_distributor(struct work_struct *);
690 
691 /*
692  * peer_object.c
693  */
694 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
695 					 const struct sockaddr_rxrpc *);
696 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
697 				     struct sockaddr_rxrpc *, gfp_t);
698 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
699 
700 static inline void rxrpc_get_peer(struct rxrpc_peer *peer)
701 {
702 	atomic_inc(&peer->usage);
703 }
704 
705 static inline
706 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
707 {
708 	return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
709 }
710 
711 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
712 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
713 {
714 	if (peer && atomic_dec_and_test(&peer->usage))
715 		__rxrpc_put_peer(peer);
716 }
717 
718 /*
719  * proc.c
720  */
721 extern const char *const rxrpc_call_states[];
722 extern const struct file_operations rxrpc_call_seq_fops;
723 extern const struct file_operations rxrpc_connection_seq_fops;
724 
725 /*
726  * recvmsg.c
727  */
728 void rxrpc_remove_user_ID(struct rxrpc_sock *, struct rxrpc_call *);
729 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
730 
731 /*
732  * rxkad.c
733  */
734 #ifdef CONFIG_RXKAD
735 extern const struct rxrpc_security rxkad;
736 #endif
737 
738 /*
739  * security.c
740  */
741 int __init rxrpc_init_security(void);
742 void rxrpc_exit_security(void);
743 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
744 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
745 
746 /*
747  * skbuff.c
748  */
749 void rxrpc_packet_destructor(struct sk_buff *);
750 
751 /*
752  * sysctl.c
753  */
754 #ifdef CONFIG_SYSCTL
755 extern int __init rxrpc_sysctl_init(void);
756 extern void rxrpc_sysctl_exit(void);
757 #else
758 static inline int __init rxrpc_sysctl_init(void) { return 0; }
759 static inline void rxrpc_sysctl_exit(void) {}
760 #endif
761 
762 /*
763  * utils.c
764  */
765 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
766 
767 /*
768  * debug tracing
769  */
770 extern unsigned int rxrpc_debug;
771 
772 #define dbgprintk(FMT,...) \
773 	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
774 
775 #define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
776 #define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
777 #define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
778 #define kproto(FMT,...)	dbgprintk("### "FMT ,##__VA_ARGS__)
779 #define knet(FMT,...)	dbgprintk("@@@ "FMT ,##__VA_ARGS__)
780 
781 
782 #if defined(__KDEBUG)
783 #define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
784 #define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
785 #define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
786 #define _proto(FMT,...)	kproto(FMT,##__VA_ARGS__)
787 #define _net(FMT,...)	knet(FMT,##__VA_ARGS__)
788 
789 #elif defined(CONFIG_AF_RXRPC_DEBUG)
790 #define RXRPC_DEBUG_KENTER	0x01
791 #define RXRPC_DEBUG_KLEAVE	0x02
792 #define RXRPC_DEBUG_KDEBUG	0x04
793 #define RXRPC_DEBUG_KPROTO	0x08
794 #define RXRPC_DEBUG_KNET	0x10
795 
796 #define _enter(FMT,...)					\
797 do {							\
798 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER))	\
799 		kenter(FMT,##__VA_ARGS__);		\
800 } while (0)
801 
802 #define _leave(FMT,...)					\
803 do {							\
804 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE))	\
805 		kleave(FMT,##__VA_ARGS__);		\
806 } while (0)
807 
808 #define _debug(FMT,...)					\
809 do {							\
810 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG))	\
811 		kdebug(FMT,##__VA_ARGS__);		\
812 } while (0)
813 
814 #define _proto(FMT,...)					\
815 do {							\
816 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO))	\
817 		kproto(FMT,##__VA_ARGS__);		\
818 } while (0)
819 
820 #define _net(FMT,...)					\
821 do {							\
822 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))	\
823 		knet(FMT,##__VA_ARGS__);		\
824 } while (0)
825 
826 #else
827 #define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
828 #define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
829 #define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
830 #define _proto(FMT,...)	no_printk("### "FMT ,##__VA_ARGS__)
831 #define _net(FMT,...)	no_printk("@@@ "FMT ,##__VA_ARGS__)
832 #endif
833 
834 /*
835  * debug assertion checking
836  */
837 #if 1 // defined(__KDEBUGALL)
838 
839 #define ASSERT(X)						\
840 do {								\
841 	if (unlikely(!(X))) {					\
842 		pr_err("Assertion failed\n");			\
843 		BUG();						\
844 	}							\
845 } while (0)
846 
847 #define ASSERTCMP(X, OP, Y)						\
848 do {									\
849 	unsigned long _x = (unsigned long)(X);				\
850 	unsigned long _y = (unsigned long)(Y);				\
851 	if (unlikely(!(_x OP _y))) {					\
852 		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n",			\
853 		       _x, _x, #OP, _y, _y);				\
854 		BUG();							\
855 	}								\
856 } while (0)
857 
858 #define ASSERTIF(C, X)						\
859 do {								\
860 	if (unlikely((C) && !(X))) {				\
861 		pr_err("Assertion failed\n");			\
862 		BUG();						\
863 	}							\
864 } while (0)
865 
866 #define ASSERTIFCMP(C, X, OP, Y)					\
867 do {									\
868 	unsigned long _x = (unsigned long)(X);				\
869 	unsigned long _y = (unsigned long)(Y);				\
870 	if (unlikely((C) && !(_x OP _y))) {				\
871 		pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
872 		       _x, _x, #OP, _y, _y);				\
873 		BUG();							\
874 	}								\
875 } while (0)
876 
877 #else
878 
879 #define ASSERT(X)				\
880 do {						\
881 } while (0)
882 
883 #define ASSERTCMP(X, OP, Y)			\
884 do {						\
885 } while (0)
886 
887 #define ASSERTIF(C, X)				\
888 do {						\
889 } while (0)
890 
891 #define ASSERTIFCMP(C, X, OP, Y)		\
892 do {						\
893 } while (0)
894 
895 #endif /* __KDEBUGALL */
896 
897 /*
898  * socket buffer accounting / leak finding
899  */
900 static inline void __rxrpc_new_skb(struct sk_buff *skb, const char *fn)
901 {
902 	//_net("new skb %p %s [%d]", skb, fn, atomic_read(&rxrpc_n_skbs));
903 	//atomic_inc(&rxrpc_n_skbs);
904 }
905 
906 #define rxrpc_new_skb(skb) __rxrpc_new_skb((skb), __func__)
907 
908 static inline void __rxrpc_kill_skb(struct sk_buff *skb, const char *fn)
909 {
910 	//_net("kill skb %p %s [%d]", skb, fn, atomic_read(&rxrpc_n_skbs));
911 	//atomic_dec(&rxrpc_n_skbs);
912 }
913 
914 #define rxrpc_kill_skb(skb) __rxrpc_kill_skb((skb), __func__)
915 
916 static inline void __rxrpc_free_skb(struct sk_buff *skb, const char *fn)
917 {
918 	if (skb) {
919 		CHECK_SLAB_OKAY(&skb->users);
920 		//_net("free skb %p %s [%d]",
921 		//     skb, fn, atomic_read(&rxrpc_n_skbs));
922 		//atomic_dec(&rxrpc_n_skbs);
923 		kfree_skb(skb);
924 	}
925 }
926 
927 #define rxrpc_free_skb(skb) __rxrpc_free_skb((skb), __func__)
928 
929 static inline void rxrpc_purge_queue(struct sk_buff_head *list)
930 {
931 	struct sk_buff *skb;
932 	while ((skb = skb_dequeue((list))) != NULL)
933 		rxrpc_free_skb(skb);
934 }
935 
936 #define rxrpc_get_call(CALL)				\
937 do {							\
938 	CHECK_SLAB_OKAY(&(CALL)->usage);		\
939 	if (atomic_inc_return(&(CALL)->usage) == 1)	\
940 		BUG();					\
941 } while (0)
942 
943 #define rxrpc_put_call(CALL)				\
944 do {							\
945 	__rxrpc_put_call(CALL);				\
946 } while (0)
947