net/rxrpc/ar-internal.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /* AF_RXRPC internal definitions
   3  *
   4  * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
   5  * Written by David Howells (dhowells@redhat.com)
   6  */
   7
   8 #include <linux/atomic.h>
   9 #include <linux/seqlock.h>
  10 #include <linux/win_minmax.h>
  11 #include <net/net_namespace.h>
  12 #include <net/netns/generic.h>
  13 #include <net/sock.h>
  14 #include <net/af_rxrpc.h>
  15 #include <keys/rxrpc-type.h>
  16 #include "protocol.h"
  17
  18 #define FCRYPT_BSIZE 8
  19 struct rxrpc_crypt {
  20         union {
  21                 u8      x[FCRYPT_BSIZE];
  22                 __be32  n[2];
  23         };
  24 } __attribute__((aligned(8)));
  25
  26 #define rxrpc_queue_work(WS)    queue_work(rxrpc_workqueue, (WS))
  27 #define rxrpc_queue_delayed_work(WS,D)  \
  28         queue_delayed_work(rxrpc_workqueue, (WS), (D))
  29
  30 struct key_preparsed_payload;
  31 struct rxrpc_connection;
  32 struct rxrpc_txbuf;
  33
  34 /*
  35  * Mark applied to socket buffers in skb->mark.  skb->priority is used
  36  * to pass supplementary information.
  37  */
  38 enum rxrpc_skb_mark {
  39         RXRPC_SKB_MARK_PACKET,          /* Received packet */
  40         RXRPC_SKB_MARK_ERROR,           /* Error notification */
  41         RXRPC_SKB_MARK_REJECT_BUSY,     /* Reject with BUSY */
  42         RXRPC_SKB_MARK_REJECT_ABORT,    /* Reject with ABORT (code in skb->priority) */
  43 };
  44
  45 /*
  46  * sk_state for RxRPC sockets
  47  */
  48 enum {
  49         RXRPC_UNBOUND = 0,
  50         RXRPC_CLIENT_UNBOUND,           /* Unbound socket used as client */
  51         RXRPC_CLIENT_BOUND,             /* client local address bound */
  52         RXRPC_SERVER_BOUND,             /* server local address bound */
  53         RXRPC_SERVER_BOUND2,            /* second server local address bound */
  54         RXRPC_SERVER_LISTENING,         /* server listening for connections */
  55         RXRPC_SERVER_LISTEN_DISABLED,   /* server listening disabled */
  56         RXRPC_CLOSE,                    /* socket is being closed */
  57 };
  58
  59 /*
  60  * Per-network namespace data.
  61  */
  62 struct rxrpc_net {
  63         struct proc_dir_entry   *proc_net;      /* Subdir in /proc/net */
  64         u32                     epoch;          /* Local epoch for detecting local-end reset */
  65         struct list_head        calls;          /* List of calls active in this namespace */
  66         spinlock_t              call_lock;      /* Lock for ->calls */
  67         atomic_t                nr_calls;       /* Count of allocated calls */
  68
  69         atomic_t                nr_conns;
  70         struct list_head        conn_proc_list; /* List of conns in this namespace for proc */
  71         struct list_head        service_conns;  /* Service conns in this namespace */
  72         rwlock_t                conn_lock;      /* Lock for ->conn_proc_list, ->service_conns */
  73         struct work_struct      service_conn_reaper;
  74         struct timer_list       service_conn_reap_timer;
  75
  76         bool                    live;
  77
  78         bool                    kill_all_client_conns;
  79         atomic_t                nr_client_conns;
  80         spinlock_t              client_conn_cache_lock; /* Lock for ->*_client_conns */
  81         struct mutex            client_conn_discard_lock; /* Prevent multiple discarders */
  82         struct list_head        idle_client_conns;
  83         struct work_struct      client_conn_reaper;
  84         struct timer_list       client_conn_reap_timer;
  85
  86         struct hlist_head       local_endpoints;
  87         struct mutex            local_mutex;    /* Lock for ->local_endpoints */
  88
  89         DECLARE_HASHTABLE       (peer_hash, 10);
  90         spinlock_t              peer_hash_lock; /* Lock for ->peer_hash */
  91
  92 #define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
  93         u8                      peer_keepalive_cursor;
  94         time64_t                peer_keepalive_base;
  95         struct list_head        peer_keepalive[32];
  96         struct list_head        peer_keepalive_new;
  97         struct timer_list       peer_keepalive_timer;
  98         struct work_struct      peer_keepalive_work;
  99
 100         atomic_t                stat_tx_data;
 101         atomic_t                stat_tx_data_retrans;
 102         atomic_t                stat_tx_data_send;
 103         atomic_t                stat_tx_data_send_frag;
 104         atomic_t                stat_rx_data;
 105         atomic_t                stat_rx_data_reqack;
 106         atomic_t                stat_rx_data_jumbo;
 107
 108         atomic_t                stat_tx_ack_fill;
 109         atomic_t                stat_tx_ack_send;
 110         atomic_t                stat_tx_ack_skip;
 111         atomic_t                stat_tx_acks[256];
 112         atomic_t                stat_rx_acks[256];
 113
 114         atomic_t                stat_why_req_ack[8];
 115
 116         atomic_t                stat_io_loop;
 117 };
 118
 119 /*
 120  * Service backlog preallocation.
 121  *
 122  * This contains circular buffers of preallocated peers, connections and calls
 123  * for incoming service calls and their head and tail pointers.  This allows
 124  * calls to be set up in the data_ready handler, thereby avoiding the need to
 125  * shuffle packets around so much.
 126  */
 127 struct rxrpc_backlog {
 128         unsigned short          peer_backlog_head;
 129         unsigned short          peer_backlog_tail;
 130         unsigned short          conn_backlog_head;
 131         unsigned short          conn_backlog_tail;
 132         unsigned short          call_backlog_head;
 133         unsigned short          call_backlog_tail;
 134 #define RXRPC_BACKLOG_MAX       32
 135         struct rxrpc_peer       *peer_backlog[RXRPC_BACKLOG_MAX];
 136         struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
 137         struct rxrpc_call       *call_backlog[RXRPC_BACKLOG_MAX];
 138 };
 139
 140 /*
 141  * RxRPC socket definition
 142  */
 143 struct rxrpc_sock {
 144         /* WARNING: sk has to be the first member */
 145         struct sock             sk;
 146         rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
 147         rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
 148         struct rxrpc_local      *local;         /* local endpoint */
 149         struct rxrpc_backlog    *backlog;       /* Preallocation for services */
 150         spinlock_t              incoming_lock;  /* Incoming call vs service shutdown lock */
 151         struct list_head        sock_calls;     /* List of calls owned by this socket */
 152         struct list_head        to_be_accepted; /* calls awaiting acceptance */
 153         struct list_head        recvmsg_q;      /* Calls awaiting recvmsg's attention  */
 154         rwlock_t                recvmsg_lock;   /* Lock for recvmsg_q */
 155         struct key              *key;           /* security for this socket */
 156         struct key              *securities;    /* list of server security descriptors */
 157         struct rb_root          calls;          /* User ID -> call mapping */
 158         unsigned long           flags;
 159 #define RXRPC_SOCK_CONNECTED            0       /* connect_srx is set */
 160         rwlock_t                call_lock;      /* lock for calls */
 161         u32                     min_sec_level;  /* minimum security level */
 162 #define RXRPC_SECURITY_MAX      RXRPC_SECURITY_ENCRYPT
 163         bool                    exclusive;      /* Exclusive connection for a client socket */
 164         u16                     second_service; /* Additional service bound to the endpoint */
 165         struct {
 166                 /* Service upgrade information */
 167                 u16             from;           /* Service ID to upgrade (if not 0) */
 168                 u16             to;             /* service ID to upgrade to */
 169         } service_upgrade;
 170         sa_family_t             family;         /* Protocol family created with */
 171         struct sockaddr_rxrpc   srx;            /* Primary Service/local addresses */
 172         struct sockaddr_rxrpc   connect_srx;    /* Default client address from connect() */
 173 };
 174
 175 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
 176
 177 /*
 178  * CPU-byteorder normalised Rx packet header.
 179  */
 180 struct rxrpc_host_header {
 181         u32             epoch;          /* client boot timestamp */
 182         u32             cid;            /* connection and channel ID */
 183         u32             callNumber;     /* call ID (0 for connection-level packets) */
 184         u32             seq;            /* sequence number of pkt in call stream */
 185         u32             serial;         /* serial number of pkt sent to network */
 186         u8              type;           /* packet type */
 187         u8              flags;          /* packet flags */
 188         u8              userStatus;     /* app-layer defined status */
 189         u8              securityIndex;  /* security protocol ID */
 190         union {
 191                 u16     _rsvd;          /* reserved */
 192                 u16     cksum;          /* kerberos security checksum */
 193         };
 194         u16             serviceId;      /* service ID */
 195 } __packed;
 196
 197 /*
 198  * RxRPC socket buffer private variables
 199  * - max 48 bytes (struct sk_buff::cb)
 200  */
 201 struct rxrpc_skb_priv {
 202         u16             offset;         /* Offset of data */
 203         u16             len;            /* Length of data */
 204         u8              flags;
 205 #define RXRPC_RX_VERIFIED       0x01
 206
 207         struct rxrpc_host_header hdr;   /* RxRPC packet header from this packet */
 208 };
 209
 210 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
 211
 212 /*
 213  * RxRPC security module interface
 214  */
 215 struct rxrpc_security {
 216         const char              *name;          /* name of this service */
 217         u8                      security_index; /* security type provided */
 218         u32                     no_key_abort;   /* Abort code indicating no key */
 219
 220         /* Initialise a security service */
 221         int (*init)(void);
 222
 223         /* Clean up a security service */
 224         void (*exit)(void);
 225
 226         /* Parse the information from a server key */
 227         int (*preparse_server_key)(struct key_preparsed_payload *);
 228
 229         /* Clean up the preparse buffer after parsing a server key */
 230         void (*free_preparse_server_key)(struct key_preparsed_payload *);
 231
 232         /* Destroy the payload of a server key */
 233         void (*destroy_server_key)(struct key *);
 234
 235         /* Describe a server key */
 236         void (*describe_server_key)(const struct key *, struct seq_file *);
 237
 238         /* initialise a connection's security */
 239         int (*init_connection_security)(struct rxrpc_connection *,
 240                                         struct rxrpc_key_token *);
 241
 242         /* Work out how much data we can store in a packet, given an estimate
 243          * of the amount of data remaining.
 244          */
 245         int (*how_much_data)(struct rxrpc_call *, size_t,
 246                              size_t *, size_t *, size_t *);
 247
 248         /* impose security on a packet */
 249         int (*secure_packet)(struct rxrpc_call *, struct rxrpc_txbuf *);
 250
 251         /* verify the security on a received packet */
 252         int (*verify_packet)(struct rxrpc_call *, struct sk_buff *);
 253
 254         /* Free crypto request on a call */
 255         void (*free_call_crypto)(struct rxrpc_call *);
 256
 257         /* issue a challenge */
 258         int (*issue_challenge)(struct rxrpc_connection *);
 259
 260         /* respond to a challenge */
 261         int (*respond_to_challenge)(struct rxrpc_connection *,
 262                                     struct sk_buff *,
 263                                     u32 *);
 264
 265         /* verify a response */
 266         int (*verify_response)(struct rxrpc_connection *,
 267                                struct sk_buff *,
 268                                u32 *);
 269
 270         /* clear connection security */
 271         void (*clear)(struct rxrpc_connection *);
 272 };
 273
 274 /*
 275  * RxRPC local transport endpoint description
 276  * - owned by a single AF_RXRPC socket
 277  * - pointed to by transport socket struct sk_user_data
 278  */
 279 struct rxrpc_local {
 280         struct rcu_head         rcu;
 281         atomic_t                active_users;   /* Number of users of the local endpoint */
 282         refcount_t              ref;            /* Number of references to the structure */
 283         struct rxrpc_net        *rxnet;         /* The network ns in which this resides */
 284         struct hlist_node       link;
 285         struct socket           *socket;        /* my UDP socket */
 286         struct task_struct      *io_thread;
 287         struct list_head        ack_tx_queue;   /* List of ACKs that need sending */
 288         spinlock_t              ack_tx_lock;    /* ACK list lock */
 289         struct rxrpc_sock __rcu *service;       /* Service(s) listening on this endpoint */
 290         struct rw_semaphore     defrag_sem;     /* control re-enablement of IP DF bit */
 291         struct sk_buff_head     rx_queue;       /* Received packets */
 292         struct list_head        call_attend_q;  /* Calls requiring immediate attention */
 293         struct rb_root          client_bundles; /* Client connection bundles by socket params */
 294         spinlock_t              client_bundles_lock; /* Lock for client_bundles */
 295         spinlock_t              lock;           /* access lock */
 296         rwlock_t                services_lock;  /* lock for services list */
 297         int                     debug_id;       /* debug ID for printks */
 298         bool                    dead;
 299         bool                    service_closed; /* Service socket closed */
 300         struct sockaddr_rxrpc   srx;            /* local address */
 301 };
 302
 303 /*
 304  * RxRPC remote transport endpoint definition
 305  * - matched by local endpoint, remote port, address and protocol type
 306  */
 307 struct rxrpc_peer {
 308         struct rcu_head         rcu;            /* This must be first */
 309         refcount_t              ref;
 310         unsigned long           hash_key;
 311         struct hlist_node       hash_link;
 312         struct rxrpc_local      *local;
 313         struct hlist_head       error_targets;  /* targets for net error distribution */
 314         struct rb_root          service_conns;  /* Service connections */
 315         struct list_head        keepalive_link; /* Link in net->peer_keepalive[] */
 316         time64_t                last_tx_at;     /* Last time packet sent here */
 317         seqlock_t               service_conn_lock;
 318         spinlock_t              lock;           /* access lock */
 319         unsigned int            if_mtu;         /* interface MTU for this peer */
 320         unsigned int            mtu;            /* network MTU for this peer */
 321         unsigned int            maxdata;        /* data size (MTU - hdrsize) */
 322         unsigned short          hdrsize;        /* header size (IP + UDP + RxRPC) */
 323         int                     debug_id;       /* debug ID for printks */
 324         struct sockaddr_rxrpc   srx;            /* remote address */
 325
 326         /* calculated RTT cache */
 327 #define RXRPC_RTT_CACHE_SIZE 32
 328         spinlock_t              rtt_input_lock; /* RTT lock for input routine */
 329         ktime_t                 rtt_last_req;   /* Time of last RTT request */
 330         unsigned int            rtt_count;      /* Number of samples we've got */
 331
 332         u32                     srtt_us;        /* smoothed round trip time << 3 in usecs */
 333         u32                     mdev_us;        /* medium deviation                     */
 334         u32                     mdev_max_us;    /* maximal mdev for the last rtt period */
 335         u32                     rttvar_us;      /* smoothed mdev_max                    */
 336         u32                     rto_j;          /* Retransmission timeout in jiffies */
 337         u8                      backoff;        /* Backoff timeout */
 338
 339         u8                      cong_ssthresh;  /* Congestion slow-start threshold */
 340 };
 341
 342 /*
 343  * Keys for matching a connection.
 344  */
 345 struct rxrpc_conn_proto {
 346         union {
 347                 struct {
 348                         u32     epoch;          /* epoch of this connection */
 349                         u32     cid;            /* connection ID */
 350                 };
 351                 u64             index_key;
 352         };
 353 };
 354
 355 struct rxrpc_conn_parameters {
 356         struct rxrpc_local      *local;         /* Representation of local endpoint */
 357         struct rxrpc_peer       *peer;          /* Remote endpoint */
 358         struct key              *key;           /* Security details */
 359         bool                    exclusive;      /* T if conn is exclusive */
 360         bool                    upgrade;        /* T if service ID can be upgraded */
 361         u16                     service_id;     /* Service ID for this connection */
 362         u32                     security_level; /* Security level selected */
 363 };
 364
 365 /*
 366  * Bits in the connection flags.
 367  */
 368 enum rxrpc_conn_flag {
 369         RXRPC_CONN_HAS_IDR,             /* Has a client conn ID assigned */
 370         RXRPC_CONN_IN_SERVICE_CONNS,    /* Conn is in peer->service_conns */
 371         RXRPC_CONN_DONT_REUSE,          /* Don't reuse this connection */
 372         RXRPC_CONN_PROBING_FOR_UPGRADE, /* Probing for service upgrade */
 373         RXRPC_CONN_FINAL_ACK_0,         /* Need final ACK for channel 0 */
 374         RXRPC_CONN_FINAL_ACK_1,         /* Need final ACK for channel 1 */
 375         RXRPC_CONN_FINAL_ACK_2,         /* Need final ACK for channel 2 */
 376         RXRPC_CONN_FINAL_ACK_3,         /* Need final ACK for channel 3 */
 377 };
 378
 379 #define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) |    \
 380                                    (1UL << RXRPC_CONN_FINAL_ACK_1) |    \
 381                                    (1UL << RXRPC_CONN_FINAL_ACK_2) |    \
 382                                    (1UL << RXRPC_CONN_FINAL_ACK_3))
 383
 384 /*
 385  * Events that can be raised upon a connection.
 386  */
 387 enum rxrpc_conn_event {
 388         RXRPC_CONN_EV_CHALLENGE,        /* Send challenge packet */
 389 };
 390
 391 /*
 392  * The connection protocol state.
 393  */
 394 enum rxrpc_conn_proto_state {
 395         RXRPC_CONN_UNUSED,              /* Connection not yet attempted */
 396         RXRPC_CONN_CLIENT,              /* Client connection */
 397         RXRPC_CONN_SERVICE_PREALLOC,    /* Service connection preallocation */
 398         RXRPC_CONN_SERVICE_UNSECURED,   /* Service unsecured connection */
 399         RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
 400         RXRPC_CONN_SERVICE,             /* Service secured connection */
 401         RXRPC_CONN_REMOTELY_ABORTED,    /* Conn aborted by peer */
 402         RXRPC_CONN_LOCALLY_ABORTED,     /* Conn aborted locally */
 403         RXRPC_CONN__NR_STATES
 404 };
 405
 406 /*
 407  * RxRPC client connection bundle.
 408  */
 409 struct rxrpc_bundle {
 410         struct rxrpc_local      *local;         /* Representation of local endpoint */
 411         struct rxrpc_peer       *peer;          /* Remote endpoint */
 412         struct key              *key;           /* Security details */
 413         refcount_t              ref;
 414         atomic_t                active;         /* Number of active users */
 415         unsigned int            debug_id;
 416         u32                     security_level; /* Security level selected */
 417         u16                     service_id;     /* Service ID for this connection */
 418         bool                    try_upgrade;    /* True if the bundle is attempting upgrade */
 419         bool                    alloc_conn;     /* True if someone's getting a conn */
 420         bool                    exclusive;      /* T if conn is exclusive */
 421         bool                    upgrade;        /* T if service ID can be upgraded */
 422         short                   alloc_error;    /* Error from last conn allocation */
 423         spinlock_t              channel_lock;
 424         struct rb_node          local_node;     /* Node in local->client_conns */
 425         struct list_head        waiting_calls;  /* Calls waiting for channels */
 426         unsigned long           avail_chans;    /* Mask of available channels */
 427         struct rxrpc_connection *conns[4];      /* The connections in the bundle (max 4) */
 428 };
 429
 430 /*
 431  * RxRPC connection definition
 432  * - matched by { local, peer, epoch, conn_id, direction }
 433  * - each connection can only handle four simultaneous calls
 434  */
 435 struct rxrpc_connection {
 436         struct rxrpc_conn_proto proto;
 437         struct rxrpc_local      *local;         /* Representation of local endpoint */
 438         struct rxrpc_peer       *peer;          /* Remote endpoint */
 439         struct rxrpc_net        *rxnet;         /* Network namespace to which call belongs */
 440         struct key              *key;           /* Security details */
 441
 442         refcount_t              ref;
 443         atomic_t                active;         /* Active count for service conns */
 444         struct rcu_head         rcu;
 445         struct list_head        cache_link;
 446
 447         unsigned char           act_chans;      /* Mask of active channels */
 448         struct rxrpc_channel {
 449                 unsigned long           final_ack_at;   /* Time at which to issue final ACK */
 450                 struct rxrpc_call __rcu *call;          /* Active call */
 451                 unsigned int            call_debug_id;  /* call->debug_id */
 452                 u32                     call_id;        /* ID of current call */
 453                 u32                     call_counter;   /* Call ID counter */
 454                 u32                     last_call;      /* ID of last call */
 455                 u8                      last_type;      /* Type of last packet */
 456                 union {
 457                         u32             last_seq;
 458                         u32             last_abort;
 459                 };
 460         } channels[RXRPC_MAXCALLS];
 461
 462         struct timer_list       timer;          /* Conn event timer */
 463         struct work_struct      processor;      /* connection event processor */
 464         struct work_struct      destructor;     /* In-process-context destroyer */
 465         struct rxrpc_bundle     *bundle;        /* Client connection bundle */
 466         struct rb_node          service_node;   /* Node in peer->service_conns */
 467         struct list_head        proc_link;      /* link in procfs list */
 468         struct list_head        link;           /* link in master connection list */
 469         struct sk_buff_head     rx_queue;       /* received conn-level packets */
 470
 471         const struct rxrpc_security *security;  /* applied security module */
 472         union {
 473                 struct {
 474                         struct crypto_sync_skcipher *cipher;    /* encryption handle */
 475                         struct rxrpc_crypt csum_iv;     /* packet checksum base */
 476                         u32     nonce;          /* response re-use preventer */
 477                 } rxkad;
 478         };
 479         unsigned long           flags;
 480         unsigned long           events;
 481         unsigned long           idle_timestamp; /* Time at which last became idle */
 482         spinlock_t              state_lock;     /* state-change lock */
 483         enum rxrpc_conn_proto_state state;      /* current state of connection */
 484         u32                     abort_code;     /* Abort code of connection abort */
 485         int                     debug_id;       /* debug ID for printks */
 486         atomic_t                serial;         /* packet serial number counter */
 487         unsigned int            hi_serial;      /* highest serial number received */
 488         u32                     service_id;     /* Service ID, possibly upgraded */
 489         u32                     security_level; /* Security level selected */
 490         u8                      security_ix;    /* security type */
 491         u8                      out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
 492         u8                      bundle_shift;   /* Index into bundle->avail_chans */
 493         bool                    exclusive;      /* T if conn is exclusive */
 494         bool                    upgrade;        /* T if service ID can be upgraded */
 495         u16                     orig_service_id; /* Originally requested service ID */
 496         short                   error;          /* Local error code */
 497 };
 498
 499 static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
 500 {
 501         return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
 502 }
 503
 504 static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
 505 {
 506         return !rxrpc_to_server(sp);
 507 }
 508
 509 /*
 510  * Flags in call->flags.
 511  */
 512 enum rxrpc_call_flag {
 513         RXRPC_CALL_RELEASED,            /* call has been released - no more message to userspace */
 514         RXRPC_CALL_HAS_USERID,          /* has a user ID attached */
 515         RXRPC_CALL_IS_SERVICE,          /* Call is service call */
 516         RXRPC_CALL_EXPOSED,             /* The call was exposed to the world */
 517         RXRPC_CALL_RX_LAST,             /* Received the last packet (at rxtx_top) */
 518         RXRPC_CALL_TX_LAST,             /* Last packet in Tx buffer (at rxtx_top) */
 519         RXRPC_CALL_TX_ALL_ACKED,        /* Last packet has been hard-acked */
 520         RXRPC_CALL_SEND_PING,           /* A ping will need to be sent */
 521         RXRPC_CALL_RETRANS_TIMEOUT,     /* Retransmission due to timeout occurred */
 522         RXRPC_CALL_BEGAN_RX_TIMER,      /* We began the expect_rx_by timer */
 523         RXRPC_CALL_RX_HEARD,            /* The peer responded at least once to this call */
 524         RXRPC_CALL_DISCONNECTED,        /* The call has been disconnected */
 525         RXRPC_CALL_KERNEL,              /* The call was made by the kernel */
 526         RXRPC_CALL_UPGRADE,             /* Service upgrade was requested for the call */
 527         RXRPC_CALL_EXCLUSIVE,           /* The call uses a once-only connection */
 528         RXRPC_CALL_RX_IS_IDLE,          /* Reception is idle - send an ACK */
 529 };
 530
 531 /*
 532  * Events that can be raised on a call.
 533  */
 534 enum rxrpc_call_event {
 535         RXRPC_CALL_EV_ACK_LOST,         /* ACK may be lost, send ping */
 536         RXRPC_CALL_EV_INITIAL_PING,     /* Send initial ping for a new service call */
 537 };
 538
 539 /*
 540  * The states that a call can be in.
 541  */
 542 enum rxrpc_call_state {
 543         RXRPC_CALL_UNINITIALISED,
 544         RXRPC_CALL_CLIENT_AWAIT_CONN,   /* - client waiting for connection to become available */
 545         RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
 546         RXRPC_CALL_CLIENT_AWAIT_REPLY,  /* - client awaiting reply */
 547         RXRPC_CALL_CLIENT_RECV_REPLY,   /* - client receiving reply phase */
 548         RXRPC_CALL_SERVER_PREALLOC,     /* - service preallocation */
 549         RXRPC_CALL_SERVER_SECURING,     /* - server securing request connection */
 550         RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
 551         RXRPC_CALL_SERVER_ACK_REQUEST,  /* - server pending ACK of request */
 552         RXRPC_CALL_SERVER_SEND_REPLY,   /* - server sending reply */
 553         RXRPC_CALL_SERVER_AWAIT_ACK,    /* - server awaiting final ACK */
 554         RXRPC_CALL_COMPLETE,            /* - call complete */
 555         NR__RXRPC_CALL_STATES
 556 };
 557
 558 /*
 559  * Call completion condition (state == RXRPC_CALL_COMPLETE).
 560  */
 561 enum rxrpc_call_completion {
 562         RXRPC_CALL_SUCCEEDED,           /* - Normal termination */
 563         RXRPC_CALL_REMOTELY_ABORTED,    /* - call aborted by peer */
 564         RXRPC_CALL_LOCALLY_ABORTED,     /* - call aborted locally on error or close */
 565         RXRPC_CALL_LOCAL_ERROR,         /* - call failed due to local error */
 566         RXRPC_CALL_NETWORK_ERROR,       /* - call terminated by network error */
 567         NR__RXRPC_CALL_COMPLETIONS
 568 };
 569
 570 /*
 571  * Call Tx congestion management modes.
 572  */
 573 enum rxrpc_congest_mode {
 574         RXRPC_CALL_SLOW_START,
 575         RXRPC_CALL_CONGEST_AVOIDANCE,
 576         RXRPC_CALL_PACKET_LOSS,
 577         RXRPC_CALL_FAST_RETRANSMIT,
 578         NR__RXRPC_CONGEST_MODES
 579 };
 580
 581 /*
 582  * RxRPC call definition
 583  * - matched by { connection, call_id }
 584  */
 585 struct rxrpc_call {
 586         struct rcu_head         rcu;
 587         struct rxrpc_connection *conn;          /* connection carrying call */
 588         struct rxrpc_peer       *peer;          /* Peer record for remote address */
 589         struct rxrpc_local      *local;         /* Representation of local endpoint */
 590         struct rxrpc_sock __rcu *socket;        /* socket responsible */
 591         struct rxrpc_net        *rxnet;         /* Network namespace to which call belongs */
 592         struct key              *key;           /* Security details */
 593         const struct rxrpc_security *security;  /* applied security module */
 594         struct mutex            user_mutex;     /* User access mutex */
 595         struct sockaddr_rxrpc   dest_srx;       /* Destination address */
 596         unsigned long           delay_ack_at;   /* When DELAY ACK needs to happen */
 597         unsigned long           ack_lost_at;    /* When ACK is figured as lost */
 598         unsigned long           resend_at;      /* When next resend needs to happen */
 599         unsigned long           ping_at;        /* When next to send a ping */
 600         unsigned long           keepalive_at;   /* When next to send a keepalive ping */
 601         unsigned long           expect_rx_by;   /* When we expect to get a packet by */
 602         unsigned long           expect_req_by;  /* When we expect to get a request DATA packet by */
 603         unsigned long           expect_term_by; /* When we expect call termination by */
 604         u32                     next_rx_timo;   /* Timeout for next Rx packet (jif) */
 605         u32                     next_req_timo;  /* Timeout for next Rx request packet (jif) */
 606         struct timer_list       timer;          /* Combined event timer */
 607         struct work_struct      destroyer;      /* In-process-context destroyer */
 608         rxrpc_notify_rx_t       notify_rx;      /* kernel service Rx notification function */
 609         struct list_head        link;           /* link in master call list */
 610         struct list_head        chan_wait_link; /* Link in conn->bundle->waiting_calls */
 611         struct hlist_node       error_link;     /* link in error distribution list */
 612         struct list_head        accept_link;    /* Link in rx->acceptq */
 613         struct list_head        recvmsg_link;   /* Link in rx->recvmsg_q */
 614         struct list_head        sock_link;      /* Link in rx->sock_calls */
 615         struct rb_node          sock_node;      /* Node in rx->calls */
 616         struct list_head        attend_link;    /* Link in local->call_attend_q */
 617         struct rxrpc_txbuf      *tx_pending;    /* Tx buffer being filled */
 618         wait_queue_head_t       waitq;          /* Wait queue for channel or Tx */
 619         s64                     tx_total_len;   /* Total length left to be transmitted (or -1) */
 620         unsigned long           user_call_ID;   /* user-defined call ID */
 621         unsigned long           flags;
 622         unsigned long           events;
 623         spinlock_t              notify_lock;    /* Kernel notification lock */
 624         rwlock_t                state_lock;     /* lock for state transition */
 625         u32                     abort_code;     /* Local/remote abort code */
 626         int                     error;          /* Local error incurred */
 627         enum rxrpc_call_state   state;          /* current state of call */
 628         enum rxrpc_call_completion completion;  /* Call completion condition */
 629         refcount_t              ref;
 630         u8                      security_ix;    /* Security type */
 631         enum rxrpc_interruptibility interruptibility; /* At what point call may be interrupted */
 632         u32                     call_id;        /* call ID on connection  */
 633         u32                     cid;            /* connection ID plus channel index */
 634         u32                     security_level; /* Security level selected */
 635         int                     debug_id;       /* debug ID for printks */
 636         unsigned short          rx_pkt_offset;  /* Current recvmsg packet offset */
 637         unsigned short          rx_pkt_len;     /* Current recvmsg packet len */
 638
 639         /* Transmitted data tracking. */
 640         spinlock_t              tx_lock;        /* Transmit queue lock */
 641         struct list_head        tx_sendmsg;     /* Sendmsg prepared packets */
 642         struct list_head        tx_buffer;      /* Buffer of transmissible packets */
 643         rxrpc_seq_t             tx_bottom;      /* First packet in buffer */
 644         rxrpc_seq_t             tx_transmitted; /* Highest packet transmitted */
 645         rxrpc_seq_t             tx_prepared;    /* Highest Tx slot prepared. */
 646         rxrpc_seq_t             tx_top;         /* Highest Tx slot allocated. */
 647         u16                     tx_backoff;     /* Delay to insert due to Tx failure */
 648         u8                      tx_winsize;     /* Maximum size of Tx window */
 649 #define RXRPC_TX_MAX_WINDOW     128
 650         ktime_t                 tx_last_sent;   /* Last time a transmission occurred */
 651
 652         /* Received data tracking */
 653         struct sk_buff_head     recvmsg_queue;  /* Queue of packets ready for recvmsg() */
 654         struct sk_buff_head     rx_oos_queue;   /* Queue of out of sequence packets */
 655
 656         rxrpc_seq_t             rx_highest_seq; /* Higest sequence number received */
 657         rxrpc_seq_t             rx_consumed;    /* Highest packet consumed */
 658         rxrpc_serial_t          rx_serial;      /* Highest serial received for this call */
 659         u8                      rx_winsize;     /* Size of Rx window */
 660
 661         /* TCP-style slow-start congestion control [RFC5681].  Since the SMSS
 662          * is fixed, we keep these numbers in terms of segments (ie. DATA
 663          * packets) rather than bytes.
 664          */
 665 #define RXRPC_TX_SMSS           RXRPC_JUMBO_DATALEN
 666         u8                      cong_cwnd;      /* Congestion window size */
 667         u8                      cong_extra;     /* Extra to send for congestion management */
 668         u8                      cong_ssthresh;  /* Slow-start threshold */
 669         enum rxrpc_congest_mode cong_mode:8;    /* Congestion management mode */
 670         u8                      cong_dup_acks;  /* Count of ACKs showing missing packets */
 671         u8                      cong_cumul_acks; /* Cumulative ACK count */
 672         ktime_t                 cong_tstamp;    /* Last time cwnd was changed */
 673
 674         /* Receive-phase ACK management (ACKs we send). */
 675         u8                      ackr_reason;    /* reason to ACK */
 676         rxrpc_serial_t          ackr_serial;    /* serial of packet being ACK'd */
 677         atomic64_t              ackr_window;    /* Base (in LSW) and top (in MSW) of SACK window */
 678         atomic_t                ackr_nr_unacked; /* Number of unacked packets */
 679         atomic_t                ackr_nr_consumed; /* Number of packets needing hard ACK */
 680         struct {
 681 #define RXRPC_SACK_SIZE 256
 682                  /* SACK table for soft-acked packets */
 683                 u8              ackr_sack_table[RXRPC_SACK_SIZE];
 684         } __aligned(8);
 685
 686         /* RTT management */
 687         rxrpc_serial_t          rtt_serial[4];  /* Serial number of DATA or PING sent */
 688         ktime_t                 rtt_sent_at[4]; /* Time packet sent */
 689         unsigned long           rtt_avail;      /* Mask of available slots in bits 0-3,
 690                                                  * Mask of pending samples in 8-11 */
 691 #define RXRPC_CALL_RTT_AVAIL_MASK       0xf
 692 #define RXRPC_CALL_RTT_PEND_SHIFT       8
 693
 694         /* Transmission-phase ACK management (ACKs we've received). */
 695         ktime_t                 acks_latest_ts; /* Timestamp of latest ACK received */
 696         rxrpc_seq_t             acks_first_seq; /* first sequence number received */
 697         rxrpc_seq_t             acks_prev_seq;  /* Highest previousPacket received */
 698         rxrpc_seq_t             acks_hard_ack;  /* Latest hard-ack point */
 699         rxrpc_seq_t             acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
 700         rxrpc_serial_t          acks_highest_serial; /* Highest serial number ACK'd */
 701 };
 702
 703 /*
 704  * Summary of a new ACK and the changes it made to the Tx buffer packet states.
 705  */
 706 struct rxrpc_ack_summary {
 707         u16                     nr_acks;                /* Number of ACKs in packet */
 708         u16                     nr_new_acks;            /* Number of new ACKs in packet */
 709         u16                     nr_rot_new_acks;        /* Number of rotated new ACKs */
 710         u8                      ack_reason;
 711         bool                    saw_nacks;              /* Saw NACKs in packet */
 712         bool                    new_low_nack;           /* T if new low NACK found */
 713         bool                    retrans_timeo;          /* T if reTx due to timeout happened */
 714         u8                      flight_size;            /* Number of unreceived transmissions */
 715         /* Place to stash values for tracing */
 716         enum rxrpc_congest_mode mode:8;
 717         u8                      cwnd;
 718         u8                      ssthresh;
 719         u8                      dup_acks;
 720         u8                      cumulative_acks;
 721 };
 722
 723 /*
 724  * sendmsg() cmsg-specified parameters.
 725  */
 726 enum rxrpc_command {
 727         RXRPC_CMD_SEND_DATA,            /* send data message */
 728         RXRPC_CMD_SEND_ABORT,           /* request abort generation */
 729         RXRPC_CMD_REJECT_BUSY,          /* [server] reject a call as busy */
 730         RXRPC_CMD_CHARGE_ACCEPT,        /* [server] charge accept preallocation */
 731 };
 732
 733 struct rxrpc_call_params {
 734         s64                     tx_total_len;   /* Total Tx data length (if send data) */
 735         unsigned long           user_call_ID;   /* User's call ID */
 736         struct {
 737                 u32             hard;           /* Maximum lifetime (sec) */
 738                 u32             idle;           /* Max time since last data packet (msec) */
 739                 u32             normal;         /* Max time since last call packet (msec) */
 740         } timeouts;
 741         u8                      nr_timeouts;    /* Number of timeouts specified */
 742         bool                    kernel;         /* T if kernel is making the call */
 743         enum rxrpc_interruptibility interruptibility; /* How is interruptible is the call? */
 744 };
 745
 746 struct rxrpc_send_params {
 747         struct rxrpc_call_params call;
 748         u32                     abort_code;     /* Abort code to Tx (if abort) */
 749         enum rxrpc_command      command : 8;    /* The command to implement */
 750         bool                    exclusive;      /* Shared or exclusive call */
 751         bool                    upgrade;        /* If the connection is upgradeable */
 752 };
 753
 754 /*
 755  * Buffer of data to be output as a packet.
 756  */
 757 struct rxrpc_txbuf {
 758         struct rcu_head         rcu;
 759         struct list_head        call_link;      /* Link in call->tx_sendmsg/tx_buffer */
 760         struct list_head        tx_link;        /* Link in live Enc queue or Tx queue */
 761         struct rxrpc_call       *call;          /* Call to which belongs */
 762         ktime_t                 last_sent;      /* Time at which last transmitted */
 763         refcount_t              ref;
 764         rxrpc_seq_t             seq;            /* Sequence number of this packet */
 765         unsigned int            call_debug_id;
 766         unsigned int            debug_id;
 767         unsigned int            len;            /* Amount of data in buffer */
 768         unsigned int            space;          /* Remaining data space */
 769         unsigned int            offset;         /* Offset of fill point */
 770         unsigned long           flags;
 771 #define RXRPC_TXBUF_LAST        0               /* Set if last packet in Tx phase */
 772 #define RXRPC_TXBUF_RESENT      1               /* Set if has been resent */
 773         u8 /*enum rxrpc_propose_ack_trace*/ ack_why;    /* If ack, why */
 774         struct {
 775                 /* The packet for encrypting and DMA'ing.  We align it such
 776                  * that data[] aligns correctly for any crypto blocksize.
 777                  */
 778                 u8              pad[64 - sizeof(struct rxrpc_wire_header)];
 779                 struct rxrpc_wire_header wire;  /* Network-ready header */
 780                 union {
 781                         u8      data[RXRPC_JUMBO_DATALEN]; /* Data packet */
 782                         struct {
 783                                 struct rxrpc_ackpacket ack;
 784                                 u8 acks[0];
 785                         };
 786                 };
 787         } __aligned(64);
 788 };
 789
 790 static inline bool rxrpc_sending_to_server(const struct rxrpc_txbuf *txb)
 791 {
 792         return txb->wire.flags & RXRPC_CLIENT_INITIATED;
 793 }
 794
 795 static inline bool rxrpc_sending_to_client(const struct rxrpc_txbuf *txb)
 796 {
 797         return !rxrpc_sending_to_server(txb);
 798 }
 799
 800 #include <trace/events/rxrpc.h>
 801
 802 /*
 803  * af_rxrpc.c
 804  */
 805 extern atomic_t rxrpc_n_rx_skbs;
 806 extern struct workqueue_struct *rxrpc_workqueue;
 807
 808 /*
 809  * call_accept.c
 810  */
 811 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
 812 void rxrpc_discard_prealloc(struct rxrpc_sock *);
 813 bool rxrpc_new_incoming_call(struct rxrpc_local *, struct rxrpc_peer *,
 814                              struct rxrpc_connection *, struct sockaddr_rxrpc *,
 815                              struct sk_buff *);
 816 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
 817 int rxrpc_user_charge_accept(struct rxrpc_sock *, unsigned long);
 818
 819 /*
 820  * call_event.c
 821  */
 822 void rxrpc_propose_ping(struct rxrpc_call *call, u32 serial,
 823                         enum rxrpc_propose_ack_trace why);
 824 void rxrpc_send_ACK(struct rxrpc_call *, u8, rxrpc_serial_t, enum rxrpc_propose_ack_trace);
 825 void rxrpc_propose_delay_ACK(struct rxrpc_call *, rxrpc_serial_t,
 826                              enum rxrpc_propose_ack_trace);
 827 void rxrpc_shrink_call_tx_buffer(struct rxrpc_call *);
 828 void rxrpc_resend(struct rxrpc_call *call, struct sk_buff *ack_skb);
 829
 830 void rxrpc_reduce_call_timer(struct rxrpc_call *call,
 831                              unsigned long expire_at,
 832                              unsigned long now,
 833                              enum rxrpc_timer_trace why);
 834
 835 void rxrpc_input_call_event(struct rxrpc_call *call, struct sk_buff *skb);
 836
 837 /*
 838  * call_object.c
 839  */
 840 extern const char *const rxrpc_call_states[];
 841 extern const char *const rxrpc_call_completions[];
 842 extern struct kmem_cache *rxrpc_call_jar;
 843
 844 void rxrpc_poke_call(struct rxrpc_call *call, enum rxrpc_call_poke_trace what);
 845 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
 846 struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
 847 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
 848                                          struct rxrpc_conn_parameters *,
 849                                          struct sockaddr_rxrpc *,
 850                                          struct rxrpc_call_params *, gfp_t,
 851                                          unsigned int);
 852 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
 853                          struct sk_buff *);
 854 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
 855 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
 856 void rxrpc_see_call(struct rxrpc_call *, enum rxrpc_call_trace);
 857 struct rxrpc_call *rxrpc_try_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
 858 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
 859 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
 860 void rxrpc_cleanup_call(struct rxrpc_call *);
 861 void rxrpc_destroy_all_calls(struct rxrpc_net *);
 862
 863 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
 864 {
 865         return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
 866 }
 867
 868 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
 869 {
 870         return !rxrpc_is_service_call(call);
 871 }
 872
 873 /*
 874  * conn_client.c
 875  */
 876 extern unsigned int rxrpc_reap_client_connections;
 877 extern unsigned long rxrpc_conn_idle_client_expiry;
 878 extern unsigned long rxrpc_conn_idle_client_fast_expiry;
 879 extern struct idr rxrpc_client_conn_ids;
 880
 881 void rxrpc_destroy_client_conn_ids(void);
 882 struct rxrpc_bundle *rxrpc_get_bundle(struct rxrpc_bundle *, enum rxrpc_bundle_trace);
 883 void rxrpc_put_bundle(struct rxrpc_bundle *, enum rxrpc_bundle_trace);
 884 int rxrpc_connect_call(struct rxrpc_sock *, struct rxrpc_call *,
 885                        struct rxrpc_conn_parameters *, struct sockaddr_rxrpc *,
 886                        gfp_t);
 887 void rxrpc_expose_client_call(struct rxrpc_call *);
 888 void rxrpc_disconnect_client_call(struct rxrpc_bundle *, struct rxrpc_call *);
 889 void rxrpc_put_client_conn(struct rxrpc_connection *, enum rxrpc_conn_trace);
 890 void rxrpc_discard_expired_client_conns(struct work_struct *);
 891 void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
 892 void rxrpc_clean_up_local_conns(struct rxrpc_local *);
 893
 894 /*
 895  * conn_event.c
 896  */
 897 void rxrpc_process_connection(struct work_struct *);
 898 void rxrpc_process_delayed_final_acks(struct rxrpc_connection *, bool);
 899 int rxrpc_input_conn_packet(struct rxrpc_connection *conn, struct sk_buff *skb);
 900
 901 /*
 902  * conn_object.c
 903  */
 904 extern unsigned int rxrpc_connection_expiry;
 905 extern unsigned int rxrpc_closed_conn_expiry;
 906
 907 struct rxrpc_connection *rxrpc_alloc_connection(struct rxrpc_net *, gfp_t);
 908 struct rxrpc_connection *rxrpc_find_client_connection_rcu(struct rxrpc_local *,
 909                                                           struct sockaddr_rxrpc *,
 910                                                           struct sk_buff *);
 911 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
 912 void rxrpc_disconnect_call(struct rxrpc_call *);
 913 void rxrpc_kill_client_conn(struct rxrpc_connection *);
 914 void rxrpc_queue_conn(struct rxrpc_connection *, enum rxrpc_conn_trace);
 915 void rxrpc_see_connection(struct rxrpc_connection *, enum rxrpc_conn_trace);
 916 struct rxrpc_connection *rxrpc_get_connection(struct rxrpc_connection *,
 917                                               enum rxrpc_conn_trace);
 918 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *,
 919                                                     enum rxrpc_conn_trace);
 920 void rxrpc_put_connection(struct rxrpc_connection *, enum rxrpc_conn_trace);
 921 void rxrpc_service_connection_reaper(struct work_struct *);
 922 void rxrpc_destroy_all_connections(struct rxrpc_net *);
 923
 924 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
 925 {
 926         return conn->out_clientflag;
 927 }
 928
 929 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
 930 {
 931         return !rxrpc_conn_is_client(conn);
 932 }
 933
 934 static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
 935                                            unsigned long expire_at)
 936 {
 937         timer_reduce(&conn->timer, expire_at);
 938 }
 939
 940 /*
 941  * conn_service.c
 942  */
 943 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
 944                                                      struct sk_buff *);
 945 struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
 946 void rxrpc_new_incoming_connection(struct rxrpc_sock *, struct rxrpc_connection *,
 947                                    const struct rxrpc_security *, struct sk_buff *);
 948 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
 949
 950 /*
 951  * input.c
 952  */
 953 void rxrpc_input_call_packet(struct rxrpc_call *, struct sk_buff *);
 954 void rxrpc_implicit_end_call(struct rxrpc_call *, struct sk_buff *);
 955
 956 /*
 957  * io_thread.c
 958  */
 959 int rxrpc_encap_rcv(struct sock *, struct sk_buff *);
 960 void rxrpc_error_report(struct sock *);
 961 int rxrpc_io_thread(void *data);
 962 static inline void rxrpc_wake_up_io_thread(struct rxrpc_local *local)
 963 {
 964         wake_up_process(local->io_thread);
 965 }
 966
 967 /*
 968  * insecure.c
 969  */
 970 extern const struct rxrpc_security rxrpc_no_security;
 971
 972 /*
 973  * key.c
 974  */
 975 extern struct key_type key_type_rxrpc;
 976
 977 int rxrpc_request_key(struct rxrpc_sock *, sockptr_t , int);
 978 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
 979                               u32);
 980
 981 /*
 982  * local_event.c
 983  */
 984 void rxrpc_send_version_request(struct rxrpc_local *local,
 985                                 struct rxrpc_host_header *hdr,
 986                                 struct sk_buff *skb);
 987
 988 /*
 989  * local_object.c
 990  */
 991 struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
 992 struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *, enum rxrpc_local_trace);
 993 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *, enum rxrpc_local_trace);
 994 void rxrpc_put_local(struct rxrpc_local *, enum rxrpc_local_trace);
 995 struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *, enum rxrpc_local_trace);
 996 void rxrpc_unuse_local(struct rxrpc_local *, enum rxrpc_local_trace);
 997 void rxrpc_destroy_local(struct rxrpc_local *local);
 998 void rxrpc_destroy_all_locals(struct rxrpc_net *);
 999
