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