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