net/rxrpc/ar-internal.h

   1 /* AF_RXRPC internal definitions
   2  *
   3  * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #include <linux/atomic.h>
  13 #include <linux/seqlock.h>
  14 #include <net/sock.h>
  15 #include <net/af_rxrpc.h>
  16 #include <rxrpc/packet.h>
  17
  18 #if 0
  19 #define CHECK_SLAB_OKAY(X)                                   \
  20         BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
  21                (POISON_FREE << 8 | POISON_FREE))
  22 #else
  23 #define CHECK_SLAB_OKAY(X) do {} while (0)
  24 #endif
  25
  26 #define FCRYPT_BSIZE 8
  27 struct rxrpc_crypt {
  28         union {
  29                 u8      x[FCRYPT_BSIZE];
  30                 __be32  n[2];
  31         };
  32 } __attribute__((aligned(8)));
  33
  34 #define rxrpc_queue_work(WS)    queue_work(rxrpc_workqueue, (WS))
  35 #define rxrpc_queue_delayed_work(WS,D)  \
  36         queue_delayed_work(rxrpc_workqueue, (WS), (D))
  37
  38 #define rxrpc_queue_call(CALL)  rxrpc_queue_work(&(CALL)->processor)
  39
  40 struct rxrpc_connection;
  41
  42 /*
  43  * sk_state for RxRPC sockets
  44  */
  45 enum {
  46         RXRPC_UNBOUND = 0,
  47         RXRPC_CLIENT_UNBOUND,           /* Unbound socket used as client */
  48         RXRPC_CLIENT_BOUND,             /* client local address bound */
  49         RXRPC_SERVER_BOUND,             /* server local address bound */
  50         RXRPC_SERVER_LISTENING,         /* server listening for connections */
  51         RXRPC_CLOSE,                    /* socket is being closed */
  52 };
  53
  54 /*
  55  * RxRPC socket definition
  56  */
  57 struct rxrpc_sock {
  58         /* WARNING: sk has to be the first member */
  59         struct sock             sk;
  60         rxrpc_interceptor_t     interceptor;    /* kernel service Rx interceptor function */
  61         struct rxrpc_local      *local;         /* local endpoint */
  62         struct list_head        listen_link;    /* link in the local endpoint's listen list */
  63         struct list_head        secureq;        /* calls awaiting connection security clearance */
  64         struct list_head        acceptq;        /* calls awaiting acceptance */
  65         struct key              *key;           /* security for this socket */
  66         struct key              *securities;    /* list of server security descriptors */
  67         struct rb_root          calls;          /* outstanding calls on this socket */
  68         unsigned long           flags;
  69 #define RXRPC_SOCK_CONNECTED            0       /* connect_srx is set */
  70         rwlock_t                call_lock;      /* lock for calls */
  71         u32                     min_sec_level;  /* minimum security level */
  72 #define RXRPC_SECURITY_MAX      RXRPC_SECURITY_ENCRYPT
  73         bool                    exclusive;      /* Exclusive connection for a client socket */
  74         sa_family_t             family;         /* Protocol family created with */
  75         struct sockaddr_rxrpc   srx;            /* local address */
  76         struct sockaddr_rxrpc   connect_srx;    /* Default client address from connect() */
  77 };
  78
  79 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
  80
  81 /*
  82  * CPU-byteorder normalised Rx packet header.
  83  */
  84 struct rxrpc_host_header {
  85         u32             epoch;          /* client boot timestamp */
  86         u32             cid;            /* connection and channel ID */
  87         u32             callNumber;     /* call ID (0 for connection-level packets) */
  88         u32             seq;            /* sequence number of pkt in call stream */
  89         u32             serial;         /* serial number of pkt sent to network */
  90         u8              type;           /* packet type */
  91         u8              flags;          /* packet flags */
  92         u8              userStatus;     /* app-layer defined status */
  93         u8              securityIndex;  /* security protocol ID */
  94         union {
  95                 u16     _rsvd;          /* reserved */
  96                 u16     cksum;          /* kerberos security checksum */
  97         };
  98         u16             serviceId;      /* service ID */
  99 } __packed;
 100
 101 /*
 102  * RxRPC socket buffer private variables
 103  * - max 48 bytes (struct sk_buff::cb)
 104  */
 105 struct rxrpc_skb_priv {
 106         struct rxrpc_call       *call;          /* call with which associated */
 107         unsigned long           resend_at;      /* time in jiffies at which to resend */
 108         union {
 109                 unsigned int    offset;         /* offset into buffer of next read */
 110                 int             remain;         /* amount of space remaining for next write */
 111                 u32             error;          /* network error code */
 112                 bool            need_resend;    /* T if needs resending */
 113         };
 114
 115         struct rxrpc_host_header hdr;           /* RxRPC packet header from this packet */
 116 };
 117
 118 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
 119
 120 enum rxrpc_command {
 121         RXRPC_CMD_SEND_DATA,            /* send data message */
 122         RXRPC_CMD_SEND_ABORT,           /* request abort generation */
 123         RXRPC_CMD_ACCEPT,               /* [server] accept incoming call */
 124         RXRPC_CMD_REJECT_BUSY,          /* [server] reject a call as busy */
 125 };
 126
 127 /*
 128  * RxRPC security module interface
 129  */
 130 struct rxrpc_security {
 131         const char              *name;          /* name of this service */
 132         u8                      security_index; /* security type provided */
 133
 134         /* Initialise a security service */
 135         int (*init)(void);
 136
 137         /* Clean up a security service */
 138         void (*exit)(void);
 139
 140         /* initialise a connection's security */
 141         int (*init_connection_security)(struct rxrpc_connection *);
 142
 143         /* prime a connection's packet security */
 144         int (*prime_packet_security)(struct rxrpc_connection *);
 145
 146         /* impose security on a packet */
 147         int (*secure_packet)(struct rxrpc_call *,
 148                              struct sk_buff *,
 149                              size_t,
 150                              void *);
 151
 152         /* verify the security on a received packet */
 153         int (*verify_packet)(struct rxrpc_call *, struct sk_buff *, u32 *);
 154
 155         /* issue a challenge */
 156         int (*issue_challenge)(struct rxrpc_connection *);
 157
 158         /* respond to a challenge */
 159         int (*respond_to_challenge)(struct rxrpc_connection *,
 160                                     struct sk_buff *,
 161                                     u32 *);
 162
 163         /* verify a response */
 164         int (*verify_response)(struct rxrpc_connection *,
 165                                struct sk_buff *,
 166                                u32 *);
 167
 168         /* clear connection security */
 169         void (*clear)(struct rxrpc_connection *);
 170 };
 171
 172 /*
 173  * RxRPC local transport endpoint description
 174  * - owned by a single AF_RXRPC socket
 175  * - pointed to by transport socket struct sk_user_data
 176  */
 177 struct rxrpc_local {
 178         struct rcu_head         rcu;
 179         atomic_t                usage;
 180         struct list_head        link;
 181         struct socket           *socket;        /* my UDP socket */
 182         struct work_struct      processor;
 183         struct list_head        services;       /* services listening on this endpoint */
 184         struct rw_semaphore     defrag_sem;     /* control re-enablement of IP DF bit */
 185         struct sk_buff_head     accept_queue;   /* incoming calls awaiting acceptance */
 186         struct sk_buff_head     reject_queue;   /* packets awaiting rejection */
 187         struct sk_buff_head     event_queue;    /* endpoint event packets awaiting processing */
 188         struct rb_root          client_conns;   /* Client connections by socket params */
 189         spinlock_t              client_conns_lock; /* Lock for client_conns */
 190         spinlock_t              lock;           /* access lock */
 191         rwlock_t                services_lock;  /* lock for services list */
 192         int                     debug_id;       /* debug ID for printks */
 193         bool                    dead;
 194         struct sockaddr_rxrpc   srx;            /* local address */
 195 };
 196
 197 /*
 198  * RxRPC remote transport endpoint definition
 199  * - matched by local endpoint, remote port, address and protocol type
 200  */
 201 struct rxrpc_peer {
 202         struct rcu_head         rcu;            /* This must be first */
 203         atomic_t                usage;
 204         unsigned long           hash_key;
 205         struct hlist_node       hash_link;
 206         struct rxrpc_local      *local;
 207         struct hlist_head       error_targets;  /* targets for net error distribution */
 208         struct work_struct      error_distributor;
 209         struct rb_root          service_conns;  /* Service connections */
 210         seqlock_t               service_conn_lock;
 211         spinlock_t              lock;           /* access lock */
 212         unsigned int            if_mtu;         /* interface MTU for this peer */
 213         unsigned int            mtu;            /* network MTU for this peer */
 214         unsigned int            maxdata;        /* data size (MTU - hdrsize) */
 215         unsigned short          hdrsize;        /* header size (IP + UDP + RxRPC) */
 216         int                     debug_id;       /* debug ID for printks */
 217         int                     error_report;   /* Net (+0) or local (+1000000) to distribute */
 218 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
 219         struct sockaddr_rxrpc   srx;            /* remote address */
 220
 221         /* calculated RTT cache */
 222 #define RXRPC_RTT_CACHE_SIZE 32
 223         suseconds_t             rtt;            /* current RTT estimate (in uS) */
 224         unsigned int            rtt_point;      /* next entry at which to insert */
 225         unsigned int            rtt_usage;      /* amount of cache actually used */
 226         suseconds_t             rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* calculated RTT cache */
 227 };
 228
 229 /*
 230  * Keys for matching a connection.
 231  */
 232 struct rxrpc_conn_proto {
 233         union {
 234                 struct {
 235                         u32     epoch;          /* epoch of this connection */
 236                         u32     cid;            /* connection ID */
 237                 };
 238                 u64             index_key;
 239         };
 240 };
 241
 242 struct rxrpc_conn_parameters {
 243         struct rxrpc_local      *local;         /* Representation of local endpoint */
 244         struct rxrpc_peer       *peer;          /* Remote endpoint */
 245         struct key              *key;           /* Security details */
 246         bool                    exclusive;      /* T if conn is exclusive */
 247         u16                     service_id;     /* Service ID for this connection */
 248         u32                     security_level; /* Security level selected */
 249 };
 250
 251 /*
 252  * Bits in the connection flags.
 253  */
 254 enum rxrpc_conn_flag {
 255         RXRPC_CONN_HAS_IDR,             /* Has a client conn ID assigned */
 256         RXRPC_CONN_IN_SERVICE_CONNS,    /* Conn is in peer->service_conns */
 257         RXRPC_CONN_IN_CLIENT_CONNS,     /* Conn is in local->client_conns */
 258         RXRPC_CONN_EXPOSED,             /* Conn has extra ref for exposure */
 259         RXRPC_CONN_DONT_REUSE,          /* Don't reuse this connection */
 260         RXRPC_CONN_COUNTED,             /* Counted by rxrpc_nr_client_conns */
 261 };
 262
 263 /*
 264  * Events that can be raised upon a connection.
 265  */
 266 enum rxrpc_conn_event {
 267         RXRPC_CONN_EV_CHALLENGE,        /* Send challenge packet */
 268 };
 269
 270 /*
 271  * The connection cache state.
 272  */
 273 enum rxrpc_conn_cache_state {
 274         RXRPC_CONN_CLIENT_INACTIVE,     /* Conn is not yet listed */
 275         RXRPC_CONN_CLIENT_WAITING,      /* Conn is on wait list, waiting for capacity */
 276         RXRPC_CONN_CLIENT_ACTIVE,       /* Conn is on active list, doing calls */
 277         RXRPC_CONN_CLIENT_CULLED,       /* Conn is culled and delisted, doing calls */
 278         RXRPC_CONN_CLIENT_IDLE,         /* Conn is on idle list, doing mostly nothing */
 279 };
 280
 281 /*
 282  * The connection protocol state.
 283  */
 284 enum rxrpc_conn_proto_state {
 285         RXRPC_CONN_UNUSED,              /* Connection not yet attempted */
 286         RXRPC_CONN_CLIENT,              /* Client connection */
 287         RXRPC_CONN_SERVICE_UNSECURED,   /* Service unsecured connection */
 288         RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
 289         RXRPC_CONN_SERVICE,             /* Service secured connection */
 290         RXRPC_CONN_REMOTELY_ABORTED,    /* Conn aborted by peer */
 291         RXRPC_CONN_LOCALLY_ABORTED,     /* Conn aborted locally */
 292         RXRPC_CONN_NETWORK_ERROR,       /* Conn terminated by network error */
 293         RXRPC_CONN_LOCAL_ERROR,         /* Conn terminated by local error */
 294         RXRPC_CONN__NR_STATES
 295 };
 296
 297 /*
 298  * RxRPC connection definition
 299  * - matched by { local, peer, epoch, conn_id, direction }
 300  * - each connection can only handle four simultaneous calls
 301  */
 302 struct rxrpc_connection {
 303         struct rxrpc_conn_proto proto;
 304         struct rxrpc_conn_parameters params;
 305
 306         atomic_t                usage;
 307         struct rcu_head         rcu;
 308         struct list_head        cache_link;
 309
 310         spinlock_t              channel_lock;
 311         unsigned char           active_chans;   /* Mask of active channels */
 312 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
 313         struct list_head        waiting_calls;  /* Calls waiting for channels */
 314         struct rxrpc_channel {
 315                 struct rxrpc_call __rcu *call;          /* Active call */
 316                 u32                     call_id;        /* ID of current call */
 317                 u32                     call_counter;   /* Call ID counter */
 318                 u32                     last_call;      /* ID of last call */
 319                 u8                      last_type;      /* Type of last packet */
 320                 u16                     last_service_id;
 321                 union {
 322                         u32             last_seq;
 323                         u32             last_abort;
 324                 };
 325         } channels[RXRPC_MAXCALLS];
 326
 327         struct work_struct      processor;      /* connection event processor */
 328         union {
 329                 struct rb_node  client_node;    /* Node in local->client_conns */
 330                 struct rb_node  service_node;   /* Node in peer->service_conns */
 331         };
 332         struct list_head        proc_link;      /* link in procfs list */
 333         struct list_head        link;           /* link in master connection list */
 334         struct sk_buff_head     rx_queue;       /* received conn-level packets */
 335         const struct rxrpc_security *security;  /* applied security module */
 336         struct key              *server_key;    /* security for this service */
 337         struct crypto_skcipher  *cipher;        /* encryption handle */
 338         struct rxrpc_crypt      csum_iv;        /* packet checksum base */
 339         unsigned long           flags;
 340         unsigned long           events;
 341         unsigned long           idle_timestamp; /* Time at which last became idle */
 342         spinlock_t              state_lock;     /* state-change lock */
 343         enum rxrpc_conn_cache_state cache_state : 8;
 344         enum rxrpc_conn_proto_state state : 8;  /* current state of connection */
 345         u32                     local_abort;    /* local abort code */
 346         u32                     remote_abort;   /* remote abort code */
 347         int                     error;          /* local error incurred */
 348         int                     debug_id;       /* debug ID for printks */
 349         atomic_t                serial;         /* packet serial number counter */
 350         unsigned int            hi_serial;      /* highest serial number received */
 351         u8                      size_align;     /* data size alignment (for security) */
 352         u8                      header_size;    /* rxrpc + security header size */
 353         u8                      security_size;  /* security header size */
 354         u32                     security_nonce; /* response re-use preventer */
 355         u8                      security_ix;    /* security type */
 356         u8                      out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
 357 };
 358
 359 /*
 360  * Flags in call->flags.
 361  */
 362 enum rxrpc_call_flag {
 363         RXRPC_CALL_RELEASED,            /* call has been released - no more message to userspace */
 364         RXRPC_CALL_TERMINAL_MSG,        /* call has given the socket its final message */
 365         RXRPC_CALL_RCVD_LAST,           /* all packets received */
 366         RXRPC_CALL_RUN_RTIMER,          /* Tx resend timer started */
 367         RXRPC_CALL_TX_SOFT_ACK,         /* sent some soft ACKs */
 368         RXRPC_CALL_INIT_ACCEPT,         /* acceptance was initiated */
 369         RXRPC_CALL_HAS_USERID,          /* has a user ID attached */
 370         RXRPC_CALL_EXPECT_OOS,          /* expect out of sequence packets */
 371         RXRPC_CALL_IS_SERVICE,          /* Call is service call */
 372         RXRPC_CALL_EXPOSED,             /* The call was exposed to the world */
 373 };
 374
 375 /*
 376  * Events that can be raised on a call.
 377  */
 378 enum rxrpc_call_event {
 379         RXRPC_CALL_EV_RCVD_ACKALL,      /* ACKALL or reply received */
 380         RXRPC_CALL_EV_RCVD_BUSY,        /* busy packet received */
 381         RXRPC_CALL_EV_RCVD_ABORT,       /* abort packet received */
 382         RXRPC_CALL_EV_RCVD_ERROR,       /* network error received */
 383         RXRPC_CALL_EV_ACK_FINAL,        /* need to generate final ACK (and release call) */
 384         RXRPC_CALL_EV_ACK,              /* need to generate ACK */
 385         RXRPC_CALL_EV_REJECT_BUSY,      /* need to generate busy message */
 386         RXRPC_CALL_EV_ABORT,            /* need to generate abort */
 387         RXRPC_CALL_EV_CONN_ABORT,       /* local connection abort generated */
 388         RXRPC_CALL_EV_RESEND_TIMER,     /* Tx resend timer expired */
 389         RXRPC_CALL_EV_RESEND,           /* Tx resend required */
 390         RXRPC_CALL_EV_DRAIN_RX_OOS,     /* drain the Rx out of sequence queue */
 391         RXRPC_CALL_EV_LIFE_TIMER,       /* call's lifetimer ran out */
 392         RXRPC_CALL_EV_ACCEPTED,         /* incoming call accepted by userspace app */
 393         RXRPC_CALL_EV_SECURED,          /* incoming call's connection is now secure */
 394         RXRPC_CALL_EV_POST_ACCEPT,      /* need to post an "accept?" message to the app */
 395         RXRPC_CALL_EV_RELEASE,          /* need to release the call's resources */
 396 };
 397
 398 /*
 399  * The states that a call can be in.
 400  */
 401 enum rxrpc_call_state {
 402         RXRPC_CALL_UNINITIALISED,
 403         RXRPC_CALL_CLIENT_AWAIT_CONN,   /* - client waiting for connection to become available */
 404         RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
 405         RXRPC_CALL_CLIENT_AWAIT_REPLY,  /* - client awaiting reply */
 406         RXRPC_CALL_CLIENT_RECV_REPLY,   /* - client receiving reply phase */
 407         RXRPC_CALL_CLIENT_FINAL_ACK,    /* - client sending final ACK phase */
 408         RXRPC_CALL_SERVER_SECURING,     /* - server securing request connection */
 409         RXRPC_CALL_SERVER_ACCEPTING,    /* - server accepting request */
 410         RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
 411         RXRPC_CALL_SERVER_ACK_REQUEST,  /* - server pending ACK of request */
 412         RXRPC_CALL_SERVER_SEND_REPLY,   /* - server sending reply */
 413         RXRPC_CALL_SERVER_AWAIT_ACK,    /* - server awaiting final ACK */
 414         RXRPC_CALL_COMPLETE,            /* - call completed */
 415         RXRPC_CALL_SERVER_BUSY,         /* - call rejected by busy server */
 416         RXRPC_CALL_REMOTELY_ABORTED,    /* - call aborted by peer */
 417         RXRPC_CALL_LOCALLY_ABORTED,     /* - call aborted locally on error or close */
 418         RXRPC_CALL_NETWORK_ERROR,       /* - call terminated by network error */
 419         RXRPC_CALL_DEAD,                /* - call is dead */
 420         NR__RXRPC_CALL_STATES
 421 };
 422
 423 /*
 424  * RxRPC call definition
 425  * - matched by { connection, call_id }
 426  */
 427 struct rxrpc_call {
 428         struct rcu_head         rcu;
 429         struct rxrpc_connection *conn;          /* connection carrying call */
 430         struct rxrpc_peer       *peer;          /* Peer record for remote address */
 431         struct rxrpc_sock       *socket;        /* socket responsible */
 432         struct timer_list       lifetimer;      /* lifetime remaining on call */
 433         struct timer_list       deadspan;       /* reap timer for re-ACK'ing, etc  */
 434         struct timer_list       ack_timer;      /* ACK generation timer */
 435         struct timer_list       resend_timer;   /* Tx resend timer */
 436         struct work_struct      destroyer;      /* call destroyer */
 437         struct work_struct      processor;      /* packet processor and ACK generator */
 438         struct list_head        link;           /* link in master call list */
 439         struct list_head        chan_wait_link; /* Link in conn->waiting_calls */
 440         struct hlist_node       error_link;     /* link in error distribution list */
 441         struct list_head        accept_link;    /* calls awaiting acceptance */
 442         struct rb_node          sock_node;      /* node in socket call tree */
 443         struct sk_buff_head     rx_queue;       /* received packets */
 444         struct sk_buff_head     rx_oos_queue;   /* packets received out of sequence */
 445         struct sk_buff          *tx_pending;    /* Tx socket buffer being filled */
 446         wait_queue_head_t       waitq;          /* Wait queue for channel or Tx */
 447         __be32                  crypto_buf[2];  /* Temporary packet crypto buffer */
 448         unsigned long           user_call_ID;   /* user-defined call ID */
 449         unsigned long           creation_jif;   /* time of call creation */
 450         unsigned long           flags;
 451         unsigned long           events;
 452         spinlock_t              lock;
 453         rwlock_t                state_lock;     /* lock for state transition */
 454         atomic_t                usage;
 455         atomic_t                skb_count;      /* Outstanding packets on this call */
 456         atomic_t                sequence;       /* Tx data packet sequence counter */
 457         u32                     local_abort;    /* local abort code */
 458         u32                     remote_abort;   /* remote abort code */
 459         int                     error_report;   /* Network error (ICMP/local transport) */
 460         int                     error;          /* Local error incurred */
 461         enum rxrpc_call_state   state : 8;      /* current state of call */
 462         u16                     service_id;     /* service ID */
 463         u32                     call_id;        /* call ID on connection  */
 464         u32                     cid;            /* connection ID plus channel index */
 465         int                     debug_id;       /* debug ID for printks */
 466
 467         /* transmission-phase ACK management */
 468         u8                      acks_head;      /* offset into window of first entry */
 469         u8                      acks_tail;      /* offset into window of last entry */
 470         u8                      acks_winsz;     /* size of un-ACK'd window */
 471         u8                      acks_unacked;   /* lowest unacked packet in last ACK received */
 472         int                     acks_latest;    /* serial number of latest ACK received */
 473         rxrpc_seq_t             acks_hard;      /* highest definitively ACK'd msg seq */
 474         unsigned long           *acks_window;   /* sent packet window
 475                                                  * - elements are pointers with LSB set if ACK'd
 476                                                  */
 477
 478         /* receive-phase ACK management */
 479         rxrpc_seq_t             rx_data_expect; /* next data seq ID expected to be received */
 480         rxrpc_seq_t             rx_data_post;   /* next data seq ID expected to be posted */
 481         rxrpc_seq_t             rx_data_recv;   /* last data seq ID encountered by recvmsg */
 482         rxrpc_seq_t             rx_data_eaten;  /* last data seq ID consumed by recvmsg */
 483         rxrpc_seq_t             rx_first_oos;   /* first packet in rx_oos_queue (or 0) */
 484         rxrpc_seq_t             ackr_win_top;   /* top of ACK window (rx_data_eaten is bottom) */
 485         rxrpc_seq_t             ackr_prev_seq;  /* previous sequence number received */
 486         u8                      ackr_reason;    /* reason to ACK */
 487         u16                     ackr_skew;      /* skew on packet being ACK'd */
 488         rxrpc_serial_t          ackr_serial;    /* serial of packet being ACK'd */
 489         atomic_t                ackr_not_idle;  /* number of packets in Rx queue */
 490
 491         /* received packet records, 1 bit per record */
 492 #define RXRPC_ACKR_WINDOW_ASZ DIV_ROUND_UP(RXRPC_MAXACKS, BITS_PER_LONG)
 493         unsigned long           ackr_window[RXRPC_ACKR_WINDOW_ASZ + 1];
 494 };
 495
 496 /*
 497  * locally abort an RxRPC call
 498  */
 499 static inline void rxrpc_abort_call(struct rxrpc_call *call, u32 abort_code)
 500 {
 501         write_lock_bh(&call->state_lock);
 502         if (call->state < RXRPC_CALL_COMPLETE) {
 503                 call->local_abort = abort_code;
 504                 call->state = RXRPC_CALL_LOCALLY_ABORTED;
 505                 set_bit(RXRPC_CALL_EV_ABORT, &call->events);
 506         }
 507         write_unlock_bh(&call->state_lock);
 508 }
 509
 510 #include <trace/events/rxrpc.h>
 511
 512 /*
 513  * af_rxrpc.c
 514  */
 515 extern atomic_t rxrpc_n_skbs;
 516 extern u32 rxrpc_epoch;
 517 extern atomic_t rxrpc_debug_id;
 518 extern struct workqueue_struct *rxrpc_workqueue;
 519
 520 /*
 521  * call_accept.c
 522  */
 523 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
 524 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long);
 525 int rxrpc_reject_call(struct rxrpc_sock *);
 526
 527 /*
 528  * call_event.c
 529  */
 530 void __rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool);
 531 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool);
 532 void rxrpc_process_call(struct work_struct *);
 533
 534 /*
 535  * call_object.c
 536  */
 537 extern unsigned int rxrpc_max_call_lifetime;
 538 extern unsigned int rxrpc_dead_call_expiry;
 539 extern struct kmem_cache *rxrpc_call_jar;
 540 extern struct list_head rxrpc_calls;
 541 extern rwlock_t rxrpc_call_lock;
 542
 543 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
 544 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
 545                                          struct rxrpc_conn_parameters *,
 546                                          struct sockaddr_rxrpc *,
 547                                          unsigned long, gfp_t);
 548 struct rxrpc_call *rxrpc_incoming_call(struct rxrpc_sock *,
 549                                        struct rxrpc_connection *,
 550                                        struct sk_buff *);
 551 void rxrpc_release_call(struct rxrpc_call *);
 552 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
 553 void __rxrpc_put_call(struct rxrpc_call *);
 554 void __exit rxrpc_destroy_all_calls(void);
 555
 556 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
 557 {
 558         return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
 559 }
 560
 561 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
 562 {
 563         return !rxrpc_is_service_call(call);
 564 }
 565
 566 /*
 567  * conn_client.c
 568  */
 569 extern unsigned int rxrpc_max_client_connections;
 570 extern unsigned int rxrpc_reap_client_connections;
 571 extern unsigned int rxrpc_conn_idle_client_expiry;
 572 extern unsigned int rxrpc_conn_idle_client_fast_expiry;
 573 extern struct idr rxrpc_client_conn_ids;
 574
 575 void rxrpc_destroy_client_conn_ids(void);
 576 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
 577                        struct sockaddr_rxrpc *, gfp_t);
 578 void rxrpc_expose_client_call(struct rxrpc_call *);
 579 void rxrpc_disconnect_client_call(struct rxrpc_call *);
 580 void rxrpc_put_client_conn(struct rxrpc_connection *);
 581 void __exit rxrpc_destroy_all_client_connections(void);
 582
 583 /*
 584  * conn_event.c
 585  */
 586 void rxrpc_process_connection(struct work_struct *);
 587 void rxrpc_reject_packet(struct rxrpc_local *, struct sk_buff *);
 588 void rxrpc_reject_packets(struct rxrpc_local *);
 589
 590 /*
 591  * conn_object.c
 592  */
 593 extern unsigned int rxrpc_connection_expiry;
 594 extern struct list_head rxrpc_connections;
 595 extern struct list_head rxrpc_connection_proc_list;
 596 extern rwlock_t rxrpc_connection_lock;
 597
 598 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
 599 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
 600 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
 601                                                    struct sk_buff *);
 602 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
 603 void rxrpc_disconnect_call(struct rxrpc_call *);
 604 void rxrpc_kill_connection(struct rxrpc_connection *);
 605 void __rxrpc_put_connection(struct rxrpc_connection *);
 606 void __exit rxrpc_destroy_all_connections(void);
 607
 608 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
 609 {
 610         return conn->out_clientflag;
 611 }
 612
 613 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
 614 {
 615         return !rxrpc_conn_is_client(conn);
 616 }
 617
 618 static inline void rxrpc_get_connection(struct rxrpc_connection *conn)
 619 {
 620         atomic_inc(&conn->usage);
 621 }
 622
 623 static inline
 624 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *conn)
 625 {
 626         return atomic_inc_not_zero(&conn->usage) ? conn : NULL;
 627 }
 628
 629 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
 630 {
 631         if (!conn)
 632                 return;
 633
 634         if (rxrpc_conn_is_client(conn)) {
 635                 if (atomic_dec_and_test(&conn->usage))
 636                         rxrpc_put_client_conn(conn);
 637         } else {
 638                 if (atomic_dec_return(&conn->usage) == 1)
 639                         __rxrpc_put_connection(conn);
 640         }
 641 }
 642
 643
 644 static inline bool rxrpc_queue_conn(struct rxrpc_connection *conn)
 645 {
 646         if (!rxrpc_get_connection_maybe(conn))
 647                 return false;
 648         if (!rxrpc_queue_work(&conn->processor))
 649                 rxrpc_put_connection(conn);
 650         return true;
 651 }
 652
 653 /*
 654  * conn_service.c
 655  */
 656 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
 657                                                      struct sk_buff *);
 658 struct rxrpc_connection *rxrpc_incoming_connection(struct rxrpc_local *,
 659                                                    struct sockaddr_rxrpc *,
 660                                                    struct sk_buff *);
 661 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
 662
 663 /*
 664  * input.c
 665  */
 666 void rxrpc_data_ready(struct sock *);
 667 int rxrpc_queue_rcv_skb(struct rxrpc_call *, struct sk_buff *, bool, bool);
 668 void rxrpc_fast_process_packet(struct rxrpc_call *, struct sk_buff *);
 669
 670 /*
 671  * insecure.c
 672  */
 673 extern const struct rxrpc_security rxrpc_no_security;
 674
 675 /*
 676  * key.c
 677  */
 678 extern struct key_type key_type_rxrpc;
 679 extern struct key_type key_type_rxrpc_s;
 680
 681 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
 682 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
 683 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
 684                               u32);
 685
 686 /*
 687  * local_event.c
 688  */
 689 extern void rxrpc_process_local_events(struct rxrpc_local *);
 690
 691 /*
 692  * local_object.c
 693  */
 694 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
 695 void __rxrpc_put_local(struct rxrpc_local *);
 696 void __exit rxrpc_destroy_all_locals(void);
 697
 698 static inline void rxrpc_get_local(struct rxrpc_local *local)
 699 {
 700         atomic_inc(&local->usage);
 701 }
 702
 703 static inline
 704 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
 705 {
 706         return atomic_inc_not_zero(&local->usage) ? local : NULL;
 707 }
 708
 709 static inline void rxrpc_put_local(struct rxrpc_local *local)
 710 {
 711         if (local && atomic_dec_and_test(&local->usage))
 712                 __rxrpc_put_local(local);
 713 }
 714
 715 static inline void rxrpc_queue_local(struct rxrpc_local *local)
 716 {
 717         rxrpc_queue_work(&local->processor);
 718 }
 719
 720 /*
 721  * misc.c
 722  */
 723 extern unsigned int rxrpc_max_backlog __read_mostly;
 724 extern unsigned int rxrpc_requested_ack_delay;
 725 extern unsigned int rxrpc_soft_ack_delay;
 726 extern unsigned int rxrpc_idle_ack_delay;
 727 extern unsigned int rxrpc_rx_window_size;
 728 extern unsigned int rxrpc_rx_mtu;
 729 extern unsigned int rxrpc_rx_jumbo_max;
 730
 731 extern const char *const rxrpc_pkts[];
 732 extern const s8 rxrpc_ack_priority[];
 733
 734 extern const char *rxrpc_acks(u8 reason);
 735
 736 /*
 737  * output.c
 738  */
 739 extern unsigned int rxrpc_resend_timeout;
 740
 741 int rxrpc_send_data_packet(struct rxrpc_connection *, struct sk_buff *);
 742 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
 743
 744 /*
 745  * peer_event.c
 746  */
 747 void rxrpc_error_report(struct sock *);
 748 void rxrpc_peer_error_distributor(struct work_struct *);
 749
 750 /*
 751  * peer_object.c
 752  */
 753 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
 754                                          const struct sockaddr_rxrpc *);
 755 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
 756                                      struct sockaddr_rxrpc *, gfp_t);
 757 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
 758
 759 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
 760 {
 761         atomic_inc(&peer->usage);
 762         return peer;
 763 }
 764
 765 static inline
 766 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
 767 {
 768         return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
 769 }
 770
 771 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
 772 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
 773 {
 774         if (peer && atomic_dec_and_test(&peer->usage))
 775                 __rxrpc_put_peer(peer);
 776 }
 777
 778 /*
 779  * proc.c
 780  */
 781 extern const char *const rxrpc_call_states[];
 782 extern const struct file_operations rxrpc_call_seq_fops;
 783 extern const struct file_operations rxrpc_connection_seq_fops;
 784
 785 /*
 786  * recvmsg.c
 787  */
 788 void rxrpc_remove_user_ID(struct rxrpc_sock *, struct rxrpc_call *);
 789 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
 790
 791 /*
 792  * rxkad.c
 793  */
 794 #ifdef CONFIG_RXKAD
 795 extern const struct rxrpc_security rxkad;
 796 #endif
 797
 798 /*
 799  * security.c
 800  */
 801 int __init rxrpc_init_security(void);
 802 void rxrpc_exit_security(void);
 803 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
 804 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
 805
 806 /*
 807  * skbuff.c
 808  */
 809 void rxrpc_packet_destructor(struct sk_buff *);
 810 void rxrpc_new_skb(struct sk_buff *);
 811 void rxrpc_see_skb(struct sk_buff *);
 812 void rxrpc_get_skb(struct sk_buff *);
 813 void rxrpc_free_skb(struct sk_buff *);
 814 void rxrpc_purge_queue(struct sk_buff_head *);
 815
 816 /*
 817  * sysctl.c
 818  */
 819 #ifdef CONFIG_SYSCTL
 820 extern int __init rxrpc_sysctl_init(void);
 821 extern void rxrpc_sysctl_exit(void);
 822 #else
 823 static inline int __init rxrpc_sysctl_init(void) { return 0; }
 824 static inline void rxrpc_sysctl_exit(void) {}
 825 #endif
 826
 827 /*
 828  * utils.c
 829  */
 830 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
 831
 832 /*
 833  * debug tracing
 834  */
 835 extern unsigned int rxrpc_debug;
 836
 837 #define dbgprintk(FMT,...) \
 838         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
 839
 840 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
 841 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
 842 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
 843 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
 844 #define knet(FMT,...)   dbgprintk("@@@ "FMT ,##__VA_ARGS__)
 845
 846
 847 #if defined(__KDEBUG)
 848 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
 849 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
 850 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
 851 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
 852 #define _net(FMT,...)   knet(FMT,##__VA_ARGS__)
 853
 854 #elif defined(CONFIG_AF_RXRPC_DEBUG)
 855 #define RXRPC_DEBUG_KENTER      0x01
 856 #define RXRPC_DEBUG_KLEAVE      0x02
 857 #define RXRPC_DEBUG_KDEBUG      0x04
 858 #define RXRPC_DEBUG_KPROTO      0x08
 859 #define RXRPC_DEBUG_KNET        0x10
 860
 861 #define _enter(FMT,...)                                 \
 862 do {                                                    \
 863         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
 864                 kenter(FMT,##__VA_ARGS__);              \
 865 } while (0)
 866
 867 #define _leave(FMT,...)                                 \
 868 do {                                                    \
 869         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
 870                 kleave(FMT,##__VA_ARGS__);              \
 871 } while (0)
 872
 873 #define _debug(FMT,...)                                 \
 874 do {                                                    \
 875         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
 876                 kdebug(FMT,##__VA_ARGS__);              \
 877 } while (0)
 878
 879 #define _proto(FMT,...)                                 \
 880 do {                                                    \
 881         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
 882                 kproto(FMT,##__VA_ARGS__);              \
 883 } while (0)
 884
 885 #define _net(FMT,...)                                   \
 886 do {                                                    \
 887         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))   \
 888                 knet(FMT,##__VA_ARGS__);                \
 889 } while (0)
 890
 891 #else
 892 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
 893 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
 894 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
 895 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
 896 #define _net(FMT,...)   no_printk("@@@ "FMT ,##__VA_ARGS__)
 897 #endif
 898
 899 /*
 900  * debug assertion checking
 901  */
 902 #if 1 // defined(__KDEBUGALL)
 903
 904 #define ASSERT(X)                                               \
 905 do {                                                            \
 906         if (unlikely(!(X))) {                                   \
 907                 pr_err("Assertion failed\n");                   \
 908                 BUG();                                          \
 909         }                                                       \
 910 } while (0)
 911
 912 #define ASSERTCMP(X, OP, Y)                                             \
 913 do {                                                                    \
 914         unsigned long _x = (unsigned long)(X);                          \
 915         unsigned long _y = (unsigned long)(Y);                          \
 916         if (unlikely(!(_x OP _y))) {                                    \
 917                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n",                        \
 918                        _x, _x, #OP, _y, _y);                            \
 919                 BUG();                                                  \
 920         }                                                               \
 921 } while (0)
 922
 923 #define ASSERTIF(C, X)                                          \
 924 do {                                                            \
 925         if (unlikely((C) && !(X))) {                            \
 926                 pr_err("Assertion failed\n");                   \
 927                 BUG();                                          \
 928         }                                                       \
 929 } while (0)
 930
 931 #define ASSERTIFCMP(C, X, OP, Y)                                        \
 932 do {                                                                    \
 933         unsigned long _x = (unsigned long)(X);                          \
 934         unsigned long _y = (unsigned long)(Y);                          \
 935         if (unlikely((C) && !(_x OP _y))) {                             \
 936                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
 937                        _x, _x, #OP, _y, _y);                            \
 938                 BUG();                                                  \
 939         }                                                               \
 940 } while (0)
 941
 942 #else
 943
 944 #define ASSERT(X)                               \
 945 do {                                            \
 946 } while (0)
 947
 948 #define ASSERTCMP(X, OP, Y)                     \
 949 do {                                            \
 950 } while (0)
 951
 952 #define ASSERTIF(C, X)                          \
 953 do {                                            \
 954 } while (0)
 955
 956 #define ASSERTIFCMP(C, X, OP, Y)                \
 957 do {                                            \
 958 } while (0)
 959
 960 #endif /* __KDEBUGALL */
 961
 962
 963 #define rxrpc_get_call(CALL)                            \
 964 do {                                                    \
 965         CHECK_SLAB_OKAY(&(CALL)->usage);                \
 966         if (atomic_inc_return(&(CALL)->usage) == 1)     \
 967                 BUG();                                  \
 968 } while (0)
 969
 970 #define rxrpc_put_call(CALL)                            \
 971 do {                                                    \
 972         __rxrpc_put_call(CALL);                         \
 973 } while (0)