xref: /linux/net/rxrpc/ar-internal.h (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732)
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 <rxrpc/packet.h>
13 
14 #if 0
15 #define CHECK_SLAB_OKAY(X)				     \
16 	BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
17 	       (POISON_FREE << 8 | POISON_FREE))
18 #else
19 #define CHECK_SLAB_OKAY(X) do {} while(0)
20 #endif
21 
22 #define FCRYPT_BSIZE 8
23 struct rxrpc_crypt {
24 	union {
25 		u8	x[FCRYPT_BSIZE];
26 		__be32	n[2];
27 	};
28 } __attribute__((aligned(8)));
29 
30 #define rxrpc_queue_work(WS)	queue_work(rxrpc_workqueue, (WS))
31 #define rxrpc_queue_delayed_work(WS,D)	\
32 	queue_delayed_work(rxrpc_workqueue, (WS), (D))
33 
34 #define rxrpc_queue_call(CALL)	rxrpc_queue_work(&(CALL)->processor)
35 #define rxrpc_queue_conn(CONN)	rxrpc_queue_work(&(CONN)->processor)
36 
37 /*
38  * sk_state for RxRPC sockets
39  */
40 enum {
41 	RXRPC_UNCONNECTED = 0,
42 	RXRPC_CLIENT_BOUND,		/* client local address bound */
43 	RXRPC_CLIENT_CONNECTED,		/* client is connected */
44 	RXRPC_SERVER_BOUND,		/* server local address bound */
45 	RXRPC_SERVER_LISTENING,		/* server listening for connections */
46 	RXRPC_CLOSE,			/* socket is being closed */
47 };
48 
49 /*
50  * RxRPC socket definition
51  */
52 struct rxrpc_sock {
53 	/* WARNING: sk has to be the first member */
54 	struct sock		sk;
55 	rxrpc_interceptor_t	interceptor;	/* kernel service Rx interceptor function */
56 	struct rxrpc_local	*local;		/* local endpoint */
57 	struct rxrpc_transport	*trans;		/* transport handler */
58 	struct rxrpc_conn_bundle *bundle;	/* virtual connection bundle */
59 	struct rxrpc_connection	*conn;		/* exclusive virtual connection */
60 	struct list_head	listen_link;	/* link in the local endpoint's listen list */
61 	struct list_head	secureq;	/* calls awaiting connection security clearance */
62 	struct list_head	acceptq;	/* calls awaiting acceptance */
63 	struct key		*key;		/* security for this socket */
64 	struct key		*securities;	/* list of server security descriptors */
65 	struct rb_root		calls;		/* outstanding calls on this socket */
66 	unsigned long		flags;
67 #define RXRPC_SOCK_EXCLUSIVE_CONN	1	/* exclusive connection for a client socket */
68 	rwlock_t		call_lock;	/* lock for calls */
69 	u32			min_sec_level;	/* minimum security level */
70 #define RXRPC_SECURITY_MAX	RXRPC_SECURITY_ENCRYPT
71 	struct sockaddr_rxrpc	srx;		/* local address */
72 	sa_family_t		proto;		/* protocol created with */
73 	__be16			service_id;	/* service ID of local/remote service */
74 };
75 
76 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
77 
78 /*
79  * RxRPC socket buffer private variables
80  * - max 48 bytes (struct sk_buff::cb)
81  */
82 struct rxrpc_skb_priv {
83 	struct rxrpc_call	*call;		/* call with which associated */
84 	unsigned long		resend_at;	/* time in jiffies at which to resend */
85 	union {
86 		unsigned int	offset;		/* offset into buffer of next read */
87 		int		remain;		/* amount of space remaining for next write */
88 		u32		error;		/* network error code */
89 		bool		need_resend;	/* T if needs resending */
90 	};
91 
92 	struct rxrpc_header	hdr;		/* RxRPC packet header from this packet */
93 };
94 
95 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
96 
97 enum rxrpc_command {
98 	RXRPC_CMD_SEND_DATA,		/* send data message */
99 	RXRPC_CMD_SEND_ABORT,		/* request abort generation */
100 	RXRPC_CMD_ACCEPT,		/* [server] accept incoming call */
101 	RXRPC_CMD_REJECT_BUSY,		/* [server] reject a call as busy */
102 };
103 
104 /*
105  * RxRPC security module interface
106  */
107 struct rxrpc_security {
108 	struct module		*owner;		/* providing module */
109 	struct list_head	link;		/* link in master list */
110 	const char		*name;		/* name of this service */
111 	u8			security_index;	/* security type provided */
112 
113 	/* initialise a connection's security */
114 	int (*init_connection_security)(struct rxrpc_connection *);
115 
116 	/* prime a connection's packet security */
117 	void (*prime_packet_security)(struct rxrpc_connection *);
118 
119 	/* impose security on a packet */
120 	int (*secure_packet)(const struct rxrpc_call *,
121 			     struct sk_buff *,
122 			     size_t,
123 			     void *);
124 
125 	/* verify the security on a received packet */
126 	int (*verify_packet)(const struct rxrpc_call *, struct sk_buff *,
127 			     u32 *);
128 
129 	/* issue a challenge */
130 	int (*issue_challenge)(struct rxrpc_connection *);
131 
132 	/* respond to a challenge */
133 	int (*respond_to_challenge)(struct rxrpc_connection *,
134 				    struct sk_buff *,
135 				    u32 *);
136 
137 	/* verify a response */
138 	int (*verify_response)(struct rxrpc_connection *,
139 			       struct sk_buff *,
140 			       u32 *);
141 
142 	/* clear connection security */
143 	void (*clear)(struct rxrpc_connection *);
144 };
145 
146 /*
147  * RxRPC local transport endpoint definition
148  * - matched by local port, address and protocol type
149  */
150 struct rxrpc_local {
151 	struct socket		*socket;	/* my UDP socket */
152 	struct work_struct	destroyer;	/* endpoint destroyer */
153 	struct work_struct	acceptor;	/* incoming call processor */
154 	struct work_struct	rejecter;	/* packet reject writer */
155 	struct work_struct	event_processor; /* endpoint event processor */
156 	struct list_head	services;	/* services listening on this endpoint */
157 	struct list_head	link;		/* link in endpoint list */
158 	struct rw_semaphore	defrag_sem;	/* control re-enablement of IP DF bit */
159 	struct sk_buff_head	accept_queue;	/* incoming calls awaiting acceptance */
160 	struct sk_buff_head	reject_queue;	/* packets awaiting rejection */
161 	struct sk_buff_head	event_queue;	/* endpoint event packets awaiting processing */
162 	spinlock_t		lock;		/* access lock */
163 	rwlock_t		services_lock;	/* lock for services list */
164 	atomic_t		usage;
165 	int			debug_id;	/* debug ID for printks */
166 	volatile char		error_rcvd;	/* T if received ICMP error outstanding */
167 	struct sockaddr_rxrpc	srx;		/* local address */
168 };
169 
170 /*
171  * RxRPC remote transport endpoint definition
172  * - matched by remote port, address and protocol type
173  * - holds the connection ID counter for connections between the two endpoints
174  */
175 struct rxrpc_peer {
176 	struct work_struct	destroyer;	/* peer destroyer */
177 	struct list_head	link;		/* link in master peer list */
178 	struct list_head	error_targets;	/* targets for net error distribution */
179 	spinlock_t		lock;		/* access lock */
180 	atomic_t		usage;
181 	unsigned int		if_mtu;		/* interface MTU for this peer */
182 	unsigned int		mtu;		/* network MTU for this peer */
183 	unsigned int		maxdata;	/* data size (MTU - hdrsize) */
184 	unsigned short		hdrsize;	/* header size (IP + UDP + RxRPC) */
185 	int			debug_id;	/* debug ID for printks */
186 	int			net_error;	/* network error distributed */
187 	struct sockaddr_rxrpc	srx;		/* remote address */
188 
189 	/* calculated RTT cache */
190 #define RXRPC_RTT_CACHE_SIZE 32
191 	suseconds_t		rtt;		/* current RTT estimate (in uS) */
192 	unsigned int		rtt_point;	/* next entry at which to insert */
193 	unsigned int		rtt_usage;	/* amount of cache actually used */
194 	suseconds_t		rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* calculated RTT cache */
195 };
196 
197 /*
198  * RxRPC point-to-point transport / connection manager definition
199  * - handles a bundle of connections between two endpoints
200  * - matched by { local, peer }
201  */
202 struct rxrpc_transport {
203 	struct rxrpc_local	*local;		/* local transport endpoint */
204 	struct rxrpc_peer	*peer;		/* remote transport endpoint */
205 	struct work_struct	error_handler;	/* network error distributor */
206 	struct rb_root		bundles;	/* client connection bundles on this transport */
207 	struct rb_root		client_conns;	/* client connections on this transport */
208 	struct rb_root		server_conns;	/* server connections on this transport */
209 	struct list_head	link;		/* link in master session list */
210 	struct sk_buff_head	error_queue;	/* error packets awaiting processing */
211 	time_t			put_time;	/* time at which to reap */
212 	spinlock_t		client_lock;	/* client connection allocation lock */
213 	rwlock_t		conn_lock;	/* lock for active/dead connections */
214 	atomic_t		usage;
215 	int			debug_id;	/* debug ID for printks */
216 	unsigned int		conn_idcounter;	/* connection ID counter (client) */
217 };
218 
219 /*
220  * RxRPC client connection bundle
221  * - matched by { transport, service_id, key }
222  */
223 struct rxrpc_conn_bundle {
224 	struct rb_node		node;		/* node in transport's lookup tree */
225 	struct list_head	unused_conns;	/* unused connections in this bundle */
226 	struct list_head	avail_conns;	/* available connections in this bundle */
227 	struct list_head	busy_conns;	/* busy connections in this bundle */
228 	struct key		*key;		/* security for this bundle */
229 	wait_queue_head_t	chanwait;	/* wait for channel to become available */
230 	atomic_t		usage;
231 	int			debug_id;	/* debug ID for printks */
232 	unsigned short		num_conns;	/* number of connections in this bundle */
233 	__be16			service_id;	/* service ID */
234 	u8			security_ix;	/* security type */
235 };
236 
237 /*
238  * RxRPC connection definition
239  * - matched by { transport, service_id, conn_id, direction, key }
240  * - each connection can only handle four simultaneous calls
241  */
242 struct rxrpc_connection {
243 	struct rxrpc_transport	*trans;		/* transport session */
244 	struct rxrpc_conn_bundle *bundle;	/* connection bundle (client) */
245 	struct work_struct	processor;	/* connection event processor */
246 	struct rb_node		node;		/* node in transport's lookup tree */
247 	struct list_head	link;		/* link in master connection list */
248 	struct list_head	bundle_link;	/* link in bundle */
249 	struct rb_root		calls;		/* calls on this connection */
250 	struct sk_buff_head	rx_queue;	/* received conn-level packets */
251 	struct rxrpc_call	*channels[RXRPC_MAXCALLS]; /* channels (active calls) */
252 	struct rxrpc_security	*security;	/* applied security module */
253 	struct key		*key;		/* security for this connection (client) */
254 	struct key		*server_key;	/* security for this service */
255 	struct crypto_blkcipher	*cipher;	/* encryption handle */
256 	struct rxrpc_crypt	csum_iv;	/* packet checksum base */
257 	unsigned long		events;
258 #define RXRPC_CONN_CHALLENGE	0		/* send challenge packet */
259 	time_t			put_time;	/* time at which to reap */
260 	rwlock_t		lock;		/* access lock */
261 	spinlock_t		state_lock;	/* state-change lock */
262 	atomic_t		usage;
263 	u32			real_conn_id;	/* connection ID (host-endian) */
264 	enum {					/* current state of connection */
265 		RXRPC_CONN_UNUSED,		/* - connection not yet attempted */
266 		RXRPC_CONN_CLIENT,		/* - client connection */
267 		RXRPC_CONN_SERVER_UNSECURED,	/* - server unsecured connection */
268 		RXRPC_CONN_SERVER_CHALLENGING,	/* - server challenging for security */
269 		RXRPC_CONN_SERVER,		/* - server secured connection */
270 		RXRPC_CONN_REMOTELY_ABORTED,	/* - conn aborted by peer */
271 		RXRPC_CONN_LOCALLY_ABORTED,	/* - conn aborted locally */
272 		RXRPC_CONN_NETWORK_ERROR,	/* - conn terminated by network error */
273 	} state;
274 	int			error;		/* error code for local abort */
275 	int			debug_id;	/* debug ID for printks */
276 	unsigned int		call_counter;	/* call ID counter */
277 	atomic_t		serial;		/* packet serial number counter */
278 	atomic_t		hi_serial;	/* highest serial number received */
279 	u8			avail_calls;	/* number of calls available */
280 	u8			size_align;	/* data size alignment (for security) */
281 	u8			header_size;	/* rxrpc + security header size */
282 	u8			security_size;	/* security header size */
283 	u32			security_level;	/* security level negotiated */
284 	u32			security_nonce;	/* response re-use preventer */
285 
286 	/* the following are all in net order */
287 	__be32			epoch;		/* epoch of this connection */
288 	__be32			cid;		/* connection ID */
289 	__be16			service_id;	/* service ID */
290 	u8			security_ix;	/* security type */
291 	u8			in_clientflag;	/* RXRPC_CLIENT_INITIATED if we are server */
292 	u8			out_clientflag;	/* RXRPC_CLIENT_INITIATED if we are client */
293 };
294 
295 /*
296  * RxRPC call definition
297  * - matched by { connection, call_id }
298  */
299 struct rxrpc_call {
300 	struct rxrpc_connection	*conn;		/* connection carrying call */
301 	struct rxrpc_sock	*socket;	/* socket responsible */
302 	struct timer_list	lifetimer;	/* lifetime remaining on call */
303 	struct timer_list	deadspan;	/* reap timer for re-ACK'ing, etc  */
304 	struct timer_list	ack_timer;	/* ACK generation timer */
305 	struct timer_list	resend_timer;	/* Tx resend timer */
306 	struct work_struct	destroyer;	/* call destroyer */
307 	struct work_struct	processor;	/* packet processor and ACK generator */
308 	struct list_head	link;		/* link in master call list */
309 	struct list_head	error_link;	/* link in error distribution list */
310 	struct list_head	accept_link;	/* calls awaiting acceptance */
311 	struct rb_node		sock_node;	/* node in socket call tree */
312 	struct rb_node		conn_node;	/* node in connection call tree */
313 	struct sk_buff_head	rx_queue;	/* received packets */
314 	struct sk_buff_head	rx_oos_queue;	/* packets received out of sequence */
315 	struct sk_buff		*tx_pending;	/* Tx socket buffer being filled */
316 	wait_queue_head_t	tx_waitq;	/* wait for Tx window space to become available */
317 	unsigned long		user_call_ID;	/* user-defined call ID */
318 	unsigned long		creation_jif;	/* time of call creation */
319 	unsigned long		flags;
320 #define RXRPC_CALL_RELEASED	0	/* call has been released - no more message to userspace */
321 #define RXRPC_CALL_TERMINAL_MSG	1	/* call has given the socket its final message */
322 #define RXRPC_CALL_RCVD_LAST	2	/* all packets received */
323 #define RXRPC_CALL_RUN_RTIMER	3	/* Tx resend timer started */
324 #define RXRPC_CALL_TX_SOFT_ACK	4	/* sent some soft ACKs */
325 #define RXRPC_CALL_PROC_BUSY	5	/* the processor is busy */
326 #define RXRPC_CALL_INIT_ACCEPT	6	/* acceptance was initiated */
327 #define RXRPC_CALL_HAS_USERID	7	/* has a user ID attached */
328 #define RXRPC_CALL_EXPECT_OOS	8	/* expect out of sequence packets */
329 	unsigned long		events;
330 #define RXRPC_CALL_RCVD_ACKALL	0	/* ACKALL or reply received */
331 #define RXRPC_CALL_RCVD_BUSY	1	/* busy packet received */
332 #define RXRPC_CALL_RCVD_ABORT	2	/* abort packet received */
333 #define RXRPC_CALL_RCVD_ERROR	3	/* network error received */
334 #define RXRPC_CALL_ACK_FINAL	4	/* need to generate final ACK (and release call) */
335 #define RXRPC_CALL_ACK		5	/* need to generate ACK */
336 #define RXRPC_CALL_REJECT_BUSY	6	/* need to generate busy message */
337 #define RXRPC_CALL_ABORT	7	/* need to generate abort */
338 #define RXRPC_CALL_CONN_ABORT	8	/* local connection abort generated */
339 #define RXRPC_CALL_RESEND_TIMER	9	/* Tx resend timer expired */
340 #define RXRPC_CALL_RESEND	10	/* Tx resend required */
341 #define RXRPC_CALL_DRAIN_RX_OOS	11	/* drain the Rx out of sequence queue */
342 #define RXRPC_CALL_LIFE_TIMER	12	/* call's lifetimer ran out */
343 #define RXRPC_CALL_ACCEPTED	13	/* incoming call accepted by userspace app */
344 #define RXRPC_CALL_SECURED	14	/* incoming call's connection is now secure */
345 #define RXRPC_CALL_POST_ACCEPT	15	/* need to post an "accept?" message to the app */
346 #define RXRPC_CALL_RELEASE	16	/* need to release the call's resources */
347 
348 	spinlock_t		lock;
349 	rwlock_t		state_lock;	/* lock for state transition */
350 	atomic_t		usage;
351 	atomic_t		sequence;	/* Tx data packet sequence counter */
352 	u32			abort_code;	/* local/remote abort code */
353 	enum {					/* current state of call */
354 		RXRPC_CALL_CLIENT_SEND_REQUEST,	/* - client sending request phase */
355 		RXRPC_CALL_CLIENT_AWAIT_REPLY,	/* - client awaiting reply */
356 		RXRPC_CALL_CLIENT_RECV_REPLY,	/* - client receiving reply phase */
357 		RXRPC_CALL_CLIENT_FINAL_ACK,	/* - client sending final ACK phase */
358 		RXRPC_CALL_SERVER_SECURING,	/* - server securing request connection */
359 		RXRPC_CALL_SERVER_ACCEPTING,	/* - server accepting request */
360 		RXRPC_CALL_SERVER_RECV_REQUEST,	/* - server receiving request */
361 		RXRPC_CALL_SERVER_ACK_REQUEST,	/* - server pending ACK of request */
362 		RXRPC_CALL_SERVER_SEND_REPLY,	/* - server sending reply */
363 		RXRPC_CALL_SERVER_AWAIT_ACK,	/* - server awaiting final ACK */
364 		RXRPC_CALL_COMPLETE,		/* - call completed */
365 		RXRPC_CALL_SERVER_BUSY,		/* - call rejected by busy server */
366 		RXRPC_CALL_REMOTELY_ABORTED,	/* - call aborted by peer */
367 		RXRPC_CALL_LOCALLY_ABORTED,	/* - call aborted locally on error or close */
368 		RXRPC_CALL_NETWORK_ERROR,	/* - call terminated by network error */
369 		RXRPC_CALL_DEAD,		/* - call is dead */
370 	} state;
371 	int			debug_id;	/* debug ID for printks */
372 	u8			channel;	/* connection channel occupied by this call */
373 
374 	/* transmission-phase ACK management */
375 	u8			acks_head;	/* offset into window of first entry */
376 	u8			acks_tail;	/* offset into window of last entry */
377 	u8			acks_winsz;	/* size of un-ACK'd window */
378 	u8			acks_unacked;	/* lowest unacked packet in last ACK received */
379 	int			acks_latest;	/* serial number of latest ACK received */
380 	rxrpc_seq_t		acks_hard;	/* highest definitively ACK'd msg seq */
381 	unsigned long		*acks_window;	/* sent packet window
382 						 * - elements are pointers with LSB set if ACK'd
383 						 */
384 
385 	/* receive-phase ACK management */
386 	rxrpc_seq_t		rx_data_expect;	/* next data seq ID expected to be received */
387 	rxrpc_seq_t		rx_data_post;	/* next data seq ID expected to be posted */
388 	rxrpc_seq_t		rx_data_recv;	/* last data seq ID encountered by recvmsg */
389 	rxrpc_seq_t		rx_data_eaten;	/* last data seq ID consumed by recvmsg */
390 	rxrpc_seq_t		rx_first_oos;	/* first packet in rx_oos_queue (or 0) */
391 	rxrpc_seq_t		ackr_win_top;	/* top of ACK window (rx_data_eaten is bottom) */
392 	rxrpc_seq_net_t		ackr_prev_seq;	/* previous sequence number received */
393 	u8			ackr_reason;	/* reason to ACK */
394 	__be32			ackr_serial;	/* serial of packet being ACK'd */
395 	atomic_t		ackr_not_idle;	/* number of packets in Rx queue */
396 
397 	/* received packet records, 1 bit per record */
398 #define RXRPC_ACKR_WINDOW_ASZ DIV_ROUND_UP(RXRPC_MAXACKS, BITS_PER_LONG)
399 	unsigned long		ackr_window[RXRPC_ACKR_WINDOW_ASZ + 1];
400 
401 	struct hlist_node	hash_node;
402 	unsigned long		hash_key;	/* Full hash key */
403 	u8			in_clientflag;	/* Copy of conn->in_clientflag for hashing */
404 	struct rxrpc_local	*local;		/* Local endpoint. Used for hashing. */
405 	sa_family_t		proto;		/* Frame protocol */
406 	/* the following should all be in net order */
407 	__be32			cid;		/* connection ID + channel index  */
408 	__be32			call_id;	/* call ID on connection  */
409 	__be32			epoch;		/* epoch of this connection */
410 	__be16			service_id;	/* service ID */
411 	union {					/* Peer IP address for hashing */
412 		__be32	ipv4_addr;
413 		__u8	ipv6_addr[16];		/* Anticipates eventual IPv6 support */
414 	} peer_ip;
415 };
416 
417 /*
418  * locally abort an RxRPC call
419  */
420 static inline void rxrpc_abort_call(struct rxrpc_call *call, u32 abort_code)
421 {
422 	write_lock_bh(&call->state_lock);
423 	if (call->state < RXRPC_CALL_COMPLETE) {
424 		call->abort_code = abort_code;
425 		call->state = RXRPC_CALL_LOCALLY_ABORTED;
426 		set_bit(RXRPC_CALL_ABORT, &call->events);
427 	}
428 	write_unlock_bh(&call->state_lock);
429 }
430 
431 /*
432  * af_rxrpc.c
433  */
434 extern atomic_t rxrpc_n_skbs;
435 extern __be32 rxrpc_epoch;
436 extern atomic_t rxrpc_debug_id;
437 extern struct workqueue_struct *rxrpc_workqueue;
438 
439 /*
440  * ar-accept.c
441  */
442 void rxrpc_accept_incoming_calls(struct work_struct *);
443 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long);
444 int rxrpc_reject_call(struct rxrpc_sock *);
445 
446 /*
447  * ar-ack.c
448  */
449 extern unsigned rxrpc_requested_ack_delay;
450 extern unsigned rxrpc_soft_ack_delay;
451 extern unsigned rxrpc_idle_ack_delay;
452 extern unsigned rxrpc_rx_window_size;
453 extern unsigned rxrpc_rx_mtu;
454 extern unsigned rxrpc_rx_jumbo_max;
455 
456 void __rxrpc_propose_ACK(struct rxrpc_call *, u8, __be32, bool);
457 void rxrpc_propose_ACK(struct rxrpc_call *, u8, __be32, bool);
458 void rxrpc_process_call(struct work_struct *);
459 
460 /*
461  * ar-call.c
462  */
463 extern unsigned rxrpc_max_call_lifetime;
464 extern unsigned rxrpc_dead_call_expiry;
465 extern struct kmem_cache *rxrpc_call_jar;
466 extern struct list_head rxrpc_calls;
467 extern rwlock_t rxrpc_call_lock;
468 
469 struct rxrpc_call *rxrpc_find_call_hash(u8,  __be32, __be32, __be32,
470 					__be16, void *, sa_family_t, const u8 *);
471 struct rxrpc_call *rxrpc_get_client_call(struct rxrpc_sock *,
472 					 struct rxrpc_transport *,
473 					 struct rxrpc_conn_bundle *,
474 					 unsigned long, int, gfp_t);
475 struct rxrpc_call *rxrpc_incoming_call(struct rxrpc_sock *,
476 				       struct rxrpc_connection *,
477 				       struct rxrpc_header *, gfp_t);
478 struct rxrpc_call *rxrpc_find_server_call(struct rxrpc_sock *, unsigned long);
479 void rxrpc_release_call(struct rxrpc_call *);
480 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
481 void __rxrpc_put_call(struct rxrpc_call *);
482 void __exit rxrpc_destroy_all_calls(void);
483 
484 /*
485  * ar-connection.c
486  */
487 extern unsigned rxrpc_connection_expiry;
488 extern struct list_head rxrpc_connections;
489 extern rwlock_t rxrpc_connection_lock;
490 
491 struct rxrpc_conn_bundle *rxrpc_get_bundle(struct rxrpc_sock *,
492 					   struct rxrpc_transport *,
493 					   struct key *, __be16, gfp_t);
494 void rxrpc_put_bundle(struct rxrpc_transport *, struct rxrpc_conn_bundle *);
495 int rxrpc_connect_call(struct rxrpc_sock *, struct rxrpc_transport *,
496 		       struct rxrpc_conn_bundle *, struct rxrpc_call *, gfp_t);
497 void rxrpc_put_connection(struct rxrpc_connection *);
498 void __exit rxrpc_destroy_all_connections(void);
499 struct rxrpc_connection *rxrpc_find_connection(struct rxrpc_transport *,
500 					       struct rxrpc_header *);
501 extern struct rxrpc_connection *
502 rxrpc_incoming_connection(struct rxrpc_transport *, struct rxrpc_header *,
503 			  gfp_t);
504 
505 /*
506  * ar-connevent.c
507  */
508 void rxrpc_process_connection(struct work_struct *);
509 void rxrpc_reject_packet(struct rxrpc_local *, struct sk_buff *);
510 void rxrpc_reject_packets(struct work_struct *);
511 
512 /*
513  * ar-error.c
514  */
515 void rxrpc_UDP_error_report(struct sock *);
516 void rxrpc_UDP_error_handler(struct work_struct *);
517 
518 /*
519  * ar-input.c
520  */
521 extern const char *rxrpc_pkts[];
522 
523 void rxrpc_data_ready(struct sock *);
524 int rxrpc_queue_rcv_skb(struct rxrpc_call *, struct sk_buff *, bool, bool);
525 void rxrpc_fast_process_packet(struct rxrpc_call *, struct sk_buff *);
526 
527 /*
528  * ar-local.c
529  */
530 extern rwlock_t rxrpc_local_lock;
531 
532 struct rxrpc_local *rxrpc_lookup_local(struct sockaddr_rxrpc *);
533 void rxrpc_put_local(struct rxrpc_local *);
534 void __exit rxrpc_destroy_all_locals(void);
535 
536 /*
537  * ar-key.c
538  */
539 extern struct key_type key_type_rxrpc;
540 extern struct key_type key_type_rxrpc_s;
541 
542 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
543 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
544 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
545 			      u32);
546 
547 /*
548  * ar-output.c
549  */
550 extern unsigned rxrpc_resend_timeout;
551 
552 int rxrpc_send_packet(struct rxrpc_transport *, struct sk_buff *);
553 int rxrpc_client_sendmsg(struct rxrpc_sock *, struct rxrpc_transport *,
554 			 struct msghdr *, size_t);
555 int rxrpc_server_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
556 
557 /*
558  * ar-peer.c
559  */
560 struct rxrpc_peer *rxrpc_get_peer(struct sockaddr_rxrpc *, gfp_t);
561 void rxrpc_put_peer(struct rxrpc_peer *);
562 struct rxrpc_peer *rxrpc_find_peer(struct rxrpc_local *, __be32, __be16);
563 void __exit rxrpc_destroy_all_peers(void);
564 
565 /*
566  * ar-proc.c
567  */
568 extern const char *const rxrpc_call_states[];
569 extern const struct file_operations rxrpc_call_seq_fops;
570 extern const struct file_operations rxrpc_connection_seq_fops;
571 
572 /*
573  * ar-recvmsg.c
574  */
575 void rxrpc_remove_user_ID(struct rxrpc_sock *, struct rxrpc_call *);
576 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
577 
578 /*
579  * ar-security.c
580  */
581 int rxrpc_register_security(struct rxrpc_security *);
582 void rxrpc_unregister_security(struct rxrpc_security *);
583 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
584 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
585 int rxrpc_secure_packet(const struct rxrpc_call *, struct sk_buff *, size_t,
586 			void *);
587 int rxrpc_verify_packet(const struct rxrpc_call *, struct sk_buff *, u32 *);
588 void rxrpc_clear_conn_security(struct rxrpc_connection *);
589 
590 /*
591  * ar-skbuff.c
592  */
593 void rxrpc_packet_destructor(struct sk_buff *);
594 
595 /*
596  * ar-transport.c
597  */
598 extern unsigned rxrpc_transport_expiry;
599 
600 struct rxrpc_transport *rxrpc_get_transport(struct rxrpc_local *,
601 					    struct rxrpc_peer *, gfp_t);
602 void rxrpc_put_transport(struct rxrpc_transport *);
603 void __exit rxrpc_destroy_all_transports(void);
604 struct rxrpc_transport *rxrpc_find_transport(struct rxrpc_local *,
605 					     struct rxrpc_peer *);
606 
607 /*
608  * sysctl.c
609  */
610 #ifdef CONFIG_SYSCTL
611 extern int __init rxrpc_sysctl_init(void);
612 extern void rxrpc_sysctl_exit(void);
613 #else
614 static inline int __init rxrpc_sysctl_init(void) { return 0; }
615 static inline void rxrpc_sysctl_exit(void) {}
616 #endif
617 
618 /*
619  * debug tracing
620  */
621 extern unsigned int rxrpc_debug;
622 
623 #define dbgprintk(FMT,...) \
624 	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
625 
626 #define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
627 #define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
628 #define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
629 #define kproto(FMT,...)	dbgprintk("### "FMT ,##__VA_ARGS__)
630 #define knet(FMT,...)	dbgprintk("@@@ "FMT ,##__VA_ARGS__)
631 
632 
633 #if defined(__KDEBUG)
634 #define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
635 #define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
636 #define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
637 #define _proto(FMT,...)	kproto(FMT,##__VA_ARGS__)
638 #define _net(FMT,...)	knet(FMT,##__VA_ARGS__)
639 
640 #elif defined(CONFIG_AF_RXRPC_DEBUG)
641 #define RXRPC_DEBUG_KENTER	0x01
642 #define RXRPC_DEBUG_KLEAVE	0x02
643 #define RXRPC_DEBUG_KDEBUG	0x04
644 #define RXRPC_DEBUG_KPROTO	0x08
645 #define RXRPC_DEBUG_KNET	0x10
646 
647 #define _enter(FMT,...)					\
648 do {							\
649 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER))	\
650 		kenter(FMT,##__VA_ARGS__);		\
651 } while (0)
652 
653 #define _leave(FMT,...)					\
654 do {							\
655 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE))	\
656 		kleave(FMT,##__VA_ARGS__);		\
657 } while (0)
658 
659 #define _debug(FMT,...)					\
660 do {							\
661 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG))	\
662 		kdebug(FMT,##__VA_ARGS__);		\
663 } while (0)
664 
665 #define _proto(FMT,...)					\
666 do {							\
667 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO))	\
668 		kproto(FMT,##__VA_ARGS__);		\
669 } while (0)
670 
671 #define _net(FMT,...)					\
672 do {							\
673 	if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))	\
674 		knet(FMT,##__VA_ARGS__);		\
675 } while (0)
676 
677 #else
678 #define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
679 #define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
680 #define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
681 #define _proto(FMT,...)	no_printk("### "FMT ,##__VA_ARGS__)
682 #define _net(FMT,...)	no_printk("@@@ "FMT ,##__VA_ARGS__)
683 #endif
684 
685 /*
686  * debug assertion checking
687  */
688 #if 1 // defined(__KDEBUGALL)
689 
690 #define ASSERT(X)						\
691 do {								\
692 	if (unlikely(!(X))) {					\
693 		printk(KERN_ERR "\n");				\
694 		printk(KERN_ERR "RxRPC: Assertion failed\n");	\
695 		BUG();						\
696 	}							\
697 } while(0)
698 
699 #define ASSERTCMP(X, OP, Y)						\
700 do {									\
701 	if (unlikely(!((X) OP (Y)))) {					\
702 		printk(KERN_ERR "\n");					\
703 		printk(KERN_ERR "RxRPC: Assertion failed\n");		\
704 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
705 		       (unsigned long)(X), (unsigned long)(Y));		\
706 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
707 		       (unsigned long)(X), (unsigned long)(Y));		\
708 		BUG();							\
709 	}								\
710 } while(0)
711 
712 #define ASSERTIF(C, X)						\
713 do {								\
714 	if (unlikely((C) && !(X))) {				\
715 		printk(KERN_ERR "\n");				\
716 		printk(KERN_ERR "RxRPC: Assertion failed\n");	\
717 		BUG();						\
718 	}							\
719 } while(0)
720 
721 #define ASSERTIFCMP(C, X, OP, Y)					\
722 do {									\
723 	if (unlikely((C) && !((X) OP (Y)))) {				\
724 		printk(KERN_ERR "\n");					\
725 		printk(KERN_ERR "RxRPC: Assertion failed\n");		\
726 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
727 		       (unsigned long)(X), (unsigned long)(Y));		\
728 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
729 		       (unsigned long)(X), (unsigned long)(Y));		\
730 		BUG();							\
731 	}								\
732 } while(0)
733 
734 #else
735 
736 #define ASSERT(X)				\
737 do {						\
738 } while(0)
739 
740 #define ASSERTCMP(X, OP, Y)			\
741 do {						\
742 } while(0)
743 
744 #define ASSERTIF(C, X)				\
745 do {						\
746 } while(0)
747 
748 #define ASSERTIFCMP(C, X, OP, Y)		\
749 do {						\
750 } while(0)
751 
752 #endif /* __KDEBUGALL */
753 
754 /*
755  * socket buffer accounting / leak finding
756  */
757 static inline void __rxrpc_new_skb(struct sk_buff *skb, const char *fn)
758 {
759 	//_net("new skb %p %s [%d]", skb, fn, atomic_read(&rxrpc_n_skbs));
760 	//atomic_inc(&rxrpc_n_skbs);
761 }
762 
763 #define rxrpc_new_skb(skb) __rxrpc_new_skb((skb), __func__)
764 
765 static inline void __rxrpc_kill_skb(struct sk_buff *skb, const char *fn)
766 {
767 	//_net("kill skb %p %s [%d]", skb, fn, atomic_read(&rxrpc_n_skbs));
768 	//atomic_dec(&rxrpc_n_skbs);
769 }
770 
771 #define rxrpc_kill_skb(skb) __rxrpc_kill_skb((skb), __func__)
772 
773 static inline void __rxrpc_free_skb(struct sk_buff *skb, const char *fn)
774 {
775 	if (skb) {
776 		CHECK_SLAB_OKAY(&skb->users);
777 		//_net("free skb %p %s [%d]",
778 		//     skb, fn, atomic_read(&rxrpc_n_skbs));
779 		//atomic_dec(&rxrpc_n_skbs);
780 		kfree_skb(skb);
781 	}
782 }
783 
784 #define rxrpc_free_skb(skb) __rxrpc_free_skb((skb), __func__)
785 
786 static inline void rxrpc_purge_queue(struct sk_buff_head *list)
787 {
788 	struct sk_buff *skb;
789 	while ((skb = skb_dequeue((list))) != NULL)
790 		rxrpc_free_skb(skb);
791 }
792 
793 static inline void __rxrpc_get_local(struct rxrpc_local *local, const char *f)
794 {
795 	CHECK_SLAB_OKAY(&local->usage);
796 	if (atomic_inc_return(&local->usage) == 1)
797 		printk("resurrected (%s)\n", f);
798 }
799 
800 #define rxrpc_get_local(LOCAL) __rxrpc_get_local((LOCAL), __func__)
801 
802 #define rxrpc_get_call(CALL)				\
803 do {							\
804 	CHECK_SLAB_OKAY(&(CALL)->usage);		\
805 	if (atomic_inc_return(&(CALL)->usage) == 1)	\
806 		BUG();					\
807 } while(0)
808 
809 #define rxrpc_put_call(CALL)				\
810 do {							\
811 	__rxrpc_put_call(CALL);				\
812 } while(0)
813