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