1 /* AF_RXRPC internal definitions
3 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
12 #include <linux/atomic.h>
13 #include <linux/seqlock.h>
15 #include <net/af_rxrpc.h>
16 #include <rxrpc/packet.h>
19 #define CHECK_SLAB_OKAY(X) \
20 BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
21 (POISON_FREE << 8 | POISON_FREE))
23 #define CHECK_SLAB_OKAY(X) do {} while (0)
26 #define FCRYPT_BSIZE 8
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 rxrpc_connection;
41 * Mark applied to socket buffers.
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 */
55 * sk_state for RxRPC sockets
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_CLOSE, /* socket is being closed */
67 * Service backlog preallocation.
69 * This contains circular buffers of preallocated peers, connections and calls
70 * for incoming service calls and their head and tail pointers. This allows
71 * calls to be set up in the data_ready handler, thereby avoiding the need to
72 * shuffle packets around so much.
74 struct rxrpc_backlog {
75 unsigned short peer_backlog_head;
76 unsigned short peer_backlog_tail;
77 unsigned short conn_backlog_head;
78 unsigned short conn_backlog_tail;
79 unsigned short call_backlog_head;
80 unsigned short call_backlog_tail;
81 #define RXRPC_BACKLOG_MAX 32
82 struct rxrpc_peer *peer_backlog[RXRPC_BACKLOG_MAX];
83 struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
84 struct rxrpc_call *call_backlog[RXRPC_BACKLOG_MAX];
88 * RxRPC socket definition
91 /* WARNING: sk has to be the first member */
93 rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
94 rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
95 struct rxrpc_local *local; /* local endpoint */
96 struct rxrpc_backlog *backlog; /* Preallocation for services */
97 spinlock_t incoming_lock; /* Incoming call vs service shutdown lock */
98 struct list_head sock_calls; /* List of calls owned by this socket */
99 struct list_head to_be_accepted; /* calls awaiting acceptance */
100 struct list_head recvmsg_q; /* Calls awaiting recvmsg's attention */
101 rwlock_t recvmsg_lock; /* Lock for recvmsg_q */
102 struct key *key; /* security for this socket */
103 struct key *securities; /* list of server security descriptors */
104 struct rb_root calls; /* User ID -> call mapping */
106 #define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
107 rwlock_t call_lock; /* lock for calls */
108 u32 min_sec_level; /* minimum security level */
109 #define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
110 bool exclusive; /* Exclusive connection for a client socket */
111 sa_family_t family; /* Protocol family created with */
112 struct sockaddr_rxrpc srx; /* local address */
113 struct sockaddr_rxrpc connect_srx; /* Default client address from connect() */
116 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
119 * CPU-byteorder normalised Rx packet header.
121 struct rxrpc_host_header {
122 u32 epoch; /* client boot timestamp */
123 u32 cid; /* connection and channel ID */
124 u32 callNumber; /* call ID (0 for connection-level packets) */
125 u32 seq; /* sequence number of pkt in call stream */
126 u32 serial; /* serial number of pkt sent to network */
127 u8 type; /* packet type */
128 u8 flags; /* packet flags */
129 u8 userStatus; /* app-layer defined status */
130 u8 securityIndex; /* security protocol ID */
132 u16 _rsvd; /* reserved */
133 u16 cksum; /* kerberos security checksum */
135 u16 serviceId; /* service ID */
139 * RxRPC socket buffer private variables
140 * - max 48 bytes (struct sk_buff::cb)
142 struct rxrpc_skb_priv {
144 u8 nr_jumbo; /* Number of jumbo subpackets */
147 int remain; /* amount of space remaining for next write */
150 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
153 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
156 * RxRPC security module interface
158 struct rxrpc_security {
159 const char *name; /* name of this service */
160 u8 security_index; /* security type provided */
162 /* Initialise a security service */
165 /* Clean up a security service */
168 /* initialise a connection's security */
169 int (*init_connection_security)(struct rxrpc_connection *);
171 /* prime a connection's packet security */
172 int (*prime_packet_security)(struct rxrpc_connection *);
174 /* impose security on a packet */
175 int (*secure_packet)(struct rxrpc_call *,
180 /* verify the security on a received packet */
181 int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
182 unsigned int, unsigned int, rxrpc_seq_t, u16);
184 /* Locate the data in a received packet that has been verified. */
185 void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
186 unsigned int *, unsigned int *);
188 /* issue a challenge */
189 int (*issue_challenge)(struct rxrpc_connection *);
191 /* respond to a challenge */
192 int (*respond_to_challenge)(struct rxrpc_connection *,
196 /* verify a response */
197 int (*verify_response)(struct rxrpc_connection *,
201 /* clear connection security */
202 void (*clear)(struct rxrpc_connection *);
206 * RxRPC local transport endpoint description
207 * - owned by a single AF_RXRPC socket
208 * - pointed to by transport socket struct sk_user_data
213 struct list_head link;
214 struct socket *socket; /* my UDP socket */
215 struct work_struct processor;
216 struct rxrpc_sock __rcu *service; /* Service(s) listening on this endpoint */
217 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
218 struct sk_buff_head reject_queue; /* packets awaiting rejection */
219 struct sk_buff_head event_queue; /* endpoint event packets awaiting processing */
220 struct rb_root client_conns; /* Client connections by socket params */
221 spinlock_t client_conns_lock; /* Lock for client_conns */
222 spinlock_t lock; /* access lock */
223 rwlock_t services_lock; /* lock for services list */
224 int debug_id; /* debug ID for printks */
226 struct sockaddr_rxrpc srx; /* local address */
230 * RxRPC remote transport endpoint definition
231 * - matched by local endpoint, remote port, address and protocol type
234 struct rcu_head rcu; /* This must be first */
236 unsigned long hash_key;
237 struct hlist_node hash_link;
238 struct rxrpc_local *local;
239 struct hlist_head error_targets; /* targets for net error distribution */
240 struct work_struct error_distributor;
241 struct rb_root service_conns; /* Service connections */
242 seqlock_t service_conn_lock;
243 spinlock_t lock; /* access lock */
244 unsigned int if_mtu; /* interface MTU for this peer */
245 unsigned int mtu; /* network MTU for this peer */
246 unsigned int maxdata; /* data size (MTU - hdrsize) */
247 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
248 int debug_id; /* debug ID for printks */
249 int error_report; /* Net (+0) or local (+1000000) to distribute */
250 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
251 struct sockaddr_rxrpc srx; /* remote address */
253 /* calculated RTT cache */
254 #define RXRPC_RTT_CACHE_SIZE 32
255 ktime_t rtt_last_req; /* Time of last RTT request */
256 u64 rtt; /* Current RTT estimate (in nS) */
257 u64 rtt_sum; /* Sum of cache contents */
258 u64 rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* Determined RTT cache */
259 u8 rtt_cursor; /* next entry at which to insert */
260 u8 rtt_usage; /* amount of cache actually used */
264 * Keys for matching a connection.
266 struct rxrpc_conn_proto {
269 u32 epoch; /* epoch of this connection */
270 u32 cid; /* connection ID */
276 struct rxrpc_conn_parameters {
277 struct rxrpc_local *local; /* Representation of local endpoint */
278 struct rxrpc_peer *peer; /* Remote endpoint */
279 struct key *key; /* Security details */
280 bool exclusive; /* T if conn is exclusive */
281 u16 service_id; /* Service ID for this connection */
282 u32 security_level; /* Security level selected */
286 * Bits in the connection flags.
288 enum rxrpc_conn_flag {
289 RXRPC_CONN_HAS_IDR, /* Has a client conn ID assigned */
290 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
291 RXRPC_CONN_IN_CLIENT_CONNS, /* Conn is in local->client_conns */
292 RXRPC_CONN_EXPOSED, /* Conn has extra ref for exposure */
293 RXRPC_CONN_DONT_REUSE, /* Don't reuse this connection */
294 RXRPC_CONN_COUNTED, /* Counted by rxrpc_nr_client_conns */
298 * Events that can be raised upon a connection.
300 enum rxrpc_conn_event {
301 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
305 * The connection cache state.
307 enum rxrpc_conn_cache_state {
308 RXRPC_CONN_CLIENT_INACTIVE, /* Conn is not yet listed */
309 RXRPC_CONN_CLIENT_WAITING, /* Conn is on wait list, waiting for capacity */
310 RXRPC_CONN_CLIENT_ACTIVE, /* Conn is on active list, doing calls */
311 RXRPC_CONN_CLIENT_CULLED, /* Conn is culled and delisted, doing calls */
312 RXRPC_CONN_CLIENT_IDLE, /* Conn is on idle list, doing mostly nothing */
313 RXRPC_CONN__NR_CACHE_STATES
317 * The connection protocol state.
319 enum rxrpc_conn_proto_state {
320 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
321 RXRPC_CONN_CLIENT, /* Client connection */
322 RXRPC_CONN_SERVICE_PREALLOC, /* Service connection preallocation */
323 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
324 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
325 RXRPC_CONN_SERVICE, /* Service secured connection */
326 RXRPC_CONN_REMOTELY_ABORTED, /* Conn aborted by peer */
327 RXRPC_CONN_LOCALLY_ABORTED, /* Conn aborted locally */
328 RXRPC_CONN__NR_STATES
332 * RxRPC connection definition
333 * - matched by { local, peer, epoch, conn_id, direction }
334 * - each connection can only handle four simultaneous calls
336 struct rxrpc_connection {
337 struct rxrpc_conn_proto proto;
338 struct rxrpc_conn_parameters params;
342 struct list_head cache_link;
344 spinlock_t channel_lock;
345 unsigned char active_chans; /* Mask of active channels */
346 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
347 struct list_head waiting_calls; /* Calls waiting for channels */
348 struct rxrpc_channel {
349 struct rxrpc_call __rcu *call; /* Active call */
350 u32 call_id; /* ID of current call */
351 u32 call_counter; /* Call ID counter */
352 u32 last_call; /* ID of last call */
353 u8 last_type; /* Type of last packet */
359 } channels[RXRPC_MAXCALLS];
361 struct work_struct processor; /* connection event processor */
363 struct rb_node client_node; /* Node in local->client_conns */
364 struct rb_node service_node; /* Node in peer->service_conns */
366 struct list_head proc_link; /* link in procfs list */
367 struct list_head link; /* link in master connection list */
368 struct sk_buff_head rx_queue; /* received conn-level packets */
369 const struct rxrpc_security *security; /* applied security module */
370 struct key *server_key; /* security for this service */
371 struct crypto_skcipher *cipher; /* encryption handle */
372 struct rxrpc_crypt csum_iv; /* packet checksum base */
374 unsigned long events;
375 unsigned long idle_timestamp; /* Time at which last became idle */
376 spinlock_t state_lock; /* state-change lock */
377 enum rxrpc_conn_cache_state cache_state;
378 enum rxrpc_conn_proto_state state; /* current state of connection */
379 u32 local_abort; /* local abort code */
380 u32 remote_abort; /* remote abort code */
381 int debug_id; /* debug ID for printks */
382 atomic_t serial; /* packet serial number counter */
383 unsigned int hi_serial; /* highest serial number received */
384 u32 security_nonce; /* response re-use preventer */
385 u8 size_align; /* data size alignment (for security) */
386 u8 security_size; /* security header size */
387 u8 security_ix; /* security type */
388 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
392 * Flags in call->flags.
394 enum rxrpc_call_flag {
395 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
396 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
397 RXRPC_CALL_IS_SERVICE, /* Call is service call */
398 RXRPC_CALL_EXPOSED, /* The call was exposed to the world */
399 RXRPC_CALL_RX_LAST, /* Received the last packet (at rxtx_top) */
400 RXRPC_CALL_TX_LAST, /* Last packet in Tx buffer (at rxtx_top) */
401 RXRPC_CALL_PINGING, /* Ping in process */
402 RXRPC_CALL_RETRANS_TIMEOUT, /* Retransmission due to timeout occurred */
406 * Events that can be raised on a call.
408 enum rxrpc_call_event {
409 RXRPC_CALL_EV_ACK, /* need to generate ACK */
410 RXRPC_CALL_EV_ABORT, /* need to generate abort */
411 RXRPC_CALL_EV_TIMER, /* Timer expired */
412 RXRPC_CALL_EV_RESEND, /* Tx resend required */
416 * The states that a call can be in.
418 enum rxrpc_call_state {
419 RXRPC_CALL_UNINITIALISED,
420 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
421 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
422 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
423 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
424 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
425 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
426 RXRPC_CALL_SERVER_ACCEPTING, /* - server accepting request */
427 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
428 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
429 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
430 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
431 RXRPC_CALL_COMPLETE, /* - call complete */
432 NR__RXRPC_CALL_STATES
436 * Call completion condition (state == RXRPC_CALL_COMPLETE).
438 enum rxrpc_call_completion {
439 RXRPC_CALL_SUCCEEDED, /* - Normal termination */
440 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
441 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
442 RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
443 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
444 NR__RXRPC_CALL_COMPLETIONS
448 * Call Tx congestion management modes.
450 enum rxrpc_congest_mode {
451 RXRPC_CALL_SLOW_START,
452 RXRPC_CALL_CONGEST_AVOIDANCE,
453 RXRPC_CALL_PACKET_LOSS,
454 RXRPC_CALL_FAST_RETRANSMIT,
455 NR__RXRPC_CONGEST_MODES
459 * RxRPC call definition
460 * - matched by { connection, call_id }
464 struct rxrpc_connection *conn; /* connection carrying call */
465 struct rxrpc_peer *peer; /* Peer record for remote address */
466 struct rxrpc_sock __rcu *socket; /* socket responsible */
467 ktime_t ack_at; /* When deferred ACK needs to happen */
468 ktime_t resend_at; /* When next resend needs to happen */
469 ktime_t expire_at; /* When the call times out */
470 struct timer_list timer; /* Combined event timer */
471 struct work_struct processor; /* Event processor */
472 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
473 struct list_head link; /* link in master call list */
474 struct list_head chan_wait_link; /* Link in conn->waiting_calls */
475 struct hlist_node error_link; /* link in error distribution list */
476 struct list_head accept_link; /* Link in rx->acceptq */
477 struct list_head recvmsg_link; /* Link in rx->recvmsg_q */
478 struct list_head sock_link; /* Link in rx->sock_calls */
479 struct rb_node sock_node; /* Node in rx->calls */
480 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
481 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
482 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
483 unsigned long user_call_ID; /* user-defined call ID */
485 unsigned long events;
487 rwlock_t state_lock; /* lock for state transition */
488 u32 abort_code; /* Local/remote abort code */
489 int error; /* Local error incurred */
490 enum rxrpc_call_state state; /* current state of call */
491 enum rxrpc_call_completion completion; /* Call completion condition */
493 u16 service_id; /* service ID */
494 u8 security_ix; /* Security type */
495 u32 call_id; /* call ID on connection */
496 u32 cid; /* connection ID plus channel index */
497 int debug_id; /* debug ID for printks */
498 unsigned short rx_pkt_offset; /* Current recvmsg packet offset */
499 unsigned short rx_pkt_len; /* Current recvmsg packet len */
501 /* Rx/Tx circular buffer, depending on phase.
503 * In the Rx phase, packets are annotated with 0 or the number of the
504 * segment of a jumbo packet each buffer refers to. There can be up to
505 * 47 segments in a maximum-size UDP packet.
507 * In the Tx phase, packets are annotated with which buffers have been
510 #define RXRPC_RXTX_BUFF_SIZE 64
511 #define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
512 #define RXRPC_INIT_RX_WINDOW_SIZE 32
513 struct sk_buff **rxtx_buffer;
514 u8 *rxtx_annotations;
515 #define RXRPC_TX_ANNO_ACK 0
516 #define RXRPC_TX_ANNO_UNACK 1
517 #define RXRPC_TX_ANNO_NAK 2
518 #define RXRPC_TX_ANNO_RETRANS 3
519 #define RXRPC_TX_ANNO_MASK 0x03
520 #define RXRPC_TX_ANNO_LAST 0x04
521 #define RXRPC_TX_ANNO_RESENT 0x08
523 #define RXRPC_RX_ANNO_JUMBO 0x3f /* Jumbo subpacket number + 1 if not zero */
524 #define RXRPC_RX_ANNO_JLAST 0x40 /* Set if last element of a jumbo packet */
525 #define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
526 rxrpc_seq_t tx_hard_ack; /* Dead slot in buffer; the first transmitted but
527 * not hard-ACK'd packet follows this.
529 rxrpc_seq_t tx_top; /* Highest Tx slot allocated. */
531 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
532 * is fixed, we keep these numbers in terms of segments (ie. DATA
533 * packets) rather than bytes.
535 #define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
536 u8 cong_cwnd; /* Congestion window size */
537 u8 cong_extra; /* Extra to send for congestion management */
538 u8 cong_ssthresh; /* Slow-start threshold */
539 enum rxrpc_congest_mode cong_mode:8; /* Congestion management mode */
540 u8 cong_dup_acks; /* Count of ACKs showing missing packets */
541 u8 cong_cumul_acks; /* Cumulative ACK count */
542 ktime_t cong_tstamp; /* Last time cwnd was changed */
544 rxrpc_seq_t rx_hard_ack; /* Dead slot in buffer; the first received but not
545 * consumed packet follows this.
547 rxrpc_seq_t rx_top; /* Highest Rx slot allocated. */
548 rxrpc_seq_t rx_expect_next; /* Expected next packet sequence number */
549 u8 rx_winsize; /* Size of Rx window */
550 u8 tx_winsize; /* Maximum size of Tx window */
551 bool tx_phase; /* T if transmission phase, F if receive phase */
552 u8 nr_jumbo_bad; /* Number of jumbo dups/exceeds-windows */
554 /* receive-phase ACK management */
555 u8 ackr_reason; /* reason to ACK */
556 u16 ackr_skew; /* skew on packet being ACK'd */
557 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
558 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
559 rxrpc_seq_t ackr_consumed; /* Highest packet shown consumed */
560 rxrpc_seq_t ackr_seen; /* Highest packet shown seen */
561 rxrpc_serial_t ackr_ping; /* Last ping sent */
562 ktime_t ackr_ping_time; /* Time last ping sent */
564 /* transmission-phase ACK management */
565 ktime_t acks_latest_ts; /* Timestamp of latest ACK received */
566 rxrpc_serial_t acks_latest; /* serial number of latest ACK received */
567 rxrpc_seq_t acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
571 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
573 struct rxrpc_ack_summary {
575 u8 nr_acks; /* Number of ACKs in packet */
576 u8 nr_nacks; /* Number of NACKs in packet */
577 u8 nr_new_acks; /* Number of new ACKs in packet */
578 u8 nr_new_nacks; /* Number of new NACKs in packet */
579 u8 nr_rot_new_acks; /* Number of rotated new ACKs */
580 bool new_low_nack; /* T if new low NACK found */
581 bool retrans_timeo; /* T if reTx due to timeout happened */
582 u8 flight_size; /* Number of unreceived transmissions */
583 /* Place to stash values for tracing */
584 enum rxrpc_congest_mode mode:8;
591 enum rxrpc_skb_trace {
592 rxrpc_skb_rx_cleaned,
596 rxrpc_skb_rx_received,
597 rxrpc_skb_rx_rotated,
600 rxrpc_skb_tx_cleaned,
604 rxrpc_skb_tx_rotated,
609 extern const char rxrpc_skb_traces[rxrpc_skb__nr_trace][7];
611 enum rxrpc_conn_trace {
612 rxrpc_conn_new_client,
613 rxrpc_conn_new_service,
617 rxrpc_conn_put_client,
618 rxrpc_conn_put_service,
622 extern const char rxrpc_conn_traces[rxrpc_conn__nr_trace][4];
624 enum rxrpc_client_trace {
625 rxrpc_client_activate_chans,
627 rxrpc_client_chan_activate,
628 rxrpc_client_chan_disconnect,
629 rxrpc_client_chan_pass,
630 rxrpc_client_chan_unstarted,
631 rxrpc_client_cleanup,
633 rxrpc_client_discard,
634 rxrpc_client_duplicate,
635 rxrpc_client_exposed,
636 rxrpc_client_replace,
637 rxrpc_client_to_active,
638 rxrpc_client_to_culled,
639 rxrpc_client_to_idle,
640 rxrpc_client_to_inactive,
641 rxrpc_client_to_waiting,
642 rxrpc_client_uncount,
643 rxrpc_client__nr_trace
646 extern const char rxrpc_client_traces[rxrpc_client__nr_trace][7];
647 extern const char rxrpc_conn_cache_states[RXRPC_CONN__NR_CACHE_STATES][5];
649 enum rxrpc_call_trace {
650 rxrpc_call_new_client,
651 rxrpc_call_new_service,
653 rxrpc_call_queued_ref,
655 rxrpc_call_connected,
658 rxrpc_call_got_userid,
659 rxrpc_call_got_kernel,
661 rxrpc_call_put_userid,
662 rxrpc_call_put_kernel,
663 rxrpc_call_put_noqueue,
668 extern const char rxrpc_call_traces[rxrpc_call__nr_trace][4];
670 enum rxrpc_transmit_trace {
672 rxrpc_transmit_queue,
673 rxrpc_transmit_queue_last,
674 rxrpc_transmit_rotate,
675 rxrpc_transmit_rotate_last,
676 rxrpc_transmit_await_reply,
678 rxrpc_transmit__nr_trace
681 extern const char rxrpc_transmit_traces[rxrpc_transmit__nr_trace][4];
683 enum rxrpc_receive_trace {
684 rxrpc_receive_incoming,
686 rxrpc_receive_queue_last,
688 rxrpc_receive_rotate,
690 rxrpc_receive__nr_trace
693 extern const char rxrpc_receive_traces[rxrpc_receive__nr_trace][4];
695 enum rxrpc_recvmsg_trace {
698 rxrpc_recvmsg_dequeue,
703 rxrpc_recvmsg_data_return,
704 rxrpc_recvmsg_terminal,
705 rxrpc_recvmsg_to_be_accepted,
706 rxrpc_recvmsg_return,
707 rxrpc_recvmsg__nr_trace
710 extern const char rxrpc_recvmsg_traces[rxrpc_recvmsg__nr_trace][5];
712 enum rxrpc_rtt_tx_trace {
715 rxrpc_rtt_tx__nr_trace
718 extern const char rxrpc_rtt_tx_traces[rxrpc_rtt_tx__nr_trace][5];
720 enum rxrpc_rtt_rx_trace {
721 rxrpc_rtt_rx_ping_response,
722 rxrpc_rtt_rx_requested_ack,
723 rxrpc_rtt_rx__nr_trace
726 extern const char rxrpc_rtt_rx_traces[rxrpc_rtt_rx__nr_trace][5];
728 enum rxrpc_timer_trace {
730 rxrpc_timer_init_for_reply,
732 rxrpc_timer_set_for_ack,
733 rxrpc_timer_set_for_resend,
734 rxrpc_timer_set_for_send,
735 rxrpc_timer__nr_trace
738 extern const char rxrpc_timer_traces[rxrpc_timer__nr_trace][8];
740 enum rxrpc_propose_ack_trace {
741 rxrpc_propose_ack_client_tx_end,
742 rxrpc_propose_ack_input_data,
743 rxrpc_propose_ack_ping_for_lost_ack,
744 rxrpc_propose_ack_ping_for_lost_reply,
745 rxrpc_propose_ack_ping_for_params,
746 rxrpc_propose_ack_respond_to_ack,
747 rxrpc_propose_ack_respond_to_ping,
748 rxrpc_propose_ack_retry_tx,
749 rxrpc_propose_ack_rotate_rx,
750 rxrpc_propose_ack_terminal_ack,
751 rxrpc_propose_ack__nr_trace
754 enum rxrpc_propose_ack_outcome {
755 rxrpc_propose_ack_use,
756 rxrpc_propose_ack_update,
757 rxrpc_propose_ack_subsume,
758 rxrpc_propose_ack__nr_outcomes
761 extern const char rxrpc_propose_ack_traces[rxrpc_propose_ack__nr_trace][8];
762 extern const char *const rxrpc_propose_ack_outcomes[rxrpc_propose_ack__nr_outcomes];
764 enum rxrpc_congest_change {
765 rxrpc_cong_begin_retransmission,
766 rxrpc_cong_cleared_nacks,
767 rxrpc_cong_new_low_nack,
768 rxrpc_cong_no_change,
770 rxrpc_cong_retransmit_again,
771 rxrpc_cong_rtt_window_end,
773 rxrpc_congest__nr_change
776 extern const char rxrpc_congest_modes[NR__RXRPC_CONGEST_MODES][10];
777 extern const char rxrpc_congest_changes[rxrpc_congest__nr_change][9];
779 extern const char *const rxrpc_pkts[];
780 extern const char const rxrpc_ack_names[RXRPC_ACK__INVALID + 1][4];
782 #include <trace/events/rxrpc.h>
787 extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
788 extern u32 rxrpc_epoch;
789 extern atomic_t rxrpc_debug_id;
790 extern struct workqueue_struct *rxrpc_workqueue;
795 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
796 void rxrpc_discard_prealloc(struct rxrpc_sock *);
797 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
798 struct rxrpc_connection *,
800 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
801 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
803 int rxrpc_reject_call(struct rxrpc_sock *);
808 void rxrpc_set_timer(struct rxrpc_call *, enum rxrpc_timer_trace, ktime_t);
809 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool, bool,
810 enum rxrpc_propose_ack_trace);
811 void rxrpc_process_call(struct work_struct *);
816 extern const char *const rxrpc_call_states[];
817 extern const char *const rxrpc_call_completions[];
818 extern unsigned int rxrpc_max_call_lifetime;
819 extern struct kmem_cache *rxrpc_call_jar;
820 extern struct list_head rxrpc_calls;
821 extern rwlock_t rxrpc_call_lock;
823 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
824 struct rxrpc_call *rxrpc_alloc_call(gfp_t);
825 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
826 struct rxrpc_conn_parameters *,
827 struct sockaddr_rxrpc *,
828 unsigned long, gfp_t);
829 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
831 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
832 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
833 bool __rxrpc_queue_call(struct rxrpc_call *);
834 bool rxrpc_queue_call(struct rxrpc_call *);
835 void rxrpc_see_call(struct rxrpc_call *);
836 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
837 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
838 void rxrpc_cleanup_call(struct rxrpc_call *);
839 void __exit rxrpc_destroy_all_calls(void);
841 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
843 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
846 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
848 return !rxrpc_is_service_call(call);
852 * Transition a call to the complete state.
854 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
855 enum rxrpc_call_completion compl,
859 if (call->state < RXRPC_CALL_COMPLETE) {
860 call->abort_code = abort_code;
862 call->completion = compl,
863 call->state = RXRPC_CALL_COMPLETE;
864 wake_up(&call->waitq);
870 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
871 enum rxrpc_call_completion compl,
877 write_lock_bh(&call->state_lock);
878 ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
879 write_unlock_bh(&call->state_lock);
884 * Record that a call successfully completed.
886 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
888 return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
891 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
895 write_lock_bh(&call->state_lock);
896 ret = __rxrpc_call_completed(call);
897 write_unlock_bh(&call->state_lock);
902 * Record that a call is locally aborted.
904 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
906 u32 abort_code, int error)
908 trace_rxrpc_abort(why, call->cid, call->call_id, seq,
910 return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
914 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
915 rxrpc_seq_t seq, u32 abort_code, int error)
919 write_lock_bh(&call->state_lock);
920 ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
921 write_unlock_bh(&call->state_lock);
928 extern unsigned int rxrpc_max_client_connections;
929 extern unsigned int rxrpc_reap_client_connections;
930 extern unsigned int rxrpc_conn_idle_client_expiry;
931 extern unsigned int rxrpc_conn_idle_client_fast_expiry;
932 extern struct idr rxrpc_client_conn_ids;
934 void rxrpc_destroy_client_conn_ids(void);
935 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
936 struct sockaddr_rxrpc *, gfp_t);
937 void rxrpc_expose_client_call(struct rxrpc_call *);
938 void rxrpc_disconnect_client_call(struct rxrpc_call *);
939 void rxrpc_put_client_conn(struct rxrpc_connection *);
940 void __exit rxrpc_destroy_all_client_connections(void);
945 void rxrpc_process_connection(struct work_struct *);
950 extern unsigned int rxrpc_connection_expiry;
951 extern struct list_head rxrpc_connections;
952 extern struct list_head rxrpc_connection_proc_list;
953 extern rwlock_t rxrpc_connection_lock;
955 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
956 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
957 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
959 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
960 void rxrpc_disconnect_call(struct rxrpc_call *);
961 void rxrpc_kill_connection(struct rxrpc_connection *);
962 bool rxrpc_queue_conn(struct rxrpc_connection *);
963 void rxrpc_see_connection(struct rxrpc_connection *);
964 void rxrpc_get_connection(struct rxrpc_connection *);
965 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
966 void rxrpc_put_service_conn(struct rxrpc_connection *);
967 void __exit rxrpc_destroy_all_connections(void);
969 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
971 return conn->out_clientflag;
974 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
976 return !rxrpc_conn_is_client(conn);
979 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
984 if (rxrpc_conn_is_client(conn))
985 rxrpc_put_client_conn(conn);
987 rxrpc_put_service_conn(conn);
993 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
995 struct rxrpc_connection *rxrpc_prealloc_service_connection(gfp_t);
996 void rxrpc_new_incoming_connection(struct rxrpc_connection *, struct sk_buff *);
997 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
1002 void rxrpc_data_ready(struct sock *);
1007 extern const struct rxrpc_security rxrpc_no_security;
1012 extern struct key_type key_type_rxrpc;
1013 extern struct key_type key_type_rxrpc_s;
1015 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
1016 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
1017 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
1023 extern void rxrpc_process_local_events(struct rxrpc_local *);
1028 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
1029 void __rxrpc_put_local(struct rxrpc_local *);
1030 void __exit rxrpc_destroy_all_locals(void);
1032 static inline void rxrpc_get_local(struct rxrpc_local *local)
1034 atomic_inc(&local->usage);
1038 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
1040 return atomic_inc_not_zero(&local->usage) ? local : NULL;
1043 static inline void rxrpc_put_local(struct rxrpc_local *local)
1045 if (local && atomic_dec_and_test(&local->usage))
1046 __rxrpc_put_local(local);
1049 static inline void rxrpc_queue_local(struct rxrpc_local *local)
1051 rxrpc_queue_work(&local->processor);
1057 extern unsigned int rxrpc_max_backlog __read_mostly;
1058 extern unsigned int rxrpc_requested_ack_delay;
1059 extern unsigned int rxrpc_soft_ack_delay;
1060 extern unsigned int rxrpc_idle_ack_delay;
1061 extern unsigned int rxrpc_rx_window_size;
1062 extern unsigned int rxrpc_rx_mtu;
1063 extern unsigned int rxrpc_rx_jumbo_max;
1064 extern unsigned int rxrpc_resend_timeout;
1066 extern const s8 rxrpc_ack_priority[];
1071 int rxrpc_send_call_packet(struct rxrpc_call *, u8);
1072 int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
1073 void rxrpc_reject_packets(struct rxrpc_local *);
1078 void rxrpc_error_report(struct sock *);
1079 void rxrpc_peer_error_distributor(struct work_struct *);
1080 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace,
1081 rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1086 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1087 const struct sockaddr_rxrpc *);
1088 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
1089 struct sockaddr_rxrpc *, gfp_t);
1090 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
1091 struct rxrpc_peer *rxrpc_lookup_incoming_peer(struct rxrpc_local *,
1092 struct rxrpc_peer *);
1094 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
1096 atomic_inc(&peer->usage);
1101 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
1103 return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
1106 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
1107 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
1109 if (peer && atomic_dec_and_test(&peer->usage))
1110 __rxrpc_put_peer(peer);
1116 extern const struct file_operations rxrpc_call_seq_fops;
1117 extern const struct file_operations rxrpc_connection_seq_fops;
1122 void rxrpc_notify_socket(struct rxrpc_call *);
1123 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1129 extern const struct rxrpc_security rxkad;
1135 int __init rxrpc_init_security(void);
1136 void rxrpc_exit_security(void);
1137 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1138 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
1143 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1148 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1149 void rxrpc_packet_destructor(struct sk_buff *);
1150 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1151 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1152 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1153 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1154 void rxrpc_lose_skb(struct sk_buff *, enum rxrpc_skb_trace);
1155 void rxrpc_purge_queue(struct sk_buff_head *);
1160 #ifdef CONFIG_SYSCTL
1161 extern int __init rxrpc_sysctl_init(void);
1162 extern void rxrpc_sysctl_exit(void);
1164 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1165 static inline void rxrpc_sysctl_exit(void) {}
1171 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1173 static inline bool before(u32 seq1, u32 seq2)
1175 return (s32)(seq1 - seq2) < 0;
1177 static inline bool before_eq(u32 seq1, u32 seq2)
1179 return (s32)(seq1 - seq2) <= 0;
1181 static inline bool after(u32 seq1, u32 seq2)
1183 return (s32)(seq1 - seq2) > 0;
1185 static inline bool after_eq(u32 seq1, u32 seq2)
1187 return (s32)(seq1 - seq2) >= 0;
1193 extern unsigned int rxrpc_debug;
1195 #define dbgprintk(FMT,...) \
1196 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1198 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1199 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1200 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1201 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1202 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1205 #if defined(__KDEBUG)
1206 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1207 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1208 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1209 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1210 #define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1212 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1213 #define RXRPC_DEBUG_KENTER 0x01
1214 #define RXRPC_DEBUG_KLEAVE 0x02
1215 #define RXRPC_DEBUG_KDEBUG 0x04
1216 #define RXRPC_DEBUG_KPROTO 0x08
1217 #define RXRPC_DEBUG_KNET 0x10
1219 #define _enter(FMT,...) \
1221 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1222 kenter(FMT,##__VA_ARGS__); \
1225 #define _leave(FMT,...) \
1227 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1228 kleave(FMT,##__VA_ARGS__); \
1231 #define _debug(FMT,...) \
1233 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1234 kdebug(FMT,##__VA_ARGS__); \
1237 #define _proto(FMT,...) \
1239 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1240 kproto(FMT,##__VA_ARGS__); \
1243 #define _net(FMT,...) \
1245 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1246 knet(FMT,##__VA_ARGS__); \
1250 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1251 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1252 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1253 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1254 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1258 * debug assertion checking
1260 #if 1 // defined(__KDEBUGALL)
1264 if (unlikely(!(X))) { \
1265 pr_err("Assertion failed\n"); \
1270 #define ASSERTCMP(X, OP, Y) \
1272 __typeof__(X) _x = (X); \
1273 __typeof__(Y) _y = (__typeof__(X))(Y); \
1274 if (unlikely(!(_x OP _y))) { \
1275 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1276 (unsigned long)_x, (unsigned long)_x, #OP, \
1277 (unsigned long)_y, (unsigned long)_y); \
1282 #define ASSERTIF(C, X) \
1284 if (unlikely((C) && !(X))) { \
1285 pr_err("Assertion failed\n"); \
1290 #define ASSERTIFCMP(C, X, OP, Y) \
1292 __typeof__(X) _x = (X); \
1293 __typeof__(Y) _y = (__typeof__(X))(Y); \
1294 if (unlikely((C) && !(_x OP _y))) { \
1295 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1296 (unsigned long)_x, (unsigned long)_x, #OP, \
1297 (unsigned long)_y, (unsigned long)_y); \
1308 #define ASSERTCMP(X, OP, Y) \
1312 #define ASSERTIF(C, X) \
1316 #define ASSERTIFCMP(C, X, OP, Y) \
1320 #endif /* __KDEBUGALL */