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 enum rxrpc_call_trace { 512 rxrpc_call_new_client, 513 rxrpc_call_new_service, 514 rxrpc_call_queued, 515 rxrpc_call_queued_ref, 516 rxrpc_call_seen, 517 rxrpc_call_got, 518 rxrpc_call_got_skb, 519 rxrpc_call_got_userid, 520 rxrpc_call_put, 521 rxrpc_call_put_skb, 522 rxrpc_call_put_userid, 523 rxrpc_call_put_noqueue, 524 rxrpc_call__nr_trace 525 }; 526 527 extern const char rxrpc_call_traces[rxrpc_call__nr_trace][4]; 528 529 #include <trace/events/rxrpc.h> 530 531 /* 532 * af_rxrpc.c 533 */ 534 extern atomic_t rxrpc_n_skbs; 535 extern u32 rxrpc_epoch; 536 extern atomic_t rxrpc_debug_id; 537 extern struct workqueue_struct *rxrpc_workqueue; 538 539 /* 540 * call_accept.c 541 */ 542 void rxrpc_accept_incoming_calls(struct rxrpc_local *); 543 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long, 544 rxrpc_notify_rx_t); 545 int rxrpc_reject_call(struct rxrpc_sock *); 546 547 /* 548 * call_event.c 549 */ 550 void __rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool); 551 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool); 552 void rxrpc_process_call(struct work_struct *); 553 554 /* 555 * call_object.c 556 */ 557 extern const char *const rxrpc_call_states[]; 558 extern const char *const rxrpc_call_completions[]; 559 extern unsigned int rxrpc_max_call_lifetime; 560 extern unsigned int rxrpc_dead_call_expiry; 561 extern struct kmem_cache *rxrpc_call_jar; 562 extern struct list_head rxrpc_calls; 563 extern rwlock_t rxrpc_call_lock; 564 565 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long); 566 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *, 567 struct rxrpc_conn_parameters *, 568 struct sockaddr_rxrpc *, 569 unsigned long, gfp_t); 570 struct rxrpc_call *rxrpc_incoming_call(struct rxrpc_sock *, 571 struct rxrpc_connection *, 572 struct sk_buff *); 573 void rxrpc_release_call(struct rxrpc_call *); 574 void rxrpc_release_calls_on_socket(struct rxrpc_sock *); 575 void rxrpc_see_call(struct rxrpc_call *); 576 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace); 577 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace); 578 void rxrpc_get_call_for_skb(struct rxrpc_call *, struct sk_buff *); 579 void rxrpc_put_call_for_skb(struct rxrpc_call *, struct sk_buff *); 580 void __exit rxrpc_destroy_all_calls(void); 581 582 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call) 583 { 584 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags); 585 } 586 587 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call) 588 { 589 return !rxrpc_is_service_call(call); 590 } 591 592 /* 593 * Transition a call to the complete state. 594 */ 595 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call, 596 enum rxrpc_call_completion compl, 597 u32 abort_code, 598 int error) 599 { 600 if (call->state < RXRPC_CALL_COMPLETE) { 601 call->abort_code = abort_code; 602 call->error = error; 603 call->completion = compl, 604 call->state = RXRPC_CALL_COMPLETE; 605 return true; 606 } 607 return false; 608 } 609 610 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call, 611 enum rxrpc_call_completion compl, 612 u32 abort_code, 613 int error) 614 { 615 int ret; 616 617 write_lock_bh(&call->state_lock); 618 ret = __rxrpc_set_call_completion(call, compl, abort_code, error); 619 write_unlock_bh(&call->state_lock); 620 return ret; 621 } 622 623 /* 624 * Record that a call successfully completed. 625 */ 626 static inline void __rxrpc_call_completed(struct rxrpc_call *call) 627 { 628 __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0); 629 } 630 631 static inline void rxrpc_call_completed(struct rxrpc_call *call) 632 { 633 write_lock_bh(&call->state_lock); 634 __rxrpc_call_completed(call); 635 write_unlock_bh(&call->state_lock); 636 } 637 638 /* 639 * Record that a call is locally aborted. 640 */ 641 static inline bool __rxrpc_abort_call(struct rxrpc_call *call, 642 u32 abort_code, int error) 643 { 644 if (__rxrpc_set_call_completion(call, 645 RXRPC_CALL_LOCALLY_ABORTED, 646 abort_code, error)) { 647 set_bit(RXRPC_CALL_EV_ABORT, &call->events); 648 return true; 649 } 650 return false; 651 } 652 653 static inline bool rxrpc_abort_call(struct rxrpc_call *call, 654 u32 abort_code, int error) 655 { 656 bool ret; 657 658 write_lock_bh(&call->state_lock); 659 ret = __rxrpc_abort_call(call, abort_code, error); 660 write_unlock_bh(&call->state_lock); 661 return ret; 662 } 663 664 /* 665 * conn_client.c 666 */ 667 extern unsigned int rxrpc_max_client_connections; 668 extern unsigned int rxrpc_reap_client_connections; 669 extern unsigned int rxrpc_conn_idle_client_expiry; 670 extern unsigned int rxrpc_conn_idle_client_fast_expiry; 671 extern struct idr rxrpc_client_conn_ids; 672 673 void rxrpc_destroy_client_conn_ids(void); 674 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *, 675 struct sockaddr_rxrpc *, gfp_t); 676 void rxrpc_expose_client_call(struct rxrpc_call *); 677 void rxrpc_disconnect_client_call(struct rxrpc_call *); 678 void rxrpc_put_client_conn(struct rxrpc_connection *); 679 void __exit rxrpc_destroy_all_client_connections(void); 680 681 /* 682 * conn_event.c 683 */ 684 void rxrpc_process_connection(struct work_struct *); 685 void rxrpc_reject_packet(struct rxrpc_local *, struct sk_buff *); 686 void rxrpc_reject_packets(struct rxrpc_local *); 687 688 /* 689 * conn_object.c 690 */ 691 extern unsigned int rxrpc_connection_expiry; 692 extern struct list_head rxrpc_connections; 693 extern struct list_head rxrpc_connection_proc_list; 694 extern rwlock_t rxrpc_connection_lock; 695 696 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *); 697 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t); 698 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *, 699 struct sk_buff *); 700 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *); 701 void rxrpc_disconnect_call(struct rxrpc_call *); 702 void rxrpc_kill_connection(struct rxrpc_connection *); 703 void __rxrpc_put_connection(struct rxrpc_connection *); 704 void __exit rxrpc_destroy_all_connections(void); 705 706 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn) 707 { 708 return conn->out_clientflag; 709 } 710 711 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn) 712 { 713 return !rxrpc_conn_is_client(conn); 714 } 715 716 static inline void rxrpc_get_connection(struct rxrpc_connection *conn) 717 { 718 atomic_inc(&conn->usage); 719 } 720 721 static inline 722 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *conn) 723 { 724 return atomic_inc_not_zero(&conn->usage) ? conn : NULL; 725 } 726 727 static inline void rxrpc_put_connection(struct rxrpc_connection *conn) 728 { 729 if (!conn) 730 return; 731 732 if (rxrpc_conn_is_client(conn)) { 733 if (atomic_dec_and_test(&conn->usage)) 734 rxrpc_put_client_conn(conn); 735 } else { 736 if (atomic_dec_return(&conn->usage) == 1) 737 __rxrpc_put_connection(conn); 738 } 739 } 740 741 static inline bool rxrpc_queue_conn(struct rxrpc_connection *conn) 742 { 743 if (!rxrpc_get_connection_maybe(conn)) 744 return false; 745 if (!rxrpc_queue_work(&conn->processor)) 746 rxrpc_put_connection(conn); 747 return true; 748 } 749 750 /* 751 * conn_service.c 752 */ 753 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *, 754 struct sk_buff *); 755 struct rxrpc_connection *rxrpc_incoming_connection(struct rxrpc_local *, 756 struct sockaddr_rxrpc *, 757 struct sk_buff *); 758 void rxrpc_unpublish_service_conn(struct rxrpc_connection *); 759 760 /* 761 * input.c 762 */ 763 void rxrpc_data_ready(struct sock *); 764 int rxrpc_queue_rcv_skb(struct rxrpc_call *, struct sk_buff *, bool, bool); 765 void rxrpc_fast_process_packet(struct rxrpc_call *, struct sk_buff *); 766 767 /* 768 * insecure.c 769 */ 770 extern const struct rxrpc_security rxrpc_no_security; 771 772 /* 773 * key.c 774 */ 775 extern struct key_type key_type_rxrpc; 776 extern struct key_type key_type_rxrpc_s; 777 778 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int); 779 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int); 780 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t, 781 u32); 782 783 /* 784 * local_event.c 785 */ 786 extern void rxrpc_process_local_events(struct rxrpc_local *); 787 788 /* 789 * local_object.c 790 */ 791 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *); 792 void __rxrpc_put_local(struct rxrpc_local *); 793 void __exit rxrpc_destroy_all_locals(void); 794 795 static inline void rxrpc_get_local(struct rxrpc_local *local) 796 { 797 atomic_inc(&local->usage); 798 } 799 800 static inline 801 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local) 802 { 803 return atomic_inc_not_zero(&local->usage) ? local : NULL; 804 } 805 806 static inline void rxrpc_put_local(struct rxrpc_local *local) 807 { 808 if (local && atomic_dec_and_test(&local->usage)) 809 __rxrpc_put_local(local); 810 } 811 812 static inline void rxrpc_queue_local(struct rxrpc_local *local) 813 { 814 rxrpc_queue_work(&local->processor); 815 } 816 817 /* 818 * misc.c 819 */ 820 extern unsigned int rxrpc_max_backlog __read_mostly; 821 extern unsigned int rxrpc_requested_ack_delay; 822 extern unsigned int rxrpc_soft_ack_delay; 823 extern unsigned int rxrpc_idle_ack_delay; 824 extern unsigned int rxrpc_rx_window_size; 825 extern unsigned int rxrpc_rx_mtu; 826 extern unsigned int rxrpc_rx_jumbo_max; 827 extern unsigned int rxrpc_resend_timeout; 828 829 extern const char *const rxrpc_pkts[]; 830 extern const s8 rxrpc_ack_priority[]; 831 832 extern const char *rxrpc_acks(u8 reason); 833 834 /* 835 * output.c 836 */ 837 int rxrpc_send_data_packet(struct rxrpc_connection *, struct sk_buff *); 838 839 /* 840 * peer_event.c 841 */ 842 void rxrpc_error_report(struct sock *); 843 void rxrpc_peer_error_distributor(struct work_struct *); 844 845 /* 846 * peer_object.c 847 */ 848 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *, 849 const struct sockaddr_rxrpc *); 850 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *, 851 struct sockaddr_rxrpc *, gfp_t); 852 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t); 853 854 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer) 855 { 856 atomic_inc(&peer->usage); 857 return peer; 858 } 859 860 static inline 861 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer) 862 { 863 return atomic_inc_not_zero(&peer->usage) ? peer : NULL; 864 } 865 866 extern void __rxrpc_put_peer(struct rxrpc_peer *peer); 867 static inline void rxrpc_put_peer(struct rxrpc_peer *peer) 868 { 869 if (peer && atomic_dec_and_test(&peer->usage)) 870 __rxrpc_put_peer(peer); 871 } 872 873 /* 874 * proc.c 875 */ 876 extern const struct file_operations rxrpc_call_seq_fops; 877 extern const struct file_operations rxrpc_connection_seq_fops; 878 879 /* 880 * recvmsg.c 881 */ 882 void rxrpc_remove_user_ID(struct rxrpc_sock *, struct rxrpc_call *); 883 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int); 884 885 /* 886 * rxkad.c 887 */ 888 #ifdef CONFIG_RXKAD 889 extern const struct rxrpc_security rxkad; 890 #endif 891 892 /* 893 * security.c 894 */ 895 int __init rxrpc_init_security(void); 896 void rxrpc_exit_security(void); 897 int rxrpc_init_client_conn_security(struct rxrpc_connection *); 898 int rxrpc_init_server_conn_security(struct rxrpc_connection *); 899 900 /* 901 * sendmsg.c 902 */ 903 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t); 904 905 /* 906 * skbuff.c 907 */ 908 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *); 909 void rxrpc_packet_destructor(struct sk_buff *); 910 void rxrpc_new_skb(struct sk_buff *); 911 void rxrpc_see_skb(struct sk_buff *); 912 void rxrpc_get_skb(struct sk_buff *); 913 void rxrpc_free_skb(struct sk_buff *); 914 void rxrpc_purge_queue(struct sk_buff_head *); 915 916 /* 917 * sysctl.c 918 */ 919 #ifdef CONFIG_SYSCTL 920 extern int __init rxrpc_sysctl_init(void); 921 extern void rxrpc_sysctl_exit(void); 922 #else 923 static inline int __init rxrpc_sysctl_init(void) { return 0; } 924 static inline void rxrpc_sysctl_exit(void) {} 925 #endif 926 927 /* 928 * utils.c 929 */ 930 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *); 931 932 /* 933 * debug tracing 934 */ 935 extern unsigned int rxrpc_debug; 936 937 #define dbgprintk(FMT,...) \ 938 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__) 939 940 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__) 941 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__) 942 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__) 943 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__) 944 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__) 945 946 947 #if defined(__KDEBUG) 948 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__) 949 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__) 950 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__) 951 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__) 952 #define _net(FMT,...) knet(FMT,##__VA_ARGS__) 953 954 #elif defined(CONFIG_AF_RXRPC_DEBUG) 955 #define RXRPC_DEBUG_KENTER 0x01 956 #define RXRPC_DEBUG_KLEAVE 0x02 957 #define RXRPC_DEBUG_KDEBUG 0x04 958 #define RXRPC_DEBUG_KPROTO 0x08 959 #define RXRPC_DEBUG_KNET 0x10 960 961 #define _enter(FMT,...) \ 962 do { \ 963 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \ 964 kenter(FMT,##__VA_ARGS__); \ 965 } while (0) 966 967 #define _leave(FMT,...) \ 968 do { \ 969 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \ 970 kleave(FMT,##__VA_ARGS__); \ 971 } while (0) 972 973 #define _debug(FMT,...) \ 974 do { \ 975 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \ 976 kdebug(FMT,##__VA_ARGS__); \ 977 } while (0) 978 979 #define _proto(FMT,...) \ 980 do { \ 981 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \ 982 kproto(FMT,##__VA_ARGS__); \ 983 } while (0) 984 985 #define _net(FMT,...) \ 986 do { \ 987 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \ 988 knet(FMT,##__VA_ARGS__); \ 989 } while (0) 990 991 #else 992 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__) 993 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__) 994 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__) 995 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__) 996 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__) 997 #endif 998 999 /* 1000 * debug assertion checking 1001 */ 1002 #if 1 // defined(__KDEBUGALL) 1003 1004 #define ASSERT(X) \ 1005 do { \ 1006 if (unlikely(!(X))) { \ 1007 pr_err("Assertion failed\n"); \ 1008 BUG(); \ 1009 } \ 1010 } while (0) 1011 1012 #define ASSERTCMP(X, OP, Y) \ 1013 do { \ 1014 unsigned long _x = (unsigned long)(X); \ 1015 unsigned long _y = (unsigned long)(Y); \ 1016 if (unlikely(!(_x OP _y))) { \ 1017 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \ 1018 _x, _x, #OP, _y, _y); \ 1019 BUG(); \ 1020 } \ 1021 } while (0) 1022 1023 #define ASSERTIF(C, X) \ 1024 do { \ 1025 if (unlikely((C) && !(X))) { \ 1026 pr_err("Assertion failed\n"); \ 1027 BUG(); \ 1028 } \ 1029 } while (0) 1030 1031 #define ASSERTIFCMP(C, X, OP, Y) \ 1032 do { \ 1033 unsigned long _x = (unsigned long)(X); \ 1034 unsigned long _y = (unsigned long)(Y); \ 1035 if (unlikely((C) && !(_x OP _y))) { \ 1036 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \ 1037 _x, _x, #OP, _y, _y); \ 1038 BUG(); \ 1039 } \ 1040 } while (0) 1041 1042 #else 1043 1044 #define ASSERT(X) \ 1045 do { \ 1046 } while (0) 1047 1048 #define ASSERTCMP(X, OP, Y) \ 1049 do { \ 1050 } while (0) 1051 1052 #define ASSERTIF(C, X) \ 1053 do { \ 1054 } while (0) 1055 1056 #define ASSERTIFCMP(C, X, OP, Y) \ 1057 do { \ 1058 } while (0) 1059 1060 #endif /* __KDEBUGALL */ 1061