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