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