net/rxrpc/ar-internal.h

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