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