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 struct rxrpc_connection;
  39
  40 /*
  41  * Mark applied to socket buffers.
  42  */
  43 enum rxrpc_skb_mark {
  44         RXRPC_SKB_MARK_DATA,            /* data message */
  45         RXRPC_SKB_MARK_FINAL_ACK,       /* final ACK received message */
  46         RXRPC_SKB_MARK_BUSY,            /* server busy message */
  47         RXRPC_SKB_MARK_REMOTE_ABORT,    /* remote abort message */
  48         RXRPC_SKB_MARK_LOCAL_ABORT,     /* local abort message */
  49         RXRPC_SKB_MARK_NET_ERROR,       /* network error message */
  50         RXRPC_SKB_MARK_LOCAL_ERROR,     /* local error message */
  51         RXRPC_SKB_MARK_NEW_CALL,        /* local error message */
  52 };
  53
  54 /*
  55  * sk_state for RxRPC sockets
  56  */
  57 enum {
  58         RXRPC_UNBOUND = 0,
  59         RXRPC_CLIENT_UNBOUND,           /* Unbound socket used as client */
  60         RXRPC_CLIENT_BOUND,             /* client local address bound */
  61         RXRPC_SERVER_BOUND,             /* server local address bound */
  62         RXRPC_SERVER_LISTENING,         /* server listening for connections */
  63         RXRPC_CLOSE,                    /* socket is being closed */
  64 };
  65
  66 /*
  67  * Service backlog preallocation.
  68  *
  69  * This contains circular buffers of preallocated peers, connections and calls
  70  * for incoming service calls and their head and tail pointers.  This allows
  71  * calls to be set up in the data_ready handler, thereby avoiding the need to
  72  * shuffle packets around so much.
  73  */
  74 struct rxrpc_backlog {
  75         unsigned short          peer_backlog_head;
  76         unsigned short          peer_backlog_tail;
  77         unsigned short          conn_backlog_head;
  78         unsigned short          conn_backlog_tail;
  79         unsigned short          call_backlog_head;
  80         unsigned short          call_backlog_tail;
  81 #define RXRPC_BACKLOG_MAX       32
  82         struct rxrpc_peer       *peer_backlog[RXRPC_BACKLOG_MAX];
  83         struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
  84         struct rxrpc_call       *call_backlog[RXRPC_BACKLOG_MAX];
  85 };
  86
  87 /*
  88  * RxRPC socket definition
  89  */
  90 struct rxrpc_sock {
  91         /* WARNING: sk has to be the first member */
  92         struct sock             sk;
  93         rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
  94         rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
  95         struct rxrpc_local      *local;         /* local endpoint */
  96         struct hlist_node       listen_link;    /* link in the local endpoint's listen list */
  97         struct rxrpc_backlog    *backlog;       /* Preallocation for services */
  98         spinlock_t              incoming_lock;  /* Incoming call vs service shutdown lock */
  99         struct list_head        sock_calls;     /* List of calls owned by this socket */
 100         struct list_head        to_be_accepted; /* calls awaiting acceptance */
 101         struct list_head        recvmsg_q;      /* Calls awaiting recvmsg's attention  */
 102         rwlock_t                recvmsg_lock;   /* Lock for recvmsg_q */
 103         struct key              *key;           /* security for this socket */
 104         struct key              *securities;    /* list of server security descriptors */
 105         struct rb_root          calls;          /* User ID -> call mapping */
 106         unsigned long           flags;
 107 #define RXRPC_SOCK_CONNECTED            0       /* connect_srx is set */
 108         rwlock_t                call_lock;      /* lock for calls */
 109         u32                     min_sec_level;  /* minimum security level */
 110 #define RXRPC_SECURITY_MAX      RXRPC_SECURITY_ENCRYPT
 111         bool                    exclusive;      /* Exclusive connection for a client socket */
 112         sa_family_t             family;         /* Protocol family created with */
 113         struct sockaddr_rxrpc   srx;            /* local address */
 114         struct sockaddr_rxrpc   connect_srx;    /* Default client address from connect() */
 115 };
 116
 117 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
 118
 119 /*
 120  * CPU-byteorder normalised Rx packet header.
 121  */
 122 struct rxrpc_host_header {
 123         u32             epoch;          /* client boot timestamp */
 124         u32             cid;            /* connection and channel ID */
 125         u32             callNumber;     /* call ID (0 for connection-level packets) */
 126         u32             seq;            /* sequence number of pkt in call stream */
 127         u32             serial;         /* serial number of pkt sent to network */
 128         u8              type;           /* packet type */
 129         u8              flags;          /* packet flags */
 130         u8              userStatus;     /* app-layer defined status */
 131         u8              securityIndex;  /* security protocol ID */
 132         union {
 133                 u16     _rsvd;          /* reserved */
 134                 u16     cksum;          /* kerberos security checksum */
 135         };
 136         u16             serviceId;      /* service ID */
 137 } __packed;
 138
 139 /*
 140  * RxRPC socket buffer private variables
 141  * - max 48 bytes (struct sk_buff::cb)
 142  */
 143 struct rxrpc_skb_priv {
 144         union {
 145                 u8              nr_jumbo;       /* Number of jumbo subpackets */
 146         };
 147         union {
 148                 unsigned int    offset;         /* offset into buffer of next read */
 149                 int             remain;         /* amount of space remaining for next write */
 150                 u32             error;          /* network error code */
 151         };
 152
 153         struct rxrpc_host_header hdr;           /* RxRPC packet header from this packet */
 154 };
 155
 156 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
 157
 158 /*
 159  * RxRPC security module interface
 160  */
 161 struct rxrpc_security {
 162         const char              *name;          /* name of this service */
 163         u8                      security_index; /* security type provided */
 164
 165         /* Initialise a security service */
 166         int (*init)(void);
 167
 168         /* Clean up a security service */
 169         void (*exit)(void);
 170
 171         /* initialise a connection's security */
 172         int (*init_connection_security)(struct rxrpc_connection *);
 173
 174         /* prime a connection's packet security */
 175         int (*prime_packet_security)(struct rxrpc_connection *);
 176
 177         /* impose security on a packet */
 178         int (*secure_packet)(struct rxrpc_call *,
 179                              struct sk_buff *,
 180                              size_t,
 181                              void *);
 182
 183         /* verify the security on a received packet */
 184         int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
 185                              unsigned int, unsigned int, rxrpc_seq_t, u16);
 186
 187         /* Locate the data in a received packet that has been verified. */
 188         void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
 189                             unsigned int *, unsigned int *);
 190
 191         /* issue a challenge */
 192         int (*issue_challenge)(struct rxrpc_connection *);
 193
 194         /* respond to a challenge */
 195         int (*respond_to_challenge)(struct rxrpc_connection *,
 196                                     struct sk_buff *,
 197                                     u32 *);
 198
 199         /* verify a response */
 200         int (*verify_response)(struct rxrpc_connection *,
 201                                struct sk_buff *,
 202                                u32 *);
 203
 204         /* clear connection security */
 205         void (*clear)(struct rxrpc_connection *);
 206 };
 207
 208 /*
 209  * RxRPC local transport endpoint description
 210  * - owned by a single AF_RXRPC socket
 211  * - pointed to by transport socket struct sk_user_data
 212  */
 213 struct rxrpc_local {
 214         struct rcu_head         rcu;
 215         atomic_t                usage;
 216         struct list_head        link;
 217         struct socket           *socket;        /* my UDP socket */
 218         struct work_struct      processor;
 219         struct hlist_head       services;       /* services listening on this endpoint */
 220         struct rw_semaphore     defrag_sem;     /* control re-enablement of IP DF bit */
 221         struct sk_buff_head     reject_queue;   /* packets awaiting rejection */
 222         struct sk_buff_head     event_queue;    /* endpoint event packets awaiting processing */
 223         struct rb_root          client_conns;   /* Client connections by socket params */
 224         spinlock_t              client_conns_lock; /* Lock for client_conns */
 225         spinlock_t              lock;           /* access lock */
 226         rwlock_t                services_lock;  /* lock for services list */
 227         int                     debug_id;       /* debug ID for printks */
 228         bool                    dead;
 229         struct sockaddr_rxrpc   srx;            /* local address */
 230 };
 231
 232 /*
 233  * RxRPC remote transport endpoint definition
 234  * - matched by local endpoint, remote port, address and protocol type
 235  */
 236 struct rxrpc_peer {
 237         struct rcu_head         rcu;            /* This must be first */
 238         atomic_t                usage;
 239         unsigned long           hash_key;
 240         struct hlist_node       hash_link;
 241         struct rxrpc_local      *local;
 242         struct hlist_head       error_targets;  /* targets for net error distribution */
 243         struct work_struct      error_distributor;
 244         struct rb_root          service_conns;  /* Service connections */
 245         seqlock_t               service_conn_lock;
 246         spinlock_t              lock;           /* access lock */
 247         unsigned int            if_mtu;         /* interface MTU for this peer */
 248         unsigned int            mtu;            /* network MTU for this peer */
 249         unsigned int            maxdata;        /* data size (MTU - hdrsize) */
 250         unsigned short          hdrsize;        /* header size (IP + UDP + RxRPC) */
 251         int                     debug_id;       /* debug ID for printks */
 252         int                     error_report;   /* Net (+0) or local (+1000000) to distribute */
 253 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
 254         struct sockaddr_rxrpc   srx;            /* remote address */
 255
 256         /* calculated RTT cache */
 257 #define RXRPC_RTT_CACHE_SIZE 32
 258         ktime_t                 rtt_last_req;   /* Time of last RTT request */
 259         u64                     rtt;            /* Current RTT estimate (in nS) */
 260         u64                     rtt_sum;        /* Sum of cache contents */
 261         u64                     rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* Determined RTT cache */
 262         u8                      rtt_cursor;     /* next entry at which to insert */
 263         u8                      rtt_usage;      /* amount of cache actually used */
 264 };
 265
 266 /*
 267  * Keys for matching a connection.
 268  */
 269 struct rxrpc_conn_proto {
 270         union {
 271                 struct {
 272                         u32     epoch;          /* epoch of this connection */
 273                         u32     cid;            /* connection ID */
 274                 };
 275                 u64             index_key;
 276         };
 277 };
 278
 279 struct rxrpc_conn_parameters {
 280         struct rxrpc_local      *local;         /* Representation of local endpoint */
 281         struct rxrpc_peer       *peer;          /* Remote endpoint */
 282         struct key              *key;           /* Security details */
 283         bool                    exclusive;      /* T if conn is exclusive */
 284         u16                     service_id;     /* Service ID for this connection */
 285         u32                     security_level; /* Security level selected */
 286 };
 287
 288 /*
 289  * Bits in the connection flags.
 290  */
 291 enum rxrpc_conn_flag {
 292         RXRPC_CONN_HAS_IDR,             /* Has a client conn ID assigned */
 293         RXRPC_CONN_IN_SERVICE_CONNS,    /* Conn is in peer->service_conns */
 294         RXRPC_CONN_IN_CLIENT_CONNS,     /* Conn is in local->client_conns */
 295         RXRPC_CONN_EXPOSED,             /* Conn has extra ref for exposure */
 296         RXRPC_CONN_DONT_REUSE,          /* Don't reuse this connection */
 297         RXRPC_CONN_COUNTED,             /* Counted by rxrpc_nr_client_conns */
 298 };
 299
 300 /*
 301  * Events that can be raised upon a connection.
 302  */
 303 enum rxrpc_conn_event {
 304         RXRPC_CONN_EV_CHALLENGE,        /* Send challenge packet */
 305 };
 306
 307 /*
 308  * The connection cache state.
 309  */
 310 enum rxrpc_conn_cache_state {
 311         RXRPC_CONN_CLIENT_INACTIVE,     /* Conn is not yet listed */
 312         RXRPC_CONN_CLIENT_WAITING,      /* Conn is on wait list, waiting for capacity */
 313         RXRPC_CONN_CLIENT_ACTIVE,       /* Conn is on active list, doing calls */
 314         RXRPC_CONN_CLIENT_CULLED,       /* Conn is culled and delisted, doing calls */
 315         RXRPC_CONN_CLIENT_IDLE,         /* Conn is on idle list, doing mostly nothing */
 316         RXRPC_CONN__NR_CACHE_STATES
 317 };
 318
 319 /*
 320  * The connection protocol state.
 321  */
 322 enum rxrpc_conn_proto_state {
 323         RXRPC_CONN_UNUSED,              /* Connection not yet attempted */
 324         RXRPC_CONN_CLIENT,              /* Client connection */
 325         RXRPC_CONN_SERVICE_PREALLOC,    /* Service connection preallocation */
 326         RXRPC_CONN_SERVICE_UNSECURED,   /* Service unsecured connection */
 327         RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
 328         RXRPC_CONN_SERVICE,             /* Service secured connection */
 329         RXRPC_CONN_REMOTELY_ABORTED,    /* Conn aborted by peer */
 330         RXRPC_CONN_LOCALLY_ABORTED,     /* Conn aborted locally */
 331         RXRPC_CONN__NR_STATES
 332 };
 333
 334 /*
 335  * RxRPC connection definition
 336  * - matched by { local, peer, epoch, conn_id, direction }
 337  * - each connection can only handle four simultaneous calls
 338  */
 339 struct rxrpc_connection {
 340         struct rxrpc_conn_proto proto;
 341         struct rxrpc_conn_parameters params;
 342
 343         atomic_t                usage;
 344         struct rcu_head         rcu;
 345         struct list_head        cache_link;
 346
 347         spinlock_t              channel_lock;
 348         unsigned char           active_chans;   /* Mask of active channels */
 349 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
 350         struct list_head        waiting_calls;  /* Calls waiting for channels */
 351         struct rxrpc_channel {
 352                 struct rxrpc_call __rcu *call;          /* Active call */
 353                 u32                     call_id;        /* ID of current call */
 354                 u32                     call_counter;   /* Call ID counter */
 355                 u32                     last_call;      /* ID of last call */
 356                 u8                      last_type;      /* Type of last packet */
 357                 u16                     last_service_id;
 358                 union {
 359                         u32             last_seq;
 360                         u32             last_abort;
 361                 };
 362         } channels[RXRPC_MAXCALLS];
 363
 364         struct work_struct      processor;      /* connection event processor */
 365         union {
 366                 struct rb_node  client_node;    /* Node in local->client_conns */
 367                 struct rb_node  service_node;   /* Node in peer->service_conns */
 368         };
 369         struct list_head        proc_link;      /* link in procfs list */
 370         struct list_head        link;           /* link in master connection list */
 371         struct sk_buff_head     rx_queue;       /* received conn-level packets */
 372         const struct rxrpc_security *security;  /* applied security module */
 373         struct key              *server_key;    /* security for this service */
 374         struct crypto_skcipher  *cipher;        /* encryption handle */
 375         struct rxrpc_crypt      csum_iv;        /* packet checksum base */
 376         unsigned long           flags;
 377         unsigned long           events;
 378         unsigned long           idle_timestamp; /* Time at which last became idle */
 379         spinlock_t              state_lock;     /* state-change lock */
 380         enum rxrpc_conn_cache_state cache_state;
 381         enum rxrpc_conn_proto_state state;      /* current state of connection */
 382         u32                     local_abort;    /* local abort code */
 383         u32                     remote_abort;   /* remote abort code */
 384         int                     debug_id;       /* debug ID for printks */
 385         atomic_t                serial;         /* packet serial number counter */
 386         unsigned int            hi_serial;      /* highest serial number received */
 387         u32                     security_nonce; /* response re-use preventer */
 388         u8                      size_align;     /* data size alignment (for security) */
 389         u8                      security_size;  /* security header size */
 390         u8                      security_ix;    /* security type */
 391         u8                      out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
 392 };
 393
 394 /*
 395  * Flags in call->flags.
 396  */
 397 enum rxrpc_call_flag {
 398         RXRPC_CALL_RELEASED,            /* call has been released - no more message to userspace */
 399         RXRPC_CALL_HAS_USERID,          /* has a user ID attached */
 400         RXRPC_CALL_IS_SERVICE,          /* Call is service call */
 401         RXRPC_CALL_EXPOSED,             /* The call was exposed to the world */
 402         RXRPC_CALL_RX_LAST,             /* Received the last packet (at rxtx_top) */
 403         RXRPC_CALL_TX_LAST,             /* Last packet in Tx buffer (at rxtx_top) */
 404         RXRPC_CALL_PINGING,             /* Ping in process */
 405 };
 406
 407 /*
 408  * Events that can be raised on a call.
 409  */
 410 enum rxrpc_call_event {
 411         RXRPC_CALL_EV_ACK,              /* need to generate ACK */
 412         RXRPC_CALL_EV_ABORT,            /* need to generate abort */
 413         RXRPC_CALL_EV_TIMER,            /* Timer expired */
 414         RXRPC_CALL_EV_RESEND,           /* Tx resend required */
 415 };
 416
 417 /*
 418  * The states that a call can be in.
 419  */
 420 enum rxrpc_call_state {
 421         RXRPC_CALL_UNINITIALISED,
 422         RXRPC_CALL_CLIENT_AWAIT_CONN,   /* - client waiting for connection to become available */
 423         RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
 424         RXRPC_CALL_CLIENT_AWAIT_REPLY,  /* - client awaiting reply */
 425         RXRPC_CALL_CLIENT_RECV_REPLY,   /* - client receiving reply phase */
 426         RXRPC_CALL_SERVER_PREALLOC,     /* - service preallocation */
 427         RXRPC_CALL_SERVER_SECURING,     /* - server securing request connection */
 428         RXRPC_CALL_SERVER_ACCEPTING,    /* - server accepting request */
 429         RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
 430         RXRPC_CALL_SERVER_ACK_REQUEST,  /* - server pending ACK of request */
 431         RXRPC_CALL_SERVER_SEND_REPLY,   /* - server sending reply */
 432         RXRPC_CALL_SERVER_AWAIT_ACK,    /* - server awaiting final ACK */
 433         RXRPC_CALL_COMPLETE,            /* - call complete */
 434         NR__RXRPC_CALL_STATES
 435 };
 436
 437 /*
 438  * Call completion condition (state == RXRPC_CALL_COMPLETE).
 439  */
 440 enum rxrpc_call_completion {
 441         RXRPC_CALL_SUCCEEDED,           /* - Normal termination */
 442         RXRPC_CALL_REMOTELY_ABORTED,    /* - call aborted by peer */
 443         RXRPC_CALL_LOCALLY_ABORTED,     /* - call aborted locally on error or close */
 444         RXRPC_CALL_LOCAL_ERROR,         /* - call failed due to local error */
 445         RXRPC_CALL_NETWORK_ERROR,       /* - call terminated by network error */
 446         NR__RXRPC_CALL_COMPLETIONS
 447 };
 448
 449 /*
 450  * RxRPC call definition
 451  * - matched by { connection, call_id }
 452  */
 453 struct rxrpc_call {
 454         struct rcu_head         rcu;
 455         struct rxrpc_connection *conn;          /* connection carrying call */
 456         struct rxrpc_peer       *peer;          /* Peer record for remote address */
 457         struct rxrpc_sock __rcu *socket;        /* socket responsible */
 458         unsigned long           ack_at;         /* When deferred ACK needs to happen */
 459         unsigned long           resend_at;      /* When next resend needs to happen */
 460         unsigned long           expire_at;      /* When the call times out */
 461         struct timer_list       timer;          /* Combined event timer */
 462         struct work_struct      processor;      /* Event processor */
 463         rxrpc_notify_rx_t       notify_rx;      /* kernel service Rx notification function */
 464         struct list_head        link;           /* link in master call list */
 465         struct list_head        chan_wait_link; /* Link in conn->waiting_calls */
 466         struct hlist_node       error_link;     /* link in error distribution list */
 467         struct list_head        accept_link;    /* Link in rx->acceptq */
 468         struct list_head        recvmsg_link;   /* Link in rx->recvmsg_q */
 469         struct list_head        sock_link;      /* Link in rx->sock_calls */
 470         struct rb_node          sock_node;      /* Node in rx->calls */
 471         struct sk_buff          *tx_pending;    /* Tx socket buffer being filled */
 472         wait_queue_head_t       waitq;          /* Wait queue for channel or Tx */
 473         __be32                  crypto_buf[2];  /* Temporary packet crypto buffer */
 474         unsigned long           user_call_ID;   /* user-defined call ID */
 475         unsigned long           flags;
 476         unsigned long           events;
 477         spinlock_t              lock;
 478         rwlock_t                state_lock;     /* lock for state transition */
 479         u32                     abort_code;     /* Local/remote abort code */
 480         int                     error;          /* Local error incurred */
 481         enum rxrpc_call_state   state;          /* current state of call */
 482         enum rxrpc_call_completion completion;  /* Call completion condition */
 483         atomic_t                usage;
 484         u16                     service_id;     /* service ID */
 485         u8                      security_ix;    /* Security type */
 486         u32                     call_id;        /* call ID on connection  */
 487         u32                     cid;            /* connection ID plus channel index */
 488         int                     debug_id;       /* debug ID for printks */
 489         unsigned short          rx_pkt_offset;  /* Current recvmsg packet offset */
 490         unsigned short          rx_pkt_len;     /* Current recvmsg packet len */
 491
 492         /* Rx/Tx circular buffer, depending on phase.
 493          *
 494          * In the Rx phase, packets are annotated with 0 or the number of the
 495          * segment of a jumbo packet each buffer refers to.  There can be up to
 496          * 47 segments in a maximum-size UDP packet.
 497          *
 498          * In the Tx phase, packets are annotated with which buffers have been
 499          * acked.
 500          */
 501 #define RXRPC_RXTX_BUFF_SIZE    64
 502 #define RXRPC_RXTX_BUFF_MASK    (RXRPC_RXTX_BUFF_SIZE - 1)
 503 #define RXRPC_INIT_RX_WINDOW_SIZE 32
 504         struct sk_buff          **rxtx_buffer;
 505         u8                      *rxtx_annotations;
 506 #define RXRPC_TX_ANNO_ACK       0
 507 #define RXRPC_TX_ANNO_UNACK     1
 508 #define RXRPC_TX_ANNO_NAK       2
 509 #define RXRPC_TX_ANNO_RETRANS   3
 510 #define RXRPC_TX_ANNO_MASK      0x03
 511 #define RXRPC_TX_ANNO_LAST      0x04
 512 #define RXRPC_TX_ANNO_RESENT    0x08
 513
 514 #define RXRPC_RX_ANNO_JUMBO     0x3f            /* Jumbo subpacket number + 1 if not zero */
 515 #define RXRPC_RX_ANNO_JLAST     0x40            /* Set if last element of a jumbo packet */
 516 #define RXRPC_RX_ANNO_VERIFIED  0x80            /* Set if verified and decrypted */
 517         rxrpc_seq_t             tx_hard_ack;    /* Dead slot in buffer; the first transmitted but
 518                                                  * not hard-ACK'd packet follows this.
 519                                                  */
 520         rxrpc_seq_t             tx_top;         /* Highest Tx slot allocated. */
 521         rxrpc_seq_t             rx_hard_ack;    /* Dead slot in buffer; the first received but not
 522                                                  * consumed packet follows this.
 523                                                  */
 524         rxrpc_seq_t             rx_top;         /* Highest Rx slot allocated. */
 525         rxrpc_seq_t             rx_expect_next; /* Expected next packet sequence number */
 526         u8                      rx_winsize;     /* Size of Rx window */
 527         u8                      tx_winsize;     /* Maximum size of Tx window */
 528         bool                    tx_phase;       /* T if transmission phase, F if receive phase */
 529         u8                      nr_jumbo_bad;   /* Number of jumbo dups/exceeds-windows */
 530
 531         /* receive-phase ACK management */
 532         u8                      ackr_reason;    /* reason to ACK */
 533         u16                     ackr_skew;      /* skew on packet being ACK'd */
 534         rxrpc_serial_t          ackr_serial;    /* serial of packet being ACK'd */
 535         rxrpc_seq_t             ackr_prev_seq;  /* previous sequence number received */
 536         rxrpc_serial_t          ackr_ping;      /* Last ping sent */
 537         ktime_t                 ackr_ping_time; /* Time last ping sent */
 538
 539         /* transmission-phase ACK management */
 540         rxrpc_serial_t          acks_latest;    /* serial number of latest ACK received */
 541 };
 542
 543 enum rxrpc_skb_trace {
 544         rxrpc_skb_rx_cleaned,
 545         rxrpc_skb_rx_freed,
 546         rxrpc_skb_rx_got,
 547         rxrpc_skb_rx_lost,
 548         rxrpc_skb_rx_received,
 549         rxrpc_skb_rx_rotated,
 550         rxrpc_skb_rx_purged,
 551         rxrpc_skb_rx_seen,
 552         rxrpc_skb_tx_cleaned,
 553         rxrpc_skb_tx_freed,
 554         rxrpc_skb_tx_got,
 555         rxrpc_skb_tx_lost,
 556         rxrpc_skb_tx_new,
 557         rxrpc_skb_tx_rotated,
 558         rxrpc_skb_tx_seen,
 559         rxrpc_skb__nr_trace
 560 };
 561
 562 extern const char rxrpc_skb_traces[rxrpc_skb__nr_trace][7];
 563
 564 enum rxrpc_conn_trace {
 565         rxrpc_conn_new_client,
 566         rxrpc_conn_new_service,
 567         rxrpc_conn_queued,
 568         rxrpc_conn_seen,
 569         rxrpc_conn_got,
 570         rxrpc_conn_put_client,
 571         rxrpc_conn_put_service,
 572         rxrpc_conn__nr_trace
 573 };
 574
 575 extern const char rxrpc_conn_traces[rxrpc_conn__nr_trace][4];
 576
 577 enum rxrpc_client_trace {
 578         rxrpc_client_activate_chans,
 579         rxrpc_client_alloc,
 580         rxrpc_client_chan_activate,
 581         rxrpc_client_chan_disconnect,
 582         rxrpc_client_chan_pass,
 583         rxrpc_client_chan_unstarted,
 584         rxrpc_client_cleanup,
 585         rxrpc_client_count,
 586         rxrpc_client_discard,
 587         rxrpc_client_duplicate,
 588         rxrpc_client_exposed,
 589         rxrpc_client_replace,
 590         rxrpc_client_to_active,
 591         rxrpc_client_to_culled,
 592         rxrpc_client_to_idle,
 593         rxrpc_client_to_inactive,
 594         rxrpc_client_to_waiting,
 595         rxrpc_client_uncount,
 596         rxrpc_client__nr_trace
 597 };
 598
 599 extern const char rxrpc_client_traces[rxrpc_client__nr_trace][7];
 600 extern const char rxrpc_conn_cache_states[RXRPC_CONN__NR_CACHE_STATES][5];
 601
 602 enum rxrpc_call_trace {
 603         rxrpc_call_new_client,
 604         rxrpc_call_new_service,
 605         rxrpc_call_queued,
 606         rxrpc_call_queued_ref,
 607         rxrpc_call_seen,
 608         rxrpc_call_connected,
 609         rxrpc_call_release,
 610         rxrpc_call_got,
 611         rxrpc_call_got_userid,
 612         rxrpc_call_got_kernel,
 613         rxrpc_call_put,
 614         rxrpc_call_put_userid,
 615         rxrpc_call_put_kernel,
 616         rxrpc_call_put_noqueue,
 617         rxrpc_call_error,
 618         rxrpc_call__nr_trace
 619 };
 620
 621 extern const char rxrpc_call_traces[rxrpc_call__nr_trace][4];
 622
 623 enum rxrpc_transmit_trace {
 624         rxrpc_transmit_wait,
 625         rxrpc_transmit_queue,
 626         rxrpc_transmit_queue_last,
 627         rxrpc_transmit_rotate,
 628         rxrpc_transmit_rotate_last,
 629         rxrpc_transmit_await_reply,
 630         rxrpc_transmit_end,
 631         rxrpc_transmit__nr_trace
 632 };
 633
 634 extern const char rxrpc_transmit_traces[rxrpc_transmit__nr_trace][4];
 635
 636 enum rxrpc_receive_trace {
 637         rxrpc_receive_incoming,
 638         rxrpc_receive_queue,
 639         rxrpc_receive_queue_last,
 640         rxrpc_receive_front,
 641         rxrpc_receive_rotate,
 642         rxrpc_receive_end,
 643         rxrpc_receive__nr_trace
 644 };
 645
 646 extern const char rxrpc_receive_traces[rxrpc_receive__nr_trace][4];
 647
 648 enum rxrpc_recvmsg_trace {
 649         rxrpc_recvmsg_enter,
 650         rxrpc_recvmsg_wait,
 651         rxrpc_recvmsg_dequeue,
 652         rxrpc_recvmsg_hole,
 653         rxrpc_recvmsg_next,
 654         rxrpc_recvmsg_cont,
 655         rxrpc_recvmsg_full,
 656         rxrpc_recvmsg_data_return,
 657         rxrpc_recvmsg_terminal,
 658         rxrpc_recvmsg_to_be_accepted,
 659         rxrpc_recvmsg_return,
 660         rxrpc_recvmsg__nr_trace
 661 };
 662
 663 extern const char rxrpc_recvmsg_traces[rxrpc_recvmsg__nr_trace][5];
 664
 665 enum rxrpc_rtt_tx_trace {
 666         rxrpc_rtt_tx_ping,
 667         rxrpc_rtt_tx_data,
 668         rxrpc_rtt_tx__nr_trace
 669 };
 670
 671 extern const char rxrpc_rtt_tx_traces[rxrpc_rtt_tx__nr_trace][5];
 672
 673 enum rxrpc_rtt_rx_trace {
 674         rxrpc_rtt_rx_ping_response,
 675         rxrpc_rtt_rx_requested_ack,
 676         rxrpc_rtt_rx__nr_trace
 677 };
 678
 679 extern const char rxrpc_rtt_rx_traces[rxrpc_rtt_rx__nr_trace][5];
 680
 681 extern const char *const rxrpc_pkts[];
 682 extern const char *rxrpc_acks(u8 reason);
 683
 684 #include <trace/events/rxrpc.h>
 685
 686 /*
 687  * af_rxrpc.c
 688  */
 689 extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
 690 extern u32 rxrpc_epoch;
 691 extern atomic_t rxrpc_debug_id;
 692 extern struct workqueue_struct *rxrpc_workqueue;
 693
 694 /*
 695  * call_accept.c
 696  */
 697 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
 698 void rxrpc_discard_prealloc(struct rxrpc_sock *);
 699 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
 700                                            struct rxrpc_connection *,
 701                                            struct sk_buff *);
 702 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
 703 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
 704                                      rxrpc_notify_rx_t);
 705 int rxrpc_reject_call(struct rxrpc_sock *);
 706
 707 /*
 708  * call_event.c
 709  */
 710 void rxrpc_set_timer(struct rxrpc_call *);
 711 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool, bool);
 712 void rxrpc_process_call(struct work_struct *);
 713
 714 /*
 715  * call_object.c
 716  */
 717 extern const char *const rxrpc_call_states[];
 718 extern const char *const rxrpc_call_completions[];
 719 extern unsigned int rxrpc_max_call_lifetime;
 720 extern struct kmem_cache *rxrpc_call_jar;
 721 extern struct list_head rxrpc_calls;
 722 extern rwlock_t rxrpc_call_lock;
 723
 724 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
 725 struct rxrpc_call *rxrpc_alloc_call(gfp_t);
 726 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
 727                                          struct rxrpc_conn_parameters *,
 728                                          struct sockaddr_rxrpc *,
 729                                          unsigned long, gfp_t);
 730 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
 731                          struct sk_buff *);
 732 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
 733 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
 734 bool __rxrpc_queue_call(struct rxrpc_call *);
 735 bool rxrpc_queue_call(struct rxrpc_call *);
 736 void rxrpc_see_call(struct rxrpc_call *);
 737 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
 738 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
 739 void rxrpc_cleanup_call(struct rxrpc_call *);
 740 void __exit rxrpc_destroy_all_calls(void);
 741
 742 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
 743 {
 744         return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
 745 }
 746
 747 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
 748 {
 749         return !rxrpc_is_service_call(call);
 750 }
 751
 752 /*
 753  * Transition a call to the complete state.
 754  */
 755 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
 756                                                enum rxrpc_call_completion compl,
 757                                                u32 abort_code,
 758                                                int error)
 759 {
 760         if (call->state < RXRPC_CALL_COMPLETE) {
 761                 call->abort_code = abort_code;
 762                 call->error = error;
 763                 call->completion = compl,
 764                 call->state = RXRPC_CALL_COMPLETE;
 765                 wake_up(&call->waitq);
 766                 return true;
 767         }
 768         return false;
 769 }
 770
 771 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
 772                                              enum rxrpc_call_completion compl,
 773                                              u32 abort_code,
 774                                              int error)
 775 {
 776         bool ret;
 777
 778         write_lock_bh(&call->state_lock);
 779         ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
 780         write_unlock_bh(&call->state_lock);
 781         return ret;
 782 }
 783
 784 /*
 785  * Record that a call successfully completed.
 786  */
 787 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
 788 {
 789         return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
 790 }
 791
 792 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
 793 {
 794         bool ret;
 795
 796         write_lock_bh(&call->state_lock);
 797         ret = __rxrpc_call_completed(call);
 798         write_unlock_bh(&call->state_lock);
 799         return ret;
 800 }
 801
 802 /*
 803  * Record that a call is locally aborted.
 804  */
 805 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
 806                                       rxrpc_seq_t seq,
 807                                       u32 abort_code, int error)
 808 {
 809         trace_rxrpc_abort(why, call->cid, call->call_id, seq,
 810                           abort_code, error);
 811         return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
 812                                            abort_code, error);
 813 }
 814
 815 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
 816                                     rxrpc_seq_t seq, u32 abort_code, int error)
 817 {
 818         bool ret;
 819
 820         write_lock_bh(&call->state_lock);
 821         ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
 822         write_unlock_bh(&call->state_lock);
 823         return ret;
 824 }
 825
 826 /*
 827  * conn_client.c
 828  */
 829 extern unsigned int rxrpc_max_client_connections;
 830 extern unsigned int rxrpc_reap_client_connections;
 831 extern unsigned int rxrpc_conn_idle_client_expiry;
 832 extern unsigned int rxrpc_conn_idle_client_fast_expiry;
 833 extern struct idr rxrpc_client_conn_ids;
 834
 835 void rxrpc_destroy_client_conn_ids(void);
 836 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
 837                        struct sockaddr_rxrpc *, gfp_t);
 838 void rxrpc_expose_client_call(struct rxrpc_call *);
 839 void rxrpc_disconnect_client_call(struct rxrpc_call *);
 840 void rxrpc_put_client_conn(struct rxrpc_connection *);
 841 void __exit rxrpc_destroy_all_client_connections(void);
 842
 843 /*
 844  * conn_event.c
 845  */
 846 void rxrpc_process_connection(struct work_struct *);
 847
 848 /*
 849  * conn_object.c
 850  */
 851 extern unsigned int rxrpc_connection_expiry;
 852 extern struct list_head rxrpc_connections;
 853 extern struct list_head rxrpc_connection_proc_list;
 854 extern rwlock_t rxrpc_connection_lock;
 855
 856 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
 857 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
 858 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
 859                                                    struct sk_buff *);
 860 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
 861 void rxrpc_disconnect_call(struct rxrpc_call *);
 862 void rxrpc_kill_connection(struct rxrpc_connection *);
 863 bool rxrpc_queue_conn(struct rxrpc_connection *);
 864 void rxrpc_see_connection(struct rxrpc_connection *);
 865 void rxrpc_get_connection(struct rxrpc_connection *);
 866 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
 867 void rxrpc_put_service_conn(struct rxrpc_connection *);
 868 void __exit rxrpc_destroy_all_connections(void);
 869
 870 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
 871 {
 872         return conn->out_clientflag;
 873 }
 874
 875 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
 876 {
 877         return !rxrpc_conn_is_client(conn);
 878 }
 879
 880 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
 881 {
 882         if (!conn)
 883                 return;
 884
 885         if (rxrpc_conn_is_client(conn))
 886                 rxrpc_put_client_conn(conn);
 887         else
 888                 rxrpc_put_service_conn(conn);
 889 }
 890
 891 /*
 892  * conn_service.c
 893  */
 894 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
 895                                                      struct sk_buff *);
 896 struct rxrpc_connection *rxrpc_prealloc_service_connection(gfp_t);
 897 void rxrpc_new_incoming_connection(struct rxrpc_connection *, struct sk_buff *);
 898 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
 899
 900 /*
 901  * input.c
 902  */
 903 void rxrpc_data_ready(struct sock *);
 904
 905 /*
 906  * insecure.c
 907  */
 908 extern const struct rxrpc_security rxrpc_no_security;
 909
 910 /*
 911  * key.c
 912  */
 913 extern struct key_type key_type_rxrpc;
 914 extern struct key_type key_type_rxrpc_s;
 915
 916 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
 917 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
 918 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
 919                               u32);
 920
 921 /*
 922  * local_event.c
 923  */
 924 extern void rxrpc_process_local_events(struct rxrpc_local *);
 925
 926 /*
 927  * local_object.c
 928  */
 929 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
 930 void __rxrpc_put_local(struct rxrpc_local *);
 931 void __exit rxrpc_destroy_all_locals(void);
 932
 933 static inline void rxrpc_get_local(struct rxrpc_local *local)
 934 {
 935         atomic_inc(&local->usage);
 936 }
 937
 938 static inline
 939 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
 940 {
 941         return atomic_inc_not_zero(&local->usage) ? local : NULL;
 942 }
 943
 944 static inline void rxrpc_put_local(struct rxrpc_local *local)
 945 {
 946         if (local && atomic_dec_and_test(&local->usage))
 947                 __rxrpc_put_local(local);
 948 }
 949
 950 static inline void rxrpc_queue_local(struct rxrpc_local *local)
 951 {
 952         rxrpc_queue_work(&local->processor);
 953 }
 954
 955 /*
 956  * misc.c
 957  */
 958 extern unsigned int rxrpc_max_backlog __read_mostly;
 959 extern unsigned int rxrpc_requested_ack_delay;
 960 extern unsigned int rxrpc_soft_ack_delay;
 961 extern unsigned int rxrpc_idle_ack_delay;
 962 extern unsigned int rxrpc_rx_window_size;
 963 extern unsigned int rxrpc_rx_mtu;
 964 extern unsigned int rxrpc_rx_jumbo_max;
 965 extern unsigned int rxrpc_resend_timeout;
 966
 967 extern const s8 rxrpc_ack_priority[];
 968
 969 /*
 970  * output.c
 971  */
 972 int rxrpc_send_call_packet(struct rxrpc_call *, u8);
 973 int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *);
 974 void rxrpc_reject_packets(struct rxrpc_local *);
 975
 976 /*
 977  * peer_event.c
 978  */
 979 void rxrpc_error_report(struct sock *);
 980 void rxrpc_peer_error_distributor(struct work_struct *);
 981 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace,
 982                         rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
 983
 984 /*
 985  * peer_object.c
 986  */
 987 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
 988                                          const struct sockaddr_rxrpc *);
 989 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
 990                                      struct sockaddr_rxrpc *, gfp_t);
 991 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
 992 struct rxrpc_peer *rxrpc_lookup_incoming_peer(struct rxrpc_local *,
 993                                               struct rxrpc_peer *);
 994
 995 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
 996 {
 997         atomic_inc(&peer->usage);
 998         return peer;
 999 }
