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