1000 static inline bool __rxrpc_unuse_local(struct rxrpc_local *local,
1001                                        enum rxrpc_local_trace why)
1002 {
1003         unsigned int debug_id = local->debug_id;
1004         int r, u;
1005
1006         r = refcount_read(&local->ref);
1007         u = atomic_dec_return(&local->active_users);
1008         trace_rxrpc_local(debug_id, why, r, u);
1009         return u == 0;
1010 }
1011
1012 static inline bool __rxrpc_use_local(struct rxrpc_local *local,
1013                                      enum rxrpc_local_trace why)
1014 {
1015         int r, u;
1016
1017         r = refcount_read(&local->ref);
1018         u = atomic_fetch_add_unless(&local->active_users, 1, 0);
1019         trace_rxrpc_local(local->debug_id, why, r, u);
1020         return u != 0;
1021 }
1022
1023 static inline void rxrpc_see_local(struct rxrpc_local *local,
1024                                    enum rxrpc_local_trace why)
1025 {
1026         int r, u;
1027
1028         r = refcount_read(&local->ref);
1029         u = atomic_read(&local->active_users);
1030         trace_rxrpc_local(local->debug_id, why, r, u);
1031 }
1032
1033 /*
1034  * misc.c
1035  */
1036 extern unsigned int rxrpc_max_backlog __read_mostly;
1037 extern unsigned long rxrpc_soft_ack_delay;
1038 extern unsigned long rxrpc_idle_ack_delay;
1039 extern unsigned int rxrpc_rx_window_size;
1040 extern unsigned int rxrpc_rx_mtu;
1041 extern unsigned int rxrpc_rx_jumbo_max;
1042
1043 /*
1044  * net_ns.c
1045  */
1046 extern unsigned int rxrpc_net_id;
1047 extern struct pernet_operations rxrpc_net_ops;
1048
1049 static inline struct rxrpc_net *rxrpc_net(struct net *net)
1050 {
1051         return net_generic(net, rxrpc_net_id);
1052 }
1053
1054 /*
1055  * output.c
1056  */
1057 void rxrpc_transmit_ack_packets(struct rxrpc_local *);
1058 int rxrpc_send_abort_packet(struct rxrpc_call *);
1059 int rxrpc_send_data_packet(struct rxrpc_call *, struct rxrpc_txbuf *);
1060 void rxrpc_reject_packet(struct rxrpc_local *local, struct sk_buff *skb);
1061 void rxrpc_send_keepalive(struct rxrpc_peer *);
1062 void rxrpc_transmit_one(struct rxrpc_call *call, struct rxrpc_txbuf *txb);
1063
1064 /*
1065  * peer_event.c
1066  */
1067 void rxrpc_input_error(struct rxrpc_local *, struct sk_buff *);
1068 void rxrpc_peer_keepalive_worker(struct work_struct *);
1069
1070 /*
1071  * peer_object.c
1072  */
1073 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1074                                          const struct sockaddr_rxrpc *);
1075 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_sock *, struct rxrpc_local *,
1076                                      struct sockaddr_rxrpc *, gfp_t);
1077 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t,
1078                                     enum rxrpc_peer_trace);
1079 void rxrpc_new_incoming_peer(struct rxrpc_sock *, struct rxrpc_local *,
1080                              struct rxrpc_peer *);
1081 void rxrpc_destroy_all_peers(struct rxrpc_net *);
1082 struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *, enum rxrpc_peer_trace);
1083 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *, enum rxrpc_peer_trace);
1084 void rxrpc_put_peer(struct rxrpc_peer *, enum rxrpc_peer_trace);
1085 void rxrpc_put_peer_locked(struct rxrpc_peer *, enum rxrpc_peer_trace);
1086
1087 /*
1088  * proc.c
1089  */
1090 extern const struct seq_operations rxrpc_call_seq_ops;
1091 extern const struct seq_operations rxrpc_connection_seq_ops;
1092 extern const struct seq_operations rxrpc_peer_seq_ops;
1093 extern const struct seq_operations rxrpc_local_seq_ops;
1094
1095 /*
1096  * recvmsg.c
1097  */
1098 void rxrpc_notify_socket(struct rxrpc_call *);
1099 bool __rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1100 bool rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1101 bool __rxrpc_call_completed(struct rxrpc_call *);
1102 bool rxrpc_call_completed(struct rxrpc_call *);
1103 bool __rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1104 bool rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1105 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1106
1107 /*
1108  * Abort a call due to a protocol error.
1109  */
1110 static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
1111                                         struct sk_buff *skb,
1112                                         const char *eproto_why,
1113                                         const char *why,
1114                                         u32 abort_code)
1115 {
1116         struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
1117
1118         trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
1119         return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
1120 }
1121
1122 #define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
1123         __rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
1124                              (abort_why), (abort_code))
1125
1126 /*
1127  * rtt.c
1128  */
1129 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace, int,
1130                         rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1131 unsigned long rxrpc_get_rto_backoff(struct rxrpc_peer *, bool);
1132 void rxrpc_peer_init_rtt(struct rxrpc_peer *);
1133
1134 /*
1135  * rxkad.c
1136  */
1137 #ifdef CONFIG_RXKAD
1138 extern const struct rxrpc_security rxkad;
1139 #endif
1140
1141 /*
1142  * security.c
1143  */
1144 int __init rxrpc_init_security(void);
1145 const struct rxrpc_security *rxrpc_security_lookup(u8);
1146 void rxrpc_exit_security(void);
1147 int rxrpc_init_client_call_security(struct rxrpc_call *);
1148 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1149 const struct rxrpc_security *rxrpc_get_incoming_security(struct rxrpc_sock *,
1150                                                          struct sk_buff *);
1151 struct key *rxrpc_look_up_server_security(struct rxrpc_connection *,
1152                                           struct sk_buff *, u32, u32);
1153
1154 /*
1155  * sendmsg.c
1156  */
1157 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1158
1159 /*
1160  * server_key.c
1161  */
1162 extern struct key_type key_type_rxrpc_s;
1163
1164 int rxrpc_server_keyring(struct rxrpc_sock *, sockptr_t, int);
1165
1166 /*
1167  * skbuff.c
1168  */
1169 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1170 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1171 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1172 void rxrpc_eaten_skb(struct sk_buff *, enum rxrpc_skb_trace);
1173 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1174 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1175 void rxrpc_purge_queue(struct sk_buff_head *);
1176
1177 /*
1178  * stats.c
1179  */
1180 int rxrpc_stats_show(struct seq_file *seq, void *v);
1181 int rxrpc_stats_clear(struct file *file, char *buf, size_t size);
1182
1183 #define rxrpc_inc_stat(rxnet, s) atomic_inc(&(rxnet)->s)
1184 #define rxrpc_dec_stat(rxnet, s) atomic_dec(&(rxnet)->s)
1185
1186 /*
1187  * sysctl.c
1188  */
1189 #ifdef CONFIG_SYSCTL
1190 extern int __init rxrpc_sysctl_init(void);
1191 extern void rxrpc_sysctl_exit(void);
1192 #else
1193 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1194 static inline void rxrpc_sysctl_exit(void) {}
1195 #endif
1196
1197 /*
1198  * txbuf.c
1199  */
1200 extern atomic_t rxrpc_nr_txbuf;
1201 struct rxrpc_txbuf *rxrpc_alloc_txbuf(struct rxrpc_call *call, u8 packet_type,
1202                                       gfp_t gfp);
1203 void rxrpc_get_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1204 void rxrpc_see_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1205 void rxrpc_put_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1206
1207 /*
1208  * utils.c
1209  */
1210 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1211
1212 static inline bool before(u32 seq1, u32 seq2)
1213 {
1214         return (s32)(seq1 - seq2) < 0;
1215 }
1216 static inline bool before_eq(u32 seq1, u32 seq2)
1217 {
1218         return (s32)(seq1 - seq2) <= 0;
1219 }
1220 static inline bool after(u32 seq1, u32 seq2)
1221 {
1222         return (s32)(seq1 - seq2) > 0;
1223 }
1224 static inline bool after_eq(u32 seq1, u32 seq2)
1225 {
1226         return (s32)(seq1 - seq2) >= 0;
1227 }
1228
1229 /*
1230  * debug tracing
1231  */
1232 extern unsigned int rxrpc_debug;
1233
1234 #define dbgprintk(FMT,...) \
1235         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1236
1237 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1238 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1239 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1240
1241
1242 #if defined(__KDEBUG)
1243 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1244 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1245 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1246
1247 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1248 #define RXRPC_DEBUG_KENTER      0x01
1249 #define RXRPC_DEBUG_KLEAVE      0x02
1250 #define RXRPC_DEBUG_KDEBUG      0x04
1251
1252 #define _enter(FMT,...)                                 \
1253 do {                                                    \
1254         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1255                 kenter(FMT,##__VA_ARGS__);              \
1256 } while (0)
1257
1258 #define _leave(FMT,...)                                 \
1259 do {                                                    \
1260         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1261                 kleave(FMT,##__VA_ARGS__);              \
1262 } while (0)
1263
1264 #define _debug(FMT,...)                                 \
1265 do {                                                    \
1266         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1267                 kdebug(FMT,##__VA_ARGS__);              \
1268 } while (0)
1269
1270 #else
1271 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1272 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1273 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1274 #endif
1275
1276 /*
1277  * debug assertion checking
1278  */
1279 #if 1 // defined(__KDEBUGALL)
1280
1281 #define ASSERT(X)                                               \
1282 do {                                                            \
1283         if (unlikely(!(X))) {                                   \
1284                 pr_err("Assertion failed\n");                   \
1285                 BUG();                                          \
1286         }                                                       \
1287 } while (0)
1288
1289 #define ASSERTCMP(X, OP, Y)                                             \
1290 do {                                                                    \
1291         __typeof__(X) _x = (X);                                         \
1292         __typeof__(Y) _y = (__typeof__(X))(Y);                          \
1293         if (unlikely(!(_x OP _y))) {                                    \
1294                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1295                        (unsigned long)_x, (unsigned long)_x, #OP,       \
1296                        (unsigned long)_y, (unsigned long)_y);           \
1297                 BUG();                                                  \
1298         }                                                               \
1299 } while (0)
1300
1301 #define ASSERTIF(C, X)                                          \
1302 do {                                                            \
1303         if (unlikely((C) && !(X))) {                            \
1304                 pr_err("Assertion failed\n");                   \
1305                 BUG();                                          \
1306         }                                                       \
1307 } while (0)
1308
1309 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1310 do {                                                                    \
1311         __typeof__(X) _x = (X);                                         \
1312         __typeof__(Y) _y = (__typeof__(X))(Y);                          \
1313         if (unlikely((C) && !(_x OP _y))) {                             \
1314                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1315                        (unsigned long)_x, (unsigned long)_x, #OP,       \
1316                        (unsigned long)_y, (unsigned long)_y);           \
1317                 BUG();                                                  \
1318         }                                                               \
1319 } while (0)
1320
1321 #else
1322
1323 #define ASSERT(X)                               \
1324 do {                                            \
1325 } while (0)
1326
1327 #define ASSERTCMP(X, OP, Y)                     \
1328 do {                                            \
1329 } while (0)
1330
1331 #define ASSERTIF(C, X)                          \
1332 do {                                            \
1333 } while (0)
1334
1335 #define ASSERTIFCMP(C, X, OP, Y)                \
1336 do {                                            \
1337 } while (0)
1338
1339 #endif /* __KDEBUGALL */