1000
1001 static inline
1002 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
1003 {
1004         return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
1005 }
1006
1007 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
1008 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
1009 {
1010         if (peer && atomic_dec_and_test(&peer->usage))
1011                 __rxrpc_put_peer(peer);
1012 }
1013
1014 /*
1015  * proc.c
1016  */
1017 extern const struct file_operations rxrpc_call_seq_fops;
1018 extern const struct file_operations rxrpc_connection_seq_fops;
1019
1020 /*
1021  * recvmsg.c
1022  */
1023 void rxrpc_notify_socket(struct rxrpc_call *);
1024 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1025
1026 /*
1027  * rxkad.c
1028  */
1029 #ifdef CONFIG_RXKAD
1030 extern const struct rxrpc_security rxkad;
1031 #endif
1032
1033 /*
1034  * security.c
1035  */
1036 int __init rxrpc_init_security(void);
1037 void rxrpc_exit_security(void);
1038 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1039 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
1040
1041 /*
1042  * sendmsg.c
1043  */
1044 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1045
1046 /*
1047  * skbuff.c
1048  */
1049 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1050 void rxrpc_packet_destructor(struct sk_buff *);
1051 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1052 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1053 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1054 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1055 void rxrpc_lose_skb(struct sk_buff *, enum rxrpc_skb_trace);
1056 void rxrpc_purge_queue(struct sk_buff_head *);
1057
1058 /*
1059  * sysctl.c
1060  */
1061 #ifdef CONFIG_SYSCTL
1062 extern int __init rxrpc_sysctl_init(void);
1063 extern void rxrpc_sysctl_exit(void);
1064 #else
1065 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1066 static inline void rxrpc_sysctl_exit(void) {}
1067 #endif
1068
1069 /*
1070  * utils.c
1071  */
1072 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1073
1074 static inline bool before(u32 seq1, u32 seq2)
1075 {
1076         return (s32)(seq1 - seq2) < 0;
1077 }
1078 static inline bool before_eq(u32 seq1, u32 seq2)
1079 {
1080         return (s32)(seq1 - seq2) <= 0;
1081 }
1082 static inline bool after(u32 seq1, u32 seq2)
1083 {
1084         return (s32)(seq1 - seq2) > 0;
1085 }
1086 static inline bool after_eq(u32 seq1, u32 seq2)
1087 {
1088         return (s32)(seq1 - seq2) >= 0;
1089 }
1090
1091 /*
1092  * debug tracing
1093  */
1094 extern unsigned int rxrpc_debug;
1095
1096 #define dbgprintk(FMT,...) \
1097         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1098
1099 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1100 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1101 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1102 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1103 #define knet(FMT,...)   dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1104
1105
1106 #if defined(__KDEBUG)
1107 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1108 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1109 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1110 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1111 #define _net(FMT,...)   knet(FMT,##__VA_ARGS__)
1112
1113 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1114 #define RXRPC_DEBUG_KENTER      0x01
1115 #define RXRPC_DEBUG_KLEAVE      0x02
1116 #define RXRPC_DEBUG_KDEBUG      0x04
1117 #define RXRPC_DEBUG_KPROTO      0x08
1118 #define RXRPC_DEBUG_KNET        0x10
1119
1120 #define _enter(FMT,...)                                 \
1121 do {                                                    \
1122         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1123                 kenter(FMT,##__VA_ARGS__);              \
1124 } while (0)
1125
1126 #define _leave(FMT,...)                                 \
1127 do {                                                    \
1128         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1129                 kleave(FMT,##__VA_ARGS__);              \
1130 } while (0)
1131
1132 #define _debug(FMT,...)                                 \
1133 do {                                                    \
1134         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1135                 kdebug(FMT,##__VA_ARGS__);              \
1136 } while (0)
1137
1138 #define _proto(FMT,...)                                 \
1139 do {                                                    \
1140         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1141                 kproto(FMT,##__VA_ARGS__);              \
1142 } while (0)
1143
1144 #define _net(FMT,...)                                   \
1145 do {                                                    \
1146         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))   \
1147                 knet(FMT,##__VA_ARGS__);                \
1148 } while (0)
1149
1150 #else
1151 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1152 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1153 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1154 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1155 #define _net(FMT,...)   no_printk("@@@ "FMT ,##__VA_ARGS__)
1156 #endif
1157
1158 /*
1159  * debug assertion checking
1160  */
1161 #if 1 // defined(__KDEBUGALL)
1162
1163 #define ASSERT(X)                                               \
1164 do {                                                            \
1165         if (unlikely(!(X))) {                                   \
1166                 pr_err("Assertion failed\n");                   \
1167                 BUG();                                          \
1168         }                                                       \
1169 } while (0)
1170
1171 #define ASSERTCMP(X, OP, Y)                                             \
1172 do {                                                                    \
1173         __typeof__(X) _x = (X);                                         \
1174         __typeof__(Y) _y = (__typeof__(X))(Y);                          \
1175         if (unlikely(!(_x OP _y))) {                                    \
1176                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1177                        (unsigned long)_x, (unsigned long)_x, #OP,       \
1178                        (unsigned long)_y, (unsigned long)_y);           \
1179                 BUG();                                                  \
1180         }                                                               \
1181 } while (0)
1182
1183 #define ASSERTIF(C, X)                                          \
1184 do {                                                            \
1185         if (unlikely((C) && !(X))) {                            \
1186                 pr_err("Assertion failed\n");                   \
1187                 BUG();                                          \
1188         }                                                       \
1189 } while (0)
1190
1191 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1192 do {                                                                    \
1193         __typeof__(X) _x = (X);                                         \
1194         __typeof__(Y) _y = (__typeof__(X))(Y);                          \
1195         if (unlikely((C) && !(_x OP _y))) {                             \
1196                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1197                        (unsigned long)_x, (unsigned long)_x, #OP,       \
1198                        (unsigned long)_y, (unsigned long)_y);           \
1199                 BUG();                                                  \
1200         }                                                               \
1201 } while (0)
1202
1203 #else
1204
1205 #define ASSERT(X)                               \
1206 do {                                            \
1207 } while (0)
1208
1209 #define ASSERTCMP(X, OP, Y)                     \
1210 do {                                            \
1211 } while (0)
1212
1213 #define ASSERTIF(C, X)                          \
1214 do {                                            \
1215 } while (0)
1216
1217 #define ASSERTIFCMP(C, X, OP, Y)                \
1218 do {                                            \
1219 } while (0)
1220
1221 #endif /* __KDEBUGALL */