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_SEND_PING, /* A ping will need to be sent */
402 RXRPC_CALL_PINGING, /* Ping in process */
403 RXRPC_CALL_RETRANS_TIMEOUT, /* Retransmission due to timeout occurred */
404 RXRPC_CALL_DISCONNECTED, /* The call has been disconnected */
408 * Events that can be raised on a call.
410 enum rxrpc_call_event {
411 RXRPC_CALL_EV_ACK, /* need to generate ACK */
412 RXRPC_CALL_EV_ABORT, /* need to generate abort */
413 RXRPC_CALL_EV_TIMER, /* Timer expired */
414 RXRPC_CALL_EV_RESEND, /* Tx resend required */
415 RXRPC_CALL_EV_PING, /* Ping send required */
419 * The states that a call can be in.
421 enum rxrpc_call_state {
422 RXRPC_CALL_UNINITIALISED,
423 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
424 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
425 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
426 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
427 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
428 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
429 RXRPC_CALL_SERVER_ACCEPTING, /* - server accepting request */
430 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
431 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
432 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
433 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
434 RXRPC_CALL_COMPLETE, /* - call complete */
435 NR__RXRPC_CALL_STATES
439 * Call completion condition (state == RXRPC_CALL_COMPLETE).
441 enum rxrpc_call_completion {
442 RXRPC_CALL_SUCCEEDED, /* - Normal termination */
443 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
444 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
445 RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
446 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
447 NR__RXRPC_CALL_COMPLETIONS
451 * Call Tx congestion management modes.
453 enum rxrpc_congest_mode {
454 RXRPC_CALL_SLOW_START,
455 RXRPC_CALL_CONGEST_AVOIDANCE,
456 RXRPC_CALL_PACKET_LOSS,
457 RXRPC_CALL_FAST_RETRANSMIT,
458 NR__RXRPC_CONGEST_MODES
462 * RxRPC call definition
463 * - matched by { connection, call_id }
467 struct rxrpc_connection *conn; /* connection carrying call */
468 struct rxrpc_peer *peer; /* Peer record for remote address */
469 struct rxrpc_sock __rcu *socket; /* socket responsible */
470 ktime_t ack_at; /* When deferred ACK needs to happen */
471 ktime_t resend_at; /* When next resend needs to happen */
472 ktime_t ping_at; /* When next to send a ping */
473 ktime_t expire_at; /* When the call times out */
474 struct timer_list timer; /* Combined event timer */
475 struct work_struct processor; /* Event processor */
476 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
477 struct list_head link; /* link in master call list */
478 struct list_head chan_wait_link; /* Link in conn->waiting_calls */
479 struct hlist_node error_link; /* link in error distribution list */
480 struct list_head accept_link; /* Link in rx->acceptq */
481 struct list_head recvmsg_link; /* Link in rx->recvmsg_q */
482 struct list_head sock_link; /* Link in rx->sock_calls */
483 struct rb_node sock_node; /* Node in rx->calls */
484 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
485 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
486 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
487 unsigned long user_call_ID; /* user-defined call ID */
489 unsigned long events;
491 rwlock_t state_lock; /* lock for state transition */
492 u32 abort_code; /* Local/remote abort code */
493 int error; /* Local error incurred */
494 enum rxrpc_call_state state; /* current state of call */
495 enum rxrpc_call_completion completion; /* Call completion condition */
497 u16 service_id; /* service ID */
498 u8 security_ix; /* Security type */
499 u32 call_id; /* call ID on connection */
500 u32 cid; /* connection ID plus channel index */
501 int debug_id; /* debug ID for printks */
502 unsigned short rx_pkt_offset; /* Current recvmsg packet offset */
503 unsigned short rx_pkt_len; /* Current recvmsg packet len */
505 /* Rx/Tx circular buffer, depending on phase.
507 * In the Rx phase, packets are annotated with 0 or the number of the
508 * segment of a jumbo packet each buffer refers to. There can be up to
509 * 47 segments in a maximum-size UDP packet.
511 * In the Tx phase, packets are annotated with which buffers have been
514 #define RXRPC_RXTX_BUFF_SIZE 64
515 #define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
516 #define RXRPC_INIT_RX_WINDOW_SIZE 32
517 struct sk_buff **rxtx_buffer;
518 u8 *rxtx_annotations;
519 #define RXRPC_TX_ANNO_ACK 0
520 #define RXRPC_TX_ANNO_UNACK 1
521 #define RXRPC_TX_ANNO_NAK 2
522 #define RXRPC_TX_ANNO_RETRANS 3
523 #define RXRPC_TX_ANNO_MASK 0x03
524 #define RXRPC_TX_ANNO_LAST 0x04
525 #define RXRPC_TX_ANNO_RESENT 0x08
527 #define RXRPC_RX_ANNO_JUMBO 0x3f /* Jumbo subpacket number + 1 if not zero */
528 #define RXRPC_RX_ANNO_JLAST 0x40 /* Set if last element of a jumbo packet */
529 #define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
530 rxrpc_seq_t tx_hard_ack; /* Dead slot in buffer; the first transmitted but
531 * not hard-ACK'd packet follows this.
533 rxrpc_seq_t tx_top; /* Highest Tx slot allocated. */
535 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
536 * is fixed, we keep these numbers in terms of segments (ie. DATA
537 * packets) rather than bytes.
539 #define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
540 u8 cong_cwnd; /* Congestion window size */
541 u8 cong_extra; /* Extra to send for congestion management */
542 u8 cong_ssthresh; /* Slow-start threshold */
543 enum rxrpc_congest_mode cong_mode:8; /* Congestion management mode */
544 u8 cong_dup_acks; /* Count of ACKs showing missing packets */
545 u8 cong_cumul_acks; /* Cumulative ACK count */
546 ktime_t cong_tstamp; /* Last time cwnd was changed */
548 rxrpc_seq_t rx_hard_ack; /* Dead slot in buffer; the first received but not
549 * consumed packet follows this.
551 rxrpc_seq_t rx_top; /* Highest Rx slot allocated. */
552 rxrpc_seq_t rx_expect_next; /* Expected next packet sequence number */
553 u8 rx_winsize; /* Size of Rx window */
554 u8 tx_winsize; /* Maximum size of Tx window */
555 bool tx_phase; /* T if transmission phase, F if receive phase */
556 u8 nr_jumbo_bad; /* Number of jumbo dups/exceeds-windows */
558 /* receive-phase ACK management */
559 u8 ackr_reason; /* reason to ACK */
560 u16 ackr_skew; /* skew on packet being ACK'd */
561 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
562 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
563 rxrpc_seq_t ackr_consumed; /* Highest packet shown consumed */
564 rxrpc_seq_t ackr_seen; /* Highest packet shown seen */
566 /* ping management */
567 rxrpc_serial_t ping_serial; /* Last ping sent */
568 ktime_t ping_time; /* Time last ping sent */
570 /* transmission-phase ACK management */
571 ktime_t acks_latest_ts; /* Timestamp of latest ACK received */
572 rxrpc_serial_t acks_latest; /* serial number of latest ACK received */
573 rxrpc_seq_t acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
577 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
579 struct rxrpc_ack_summary {
581 u8 nr_acks; /* Number of ACKs in packet */
582 u8 nr_nacks; /* Number of NACKs in packet */
583 u8 nr_new_acks; /* Number of new ACKs in packet */
584 u8 nr_new_nacks; /* Number of new NACKs in packet */
585 u8 nr_rot_new_acks; /* Number of rotated new ACKs */
586 bool new_low_nack; /* T if new low NACK found */
587 bool retrans_timeo; /* T if reTx due to timeout happened */
588 u8 flight_size; /* Number of unreceived transmissions */
589 /* Place to stash values for tracing */
590 enum rxrpc_congest_mode mode:8;
597 enum rxrpc_skb_trace {
598 rxrpc_skb_rx_cleaned,
602 rxrpc_skb_rx_received,
603 rxrpc_skb_rx_rotated,
606 rxrpc_skb_tx_cleaned,
610 rxrpc_skb_tx_rotated,
615 extern const char rxrpc_skb_traces[rxrpc_skb__nr_trace][7];
617 enum rxrpc_conn_trace {
618 rxrpc_conn_new_client,
619 rxrpc_conn_new_service,
623 rxrpc_conn_put_client,
624 rxrpc_conn_put_service,
628 extern const char rxrpc_conn_traces[rxrpc_conn__nr_trace][4];
630 enum rxrpc_client_trace {
631 rxrpc_client_activate_chans,
633 rxrpc_client_chan_activate,
634 rxrpc_client_chan_disconnect,
635 rxrpc_client_chan_pass,
636 rxrpc_client_chan_unstarted,
637 rxrpc_client_cleanup,
639 rxrpc_client_discard,
640 rxrpc_client_duplicate,
641 rxrpc_client_exposed,
642 rxrpc_client_replace,
643 rxrpc_client_to_active,
644 rxrpc_client_to_culled,
645 rxrpc_client_to_idle,
646 rxrpc_client_to_inactive,
647 rxrpc_client_to_waiting,
648 rxrpc_client_uncount,
649 rxrpc_client__nr_trace
652 extern const char rxrpc_client_traces[rxrpc_client__nr_trace][7];
653 extern const char rxrpc_conn_cache_states[RXRPC_CONN__NR_CACHE_STATES][5];
655 enum rxrpc_call_trace {
656 rxrpc_call_new_client,
657 rxrpc_call_new_service,
659 rxrpc_call_queued_ref,
661 rxrpc_call_connected,
664 rxrpc_call_got_userid,
665 rxrpc_call_got_kernel,
667 rxrpc_call_put_userid,
668 rxrpc_call_put_kernel,
669 rxrpc_call_put_noqueue,
674 extern const char rxrpc_call_traces[rxrpc_call__nr_trace][4];
676 enum rxrpc_transmit_trace {
678 rxrpc_transmit_queue,
679 rxrpc_transmit_queue_last,
680 rxrpc_transmit_rotate,
681 rxrpc_transmit_rotate_last,
682 rxrpc_transmit_await_reply,
684 rxrpc_transmit__nr_trace
687 extern const char rxrpc_transmit_traces[rxrpc_transmit__nr_trace][4];
689 enum rxrpc_receive_trace {
690 rxrpc_receive_incoming,
692 rxrpc_receive_queue_last,
694 rxrpc_receive_rotate,
696 rxrpc_receive__nr_trace
699 extern const char rxrpc_receive_traces[rxrpc_receive__nr_trace][4];
701 enum rxrpc_recvmsg_trace {
704 rxrpc_recvmsg_dequeue,
709 rxrpc_recvmsg_data_return,
710 rxrpc_recvmsg_terminal,
711 rxrpc_recvmsg_to_be_accepted,
712 rxrpc_recvmsg_return,
713 rxrpc_recvmsg__nr_trace
716 extern const char rxrpc_recvmsg_traces[rxrpc_recvmsg__nr_trace][5];
718 enum rxrpc_rtt_tx_trace {
721 rxrpc_rtt_tx__nr_trace
724 extern const char rxrpc_rtt_tx_traces[rxrpc_rtt_tx__nr_trace][5];
726 enum rxrpc_rtt_rx_trace {
727 rxrpc_rtt_rx_ping_response,
728 rxrpc_rtt_rx_requested_ack,
729 rxrpc_rtt_rx__nr_trace
732 extern const char rxrpc_rtt_rx_traces[rxrpc_rtt_rx__nr_trace][5];
734 enum rxrpc_timer_trace {
736 rxrpc_timer_init_for_reply,
737 rxrpc_timer_init_for_send_reply,
739 rxrpc_timer_set_for_ack,
740 rxrpc_timer_set_for_ping,
741 rxrpc_timer_set_for_resend,
742 rxrpc_timer_set_for_send,
743 rxrpc_timer__nr_trace
746 extern const char rxrpc_timer_traces[rxrpc_timer__nr_trace][8];
748 enum rxrpc_propose_ack_trace {
749 rxrpc_propose_ack_client_tx_end,
750 rxrpc_propose_ack_input_data,
751 rxrpc_propose_ack_ping_for_lost_ack,
752 rxrpc_propose_ack_ping_for_lost_reply,
753 rxrpc_propose_ack_ping_for_params,
754 rxrpc_propose_ack_processing_op,
755 rxrpc_propose_ack_respond_to_ack,
756 rxrpc_propose_ack_respond_to_ping,
757 rxrpc_propose_ack_retry_tx,
758 rxrpc_propose_ack_rotate_rx,
759 rxrpc_propose_ack_terminal_ack,
760 rxrpc_propose_ack__nr_trace
763 enum rxrpc_propose_ack_outcome {
764 rxrpc_propose_ack_use,
765 rxrpc_propose_ack_update,
766 rxrpc_propose_ack_subsume,
767 rxrpc_propose_ack__nr_outcomes
770 extern const char rxrpc_propose_ack_traces[rxrpc_propose_ack__nr_trace][8];
771 extern const char *const rxrpc_propose_ack_outcomes[rxrpc_propose_ack__nr_outcomes];
773 enum rxrpc_congest_change {
774 rxrpc_cong_begin_retransmission,
775 rxrpc_cong_cleared_nacks,
776 rxrpc_cong_new_low_nack,
777 rxrpc_cong_no_change,
779 rxrpc_cong_retransmit_again,
780 rxrpc_cong_rtt_window_end,
782 rxrpc_congest__nr_change
785 extern const char rxrpc_congest_modes[NR__RXRPC_CONGEST_MODES][10];
786 extern const char rxrpc_congest_changes[rxrpc_congest__nr_change][9];
788 extern const char *const rxrpc_pkts[];
789 extern const char rxrpc_ack_names[RXRPC_ACK__INVALID + 1][4];
791 #include <trace/events/rxrpc.h>
796 extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
797 extern u32 rxrpc_epoch;
798 extern atomic_t rxrpc_debug_id;
799 extern struct workqueue_struct *rxrpc_workqueue;
804 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
805 void rxrpc_discard_prealloc(struct rxrpc_sock *);
806 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
807 struct rxrpc_connection *,
809 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
810 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
812 int rxrpc_reject_call(struct rxrpc_sock *);
817 void __rxrpc_set_timer(struct rxrpc_call *, enum rxrpc_timer_trace, ktime_t);
818 void rxrpc_set_timer(struct rxrpc_call *, enum rxrpc_timer_trace, ktime_t);
819 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool, bool,
820 enum rxrpc_propose_ack_trace);
821 void rxrpc_process_call(struct work_struct *);
826 extern const char *const rxrpc_call_states[];
827 extern const char *const rxrpc_call_completions[];
828 extern unsigned int rxrpc_max_call_lifetime;
829 extern struct kmem_cache *rxrpc_call_jar;
830 extern struct list_head rxrpc_calls;
831 extern rwlock_t rxrpc_call_lock;
833 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
834 struct rxrpc_call *rxrpc_alloc_call(gfp_t);
835 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
836 struct rxrpc_conn_parameters *,
837 struct sockaddr_rxrpc *,
838 unsigned long, gfp_t);
839 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
841 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
842 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
843 bool __rxrpc_queue_call(struct rxrpc_call *);
844 bool rxrpc_queue_call(struct rxrpc_call *);
845 void rxrpc_see_call(struct rxrpc_call *);
846 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
847 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
848 void rxrpc_cleanup_call(struct rxrpc_call *);
849 void __exit rxrpc_destroy_all_calls(void);
851 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
853 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
856 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
858 return !rxrpc_is_service_call(call);
862 * Transition a call to the complete state.
864 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
865 enum rxrpc_call_completion compl,
869 if (call->state < RXRPC_CALL_COMPLETE) {
870 call->abort_code = abort_code;
872 call->completion = compl,
873 call->state = RXRPC_CALL_COMPLETE;
874 wake_up(&call->waitq);
880 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
881 enum rxrpc_call_completion compl,
887 write_lock_bh(&call->state_lock);
888 ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
889 write_unlock_bh(&call->state_lock);
894 * Record that a call successfully completed.
896 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
898 return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
901 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
905 write_lock_bh(&call->state_lock);
906 ret = __rxrpc_call_completed(call);
907 write_unlock_bh(&call->state_lock);
912 * Record that a call is locally aborted.
914 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
916 u32 abort_code, int error)
918 trace_rxrpc_abort(why, call->cid, call->call_id, seq,
920 return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
924 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
925 rxrpc_seq_t seq, u32 abort_code, int error)
929 write_lock_bh(&call->state_lock);
930 ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
931 write_unlock_bh(&call->state_lock);
938 extern unsigned int rxrpc_max_client_connections;
939 extern unsigned int rxrpc_reap_client_connections;
940 extern unsigned int rxrpc_conn_idle_client_expiry;
941 extern unsigned int rxrpc_conn_idle_client_fast_expiry;
942 extern struct idr rxrpc_client_conn_ids;
944 void rxrpc_destroy_client_conn_ids(void);
945 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
946 struct sockaddr_rxrpc *, gfp_t);
947 void rxrpc_expose_client_call(struct rxrpc_call *);
948 void rxrpc_disconnect_client_call(struct rxrpc_call *);
949 void rxrpc_put_client_conn(struct rxrpc_connection *);
950 void __exit rxrpc_destroy_all_client_connections(void);
955 void rxrpc_process_connection(struct work_struct *);
960 extern unsigned int rxrpc_connection_expiry;
961 extern struct list_head rxrpc_connections;
962 extern struct list_head rxrpc_connection_proc_list;
963 extern rwlock_t rxrpc_connection_lock;
965 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
966 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
967 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
969 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
970 void rxrpc_disconnect_call(struct rxrpc_call *);
971 void rxrpc_kill_connection(struct rxrpc_connection *);
972 bool rxrpc_queue_conn(struct rxrpc_connection *);
973 void rxrpc_see_connection(struct rxrpc_connection *);
974 void rxrpc_get_connection(struct rxrpc_connection *);
975 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
976 void rxrpc_put_service_conn(struct rxrpc_connection *);
977 void __exit rxrpc_destroy_all_connections(void);
979 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
981 return conn->out_clientflag;
984 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
986 return !rxrpc_conn_is_client(conn);
989 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
994 if (rxrpc_conn_is_client(conn))
995 rxrpc_put_client_conn(conn);
997 rxrpc_put_service_conn(conn);
1003 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
1005 struct rxrpc_connection *rxrpc_prealloc_service_connection(gfp_t);
1006 void rxrpc_new_incoming_connection(struct rxrpc_connection *, struct sk_buff *);
1007 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
1012 void rxrpc_data_ready(struct sock *);
1017 extern const struct rxrpc_security rxrpc_no_security;
1022 extern struct key_type key_type_rxrpc;
1023 extern struct key_type key_type_rxrpc_s;
1025 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
1026 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
1027 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
1033 extern void rxrpc_process_local_events(struct rxrpc_local *);
1038 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
1039 void __rxrpc_put_local(struct rxrpc_local *);
1040 void __exit rxrpc_destroy_all_locals(void);
1042 static inline void rxrpc_get_local(struct rxrpc_local *local)
1044 atomic_inc(&local->usage);
1048 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
1050 return atomic_inc_not_zero(&local->usage) ? local : NULL;
1053 static inline void rxrpc_put_local(struct rxrpc_local *local)
1055 if (local && atomic_dec_and_test(&local->usage))
1056 __rxrpc_put_local(local);
1059 static inline void rxrpc_queue_local(struct rxrpc_local *local)
1061 rxrpc_queue_work(&local->processor);
1067 extern unsigned int rxrpc_max_backlog __read_mostly;
1068 extern unsigned int rxrpc_requested_ack_delay;
1069 extern unsigned int rxrpc_soft_ack_delay;
1070 extern unsigned int rxrpc_idle_ack_delay;
1071 extern unsigned int rxrpc_rx_window_size;
1072 extern unsigned int rxrpc_rx_mtu;
1073 extern unsigned int rxrpc_rx_jumbo_max;
1074 extern unsigned int rxrpc_resend_timeout;
1076 extern const s8 rxrpc_ack_priority[];
1081 int rxrpc_send_ack_packet(struct rxrpc_call *, bool);
1082 int rxrpc_send_abort_packet(struct rxrpc_call *);
1083 int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
1084 void rxrpc_reject_packets(struct rxrpc_local *);
1089 void rxrpc_error_report(struct sock *);
1090 void rxrpc_peer_error_distributor(struct work_struct *);
1091 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace,
1092 rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1097 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1098 const struct sockaddr_rxrpc *);
1099 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
1100 struct sockaddr_rxrpc *, gfp_t);
1101 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
1102 struct rxrpc_peer *rxrpc_lookup_incoming_peer(struct rxrpc_local *,
1103 struct rxrpc_peer *);
1105 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
1107 atomic_inc(&peer->usage);
1112 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
1114 return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
1117 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
1118 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
1120 if (peer && atomic_dec_and_test(&peer->usage))
1121 __rxrpc_put_peer(peer);
1127 extern const struct file_operations rxrpc_call_seq_fops;
1128 extern const struct file_operations rxrpc_connection_seq_fops;
1133 void rxrpc_notify_socket(struct rxrpc_call *);
1134 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1140 extern const struct rxrpc_security rxkad;
1146 int __init rxrpc_init_security(void);
1147 void rxrpc_exit_security(void);
1148 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1149 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
1154 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1159 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1160 void rxrpc_packet_destructor(struct sk_buff *);
1161 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1162 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1163 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1164 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1165 void rxrpc_lose_skb(struct sk_buff *, enum rxrpc_skb_trace);
1166 void rxrpc_purge_queue(struct sk_buff_head *);
1171 #ifdef CONFIG_SYSCTL
1172 extern int __init rxrpc_sysctl_init(void);
1173 extern void rxrpc_sysctl_exit(void);
1175 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1176 static inline void rxrpc_sysctl_exit(void) {}
1182 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1184 static inline bool before(u32 seq1, u32 seq2)
1186 return (s32)(seq1 - seq2) < 0;
1188 static inline bool before_eq(u32 seq1, u32 seq2)
1190 return (s32)(seq1 - seq2) <= 0;
1192 static inline bool after(u32 seq1, u32 seq2)
1194 return (s32)(seq1 - seq2) > 0;
1196 static inline bool after_eq(u32 seq1, u32 seq2)
1198 return (s32)(seq1 - seq2) >= 0;
1204 extern unsigned int rxrpc_debug;
1206 #define dbgprintk(FMT,...) \
1207 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1209 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1210 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1211 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1212 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1213 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1216 #if defined(__KDEBUG)
1217 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1218 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1219 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1220 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1221 #define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1223 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1224 #define RXRPC_DEBUG_KENTER 0x01
1225 #define RXRPC_DEBUG_KLEAVE 0x02
1226 #define RXRPC_DEBUG_KDEBUG 0x04
1227 #define RXRPC_DEBUG_KPROTO 0x08
1228 #define RXRPC_DEBUG_KNET 0x10
1230 #define _enter(FMT,...) \
1232 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1233 kenter(FMT,##__VA_ARGS__); \
1236 #define _leave(FMT,...) \
1238 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1239 kleave(FMT,##__VA_ARGS__); \
1242 #define _debug(FMT,...) \
1244 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1245 kdebug(FMT,##__VA_ARGS__); \
1248 #define _proto(FMT,...) \
1250 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1251 kproto(FMT,##__VA_ARGS__); \
1254 #define _net(FMT,...) \
1256 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1257 knet(FMT,##__VA_ARGS__); \
1261 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1262 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1263 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1264 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1265 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1269 * debug assertion checking
1271 #if 1 // defined(__KDEBUGALL)
1275 if (unlikely(!(X))) { \
1276 pr_err("Assertion failed\n"); \
1281 #define ASSERTCMP(X, OP, Y) \
1283 __typeof__(X) _x = (X); \
1284 __typeof__(Y) _y = (__typeof__(X))(Y); \
1285 if (unlikely(!(_x OP _y))) { \
1286 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1287 (unsigned long)_x, (unsigned long)_x, #OP, \
1288 (unsigned long)_y, (unsigned long)_y); \
1293 #define ASSERTIF(C, X) \
1295 if (unlikely((C) && !(X))) { \
1296 pr_err("Assertion failed\n"); \
1301 #define ASSERTIFCMP(C, X, OP, Y) \
1303 __typeof__(X) _x = (X); \
1304 __typeof__(Y) _y = (__typeof__(X))(Y); \
1305 if (unlikely((C) && !(_x OP _y))) { \
1306 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1307 (unsigned long)_x, (unsigned long)_x, #OP, \
1308 (unsigned long)_y, (unsigned long)_y); \
1319 #define ASSERTCMP(X, OP, Y) \
1323 #define ASSERTIF(C, X) \
1327 #define ASSERTIFCMP(C, X, OP, Y) \
1331 #endif /* __KDEBUGALL */