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>
14 #include <net/net_namespace.h>
15 #include <net/netns/generic.h>
17 #include <net/af_rxrpc.h>
21 #define CHECK_SLAB_OKAY(X) \
22 BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
23 (POISON_FREE << 8 | POISON_FREE))
25 #define CHECK_SLAB_OKAY(X) do {} while (0)
28 #define FCRYPT_BSIZE 8
34 } __attribute__((aligned(8)));
36 #define rxrpc_queue_work(WS) queue_work(rxrpc_workqueue, (WS))
37 #define rxrpc_queue_delayed_work(WS,D) \
38 queue_delayed_work(rxrpc_workqueue, (WS), (D))
40 struct rxrpc_connection
;
43 * Mark applied to socket buffers.
46 RXRPC_SKB_MARK_DATA
, /* data message */
47 RXRPC_SKB_MARK_FINAL_ACK
, /* final ACK received message */
48 RXRPC_SKB_MARK_BUSY
, /* server busy message */
49 RXRPC_SKB_MARK_REMOTE_ABORT
, /* remote abort message */
50 RXRPC_SKB_MARK_LOCAL_ABORT
, /* local abort message */
51 RXRPC_SKB_MARK_NET_ERROR
, /* network error message */
52 RXRPC_SKB_MARK_LOCAL_ERROR
, /* local error message */
53 RXRPC_SKB_MARK_NEW_CALL
, /* local error message */
57 * sk_state for RxRPC sockets
61 RXRPC_CLIENT_UNBOUND
, /* Unbound socket used as client */
62 RXRPC_CLIENT_BOUND
, /* client local address bound */
63 RXRPC_SERVER_BOUND
, /* server local address bound */
64 RXRPC_SERVER_BOUND2
, /* second server local address bound */
65 RXRPC_SERVER_LISTENING
, /* server listening for connections */
66 RXRPC_SERVER_LISTEN_DISABLED
, /* server listening disabled */
67 RXRPC_CLOSE
, /* socket is being closed */
71 * Per-network namespace data.
74 struct proc_dir_entry
*proc_net
; /* Subdir in /proc/net */
75 u32 epoch
; /* Local epoch for detecting local-end reset */
76 struct list_head calls
; /* List of calls active in this namespace */
77 rwlock_t call_lock
; /* Lock for ->calls */
79 struct list_head conn_proc_list
; /* List of conns in this namespace for proc */
80 struct list_head service_conns
; /* Service conns in this namespace */
81 rwlock_t conn_lock
; /* Lock for ->conn_proc_list, ->service_conns */
82 struct delayed_work service_conn_reaper
;
84 unsigned int nr_client_conns
;
85 unsigned int nr_active_client_conns
;
86 bool kill_all_client_conns
;
87 spinlock_t client_conn_cache_lock
; /* Lock for ->*_client_conns */
88 spinlock_t client_conn_discard_lock
; /* Prevent multiple discarders */
89 struct list_head waiting_client_conns
;
90 struct list_head active_client_conns
;
91 struct list_head idle_client_conns
;
92 struct delayed_work client_conn_reaper
;
94 struct list_head local_endpoints
;
95 struct mutex local_mutex
; /* Lock for ->local_endpoints */
97 spinlock_t peer_hash_lock
; /* Lock for ->peer_hash */
98 DECLARE_HASHTABLE (peer_hash
, 10);
102 * Service backlog preallocation.
104 * This contains circular buffers of preallocated peers, connections and calls
105 * for incoming service calls and their head and tail pointers. This allows
106 * calls to be set up in the data_ready handler, thereby avoiding the need to
107 * shuffle packets around so much.
109 struct rxrpc_backlog
{
110 unsigned short peer_backlog_head
;
111 unsigned short peer_backlog_tail
;
112 unsigned short conn_backlog_head
;
113 unsigned short conn_backlog_tail
;
114 unsigned short call_backlog_head
;
115 unsigned short call_backlog_tail
;
116 #define RXRPC_BACKLOG_MAX 32
117 struct rxrpc_peer
*peer_backlog
[RXRPC_BACKLOG_MAX
];
118 struct rxrpc_connection
*conn_backlog
[RXRPC_BACKLOG_MAX
];
119 struct rxrpc_call
*call_backlog
[RXRPC_BACKLOG_MAX
];
123 * RxRPC socket definition
126 /* WARNING: sk has to be the first member */
128 rxrpc_notify_new_call_t notify_new_call
; /* Func to notify of new call */
129 rxrpc_discard_new_call_t discard_new_call
; /* Func to discard a new call */
130 struct rxrpc_local
*local
; /* local endpoint */
131 struct rxrpc_backlog
*backlog
; /* Preallocation for services */
132 spinlock_t incoming_lock
; /* Incoming call vs service shutdown lock */
133 struct list_head sock_calls
; /* List of calls owned by this socket */
134 struct list_head to_be_accepted
; /* calls awaiting acceptance */
135 struct list_head recvmsg_q
; /* Calls awaiting recvmsg's attention */
136 rwlock_t recvmsg_lock
; /* Lock for recvmsg_q */
137 struct key
*key
; /* security for this socket */
138 struct key
*securities
; /* list of server security descriptors */
139 struct rb_root calls
; /* User ID -> call mapping */
141 #define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
142 rwlock_t call_lock
; /* lock for calls */
143 u32 min_sec_level
; /* minimum security level */
144 #define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
145 bool exclusive
; /* Exclusive connection for a client socket */
146 u16 second_service
; /* Additional service bound to the endpoint */
148 /* Service upgrade information */
149 u16 from
; /* Service ID to upgrade (if not 0) */
150 u16 to
; /* service ID to upgrade to */
152 sa_family_t family
; /* Protocol family created with */
153 struct sockaddr_rxrpc srx
; /* Primary Service/local addresses */
154 struct sockaddr_rxrpc connect_srx
; /* Default client address from connect() */
157 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
160 * CPU-byteorder normalised Rx packet header.
162 struct rxrpc_host_header
{
163 u32 epoch
; /* client boot timestamp */
164 u32 cid
; /* connection and channel ID */
165 u32 callNumber
; /* call ID (0 for connection-level packets) */
166 u32 seq
; /* sequence number of pkt in call stream */
167 u32 serial
; /* serial number of pkt sent to network */
168 u8 type
; /* packet type */
169 u8 flags
; /* packet flags */
170 u8 userStatus
; /* app-layer defined status */
171 u8 securityIndex
; /* security protocol ID */
173 u16 _rsvd
; /* reserved */
174 u16 cksum
; /* kerberos security checksum */
176 u16 serviceId
; /* service ID */
180 * RxRPC socket buffer private variables
181 * - max 48 bytes (struct sk_buff::cb)
183 struct rxrpc_skb_priv
{
185 u8 nr_jumbo
; /* Number of jumbo subpackets */
188 int remain
; /* amount of space remaining for next write */
191 struct rxrpc_host_header hdr
; /* RxRPC packet header from this packet */
194 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
197 * RxRPC security module interface
199 struct rxrpc_security
{
200 const char *name
; /* name of this service */
201 u8 security_index
; /* security type provided */
203 /* Initialise a security service */
206 /* Clean up a security service */
209 /* initialise a connection's security */
210 int (*init_connection_security
)(struct rxrpc_connection
*);
212 /* prime a connection's packet security */
213 int (*prime_packet_security
)(struct rxrpc_connection
*);
215 /* impose security on a packet */
216 int (*secure_packet
)(struct rxrpc_call
*,
221 /* verify the security on a received packet */
222 int (*verify_packet
)(struct rxrpc_call
*, struct sk_buff
*,
223 unsigned int, unsigned int, rxrpc_seq_t
, u16
);
225 /* Locate the data in a received packet that has been verified. */
226 void (*locate_data
)(struct rxrpc_call
*, struct sk_buff
*,
227 unsigned int *, unsigned int *);
229 /* issue a challenge */
230 int (*issue_challenge
)(struct rxrpc_connection
*);
232 /* respond to a challenge */
233 int (*respond_to_challenge
)(struct rxrpc_connection
*,
237 /* verify a response */
238 int (*verify_response
)(struct rxrpc_connection
*,
242 /* clear connection security */
243 void (*clear
)(struct rxrpc_connection
*);
247 * RxRPC local transport endpoint description
248 * - owned by a single AF_RXRPC socket
249 * - pointed to by transport socket struct sk_user_data
254 struct rxrpc_net
*rxnet
; /* The network ns in which this resides */
255 struct list_head link
;
256 struct socket
*socket
; /* my UDP socket */
257 struct work_struct processor
;
258 struct rxrpc_sock __rcu
*service
; /* Service(s) listening on this endpoint */
259 struct rw_semaphore defrag_sem
; /* control re-enablement of IP DF bit */
260 struct sk_buff_head reject_queue
; /* packets awaiting rejection */
261 struct sk_buff_head event_queue
; /* endpoint event packets awaiting processing */
262 struct rb_root client_conns
; /* Client connections by socket params */
263 spinlock_t client_conns_lock
; /* Lock for client_conns */
264 spinlock_t lock
; /* access lock */
265 rwlock_t services_lock
; /* lock for services list */
266 int debug_id
; /* debug ID for printks */
268 struct sockaddr_rxrpc srx
; /* local address */
272 * RxRPC remote transport endpoint definition
273 * - matched by local endpoint, remote port, address and protocol type
276 struct rcu_head rcu
; /* This must be first */
278 unsigned long hash_key
;
279 struct hlist_node hash_link
;
280 struct rxrpc_local
*local
;
281 struct hlist_head error_targets
; /* targets for net error distribution */
282 struct work_struct error_distributor
;
283 struct rb_root service_conns
; /* Service connections */
284 seqlock_t service_conn_lock
;
285 spinlock_t lock
; /* access lock */
286 unsigned int if_mtu
; /* interface MTU for this peer */
287 unsigned int mtu
; /* network MTU for this peer */
288 unsigned int maxdata
; /* data size (MTU - hdrsize) */
289 unsigned short hdrsize
; /* header size (IP + UDP + RxRPC) */
290 int debug_id
; /* debug ID for printks */
291 int error_report
; /* Net (+0) or local (+1000000) to distribute */
292 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
293 struct sockaddr_rxrpc srx
; /* remote address */
295 /* calculated RTT cache */
296 #define RXRPC_RTT_CACHE_SIZE 32
297 ktime_t rtt_last_req
; /* Time of last RTT request */
298 u64 rtt
; /* Current RTT estimate (in nS) */
299 u64 rtt_sum
; /* Sum of cache contents */
300 u64 rtt_cache
[RXRPC_RTT_CACHE_SIZE
]; /* Determined RTT cache */
301 u8 rtt_cursor
; /* next entry at which to insert */
302 u8 rtt_usage
; /* amount of cache actually used */
304 u8 cong_cwnd
; /* Congestion window size */
308 * Keys for matching a connection.
310 struct rxrpc_conn_proto
{
313 u32 epoch
; /* epoch of this connection */
314 u32 cid
; /* connection ID */
320 struct rxrpc_conn_parameters
{
321 struct rxrpc_local
*local
; /* Representation of local endpoint */
322 struct rxrpc_peer
*peer
; /* Remote endpoint */
323 struct key
*key
; /* Security details */
324 bool exclusive
; /* T if conn is exclusive */
325 bool upgrade
; /* T if service ID can be upgraded */
326 u16 service_id
; /* Service ID for this connection */
327 u32 security_level
; /* Security level selected */
331 * Bits in the connection flags.
333 enum rxrpc_conn_flag
{
334 RXRPC_CONN_HAS_IDR
, /* Has a client conn ID assigned */
335 RXRPC_CONN_IN_SERVICE_CONNS
, /* Conn is in peer->service_conns */
336 RXRPC_CONN_IN_CLIENT_CONNS
, /* Conn is in local->client_conns */
337 RXRPC_CONN_EXPOSED
, /* Conn has extra ref for exposure */
338 RXRPC_CONN_DONT_REUSE
, /* Don't reuse this connection */
339 RXRPC_CONN_COUNTED
, /* Counted by rxrpc_nr_client_conns */
340 RXRPC_CONN_PROBING_FOR_UPGRADE
, /* Probing for service upgrade */
344 * Events that can be raised upon a connection.
346 enum rxrpc_conn_event
{
347 RXRPC_CONN_EV_CHALLENGE
, /* Send challenge packet */
351 * The connection cache state.
353 enum rxrpc_conn_cache_state
{
354 RXRPC_CONN_CLIENT_INACTIVE
, /* Conn is not yet listed */
355 RXRPC_CONN_CLIENT_WAITING
, /* Conn is on wait list, waiting for capacity */
356 RXRPC_CONN_CLIENT_ACTIVE
, /* Conn is on active list, doing calls */
357 RXRPC_CONN_CLIENT_UPGRADE
, /* Conn is on active list, probing for upgrade */
358 RXRPC_CONN_CLIENT_CULLED
, /* Conn is culled and delisted, doing calls */
359 RXRPC_CONN_CLIENT_IDLE
, /* Conn is on idle list, doing mostly nothing */
360 RXRPC_CONN__NR_CACHE_STATES
364 * The connection protocol state.
366 enum rxrpc_conn_proto_state
{
367 RXRPC_CONN_UNUSED
, /* Connection not yet attempted */
368 RXRPC_CONN_CLIENT
, /* Client connection */
369 RXRPC_CONN_SERVICE_PREALLOC
, /* Service connection preallocation */
370 RXRPC_CONN_SERVICE_UNSECURED
, /* Service unsecured connection */
371 RXRPC_CONN_SERVICE_CHALLENGING
, /* Service challenging for security */
372 RXRPC_CONN_SERVICE
, /* Service secured connection */
373 RXRPC_CONN_REMOTELY_ABORTED
, /* Conn aborted by peer */
374 RXRPC_CONN_LOCALLY_ABORTED
, /* Conn aborted locally */
375 RXRPC_CONN__NR_STATES
379 * RxRPC connection definition
380 * - matched by { local, peer, epoch, conn_id, direction }
381 * - each connection can only handle four simultaneous calls
383 struct rxrpc_connection
{
384 struct rxrpc_conn_proto proto
;
385 struct rxrpc_conn_parameters params
;
389 struct list_head cache_link
;
391 spinlock_t channel_lock
;
392 unsigned char active_chans
; /* Mask of active channels */
393 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
394 struct list_head waiting_calls
; /* Calls waiting for channels */
395 struct rxrpc_channel
{
396 struct rxrpc_call __rcu
*call
; /* Active call */
397 u32 call_id
; /* ID of current call */
398 u32 call_counter
; /* Call ID counter */
399 u32 last_call
; /* ID of last call */
400 u8 last_type
; /* Type of last packet */
405 } channels
[RXRPC_MAXCALLS
];
407 struct work_struct processor
; /* connection event processor */
409 struct rb_node client_node
; /* Node in local->client_conns */
410 struct rb_node service_node
; /* Node in peer->service_conns */
412 struct list_head proc_link
; /* link in procfs list */
413 struct list_head link
; /* link in master connection list */
414 struct sk_buff_head rx_queue
; /* received conn-level packets */
415 const struct rxrpc_security
*security
; /* applied security module */
416 struct key
*server_key
; /* security for this service */
417 struct crypto_skcipher
*cipher
; /* encryption handle */
418 struct rxrpc_crypt csum_iv
; /* packet checksum base */
420 unsigned long events
;
421 unsigned long idle_timestamp
; /* Time at which last became idle */
422 spinlock_t state_lock
; /* state-change lock */
423 enum rxrpc_conn_cache_state cache_state
;
424 enum rxrpc_conn_proto_state state
; /* current state of connection */
425 u32 local_abort
; /* local abort code */
426 u32 remote_abort
; /* remote abort code */
427 int debug_id
; /* debug ID for printks */
428 atomic_t serial
; /* packet serial number counter */
429 unsigned int hi_serial
; /* highest serial number received */
430 u32 security_nonce
; /* response re-use preventer */
431 u16 service_id
; /* Service ID, possibly upgraded */
432 u8 size_align
; /* data size alignment (for security) */
433 u8 security_size
; /* security header size */
434 u8 security_ix
; /* security type */
435 u8 out_clientflag
; /* RXRPC_CLIENT_INITIATED if we are client */
439 * Flags in call->flags.
441 enum rxrpc_call_flag
{
442 RXRPC_CALL_RELEASED
, /* call has been released - no more message to userspace */
443 RXRPC_CALL_HAS_USERID
, /* has a user ID attached */
444 RXRPC_CALL_IS_SERVICE
, /* Call is service call */
445 RXRPC_CALL_EXPOSED
, /* The call was exposed to the world */
446 RXRPC_CALL_RX_LAST
, /* Received the last packet (at rxtx_top) */
447 RXRPC_CALL_TX_LAST
, /* Last packet in Tx buffer (at rxtx_top) */
448 RXRPC_CALL_TX_LASTQ
, /* Last packet has been queued */
449 RXRPC_CALL_SEND_PING
, /* A ping will need to be sent */
450 RXRPC_CALL_PINGING
, /* Ping in process */
451 RXRPC_CALL_RETRANS_TIMEOUT
, /* Retransmission due to timeout occurred */
455 * Events that can be raised on a call.
457 enum rxrpc_call_event
{
458 RXRPC_CALL_EV_ACK
, /* need to generate ACK */
459 RXRPC_CALL_EV_ABORT
, /* need to generate abort */
460 RXRPC_CALL_EV_TIMER
, /* Timer expired */
461 RXRPC_CALL_EV_RESEND
, /* Tx resend required */
462 RXRPC_CALL_EV_PING
, /* Ping send required */
466 * The states that a call can be in.
468 enum rxrpc_call_state
{
469 RXRPC_CALL_UNINITIALISED
,
470 RXRPC_CALL_CLIENT_AWAIT_CONN
, /* - client waiting for connection to become available */
471 RXRPC_CALL_CLIENT_SEND_REQUEST
, /* - client sending request phase */
472 RXRPC_CALL_CLIENT_AWAIT_REPLY
, /* - client awaiting reply */
473 RXRPC_CALL_CLIENT_RECV_REPLY
, /* - client receiving reply phase */
474 RXRPC_CALL_SERVER_PREALLOC
, /* - service preallocation */
475 RXRPC_CALL_SERVER_SECURING
, /* - server securing request connection */
476 RXRPC_CALL_SERVER_ACCEPTING
, /* - server accepting request */
477 RXRPC_CALL_SERVER_RECV_REQUEST
, /* - server receiving request */
478 RXRPC_CALL_SERVER_ACK_REQUEST
, /* - server pending ACK of request */
479 RXRPC_CALL_SERVER_SEND_REPLY
, /* - server sending reply */
480 RXRPC_CALL_SERVER_AWAIT_ACK
, /* - server awaiting final ACK */
481 RXRPC_CALL_COMPLETE
, /* - call complete */
482 NR__RXRPC_CALL_STATES
486 * Call Tx congestion management modes.
488 enum rxrpc_congest_mode
{
489 RXRPC_CALL_SLOW_START
,
490 RXRPC_CALL_CONGEST_AVOIDANCE
,
491 RXRPC_CALL_PACKET_LOSS
,
492 RXRPC_CALL_FAST_RETRANSMIT
,
493 NR__RXRPC_CONGEST_MODES
497 * RxRPC call definition
498 * - matched by { connection, call_id }
502 struct rxrpc_connection
*conn
; /* connection carrying call */
503 struct rxrpc_peer
*peer
; /* Peer record for remote address */
504 struct rxrpc_sock __rcu
*socket
; /* socket responsible */
505 struct mutex user_mutex
; /* User access mutex */
506 ktime_t ack_at
; /* When deferred ACK needs to happen */
507 ktime_t resend_at
; /* When next resend needs to happen */
508 ktime_t ping_at
; /* When next to send a ping */
509 ktime_t expire_at
; /* When the call times out */
510 struct timer_list timer
; /* Combined event timer */
511 struct work_struct processor
; /* Event processor */
512 rxrpc_notify_rx_t notify_rx
; /* kernel service Rx notification function */
513 struct list_head link
; /* link in master call list */
514 struct list_head chan_wait_link
; /* Link in conn->waiting_calls */
515 struct hlist_node error_link
; /* link in error distribution list */
516 struct list_head accept_link
; /* Link in rx->acceptq */
517 struct list_head recvmsg_link
; /* Link in rx->recvmsg_q */
518 struct list_head sock_link
; /* Link in rx->sock_calls */
519 struct rb_node sock_node
; /* Node in rx->calls */
520 struct sk_buff
*tx_pending
; /* Tx socket buffer being filled */
521 wait_queue_head_t waitq
; /* Wait queue for channel or Tx */
522 s64 tx_total_len
; /* Total length left to be transmitted (or -1) */
523 __be32 crypto_buf
[2]; /* Temporary packet crypto buffer */
524 unsigned long user_call_ID
; /* user-defined call ID */
526 unsigned long events
;
528 spinlock_t notify_lock
; /* Kernel notification lock */
529 rwlock_t state_lock
; /* lock for state transition */
530 u32 abort_code
; /* Local/remote abort code */
531 int error
; /* Local error incurred */
532 enum rxrpc_call_state state
; /* current state of call */
533 enum rxrpc_call_completion completion
; /* Call completion condition */
535 u16 service_id
; /* service ID */
536 u8 security_ix
; /* Security type */
537 u32 call_id
; /* call ID on connection */
538 u32 cid
; /* connection ID plus channel index */
539 int debug_id
; /* debug ID for printks */
540 unsigned short rx_pkt_offset
; /* Current recvmsg packet offset */
541 unsigned short rx_pkt_len
; /* Current recvmsg packet len */
543 /* Rx/Tx circular buffer, depending on phase.
545 * In the Rx phase, packets are annotated with 0 or the number of the
546 * segment of a jumbo packet each buffer refers to. There can be up to
547 * 47 segments in a maximum-size UDP packet.
549 * In the Tx phase, packets are annotated with which buffers have been
552 #define RXRPC_RXTX_BUFF_SIZE 64
553 #define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
554 #define RXRPC_INIT_RX_WINDOW_SIZE 32
555 struct sk_buff
**rxtx_buffer
;
556 u8
*rxtx_annotations
;
557 #define RXRPC_TX_ANNO_ACK 0
558 #define RXRPC_TX_ANNO_UNACK 1
559 #define RXRPC_TX_ANNO_NAK 2
560 #define RXRPC_TX_ANNO_RETRANS 3
561 #define RXRPC_TX_ANNO_MASK 0x03
562 #define RXRPC_TX_ANNO_LAST 0x04
563 #define RXRPC_TX_ANNO_RESENT 0x08
565 #define RXRPC_RX_ANNO_JUMBO 0x3f /* Jumbo subpacket number + 1 if not zero */
566 #define RXRPC_RX_ANNO_JLAST 0x40 /* Set if last element of a jumbo packet */
567 #define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
568 rxrpc_seq_t tx_hard_ack
; /* Dead slot in buffer; the first transmitted but
569 * not hard-ACK'd packet follows this.
571 rxrpc_seq_t tx_top
; /* Highest Tx slot allocated. */
573 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
574 * is fixed, we keep these numbers in terms of segments (ie. DATA
575 * packets) rather than bytes.
577 #define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
578 u8 cong_cwnd
; /* Congestion window size */
579 u8 cong_extra
; /* Extra to send for congestion management */
580 u8 cong_ssthresh
; /* Slow-start threshold */
581 enum rxrpc_congest_mode cong_mode
:8; /* Congestion management mode */
582 u8 cong_dup_acks
; /* Count of ACKs showing missing packets */
583 u8 cong_cumul_acks
; /* Cumulative ACK count */
584 ktime_t cong_tstamp
; /* Last time cwnd was changed */
586 rxrpc_seq_t rx_hard_ack
; /* Dead slot in buffer; the first received but not
587 * consumed packet follows this.
589 rxrpc_seq_t rx_top
; /* Highest Rx slot allocated. */
590 rxrpc_seq_t rx_expect_next
; /* Expected next packet sequence number */
591 u8 rx_winsize
; /* Size of Rx window */
592 u8 tx_winsize
; /* Maximum size of Tx window */
593 bool tx_phase
; /* T if transmission phase, F if receive phase */
594 u8 nr_jumbo_bad
; /* Number of jumbo dups/exceeds-windows */
596 /* receive-phase ACK management */
597 u8 ackr_reason
; /* reason to ACK */
598 u16 ackr_skew
; /* skew on packet being ACK'd */
599 rxrpc_serial_t ackr_serial
; /* serial of packet being ACK'd */
600 rxrpc_seq_t ackr_prev_seq
; /* previous sequence number received */
601 rxrpc_seq_t ackr_consumed
; /* Highest packet shown consumed */
602 rxrpc_seq_t ackr_seen
; /* Highest packet shown seen */
604 /* ping management */
605 rxrpc_serial_t ping_serial
; /* Last ping sent */
606 ktime_t ping_time
; /* Time last ping sent */
608 /* transmission-phase ACK management */
609 ktime_t acks_latest_ts
; /* Timestamp of latest ACK received */
610 rxrpc_serial_t acks_latest
; /* serial number of latest ACK received */
611 rxrpc_seq_t acks_lowest_nak
; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
615 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
617 struct rxrpc_ack_summary
{
619 u8 nr_acks
; /* Number of ACKs in packet */
620 u8 nr_nacks
; /* Number of NACKs in packet */
621 u8 nr_new_acks
; /* Number of new ACKs in packet */
622 u8 nr_new_nacks
; /* Number of new NACKs in packet */
623 u8 nr_rot_new_acks
; /* Number of rotated new ACKs */
624 bool new_low_nack
; /* T if new low NACK found */
625 bool retrans_timeo
; /* T if reTx due to timeout happened */
626 u8 flight_size
; /* Number of unreceived transmissions */
627 /* Place to stash values for tracing */
628 enum rxrpc_congest_mode mode
:8;
635 #include <trace/events/rxrpc.h>
640 extern atomic_t rxrpc_n_tx_skbs
, rxrpc_n_rx_skbs
;
641 extern atomic_t rxrpc_debug_id
;
642 extern struct workqueue_struct
*rxrpc_workqueue
;
647 int rxrpc_service_prealloc(struct rxrpc_sock
*, gfp_t
);
648 void rxrpc_discard_prealloc(struct rxrpc_sock
*);
649 struct rxrpc_call
*rxrpc_new_incoming_call(struct rxrpc_local
*,
650 struct rxrpc_connection
*,
652 void rxrpc_accept_incoming_calls(struct rxrpc_local
*);
653 struct rxrpc_call
*rxrpc_accept_call(struct rxrpc_sock
*, unsigned long,
655 int rxrpc_reject_call(struct rxrpc_sock
*);
660 void __rxrpc_set_timer(struct rxrpc_call
*, enum rxrpc_timer_trace
, ktime_t
);
661 void rxrpc_set_timer(struct rxrpc_call
*, enum rxrpc_timer_trace
, ktime_t
);
662 void rxrpc_propose_ACK(struct rxrpc_call
*, u8
, u16
, u32
, bool, bool,
663 enum rxrpc_propose_ack_trace
);
664 void rxrpc_process_call(struct work_struct
*);
669 extern const char *const rxrpc_call_states
[];
670 extern const char *const rxrpc_call_completions
[];
671 extern unsigned int rxrpc_max_call_lifetime
;
672 extern struct kmem_cache
*rxrpc_call_jar
;
674 struct rxrpc_call
*rxrpc_find_call_by_user_ID(struct rxrpc_sock
*, unsigned long);
675 struct rxrpc_call
*rxrpc_alloc_call(gfp_t
);
676 struct rxrpc_call
*rxrpc_new_client_call(struct rxrpc_sock
*,
677 struct rxrpc_conn_parameters
*,
678 struct sockaddr_rxrpc
*,
679 unsigned long, s64
, gfp_t
);
680 int rxrpc_retry_client_call(struct rxrpc_sock
*,
682 struct rxrpc_conn_parameters
*,
683 struct sockaddr_rxrpc
*,
685 void rxrpc_incoming_call(struct rxrpc_sock
*, struct rxrpc_call
*,
687 void rxrpc_release_call(struct rxrpc_sock
*, struct rxrpc_call
*);
688 int rxrpc_prepare_call_for_retry(struct rxrpc_sock
*, struct rxrpc_call
*);
689 void rxrpc_release_calls_on_socket(struct rxrpc_sock
*);
690 bool __rxrpc_queue_call(struct rxrpc_call
*);
691 bool rxrpc_queue_call(struct rxrpc_call
*);
692 void rxrpc_see_call(struct rxrpc_call
*);
693 void rxrpc_get_call(struct rxrpc_call
*, enum rxrpc_call_trace
);
694 void rxrpc_put_call(struct rxrpc_call
*, enum rxrpc_call_trace
);
695 void rxrpc_cleanup_call(struct rxrpc_call
*);
696 void rxrpc_destroy_all_calls(struct rxrpc_net
*);
698 static inline bool rxrpc_is_service_call(const struct rxrpc_call
*call
)
700 return test_bit(RXRPC_CALL_IS_SERVICE
, &call
->flags
);
703 static inline bool rxrpc_is_client_call(const struct rxrpc_call
*call
)
705 return !rxrpc_is_service_call(call
);
709 * Transition a call to the complete state.
711 static inline bool __rxrpc_set_call_completion(struct rxrpc_call
*call
,
712 enum rxrpc_call_completion
compl,
716 if (call
->state
< RXRPC_CALL_COMPLETE
) {
717 call
->abort_code
= abort_code
;
719 call
->completion
= compl,
720 call
->state
= RXRPC_CALL_COMPLETE
;
721 wake_up(&call
->waitq
);
727 static inline bool rxrpc_set_call_completion(struct rxrpc_call
*call
,
728 enum rxrpc_call_completion
compl,
734 write_lock_bh(&call
->state_lock
);
735 ret
= __rxrpc_set_call_completion(call
, compl, abort_code
, error
);
736 write_unlock_bh(&call
->state_lock
);
741 * Record that a call successfully completed.
743 static inline bool __rxrpc_call_completed(struct rxrpc_call
*call
)
745 return __rxrpc_set_call_completion(call
, RXRPC_CALL_SUCCEEDED
, 0, 0);
748 static inline bool rxrpc_call_completed(struct rxrpc_call
*call
)
752 write_lock_bh(&call
->state_lock
);
753 ret
= __rxrpc_call_completed(call
);
754 write_unlock_bh(&call
->state_lock
);
759 * Record that a call is locally aborted.
761 static inline bool __rxrpc_abort_call(const char *why
, struct rxrpc_call
*call
,
763 u32 abort_code
, int error
)
765 trace_rxrpc_abort(why
, call
->cid
, call
->call_id
, seq
,
767 return __rxrpc_set_call_completion(call
, RXRPC_CALL_LOCALLY_ABORTED
,
771 static inline bool rxrpc_abort_call(const char *why
, struct rxrpc_call
*call
,
772 rxrpc_seq_t seq
, u32 abort_code
, int error
)
776 write_lock_bh(&call
->state_lock
);
777 ret
= __rxrpc_abort_call(why
, call
, seq
, abort_code
, error
);
778 write_unlock_bh(&call
->state_lock
);
783 * Abort a call due to a protocol error.
785 static inline bool __rxrpc_abort_eproto(struct rxrpc_call
*call
,
787 const char *eproto_why
,
791 struct rxrpc_skb_priv
*sp
= rxrpc_skb(skb
);
793 trace_rxrpc_rx_eproto(call
, sp
->hdr
.serial
, eproto_why
);
794 return rxrpc_abort_call(why
, call
, sp
->hdr
.seq
, abort_code
, -EPROTO
);
797 #define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
798 __rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
799 (abort_why), (abort_code))
804 extern unsigned int rxrpc_max_client_connections
;
805 extern unsigned int rxrpc_reap_client_connections
;
806 extern unsigned int rxrpc_conn_idle_client_expiry
;
807 extern unsigned int rxrpc_conn_idle_client_fast_expiry
;
808 extern struct idr rxrpc_client_conn_ids
;
810 void rxrpc_destroy_client_conn_ids(void);
811 int rxrpc_connect_call(struct rxrpc_call
*, struct rxrpc_conn_parameters
*,
812 struct sockaddr_rxrpc
*, gfp_t
);
813 void rxrpc_expose_client_call(struct rxrpc_call
*);
814 void rxrpc_disconnect_client_call(struct rxrpc_call
*);
815 void rxrpc_put_client_conn(struct rxrpc_connection
*);
816 void rxrpc_discard_expired_client_conns(struct work_struct
*);
817 void rxrpc_destroy_all_client_connections(struct rxrpc_net
*);
822 void rxrpc_process_connection(struct work_struct
*);
827 extern unsigned int rxrpc_connection_expiry
;
829 struct rxrpc_connection
*rxrpc_alloc_connection(gfp_t
);
830 struct rxrpc_connection
*rxrpc_find_connection_rcu(struct rxrpc_local
*,
832 void __rxrpc_disconnect_call(struct rxrpc_connection
*, struct rxrpc_call
*);
833 void rxrpc_disconnect_call(struct rxrpc_call
*);
834 void rxrpc_kill_connection(struct rxrpc_connection
*);
835 bool rxrpc_queue_conn(struct rxrpc_connection
*);
836 void rxrpc_see_connection(struct rxrpc_connection
*);
837 void rxrpc_get_connection(struct rxrpc_connection
*);
838 struct rxrpc_connection
*rxrpc_get_connection_maybe(struct rxrpc_connection
*);
839 void rxrpc_put_service_conn(struct rxrpc_connection
*);
840 void rxrpc_service_connection_reaper(struct work_struct
*);
841 void rxrpc_destroy_all_connections(struct rxrpc_net
*);
843 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection
*conn
)
845 return conn
->out_clientflag
;
848 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection
*conn
)
850 return !rxrpc_conn_is_client(conn
);
853 static inline void rxrpc_put_connection(struct rxrpc_connection
*conn
)
858 if (rxrpc_conn_is_client(conn
))
859 rxrpc_put_client_conn(conn
);
861 rxrpc_put_service_conn(conn
);
867 struct rxrpc_connection
*rxrpc_find_service_conn_rcu(struct rxrpc_peer
*,
869 struct rxrpc_connection
*rxrpc_prealloc_service_connection(struct rxrpc_net
*, gfp_t
);
870 void rxrpc_new_incoming_connection(struct rxrpc_sock
*,
871 struct rxrpc_connection
*, struct sk_buff
*);
872 void rxrpc_unpublish_service_conn(struct rxrpc_connection
*);
877 void rxrpc_data_ready(struct sock
*);
882 extern const struct rxrpc_security rxrpc_no_security
;
887 extern struct key_type key_type_rxrpc
;
888 extern struct key_type key_type_rxrpc_s
;
890 int rxrpc_request_key(struct rxrpc_sock
*, char __user
*, int);
891 int rxrpc_server_keyring(struct rxrpc_sock
*, char __user
*, int);
892 int rxrpc_get_server_data_key(struct rxrpc_connection
*, const void *, time64_t
,
898 extern void rxrpc_process_local_events(struct rxrpc_local
*);
903 struct rxrpc_local
*rxrpc_lookup_local(struct net
*, const struct sockaddr_rxrpc
*);
904 void __rxrpc_put_local(struct rxrpc_local
*);
905 void rxrpc_destroy_all_locals(struct rxrpc_net
*);
907 static inline void rxrpc_get_local(struct rxrpc_local
*local
)
909 atomic_inc(&local
->usage
);
913 struct rxrpc_local
*rxrpc_get_local_maybe(struct rxrpc_local
*local
)
915 return atomic_inc_not_zero(&local
->usage
) ? local
: NULL
;
918 static inline void rxrpc_put_local(struct rxrpc_local
*local
)
920 if (local
&& atomic_dec_and_test(&local
->usage
))
921 __rxrpc_put_local(local
);
924 static inline void rxrpc_queue_local(struct rxrpc_local
*local
)
926 rxrpc_queue_work(&local
->processor
);
932 extern unsigned int rxrpc_max_backlog __read_mostly
;
933 extern unsigned int rxrpc_requested_ack_delay
;
934 extern unsigned int rxrpc_soft_ack_delay
;
935 extern unsigned int rxrpc_idle_ack_delay
;
936 extern unsigned int rxrpc_rx_window_size
;
937 extern unsigned int rxrpc_rx_mtu
;
938 extern unsigned int rxrpc_rx_jumbo_max
;
939 extern unsigned int rxrpc_resend_timeout
;
941 extern const s8 rxrpc_ack_priority
[];
946 extern unsigned int rxrpc_net_id
;
947 extern struct pernet_operations rxrpc_net_ops
;
949 static inline struct rxrpc_net
*rxrpc_net(struct net
*net
)
951 return net_generic(net
, rxrpc_net_id
);
957 int rxrpc_send_ack_packet(struct rxrpc_call
*, bool);
958 int rxrpc_send_abort_packet(struct rxrpc_call
*);
959 int rxrpc_send_data_packet(struct rxrpc_call
*, struct sk_buff
*, bool);
960 void rxrpc_reject_packets(struct rxrpc_local
*);
965 void rxrpc_error_report(struct sock
*);
966 void rxrpc_peer_error_distributor(struct work_struct
*);
967 void rxrpc_peer_add_rtt(struct rxrpc_call
*, enum rxrpc_rtt_rx_trace
,
968 rxrpc_serial_t
, rxrpc_serial_t
, ktime_t
, ktime_t
);
973 struct rxrpc_peer
*rxrpc_lookup_peer_rcu(struct rxrpc_local
*,
974 const struct sockaddr_rxrpc
*);
975 struct rxrpc_peer
*rxrpc_lookup_peer(struct rxrpc_local
*,
976 struct sockaddr_rxrpc
*, gfp_t
);
977 struct rxrpc_peer
*rxrpc_alloc_peer(struct rxrpc_local
*, gfp_t
);
978 struct rxrpc_peer
*rxrpc_lookup_incoming_peer(struct rxrpc_local
*,
979 struct rxrpc_peer
*);
981 static inline struct rxrpc_peer
*rxrpc_get_peer(struct rxrpc_peer
*peer
)
983 atomic_inc(&peer
->usage
);
988 struct rxrpc_peer
*rxrpc_get_peer_maybe(struct rxrpc_peer
*peer
)
990 return atomic_inc_not_zero(&peer
->usage
) ? peer
: NULL
;
993 extern void __rxrpc_put_peer(struct rxrpc_peer
*peer
);
994 static inline void rxrpc_put_peer(struct rxrpc_peer
*peer
)
996 if (peer
&& atomic_dec_and_test(&peer
->usage
))
997 __rxrpc_put_peer(peer
);
1003 extern const struct file_operations rxrpc_call_seq_fops
;
1004 extern const struct file_operations rxrpc_connection_seq_fops
;
1009 void rxrpc_notify_socket(struct rxrpc_call
*);
1010 int rxrpc_recvmsg(struct socket
*, struct msghdr
*, size_t, int);
1016 extern const struct rxrpc_security rxkad
;
1022 int __init
rxrpc_init_security(void);
1023 void rxrpc_exit_security(void);
1024 int rxrpc_init_client_conn_security(struct rxrpc_connection
*);
1025 int rxrpc_init_server_conn_security(struct rxrpc_connection
*);
1030 int rxrpc_do_sendmsg(struct rxrpc_sock
*, struct msghdr
*, size_t);
1035 void rxrpc_kernel_data_consumed(struct rxrpc_call
*, struct sk_buff
*);
1036 void rxrpc_packet_destructor(struct sk_buff
*);
1037 void rxrpc_new_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1038 void rxrpc_see_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1039 void rxrpc_get_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1040 void rxrpc_free_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1041 void rxrpc_lose_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1042 void rxrpc_purge_queue(struct sk_buff_head
*);
1047 #ifdef CONFIG_SYSCTL
1048 extern int __init
rxrpc_sysctl_init(void);
1049 extern void rxrpc_sysctl_exit(void);
1051 static inline int __init
rxrpc_sysctl_init(void) { return 0; }
1052 static inline void rxrpc_sysctl_exit(void) {}
1058 int rxrpc_extract_addr_from_skb(struct rxrpc_local
*, struct sockaddr_rxrpc
*,
1061 static inline bool before(u32 seq1
, u32 seq2
)
1063 return (s32
)(seq1
- seq2
) < 0;
1065 static inline bool before_eq(u32 seq1
, u32 seq2
)
1067 return (s32
)(seq1
- seq2
) <= 0;
1069 static inline bool after(u32 seq1
, u32 seq2
)
1071 return (s32
)(seq1
- seq2
) > 0;
1073 static inline bool after_eq(u32 seq1
, u32 seq2
)
1075 return (s32
)(seq1
- seq2
) >= 0;
1081 extern unsigned int rxrpc_debug
;
1083 #define dbgprintk(FMT,...) \
1084 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1086 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1087 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1088 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1089 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1090 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1093 #if defined(__KDEBUG)
1094 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1095 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1096 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1097 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1098 #define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1100 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1101 #define RXRPC_DEBUG_KENTER 0x01
1102 #define RXRPC_DEBUG_KLEAVE 0x02
1103 #define RXRPC_DEBUG_KDEBUG 0x04
1104 #define RXRPC_DEBUG_KPROTO 0x08
1105 #define RXRPC_DEBUG_KNET 0x10
1107 #define _enter(FMT,...) \
1109 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1110 kenter(FMT,##__VA_ARGS__); \
1113 #define _leave(FMT,...) \
1115 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1116 kleave(FMT,##__VA_ARGS__); \
1119 #define _debug(FMT,...) \
1121 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1122 kdebug(FMT,##__VA_ARGS__); \
1125 #define _proto(FMT,...) \
1127 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1128 kproto(FMT,##__VA_ARGS__); \
1131 #define _net(FMT,...) \
1133 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1134 knet(FMT,##__VA_ARGS__); \
1138 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1139 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1140 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1141 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1142 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1146 * debug assertion checking
1148 #if 1 // defined(__KDEBUGALL)
1152 if (unlikely(!(X))) { \
1153 pr_err("Assertion failed\n"); \
1158 #define ASSERTCMP(X, OP, Y) \
1160 __typeof__(X) _x = (X); \
1161 __typeof__(Y) _y = (__typeof__(X))(Y); \
1162 if (unlikely(!(_x OP _y))) { \
1163 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1164 (unsigned long)_x, (unsigned long)_x, #OP, \
1165 (unsigned long)_y, (unsigned long)_y); \
1170 #define ASSERTIF(C, X) \
1172 if (unlikely((C) && !(X))) { \
1173 pr_err("Assertion failed\n"); \
1178 #define ASSERTIFCMP(C, X, OP, Y) \
1180 __typeof__(X) _x = (X); \
1181 __typeof__(Y) _y = (__typeof__(X))(Y); \
1182 if (unlikely((C) && !(_x OP _y))) { \
1183 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1184 (unsigned long)_x, (unsigned long)_x, #OP, \
1185 (unsigned long)_y, (unsigned long)_y); \
1196 #define ASSERTCMP(X, OP, Y) \
1200 #define ASSERTIF(C, X) \
1204 #define ASSERTIFCMP(C, X, OP, Y) \
1208 #endif /* __KDEBUGALL */