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>
18 #include <rxrpc/packet.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 */
306 * Keys for matching a connection.
308 struct rxrpc_conn_proto {
311 u32 epoch; /* epoch of this connection */
312 u32 cid; /* connection ID */
318 struct rxrpc_conn_parameters {
319 struct rxrpc_local *local; /* Representation of local endpoint */
320 struct rxrpc_peer *peer; /* Remote endpoint */
321 struct key *key; /* Security details */
322 bool exclusive; /* T if conn is exclusive */
323 bool upgrade; /* T if service ID can be upgraded */
324 u16 service_id; /* Service ID for this connection */
325 u32 security_level; /* Security level selected */
329 * Bits in the connection flags.
331 enum rxrpc_conn_flag {
332 RXRPC_CONN_HAS_IDR, /* Has a client conn ID assigned */
333 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
334 RXRPC_CONN_IN_CLIENT_CONNS, /* Conn is in local->client_conns */
335 RXRPC_CONN_EXPOSED, /* Conn has extra ref for exposure */
336 RXRPC_CONN_DONT_REUSE, /* Don't reuse this connection */
337 RXRPC_CONN_COUNTED, /* Counted by rxrpc_nr_client_conns */
338 RXRPC_CONN_PROBING_FOR_UPGRADE, /* Probing for service upgrade */
342 * Events that can be raised upon a connection.
344 enum rxrpc_conn_event {
345 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
349 * The connection cache state.
351 enum rxrpc_conn_cache_state {
352 RXRPC_CONN_CLIENT_INACTIVE, /* Conn is not yet listed */
353 RXRPC_CONN_CLIENT_WAITING, /* Conn is on wait list, waiting for capacity */
354 RXRPC_CONN_CLIENT_ACTIVE, /* Conn is on active list, doing calls */
355 RXRPC_CONN_CLIENT_UPGRADE, /* Conn is on active list, probing for upgrade */
356 RXRPC_CONN_CLIENT_CULLED, /* Conn is culled and delisted, doing calls */
357 RXRPC_CONN_CLIENT_IDLE, /* Conn is on idle list, doing mostly nothing */
358 RXRPC_CONN__NR_CACHE_STATES
362 * The connection protocol state.
364 enum rxrpc_conn_proto_state {
365 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
366 RXRPC_CONN_CLIENT, /* Client connection */
367 RXRPC_CONN_SERVICE_PREALLOC, /* Service connection preallocation */
368 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
369 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
370 RXRPC_CONN_SERVICE, /* Service secured connection */
371 RXRPC_CONN_REMOTELY_ABORTED, /* Conn aborted by peer */
372 RXRPC_CONN_LOCALLY_ABORTED, /* Conn aborted locally */
373 RXRPC_CONN__NR_STATES
377 * RxRPC connection definition
378 * - matched by { local, peer, epoch, conn_id, direction }
379 * - each connection can only handle four simultaneous calls
381 struct rxrpc_connection {
382 struct rxrpc_conn_proto proto;
383 struct rxrpc_conn_parameters params;
387 struct list_head cache_link;
389 spinlock_t channel_lock;
390 unsigned char active_chans; /* Mask of active channels */
391 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
392 struct list_head waiting_calls; /* Calls waiting for channels */
393 struct rxrpc_channel {
394 struct rxrpc_call __rcu *call; /* Active call */
395 u32 call_id; /* ID of current call */
396 u32 call_counter; /* Call ID counter */
397 u32 last_call; /* ID of last call */
398 u8 last_type; /* Type of last packet */
403 } channels[RXRPC_MAXCALLS];
405 struct work_struct processor; /* connection event processor */
407 struct rb_node client_node; /* Node in local->client_conns */
408 struct rb_node service_node; /* Node in peer->service_conns */
410 struct list_head proc_link; /* link in procfs list */
411 struct list_head link; /* link in master connection list */
412 struct sk_buff_head rx_queue; /* received conn-level packets */
413 const struct rxrpc_security *security; /* applied security module */
414 struct key *server_key; /* security for this service */
415 struct crypto_skcipher *cipher; /* encryption handle */
416 struct rxrpc_crypt csum_iv; /* packet checksum base */
418 unsigned long events;
419 unsigned long idle_timestamp; /* Time at which last became idle */
420 spinlock_t state_lock; /* state-change lock */
421 enum rxrpc_conn_cache_state cache_state;
422 enum rxrpc_conn_proto_state state; /* current state of connection */
423 u32 local_abort; /* local abort code */
424 u32 remote_abort; /* remote abort code */
425 int debug_id; /* debug ID for printks */
426 atomic_t serial; /* packet serial number counter */
427 unsigned int hi_serial; /* highest serial number received */
428 u32 security_nonce; /* response re-use preventer */
429 u16 service_id; /* Service ID, possibly upgraded */
430 u8 size_align; /* data size alignment (for security) */
431 u8 security_size; /* security header size */
432 u8 security_ix; /* security type */
433 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
437 * Flags in call->flags.
439 enum rxrpc_call_flag {
440 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
441 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
442 RXRPC_CALL_IS_SERVICE, /* Call is service call */
443 RXRPC_CALL_EXPOSED, /* The call was exposed to the world */
444 RXRPC_CALL_RX_LAST, /* Received the last packet (at rxtx_top) */
445 RXRPC_CALL_TX_LAST, /* Last packet in Tx buffer (at rxtx_top) */
446 RXRPC_CALL_SEND_PING, /* A ping will need to be sent */
447 RXRPC_CALL_PINGING, /* Ping in process */
448 RXRPC_CALL_RETRANS_TIMEOUT, /* Retransmission due to timeout occurred */
452 * Events that can be raised on a call.
454 enum rxrpc_call_event {
455 RXRPC_CALL_EV_ACK, /* need to generate ACK */
456 RXRPC_CALL_EV_ABORT, /* need to generate abort */
457 RXRPC_CALL_EV_TIMER, /* Timer expired */
458 RXRPC_CALL_EV_RESEND, /* Tx resend required */
459 RXRPC_CALL_EV_PING, /* Ping send required */
463 * The states that a call can be in.
465 enum rxrpc_call_state {
466 RXRPC_CALL_UNINITIALISED,
467 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
468 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
469 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
470 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
471 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
472 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
473 RXRPC_CALL_SERVER_ACCEPTING, /* - server accepting request */
474 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
475 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
476 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
477 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
478 RXRPC_CALL_COMPLETE, /* - call complete */
479 NR__RXRPC_CALL_STATES
483 * Call completion condition (state == RXRPC_CALL_COMPLETE).
485 enum rxrpc_call_completion {
486 RXRPC_CALL_SUCCEEDED, /* - Normal termination */
487 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
488 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
489 RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
490 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
491 NR__RXRPC_CALL_COMPLETIONS
495 * Call Tx congestion management modes.
497 enum rxrpc_congest_mode {
498 RXRPC_CALL_SLOW_START,
499 RXRPC_CALL_CONGEST_AVOIDANCE,
500 RXRPC_CALL_PACKET_LOSS,
501 RXRPC_CALL_FAST_RETRANSMIT,
502 NR__RXRPC_CONGEST_MODES
506 * RxRPC call definition
507 * - matched by { connection, call_id }
511 struct rxrpc_connection *conn; /* connection carrying call */
512 struct rxrpc_peer *peer; /* Peer record for remote address */
513 struct rxrpc_sock __rcu *socket; /* socket responsible */
514 struct mutex user_mutex; /* User access mutex */
515 ktime_t ack_at; /* When deferred ACK needs to happen */
516 ktime_t resend_at; /* When next resend needs to happen */
517 ktime_t ping_at; /* When next to send a ping */
518 ktime_t expire_at; /* When the call times out */
519 struct timer_list timer; /* Combined event timer */
520 struct work_struct processor; /* Event processor */
521 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
522 struct list_head link; /* link in master call list */
523 struct list_head chan_wait_link; /* Link in conn->waiting_calls */
524 struct hlist_node error_link; /* link in error distribution list */
525 struct list_head accept_link; /* Link in rx->acceptq */
526 struct list_head recvmsg_link; /* Link in rx->recvmsg_q */
527 struct list_head sock_link; /* Link in rx->sock_calls */
528 struct rb_node sock_node; /* Node in rx->calls */
529 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
530 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
531 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
532 unsigned long user_call_ID; /* user-defined call ID */
534 unsigned long events;
536 rwlock_t state_lock; /* lock for state transition */
537 u32 abort_code; /* Local/remote abort code */
538 int error; /* Local error incurred */
539 enum rxrpc_call_state state; /* current state of call */
540 enum rxrpc_call_completion completion; /* Call completion condition */
542 u16 service_id; /* service ID */
543 u8 security_ix; /* Security type */
544 u32 call_id; /* call ID on connection */
545 u32 cid; /* connection ID plus channel index */
546 int debug_id; /* debug ID for printks */
547 unsigned short rx_pkt_offset; /* Current recvmsg packet offset */
548 unsigned short rx_pkt_len; /* Current recvmsg packet len */
550 /* Rx/Tx circular buffer, depending on phase.
552 * In the Rx phase, packets are annotated with 0 or the number of the
553 * segment of a jumbo packet each buffer refers to. There can be up to
554 * 47 segments in a maximum-size UDP packet.
556 * In the Tx phase, packets are annotated with which buffers have been
559 #define RXRPC_RXTX_BUFF_SIZE 64
560 #define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
561 #define RXRPC_INIT_RX_WINDOW_SIZE 32
562 struct sk_buff **rxtx_buffer;
563 u8 *rxtx_annotations;
564 #define RXRPC_TX_ANNO_ACK 0
565 #define RXRPC_TX_ANNO_UNACK 1
566 #define RXRPC_TX_ANNO_NAK 2
567 #define RXRPC_TX_ANNO_RETRANS 3
568 #define RXRPC_TX_ANNO_MASK 0x03
569 #define RXRPC_TX_ANNO_LAST 0x04
570 #define RXRPC_TX_ANNO_RESENT 0x08
572 #define RXRPC_RX_ANNO_JUMBO 0x3f /* Jumbo subpacket number + 1 if not zero */
573 #define RXRPC_RX_ANNO_JLAST 0x40 /* Set if last element of a jumbo packet */
574 #define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
575 rxrpc_seq_t tx_hard_ack; /* Dead slot in buffer; the first transmitted but
576 * not hard-ACK'd packet follows this.
578 rxrpc_seq_t tx_top; /* Highest Tx slot allocated. */
580 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
581 * is fixed, we keep these numbers in terms of segments (ie. DATA
582 * packets) rather than bytes.
584 #define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
585 u8 cong_cwnd; /* Congestion window size */
586 u8 cong_extra; /* Extra to send for congestion management */
587 u8 cong_ssthresh; /* Slow-start threshold */
588 enum rxrpc_congest_mode cong_mode:8; /* Congestion management mode */
589 u8 cong_dup_acks; /* Count of ACKs showing missing packets */
590 u8 cong_cumul_acks; /* Cumulative ACK count */
591 ktime_t cong_tstamp; /* Last time cwnd was changed */
593 rxrpc_seq_t rx_hard_ack; /* Dead slot in buffer; the first received but not
594 * consumed packet follows this.
596 rxrpc_seq_t rx_top; /* Highest Rx slot allocated. */
597 rxrpc_seq_t rx_expect_next; /* Expected next packet sequence number */
598 u8 rx_winsize; /* Size of Rx window */
599 u8 tx_winsize; /* Maximum size of Tx window */
600 bool tx_phase; /* T if transmission phase, F if receive phase */
601 u8 nr_jumbo_bad; /* Number of jumbo dups/exceeds-windows */
603 /* receive-phase ACK management */
604 u8 ackr_reason; /* reason to ACK */
605 u16 ackr_skew; /* skew on packet being ACK'd */
606 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
607 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
608 rxrpc_seq_t ackr_consumed; /* Highest packet shown consumed */
609 rxrpc_seq_t ackr_seen; /* Highest packet shown seen */
611 /* ping management */
612 rxrpc_serial_t ping_serial; /* Last ping sent */
613 ktime_t ping_time; /* Time last ping sent */
615 /* transmission-phase ACK management */
616 ktime_t acks_latest_ts; /* Timestamp of latest ACK received */
617 rxrpc_serial_t acks_latest; /* serial number of latest ACK received */
618 rxrpc_seq_t acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
622 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
624 struct rxrpc_ack_summary {
626 u8 nr_acks; /* Number of ACKs in packet */
627 u8 nr_nacks; /* Number of NACKs in packet */
628 u8 nr_new_acks; /* Number of new ACKs in packet */
629 u8 nr_new_nacks; /* Number of new NACKs in packet */
630 u8 nr_rot_new_acks; /* Number of rotated new ACKs */
631 bool new_low_nack; /* T if new low NACK found */
632 bool retrans_timeo; /* T if reTx due to timeout happened */
633 u8 flight_size; /* Number of unreceived transmissions */
634 /* Place to stash values for tracing */
635 enum rxrpc_congest_mode mode:8;
642 #include <trace/events/rxrpc.h>
647 extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
648 extern atomic_t rxrpc_debug_id;
649 extern struct workqueue_struct *rxrpc_workqueue;
654 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
655 void rxrpc_discard_prealloc(struct rxrpc_sock *);
656 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
657 struct rxrpc_connection *,
659 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
660 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
662 int rxrpc_reject_call(struct rxrpc_sock *);
667 void __rxrpc_set_timer(struct rxrpc_call *, enum rxrpc_timer_trace, ktime_t);
668 void rxrpc_set_timer(struct rxrpc_call *, enum rxrpc_timer_trace, ktime_t);
669 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool, bool,
670 enum rxrpc_propose_ack_trace);
671 void rxrpc_process_call(struct work_struct *);
676 extern const char *const rxrpc_call_states[];
677 extern const char *const rxrpc_call_completions[];
678 extern unsigned int rxrpc_max_call_lifetime;
679 extern struct kmem_cache *rxrpc_call_jar;
681 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
682 struct rxrpc_call *rxrpc_alloc_call(gfp_t);
683 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
684 struct rxrpc_conn_parameters *,
685 struct sockaddr_rxrpc *,
686 unsigned long, gfp_t);
687 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
689 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
690 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
691 bool __rxrpc_queue_call(struct rxrpc_call *);
692 bool rxrpc_queue_call(struct rxrpc_call *);
693 void rxrpc_see_call(struct rxrpc_call *);
694 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
695 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
696 void rxrpc_cleanup_call(struct rxrpc_call *);
697 void rxrpc_destroy_all_calls(struct rxrpc_net *);
699 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
701 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
704 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
706 return !rxrpc_is_service_call(call);
710 * Transition a call to the complete state.
712 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
713 enum rxrpc_call_completion compl,
717 if (call->state < RXRPC_CALL_COMPLETE) {
718 call->abort_code = abort_code;
720 call->completion = compl,
721 call->state = RXRPC_CALL_COMPLETE;
722 wake_up(&call->waitq);
728 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
729 enum rxrpc_call_completion compl,
735 write_lock_bh(&call->state_lock);
736 ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
737 write_unlock_bh(&call->state_lock);
742 * Record that a call successfully completed.
744 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
746 return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
749 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
753 write_lock_bh(&call->state_lock);
754 ret = __rxrpc_call_completed(call);
755 write_unlock_bh(&call->state_lock);
760 * Record that a call is locally aborted.
762 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
764 u32 abort_code, int error)
766 trace_rxrpc_abort(why, call->cid, call->call_id, seq,
768 return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
772 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
773 rxrpc_seq_t seq, u32 abort_code, int error)
777 write_lock_bh(&call->state_lock);
778 ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
779 write_unlock_bh(&call->state_lock);
784 * Abort a call due to a protocol error.
786 static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
788 const char *eproto_why,
792 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
794 trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
795 return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
798 #define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
799 __rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
800 (abort_why), (abort_code))
805 extern unsigned int rxrpc_max_client_connections;
806 extern unsigned int rxrpc_reap_client_connections;
807 extern unsigned int rxrpc_conn_idle_client_expiry;
808 extern unsigned int rxrpc_conn_idle_client_fast_expiry;
809 extern struct idr rxrpc_client_conn_ids;
811 void rxrpc_destroy_client_conn_ids(void);
812 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
813 struct sockaddr_rxrpc *, gfp_t);
814 void rxrpc_expose_client_call(struct rxrpc_call *);
815 void rxrpc_disconnect_client_call(struct rxrpc_call *);
816 void rxrpc_put_client_conn(struct rxrpc_connection *);
817 void rxrpc_discard_expired_client_conns(struct work_struct *);
818 void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
823 void rxrpc_process_connection(struct work_struct *);
828 extern unsigned int rxrpc_connection_expiry;
830 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
831 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
832 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
834 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
835 void rxrpc_disconnect_call(struct rxrpc_call *);
836 void rxrpc_kill_connection(struct rxrpc_connection *);
837 bool rxrpc_queue_conn(struct rxrpc_connection *);
838 void rxrpc_see_connection(struct rxrpc_connection *);
839 void rxrpc_get_connection(struct rxrpc_connection *);
840 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
841 void rxrpc_put_service_conn(struct rxrpc_connection *);
842 void rxrpc_service_connection_reaper(struct work_struct *);
843 void rxrpc_destroy_all_connections(struct rxrpc_net *);
845 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
847 return conn->out_clientflag;
850 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
852 return !rxrpc_conn_is_client(conn);
855 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
860 if (rxrpc_conn_is_client(conn))
861 rxrpc_put_client_conn(conn);
863 rxrpc_put_service_conn(conn);
869 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
871 struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
872 void rxrpc_new_incoming_connection(struct rxrpc_sock *,
873 struct rxrpc_connection *, struct sk_buff *);
874 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
879 void rxrpc_data_ready(struct sock *);
884 extern const struct rxrpc_security rxrpc_no_security;
889 extern struct key_type key_type_rxrpc;
890 extern struct key_type key_type_rxrpc_s;
892 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
893 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
894 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
900 extern void rxrpc_process_local_events(struct rxrpc_local *);
905 struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
906 void __rxrpc_put_local(struct rxrpc_local *);
907 void rxrpc_destroy_all_locals(struct rxrpc_net *);
909 static inline void rxrpc_get_local(struct rxrpc_local *local)
911 atomic_inc(&local->usage);
915 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
917 return atomic_inc_not_zero(&local->usage) ? local : NULL;
920 static inline void rxrpc_put_local(struct rxrpc_local *local)
922 if (local && atomic_dec_and_test(&local->usage))
923 __rxrpc_put_local(local);
926 static inline void rxrpc_queue_local(struct rxrpc_local *local)
928 rxrpc_queue_work(&local->processor);
934 extern unsigned int rxrpc_max_backlog __read_mostly;
935 extern unsigned int rxrpc_requested_ack_delay;
936 extern unsigned int rxrpc_soft_ack_delay;
937 extern unsigned int rxrpc_idle_ack_delay;
938 extern unsigned int rxrpc_rx_window_size;
939 extern unsigned int rxrpc_rx_mtu;
940 extern unsigned int rxrpc_rx_jumbo_max;
941 extern unsigned int rxrpc_resend_timeout;
943 extern const s8 rxrpc_ack_priority[];
948 extern unsigned int rxrpc_net_id;
949 extern struct pernet_operations rxrpc_net_ops;
951 static inline struct rxrpc_net *rxrpc_net(struct net *net)
953 return net_generic(net, rxrpc_net_id);
959 int rxrpc_send_ack_packet(struct rxrpc_call *, bool);
960 int rxrpc_send_abort_packet(struct rxrpc_call *);
961 int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
962 void rxrpc_reject_packets(struct rxrpc_local *);
967 void rxrpc_error_report(struct sock *);
968 void rxrpc_peer_error_distributor(struct work_struct *);
969 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace,
970 rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
975 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
976 const struct sockaddr_rxrpc *);
977 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
978 struct sockaddr_rxrpc *, gfp_t);
979 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
980 struct rxrpc_peer *rxrpc_lookup_incoming_peer(struct rxrpc_local *,
981 struct rxrpc_peer *);
983 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
985 atomic_inc(&peer->usage);
990 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
992 return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
995 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
996 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
998 if (peer && atomic_dec_and_test(&peer->usage))
999 __rxrpc_put_peer(peer);
1005 extern const struct file_operations rxrpc_call_seq_fops;
1006 extern const struct file_operations rxrpc_connection_seq_fops;
1011 void rxrpc_notify_socket(struct rxrpc_call *);
1012 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1018 extern const struct rxrpc_security rxkad;
1024 int __init rxrpc_init_security(void);
1025 void rxrpc_exit_security(void);
1026 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1027 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
1032 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1037 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1038 void rxrpc_packet_destructor(struct sk_buff *);
1039 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1040 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1041 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1042 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1043 void rxrpc_lose_skb(struct sk_buff *, enum rxrpc_skb_trace);
1044 void rxrpc_purge_queue(struct sk_buff_head *);
1049 #ifdef CONFIG_SYSCTL
1050 extern int __init rxrpc_sysctl_init(void);
1051 extern void rxrpc_sysctl_exit(void);
1053 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1054 static inline void rxrpc_sysctl_exit(void) {}
1060 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1062 static inline bool before(u32 seq1, u32 seq2)
1064 return (s32)(seq1 - seq2) < 0;
1066 static inline bool before_eq(u32 seq1, u32 seq2)
1068 return (s32)(seq1 - seq2) <= 0;
1070 static inline bool after(u32 seq1, u32 seq2)
1072 return (s32)(seq1 - seq2) > 0;
1074 static inline bool after_eq(u32 seq1, u32 seq2)
1076 return (s32)(seq1 - seq2) >= 0;
1082 extern unsigned int rxrpc_debug;
1084 #define dbgprintk(FMT,...) \
1085 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1087 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1088 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1089 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1090 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1091 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1094 #if defined(__KDEBUG)
1095 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1096 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1097 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1098 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1099 #define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1101 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1102 #define RXRPC_DEBUG_KENTER 0x01
1103 #define RXRPC_DEBUG_KLEAVE 0x02
1104 #define RXRPC_DEBUG_KDEBUG 0x04
1105 #define RXRPC_DEBUG_KPROTO 0x08
1106 #define RXRPC_DEBUG_KNET 0x10
1108 #define _enter(FMT,...) \
1110 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1111 kenter(FMT,##__VA_ARGS__); \
1114 #define _leave(FMT,...) \
1116 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1117 kleave(FMT,##__VA_ARGS__); \
1120 #define _debug(FMT,...) \
1122 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1123 kdebug(FMT,##__VA_ARGS__); \
1126 #define _proto(FMT,...) \
1128 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1129 kproto(FMT,##__VA_ARGS__); \
1132 #define _net(FMT,...) \
1134 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1135 knet(FMT,##__VA_ARGS__); \
1139 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1140 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1141 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1142 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1143 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1147 * debug assertion checking
1149 #if 1 // defined(__KDEBUGALL)
1153 if (unlikely(!(X))) { \
1154 pr_err("Assertion failed\n"); \
1159 #define ASSERTCMP(X, OP, Y) \
1161 __typeof__(X) _x = (X); \
1162 __typeof__(Y) _y = (__typeof__(X))(Y); \
1163 if (unlikely(!(_x OP _y))) { \
1164 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1165 (unsigned long)_x, (unsigned long)_x, #OP, \
1166 (unsigned long)_y, (unsigned long)_y); \
1171 #define ASSERTIF(C, X) \
1173 if (unlikely((C) && !(X))) { \
1174 pr_err("Assertion failed\n"); \
1179 #define ASSERTIFCMP(C, X, OP, Y) \
1181 __typeof__(X) _x = (X); \
1182 __typeof__(Y) _y = (__typeof__(X))(Y); \
1183 if (unlikely((C) && !(_x OP _y))) { \
1184 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1185 (unsigned long)_x, (unsigned long)_x, #OP, \
1186 (unsigned long)_y, (unsigned long)_y); \
1197 #define ASSERTCMP(X, OP, Y) \
1201 #define ASSERTIF(C, X) \
1205 #define ASSERTIFCMP(C, X, OP, Y) \
1209 #endif /* __KDEBUGALL */