Merge tag 'iommu-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/arm64/linux
[linux/fpc-iii.git] / net / rxrpc / ar-internal.h
blob7bd6f8a66a3ef26ec3e2c47ecbd4575aba67541e
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* AF_RXRPC internal definitions
4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
6 */
8 #include <linux/atomic.h>
9 #include <linux/seqlock.h>
10 #include <linux/win_minmax.h>
11 #include <net/net_namespace.h>
12 #include <net/netns/generic.h>
13 #include <net/sock.h>
14 #include <net/af_rxrpc.h>
15 #include <keys/rxrpc-type.h>
16 #include "protocol.h"
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
26 #define FCRYPT_BSIZE 8
27 struct rxrpc_crypt {
28 union {
29 u8 x[FCRYPT_BSIZE];
30 __be32 n[2];
32 } __attribute__((aligned(8)));
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))
38 struct key_preparsed_payload;
39 struct rxrpc_connection;
42 * Mark applied to socket buffers in skb->mark. skb->priority is used
43 * to pass supplementary information.
45 enum rxrpc_skb_mark {
46 RXRPC_SKB_MARK_REJECT_BUSY, /* Reject with BUSY */
47 RXRPC_SKB_MARK_REJECT_ABORT, /* Reject with ABORT (code in skb->priority) */
51 * sk_state for RxRPC sockets
53 enum {
54 RXRPC_UNBOUND = 0,
55 RXRPC_CLIENT_UNBOUND, /* Unbound socket used as client */
56 RXRPC_CLIENT_BOUND, /* client local address bound */
57 RXRPC_SERVER_BOUND, /* server local address bound */
58 RXRPC_SERVER_BOUND2, /* second server local address bound */
59 RXRPC_SERVER_LISTENING, /* server listening for connections */
60 RXRPC_SERVER_LISTEN_DISABLED, /* server listening disabled */
61 RXRPC_CLOSE, /* socket is being closed */
65 * Per-network namespace data.
67 struct rxrpc_net {
68 struct proc_dir_entry *proc_net; /* Subdir in /proc/net */
69 u32 epoch; /* Local epoch for detecting local-end reset */
70 struct list_head calls; /* List of calls active in this namespace */
71 rwlock_t call_lock; /* Lock for ->calls */
72 atomic_t nr_calls; /* Count of allocated calls */
74 atomic_t nr_conns;
75 struct list_head conn_proc_list; /* List of conns in this namespace for proc */
76 struct list_head service_conns; /* Service conns in this namespace */
77 rwlock_t conn_lock; /* Lock for ->conn_proc_list, ->service_conns */
78 struct work_struct service_conn_reaper;
79 struct timer_list service_conn_reap_timer;
81 bool live;
83 bool kill_all_client_conns;
84 atomic_t nr_client_conns;
85 spinlock_t client_conn_cache_lock; /* Lock for ->*_client_conns */
86 spinlock_t client_conn_discard_lock; /* Prevent multiple discarders */
87 struct list_head idle_client_conns;
88 struct work_struct client_conn_reaper;
89 struct timer_list client_conn_reap_timer;
91 struct list_head local_endpoints;
92 struct mutex local_mutex; /* Lock for ->local_endpoints */
94 DECLARE_HASHTABLE (peer_hash, 10);
95 spinlock_t peer_hash_lock; /* Lock for ->peer_hash */
97 #define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
98 u8 peer_keepalive_cursor;
99 time64_t peer_keepalive_base;
100 struct list_head peer_keepalive[32];
101 struct list_head peer_keepalive_new;
102 struct timer_list peer_keepalive_timer;
103 struct work_struct peer_keepalive_work;
107 * Service backlog preallocation.
109 * This contains circular buffers of preallocated peers, connections and calls
110 * for incoming service calls and their head and tail pointers. This allows
111 * calls to be set up in the data_ready handler, thereby avoiding the need to
112 * shuffle packets around so much.
114 struct rxrpc_backlog {
115 unsigned short peer_backlog_head;
116 unsigned short peer_backlog_tail;
117 unsigned short conn_backlog_head;
118 unsigned short conn_backlog_tail;
119 unsigned short call_backlog_head;
120 unsigned short call_backlog_tail;
121 #define RXRPC_BACKLOG_MAX 32
122 struct rxrpc_peer *peer_backlog[RXRPC_BACKLOG_MAX];
123 struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
124 struct rxrpc_call *call_backlog[RXRPC_BACKLOG_MAX];
128 * RxRPC socket definition
130 struct rxrpc_sock {
131 /* WARNING: sk has to be the first member */
132 struct sock sk;
133 rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
134 rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
135 struct rxrpc_local *local; /* local endpoint */
136 struct rxrpc_backlog *backlog; /* Preallocation for services */
137 spinlock_t incoming_lock; /* Incoming call vs service shutdown lock */
138 struct list_head sock_calls; /* List of calls owned by this socket */
139 struct list_head to_be_accepted; /* calls awaiting acceptance */
140 struct list_head recvmsg_q; /* Calls awaiting recvmsg's attention */
141 rwlock_t recvmsg_lock; /* Lock for recvmsg_q */
142 struct key *key; /* security for this socket */
143 struct key *securities; /* list of server security descriptors */
144 struct rb_root calls; /* User ID -> call mapping */
145 unsigned long flags;
146 #define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
147 rwlock_t call_lock; /* lock for calls */
148 u32 min_sec_level; /* minimum security level */
149 #define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
150 bool exclusive; /* Exclusive connection for a client socket */
151 u16 second_service; /* Additional service bound to the endpoint */
152 struct {
153 /* Service upgrade information */
154 u16 from; /* Service ID to upgrade (if not 0) */
155 u16 to; /* service ID to upgrade to */
156 } service_upgrade;
157 sa_family_t family; /* Protocol family created with */
158 struct sockaddr_rxrpc srx; /* Primary Service/local addresses */
159 struct sockaddr_rxrpc connect_srx; /* Default client address from connect() */
162 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
165 * CPU-byteorder normalised Rx packet header.
167 struct rxrpc_host_header {
168 u32 epoch; /* client boot timestamp */
169 u32 cid; /* connection and channel ID */
170 u32 callNumber; /* call ID (0 for connection-level packets) */
171 u32 seq; /* sequence number of pkt in call stream */
172 u32 serial; /* serial number of pkt sent to network */
173 u8 type; /* packet type */
174 u8 flags; /* packet flags */
175 u8 userStatus; /* app-layer defined status */
176 u8 securityIndex; /* security protocol ID */
177 union {
178 u16 _rsvd; /* reserved */
179 u16 cksum; /* kerberos security checksum */
181 u16 serviceId; /* service ID */
182 } __packed;
185 * RxRPC socket buffer private variables
186 * - max 48 bytes (struct sk_buff::cb)
188 struct rxrpc_skb_priv {
189 atomic_t nr_ring_pins; /* Number of rxtx ring pins */
190 u8 nr_subpackets; /* Number of subpackets */
191 u8 rx_flags; /* Received packet flags */
192 #define RXRPC_SKB_INCL_LAST 0x01 /* - Includes last packet */
193 #define RXRPC_SKB_TX_BUFFER 0x02 /* - Is transmit buffer */
194 union {
195 int remain; /* amount of space remaining for next write */
197 /* List of requested ACKs on subpackets */
198 unsigned long rx_req_ack[(RXRPC_MAX_NR_JUMBO + BITS_PER_LONG - 1) /
199 BITS_PER_LONG];
202 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
205 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
208 * RxRPC security module interface
210 struct rxrpc_security {
211 const char *name; /* name of this service */
212 u8 security_index; /* security type provided */
213 u32 no_key_abort; /* Abort code indicating no key */
215 /* Initialise a security service */
216 int (*init)(void);
218 /* Clean up a security service */
219 void (*exit)(void);
221 /* Parse the information from a server key */
222 int (*preparse_server_key)(struct key_preparsed_payload *);
224 /* Clean up the preparse buffer after parsing a server key */
225 void (*free_preparse_server_key)(struct key_preparsed_payload *);
227 /* Destroy the payload of a server key */
228 void (*destroy_server_key)(struct key *);
230 /* Describe a server key */
231 void (*describe_server_key)(const struct key *, struct seq_file *);
233 /* initialise a connection's security */
234 int (*init_connection_security)(struct rxrpc_connection *,
235 struct rxrpc_key_token *);
237 /* Work out how much data we can store in a packet, given an estimate
238 * of the amount of data remaining.
240 int (*how_much_data)(struct rxrpc_call *, size_t,
241 size_t *, size_t *, size_t *);
243 /* impose security on a packet */
244 int (*secure_packet)(struct rxrpc_call *, struct sk_buff *, size_t);
246 /* verify the security on a received packet */
247 int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
248 unsigned int, unsigned int, rxrpc_seq_t, u16);
250 /* Free crypto request on a call */
251 void (*free_call_crypto)(struct rxrpc_call *);
253 /* Locate the data in a received packet that has been verified. */
254 void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
255 unsigned int *, unsigned int *);
257 /* issue a challenge */
258 int (*issue_challenge)(struct rxrpc_connection *);
260 /* respond to a challenge */
261 int (*respond_to_challenge)(struct rxrpc_connection *,
262 struct sk_buff *,
263 u32 *);
265 /* verify a response */
266 int (*verify_response)(struct rxrpc_connection *,
267 struct sk_buff *,
268 u32 *);
270 /* clear connection security */
271 void (*clear)(struct rxrpc_connection *);
275 * RxRPC local transport endpoint description
276 * - owned by a single AF_RXRPC socket
277 * - pointed to by transport socket struct sk_user_data
279 struct rxrpc_local {
280 struct rcu_head rcu;
281 atomic_t active_users; /* Number of users of the local endpoint */
282 atomic_t usage; /* Number of references to the structure */
283 struct rxrpc_net *rxnet; /* The network ns in which this resides */
284 struct list_head link;
285 struct socket *socket; /* my UDP socket */
286 struct work_struct processor;
287 struct rxrpc_sock __rcu *service; /* Service(s) listening on this endpoint */
288 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
289 struct sk_buff_head reject_queue; /* packets awaiting rejection */
290 struct sk_buff_head event_queue; /* endpoint event packets awaiting processing */
291 struct rb_root client_bundles; /* Client connection bundles by socket params */
292 spinlock_t client_bundles_lock; /* Lock for client_bundles */
293 spinlock_t lock; /* access lock */
294 rwlock_t services_lock; /* lock for services list */
295 int debug_id; /* debug ID for printks */
296 bool dead;
297 bool service_closed; /* Service socket closed */
298 struct sockaddr_rxrpc srx; /* local address */
302 * RxRPC remote transport endpoint definition
303 * - matched by local endpoint, remote port, address and protocol type
305 struct rxrpc_peer {
306 struct rcu_head rcu; /* This must be first */
307 atomic_t usage;
308 unsigned long hash_key;
309 struct hlist_node hash_link;
310 struct rxrpc_local *local;
311 struct hlist_head error_targets; /* targets for net error distribution */
312 struct rb_root service_conns; /* Service connections */
313 struct list_head keepalive_link; /* Link in net->peer_keepalive[] */
314 time64_t last_tx_at; /* Last time packet sent here */
315 seqlock_t service_conn_lock;
316 spinlock_t lock; /* access lock */
317 unsigned int if_mtu; /* interface MTU for this peer */
318 unsigned int mtu; /* network MTU for this peer */
319 unsigned int maxdata; /* data size (MTU - hdrsize) */
320 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
321 int debug_id; /* debug ID for printks */
322 struct sockaddr_rxrpc srx; /* remote address */
324 /* calculated RTT cache */
325 #define RXRPC_RTT_CACHE_SIZE 32
326 spinlock_t rtt_input_lock; /* RTT lock for input routine */
327 ktime_t rtt_last_req; /* Time of last RTT request */
328 unsigned int rtt_count; /* Number of samples we've got */
330 u32 srtt_us; /* smoothed round trip time << 3 in usecs */
331 u32 mdev_us; /* medium deviation */
332 u32 mdev_max_us; /* maximal mdev for the last rtt period */
333 u32 rttvar_us; /* smoothed mdev_max */
334 u32 rto_j; /* Retransmission timeout in jiffies */
335 u8 backoff; /* Backoff timeout */
337 u8 cong_cwnd; /* Congestion window size */
341 * Keys for matching a connection.
343 struct rxrpc_conn_proto {
344 union {
345 struct {
346 u32 epoch; /* epoch of this connection */
347 u32 cid; /* connection ID */
349 u64 index_key;
353 struct rxrpc_conn_parameters {
354 struct rxrpc_local *local; /* Representation of local endpoint */
355 struct rxrpc_peer *peer; /* Remote endpoint */
356 struct key *key; /* Security details */
357 bool exclusive; /* T if conn is exclusive */
358 bool upgrade; /* T if service ID can be upgraded */
359 u16 service_id; /* Service ID for this connection */
360 u32 security_level; /* Security level selected */
364 * Bits in the connection flags.
366 enum rxrpc_conn_flag {
367 RXRPC_CONN_HAS_IDR, /* Has a client conn ID assigned */
368 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
369 RXRPC_CONN_DONT_REUSE, /* Don't reuse this connection */
370 RXRPC_CONN_PROBING_FOR_UPGRADE, /* Probing for service upgrade */
371 RXRPC_CONN_FINAL_ACK_0, /* Need final ACK for channel 0 */
372 RXRPC_CONN_FINAL_ACK_1, /* Need final ACK for channel 1 */
373 RXRPC_CONN_FINAL_ACK_2, /* Need final ACK for channel 2 */
374 RXRPC_CONN_FINAL_ACK_3, /* Need final ACK for channel 3 */
377 #define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) | \
378 (1UL << RXRPC_CONN_FINAL_ACK_1) | \
379 (1UL << RXRPC_CONN_FINAL_ACK_2) | \
380 (1UL << RXRPC_CONN_FINAL_ACK_3))
383 * Events that can be raised upon a connection.
385 enum rxrpc_conn_event {
386 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
390 * The connection protocol state.
392 enum rxrpc_conn_proto_state {
393 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
394 RXRPC_CONN_CLIENT, /* Client connection */
395 RXRPC_CONN_SERVICE_PREALLOC, /* Service connection preallocation */
396 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
397 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
398 RXRPC_CONN_SERVICE, /* Service secured connection */
399 RXRPC_CONN_REMOTELY_ABORTED, /* Conn aborted by peer */
400 RXRPC_CONN_LOCALLY_ABORTED, /* Conn aborted locally */
401 RXRPC_CONN__NR_STATES
405 * RxRPC client connection bundle.
407 struct rxrpc_bundle {
408 struct rxrpc_conn_parameters params;
409 atomic_t usage;
410 unsigned int debug_id;
411 bool try_upgrade; /* True if the bundle is attempting upgrade */
412 bool alloc_conn; /* True if someone's getting a conn */
413 short alloc_error; /* Error from last conn allocation */
414 spinlock_t channel_lock;
415 struct rb_node local_node; /* Node in local->client_conns */
416 struct list_head waiting_calls; /* Calls waiting for channels */
417 unsigned long avail_chans; /* Mask of available channels */
418 struct rxrpc_connection *conns[4]; /* The connections in the bundle (max 4) */
422 * RxRPC connection definition
423 * - matched by { local, peer, epoch, conn_id, direction }
424 * - each connection can only handle four simultaneous calls
426 struct rxrpc_connection {
427 struct rxrpc_conn_proto proto;
428 struct rxrpc_conn_parameters params;
430 atomic_t usage;
431 struct rcu_head rcu;
432 struct list_head cache_link;
434 unsigned char act_chans; /* Mask of active channels */
435 struct rxrpc_channel {
436 unsigned long final_ack_at; /* Time at which to issue final ACK */
437 struct rxrpc_call __rcu *call; /* Active call */
438 unsigned int call_debug_id; /* call->debug_id */
439 u32 call_id; /* ID of current call */
440 u32 call_counter; /* Call ID counter */
441 u32 last_call; /* ID of last call */
442 u8 last_type; /* Type of last packet */
443 union {
444 u32 last_seq;
445 u32 last_abort;
447 } channels[RXRPC_MAXCALLS];
449 struct timer_list timer; /* Conn event timer */
450 struct work_struct processor; /* connection event processor */
451 struct rxrpc_bundle *bundle; /* Client connection bundle */
452 struct rb_node service_node; /* Node in peer->service_conns */
453 struct list_head proc_link; /* link in procfs list */
454 struct list_head link; /* link in master connection list */
455 struct sk_buff_head rx_queue; /* received conn-level packets */
457 const struct rxrpc_security *security; /* applied security module */
458 union {
459 struct {
460 struct crypto_sync_skcipher *cipher; /* encryption handle */
461 struct rxrpc_crypt csum_iv; /* packet checksum base */
462 u32 nonce; /* response re-use preventer */
463 } rxkad;
465 unsigned long flags;
466 unsigned long events;
467 unsigned long idle_timestamp; /* Time at which last became idle */
468 spinlock_t state_lock; /* state-change lock */
469 enum rxrpc_conn_proto_state state; /* current state of connection */
470 u32 abort_code; /* Abort code of connection abort */
471 int debug_id; /* debug ID for printks */
472 atomic_t serial; /* packet serial number counter */
473 unsigned int hi_serial; /* highest serial number received */
474 u32 service_id; /* Service ID, possibly upgraded */
475 u8 security_ix; /* security type */
476 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
477 u8 bundle_shift; /* Index into bundle->avail_chans */
478 short error; /* Local error code */
481 static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
483 return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
486 static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
488 return !rxrpc_to_server(sp);
492 * Flags in call->flags.
494 enum rxrpc_call_flag {
495 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
496 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
497 RXRPC_CALL_IS_SERVICE, /* Call is service call */
498 RXRPC_CALL_EXPOSED, /* The call was exposed to the world */
499 RXRPC_CALL_RX_LAST, /* Received the last packet (at rxtx_top) */
500 RXRPC_CALL_TX_LAST, /* Last packet in Tx buffer (at rxtx_top) */
501 RXRPC_CALL_SEND_PING, /* A ping will need to be sent */
502 RXRPC_CALL_RETRANS_TIMEOUT, /* Retransmission due to timeout occurred */
503 RXRPC_CALL_BEGAN_RX_TIMER, /* We began the expect_rx_by timer */
504 RXRPC_CALL_RX_HEARD, /* The peer responded at least once to this call */
505 RXRPC_CALL_RX_UNDERRUN, /* Got data underrun */
506 RXRPC_CALL_DISCONNECTED, /* The call has been disconnected */
507 RXRPC_CALL_KERNEL, /* The call was made by the kernel */
508 RXRPC_CALL_UPGRADE, /* Service upgrade was requested for the call */
512 * Events that can be raised on a call.
514 enum rxrpc_call_event {
515 RXRPC_CALL_EV_ACK, /* need to generate ACK */
516 RXRPC_CALL_EV_ABORT, /* need to generate abort */
517 RXRPC_CALL_EV_RESEND, /* Tx resend required */
518 RXRPC_CALL_EV_PING, /* Ping send required */
519 RXRPC_CALL_EV_EXPIRED, /* Expiry occurred */
520 RXRPC_CALL_EV_ACK_LOST, /* ACK may be lost, send ping */
524 * The states that a call can be in.
526 enum rxrpc_call_state {
527 RXRPC_CALL_UNINITIALISED,
528 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
529 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
530 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
531 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
532 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
533 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
534 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
535 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
536 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
537 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
538 RXRPC_CALL_COMPLETE, /* - call complete */
539 NR__RXRPC_CALL_STATES
543 * Call completion condition (state == RXRPC_CALL_COMPLETE).
545 enum rxrpc_call_completion {
546 RXRPC_CALL_SUCCEEDED, /* - Normal termination */
547 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
548 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
549 RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
550 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
551 NR__RXRPC_CALL_COMPLETIONS
555 * Call Tx congestion management modes.
557 enum rxrpc_congest_mode {
558 RXRPC_CALL_SLOW_START,
559 RXRPC_CALL_CONGEST_AVOIDANCE,
560 RXRPC_CALL_PACKET_LOSS,
561 RXRPC_CALL_FAST_RETRANSMIT,
562 NR__RXRPC_CONGEST_MODES
566 * RxRPC call definition
567 * - matched by { connection, call_id }
569 struct rxrpc_call {
570 struct rcu_head rcu;
571 struct rxrpc_connection *conn; /* connection carrying call */
572 struct rxrpc_peer *peer; /* Peer record for remote address */
573 struct rxrpc_sock __rcu *socket; /* socket responsible */
574 struct rxrpc_net *rxnet; /* Network namespace to which call belongs */
575 const struct rxrpc_security *security; /* applied security module */
576 struct mutex user_mutex; /* User access mutex */
577 unsigned long ack_at; /* When deferred ACK needs to happen */
578 unsigned long ack_lost_at; /* When ACK is figured as lost */
579 unsigned long resend_at; /* When next resend needs to happen */
580 unsigned long ping_at; /* When next to send a ping */
581 unsigned long keepalive_at; /* When next to send a keepalive ping */
582 unsigned long expect_rx_by; /* When we expect to get a packet by */
583 unsigned long expect_req_by; /* When we expect to get a request DATA packet by */
584 unsigned long expect_term_by; /* When we expect call termination by */
585 u32 next_rx_timo; /* Timeout for next Rx packet (jif) */
586 u32 next_req_timo; /* Timeout for next Rx request packet (jif) */
587 struct skcipher_request *cipher_req; /* Packet cipher request buffer */
588 struct timer_list timer; /* Combined event timer */
589 struct work_struct processor; /* Event processor */
590 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
591 struct list_head link; /* link in master call list */
592 struct list_head chan_wait_link; /* Link in conn->bundle->waiting_calls */
593 struct hlist_node error_link; /* link in error distribution list */
594 struct list_head accept_link; /* Link in rx->acceptq */
595 struct list_head recvmsg_link; /* Link in rx->recvmsg_q */
596 struct list_head sock_link; /* Link in rx->sock_calls */
597 struct rb_node sock_node; /* Node in rx->calls */
598 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
599 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
600 s64 tx_total_len; /* Total length left to be transmitted (or -1) */
601 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
602 unsigned long user_call_ID; /* user-defined call ID */
603 unsigned long flags;
604 unsigned long events;
605 spinlock_t lock;
606 spinlock_t notify_lock; /* Kernel notification lock */
607 rwlock_t state_lock; /* lock for state transition */
608 u32 abort_code; /* Local/remote abort code */
609 int error; /* Local error incurred */
610 enum rxrpc_call_state state; /* current state of call */
611 enum rxrpc_call_completion completion; /* Call completion condition */
612 atomic_t usage;
613 u16 service_id; /* service ID */
614 u8 security_ix; /* Security type */
615 enum rxrpc_interruptibility interruptibility; /* At what point call may be interrupted */
616 u32 call_id; /* call ID on connection */
617 u32 cid; /* connection ID plus channel index */
618 int debug_id; /* debug ID for printks */
619 unsigned short rx_pkt_offset; /* Current recvmsg packet offset */
620 unsigned short rx_pkt_len; /* Current recvmsg packet len */
621 bool rx_pkt_last; /* Current recvmsg packet is last */
623 /* Rx/Tx circular buffer, depending on phase.
625 * In the Rx phase, packets are annotated with 0 or the number of the
626 * segment of a jumbo packet each buffer refers to. There can be up to
627 * 47 segments in a maximum-size UDP packet.
629 * In the Tx phase, packets are annotated with which buffers have been
630 * acked.
632 #define RXRPC_RXTX_BUFF_SIZE 64
633 #define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
634 #define RXRPC_INIT_RX_WINDOW_SIZE 63
635 struct sk_buff **rxtx_buffer;
636 u8 *rxtx_annotations;
637 #define RXRPC_TX_ANNO_ACK 0
638 #define RXRPC_TX_ANNO_UNACK 1
639 #define RXRPC_TX_ANNO_NAK 2
640 #define RXRPC_TX_ANNO_RETRANS 3
641 #define RXRPC_TX_ANNO_MASK 0x03
642 #define RXRPC_TX_ANNO_LAST 0x04
643 #define RXRPC_TX_ANNO_RESENT 0x08
645 #define RXRPC_RX_ANNO_SUBPACKET 0x3f /* Subpacket number in jumbogram */
646 #define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
647 rxrpc_seq_t tx_hard_ack; /* Dead slot in buffer; the first transmitted but
648 * not hard-ACK'd packet follows this.
650 rxrpc_seq_t tx_top; /* Highest Tx slot allocated. */
651 u16 tx_backoff; /* Delay to insert due to Tx failure */
653 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
654 * is fixed, we keep these numbers in terms of segments (ie. DATA
655 * packets) rather than bytes.
657 #define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
658 u8 cong_cwnd; /* Congestion window size */
659 u8 cong_extra; /* Extra to send for congestion management */
660 u8 cong_ssthresh; /* Slow-start threshold */
661 enum rxrpc_congest_mode cong_mode:8; /* Congestion management mode */
662 u8 cong_dup_acks; /* Count of ACKs showing missing packets */
663 u8 cong_cumul_acks; /* Cumulative ACK count */
664 ktime_t cong_tstamp; /* Last time cwnd was changed */
666 rxrpc_seq_t rx_hard_ack; /* Dead slot in buffer; the first received but not
667 * consumed packet follows this.
669 rxrpc_seq_t rx_top; /* Highest Rx slot allocated. */
670 rxrpc_seq_t rx_expect_next; /* Expected next packet sequence number */
671 rxrpc_serial_t rx_serial; /* Highest serial received for this call */
672 u8 rx_winsize; /* Size of Rx window */
673 u8 tx_winsize; /* Maximum size of Tx window */
674 bool tx_phase; /* T if transmission phase, F if receive phase */
675 u8 nr_jumbo_bad; /* Number of jumbo dups/exceeds-windows */
677 spinlock_t input_lock; /* Lock for packet input to this call */
679 /* receive-phase ACK management */
680 u8 ackr_reason; /* reason to ACK */
681 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
682 rxrpc_serial_t ackr_first_seq; /* first sequence number received */
683 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
684 rxrpc_seq_t ackr_consumed; /* Highest packet shown consumed */
685 rxrpc_seq_t ackr_seen; /* Highest packet shown seen */
687 /* RTT management */
688 rxrpc_serial_t rtt_serial[4]; /* Serial number of DATA or PING sent */
689 ktime_t rtt_sent_at[4]; /* Time packet sent */
690 unsigned long rtt_avail; /* Mask of available slots in bits 0-3,
691 * Mask of pending samples in 8-11 */
692 #define RXRPC_CALL_RTT_AVAIL_MASK 0xf
693 #define RXRPC_CALL_RTT_PEND_SHIFT 8
695 /* transmission-phase ACK management */
696 ktime_t acks_latest_ts; /* Timestamp of latest ACK received */
697 rxrpc_seq_t acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
698 rxrpc_seq_t acks_lost_top; /* tx_top at the time lost-ack ping sent */
699 rxrpc_serial_t acks_lost_ping; /* Serial number of probe ACK */
703 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
705 struct rxrpc_ack_summary {
706 u8 ack_reason;
707 u8 nr_acks; /* Number of ACKs in packet */
708 u8 nr_nacks; /* Number of NACKs in packet */
709 u8 nr_new_acks; /* Number of new ACKs in packet */
710 u8 nr_new_nacks; /* Number of new NACKs in packet */
711 u8 nr_rot_new_acks; /* Number of rotated new ACKs */
712 bool new_low_nack; /* T if new low NACK found */
713 bool retrans_timeo; /* T if reTx due to timeout happened */
714 u8 flight_size; /* Number of unreceived transmissions */
715 /* Place to stash values for tracing */
716 enum rxrpc_congest_mode mode:8;
717 u8 cwnd;
718 u8 ssthresh;
719 u8 dup_acks;
720 u8 cumulative_acks;
724 * sendmsg() cmsg-specified parameters.
726 enum rxrpc_command {
727 RXRPC_CMD_SEND_DATA, /* send data message */
728 RXRPC_CMD_SEND_ABORT, /* request abort generation */
729 RXRPC_CMD_REJECT_BUSY, /* [server] reject a call as busy */
730 RXRPC_CMD_CHARGE_ACCEPT, /* [server] charge accept preallocation */
733 struct rxrpc_call_params {
734 s64 tx_total_len; /* Total Tx data length (if send data) */
735 unsigned long user_call_ID; /* User's call ID */
736 struct {
737 u32 hard; /* Maximum lifetime (sec) */
738 u32 idle; /* Max time since last data packet (msec) */
739 u32 normal; /* Max time since last call packet (msec) */
740 } timeouts;
741 u8 nr_timeouts; /* Number of timeouts specified */
742 bool kernel; /* T if kernel is making the call */
743 enum rxrpc_interruptibility interruptibility; /* How is interruptible is the call? */
746 struct rxrpc_send_params {
747 struct rxrpc_call_params call;
748 u32 abort_code; /* Abort code to Tx (if abort) */
749 enum rxrpc_command command : 8; /* The command to implement */
750 bool exclusive; /* Shared or exclusive call */
751 bool upgrade; /* If the connection is upgradeable */
754 #include <trace/events/rxrpc.h>
757 * af_rxrpc.c
759 extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
760 extern struct workqueue_struct *rxrpc_workqueue;
763 * call_accept.c
765 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
766 void rxrpc_discard_prealloc(struct rxrpc_sock *);
767 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
768 struct rxrpc_sock *,
769 struct sk_buff *);
770 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
771 int rxrpc_user_charge_accept(struct rxrpc_sock *, unsigned long);
774 * call_event.c
776 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool, bool,
777 enum rxrpc_propose_ack_trace);
778 void rxrpc_process_call(struct work_struct *);
780 static inline void rxrpc_reduce_call_timer(struct rxrpc_call *call,
781 unsigned long expire_at,
782 unsigned long now,
783 enum rxrpc_timer_trace why)
785 trace_rxrpc_timer(call, why, now);
786 timer_reduce(&call->timer, expire_at);
790 * call_object.c
792 extern const char *const rxrpc_call_states[];
793 extern const char *const rxrpc_call_completions[];
794 extern unsigned int rxrpc_max_call_lifetime;
795 extern struct kmem_cache *rxrpc_call_jar;
797 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
798 struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
799 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
800 struct rxrpc_conn_parameters *,
801 struct sockaddr_rxrpc *,
802 struct rxrpc_call_params *, gfp_t,
803 unsigned int);
804 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
805 struct sk_buff *);
806 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
807 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
808 bool __rxrpc_queue_call(struct rxrpc_call *);
809 bool rxrpc_queue_call(struct rxrpc_call *);
810 void rxrpc_see_call(struct rxrpc_call *);
811 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
812 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
813 void rxrpc_cleanup_call(struct rxrpc_call *);
814 void rxrpc_destroy_all_calls(struct rxrpc_net *);
816 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
818 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
821 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
823 return !rxrpc_is_service_call(call);
827 * conn_client.c
829 extern unsigned int rxrpc_reap_client_connections;
830 extern unsigned long rxrpc_conn_idle_client_expiry;
831 extern unsigned long rxrpc_conn_idle_client_fast_expiry;
832 extern struct idr rxrpc_client_conn_ids;
834 void rxrpc_destroy_client_conn_ids(void);
835 struct rxrpc_bundle *rxrpc_get_bundle(struct rxrpc_bundle *);
836 void rxrpc_put_bundle(struct rxrpc_bundle *);
837 int rxrpc_connect_call(struct rxrpc_sock *, struct rxrpc_call *,
838 struct rxrpc_conn_parameters *, struct sockaddr_rxrpc *,
839 gfp_t);
840 void rxrpc_expose_client_call(struct rxrpc_call *);
841 void rxrpc_disconnect_client_call(struct rxrpc_bundle *, struct rxrpc_call *);
842 void rxrpc_put_client_conn(struct rxrpc_connection *);
843 void rxrpc_discard_expired_client_conns(struct work_struct *);
844 void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
845 void rxrpc_clean_up_local_conns(struct rxrpc_local *);
848 * conn_event.c
850 void rxrpc_process_connection(struct work_struct *);
851 void rxrpc_process_delayed_final_acks(struct rxrpc_connection *, bool);
854 * conn_object.c
856 extern unsigned int rxrpc_connection_expiry;
857 extern unsigned int rxrpc_closed_conn_expiry;
859 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
860 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
861 struct sk_buff *,
862 struct rxrpc_peer **);
863 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
864 void rxrpc_disconnect_call(struct rxrpc_call *);
865 void rxrpc_kill_connection(struct rxrpc_connection *);
866 bool rxrpc_queue_conn(struct rxrpc_connection *);
867 void rxrpc_see_connection(struct rxrpc_connection *);
868 struct rxrpc_connection *rxrpc_get_connection(struct rxrpc_connection *);
869 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
870 void rxrpc_put_service_conn(struct rxrpc_connection *);
871 void rxrpc_service_connection_reaper(struct work_struct *);
872 void rxrpc_destroy_all_connections(struct rxrpc_net *);
874 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
876 return conn->out_clientflag;
879 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
881 return !rxrpc_conn_is_client(conn);
884 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
886 if (!conn)
887 return;
889 if (rxrpc_conn_is_client(conn))
890 rxrpc_put_client_conn(conn);
891 else
892 rxrpc_put_service_conn(conn);
895 static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
896 unsigned long expire_at)
898 timer_reduce(&conn->timer, expire_at);
902 * conn_service.c
904 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
905 struct sk_buff *);
906 struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
907 void rxrpc_new_incoming_connection(struct rxrpc_sock *, struct rxrpc_connection *,
908 const struct rxrpc_security *, struct sk_buff *);
909 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
912 * input.c
914 int rxrpc_input_packet(struct sock *, struct sk_buff *);
917 * insecure.c
919 extern const struct rxrpc_security rxrpc_no_security;
922 * key.c
924 extern struct key_type key_type_rxrpc;
926 int rxrpc_request_key(struct rxrpc_sock *, sockptr_t , int);
927 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
928 u32);
931 * local_event.c
933 extern void rxrpc_process_local_events(struct rxrpc_local *);
936 * local_object.c
938 struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
939 struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *);
940 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *);
941 void rxrpc_put_local(struct rxrpc_local *);
942 struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *);
943 void rxrpc_unuse_local(struct rxrpc_local *);
944 void rxrpc_queue_local(struct rxrpc_local *);
945 void rxrpc_destroy_all_locals(struct rxrpc_net *);
947 static inline bool __rxrpc_unuse_local(struct rxrpc_local *local)
949 return atomic_dec_return(&local->active_users) == 0;
952 static inline bool __rxrpc_use_local(struct rxrpc_local *local)
954 return atomic_fetch_add_unless(&local->active_users, 1, 0) != 0;
958 * misc.c
960 extern unsigned int rxrpc_max_backlog __read_mostly;
961 extern unsigned long rxrpc_requested_ack_delay;
962 extern unsigned long rxrpc_soft_ack_delay;
963 extern unsigned long rxrpc_idle_ack_delay;
964 extern unsigned int rxrpc_rx_window_size;
965 extern unsigned int rxrpc_rx_mtu;
966 extern unsigned int rxrpc_rx_jumbo_max;
968 extern const s8 rxrpc_ack_priority[];
971 * net_ns.c
973 extern unsigned int rxrpc_net_id;
974 extern struct pernet_operations rxrpc_net_ops;
976 static inline struct rxrpc_net *rxrpc_net(struct net *net)
978 return net_generic(net, rxrpc_net_id);
982 * output.c
984 int rxrpc_send_ack_packet(struct rxrpc_call *, bool, rxrpc_serial_t *);
985 int rxrpc_send_abort_packet(struct rxrpc_call *);
986 int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
987 void rxrpc_reject_packets(struct rxrpc_local *);
988 void rxrpc_send_keepalive(struct rxrpc_peer *);
991 * peer_event.c
993 void rxrpc_error_report(struct sock *);
994 void rxrpc_peer_keepalive_worker(struct work_struct *);
997 * peer_object.c
999 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1000 const struct sockaddr_rxrpc *);
1001 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_sock *, struct rxrpc_local *,
1002 struct sockaddr_rxrpc *, gfp_t);
1003 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
1004 void rxrpc_new_incoming_peer(struct rxrpc_sock *, struct rxrpc_local *,
1005 struct rxrpc_peer *);
1006 void rxrpc_destroy_all_peers(struct rxrpc_net *);
1007 struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *);
1008 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *);
1009 void rxrpc_put_peer(struct rxrpc_peer *);
1010 void rxrpc_put_peer_locked(struct rxrpc_peer *);
1013 * proc.c
1015 extern const struct seq_operations rxrpc_call_seq_ops;
1016 extern const struct seq_operations rxrpc_connection_seq_ops;
1017 extern const struct seq_operations rxrpc_peer_seq_ops;
1020 * recvmsg.c
1022 void rxrpc_notify_socket(struct rxrpc_call *);
1023 bool __rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1024 bool rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1025 bool __rxrpc_call_completed(struct rxrpc_call *);
1026 bool rxrpc_call_completed(struct rxrpc_call *);
1027 bool __rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1028 bool rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1029 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1032 * Abort a call due to a protocol error.
1034 static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
1035 struct sk_buff *skb,
1036 const char *eproto_why,
1037 const char *why,
1038 u32 abort_code)
1040 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
1042 trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
1043 return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
1046 #define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
1047 __rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
1048 (abort_why), (abort_code))
1051 * rtt.c
1053 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace, int,
1054 rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1055 unsigned long rxrpc_get_rto_backoff(struct rxrpc_peer *, bool);
1056 void rxrpc_peer_init_rtt(struct rxrpc_peer *);
1059 * rxkad.c
1061 #ifdef CONFIG_RXKAD
1062 extern const struct rxrpc_security rxkad;
1063 #endif
1066 * security.c
1068 int __init rxrpc_init_security(void);
1069 const struct rxrpc_security *rxrpc_security_lookup(u8);
1070 void rxrpc_exit_security(void);
1071 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1072 const struct rxrpc_security *rxrpc_get_incoming_security(struct rxrpc_sock *,
1073 struct sk_buff *);
1074 struct key *rxrpc_look_up_server_security(struct rxrpc_connection *,
1075 struct sk_buff *, u32, u32);
1078 * sendmsg.c
1080 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1083 * server_key.c
1085 extern struct key_type key_type_rxrpc_s;
1087 int rxrpc_server_keyring(struct rxrpc_sock *, sockptr_t, int);
1090 * skbuff.c
1092 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1093 void rxrpc_packet_destructor(struct sk_buff *);
1094 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1095 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1096 void rxrpc_eaten_skb(struct sk_buff *, enum rxrpc_skb_trace);
1097 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1098 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1099 void rxrpc_purge_queue(struct sk_buff_head *);
1102 * sysctl.c
1104 #ifdef CONFIG_SYSCTL
1105 extern int __init rxrpc_sysctl_init(void);
1106 extern void rxrpc_sysctl_exit(void);
1107 #else
1108 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1109 static inline void rxrpc_sysctl_exit(void) {}
1110 #endif
1113 * utils.c
1115 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1117 static inline bool before(u32 seq1, u32 seq2)
1119 return (s32)(seq1 - seq2) < 0;
1121 static inline bool before_eq(u32 seq1, u32 seq2)
1123 return (s32)(seq1 - seq2) <= 0;
1125 static inline bool after(u32 seq1, u32 seq2)
1127 return (s32)(seq1 - seq2) > 0;
1129 static inline bool after_eq(u32 seq1, u32 seq2)
1131 return (s32)(seq1 - seq2) >= 0;
1135 * debug tracing
1137 extern unsigned int rxrpc_debug;
1139 #define dbgprintk(FMT,...) \
1140 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1142 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1143 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1144 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1145 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1146 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1149 #if defined(__KDEBUG)
1150 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1151 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1152 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1153 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1154 #define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1156 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1157 #define RXRPC_DEBUG_KENTER 0x01
1158 #define RXRPC_DEBUG_KLEAVE 0x02
1159 #define RXRPC_DEBUG_KDEBUG 0x04
1160 #define RXRPC_DEBUG_KPROTO 0x08
1161 #define RXRPC_DEBUG_KNET 0x10
1163 #define _enter(FMT,...) \
1164 do { \
1165 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1166 kenter(FMT,##__VA_ARGS__); \
1167 } while (0)
1169 #define _leave(FMT,...) \
1170 do { \
1171 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1172 kleave(FMT,##__VA_ARGS__); \
1173 } while (0)
1175 #define _debug(FMT,...) \
1176 do { \
1177 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1178 kdebug(FMT,##__VA_ARGS__); \
1179 } while (0)
1181 #define _proto(FMT,...) \
1182 do { \
1183 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1184 kproto(FMT,##__VA_ARGS__); \
1185 } while (0)
1187 #define _net(FMT,...) \
1188 do { \
1189 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1190 knet(FMT,##__VA_ARGS__); \
1191 } while (0)
1193 #else
1194 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1195 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1196 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1197 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1198 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1199 #endif
1202 * debug assertion checking
1204 #if 1 // defined(__KDEBUGALL)
1206 #define ASSERT(X) \
1207 do { \
1208 if (unlikely(!(X))) { \
1209 pr_err("Assertion failed\n"); \
1210 BUG(); \
1212 } while (0)
1214 #define ASSERTCMP(X, OP, Y) \
1215 do { \
1216 __typeof__(X) _x = (X); \
1217 __typeof__(Y) _y = (__typeof__(X))(Y); \
1218 if (unlikely(!(_x OP _y))) { \
1219 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1220 (unsigned long)_x, (unsigned long)_x, #OP, \
1221 (unsigned long)_y, (unsigned long)_y); \
1222 BUG(); \
1224 } while (0)
1226 #define ASSERTIF(C, X) \
1227 do { \
1228 if (unlikely((C) && !(X))) { \
1229 pr_err("Assertion failed\n"); \
1230 BUG(); \
1232 } while (0)
1234 #define ASSERTIFCMP(C, X, OP, Y) \
1235 do { \
1236 __typeof__(X) _x = (X); \
1237 __typeof__(Y) _y = (__typeof__(X))(Y); \
1238 if (unlikely((C) && !(_x OP _y))) { \
1239 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1240 (unsigned long)_x, (unsigned long)_x, #OP, \
1241 (unsigned long)_y, (unsigned long)_y); \
1242 BUG(); \
1244 } while (0)
1246 #else
1248 #define ASSERT(X) \
1249 do { \
1250 } while (0)
1252 #define ASSERTCMP(X, OP, Y) \
1253 do { \
1254 } while (0)
1256 #define ASSERTIF(C, X) \
1257 do { \
1258 } while (0)
1260 #define ASSERTIFCMP(C, X, OP, Y) \
1261 do { \
1262 } while (0)
1264 #endif /* __KDEBUGALL */