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