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