inet_connection_sock.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. /*
  2. * NET Generic infrastructure for INET connection oriented protocols.
  3. *
  4. * Definitions for inet_connection_sock
  5. *
  6. * Authors: Many people, see the TCP sources
  7. *
  8. * From code originally in TCP
  9. *
  10. * This program is free software; you can redistribute it and/or
  11. * modify it under the terms of the GNU General Public License
  12. * as published by the Free Software Foundation; either version
  13. * 2 of the License, or (at your option) any later version.
  14. */
  15. #ifndef _INET_CONNECTION_SOCK_H
  16. #define _INET_CONNECTION_SOCK_H
  17. #include <linux/compiler.h>
  18. #include <linux/string.h>
  19. #include <linux/timer.h>
  20. #include <linux/poll.h>
  21. #include <net/inet_sock.h>
  22. #include <net/request_sock.h>
  23. #define INET_CSK_DEBUG 1
  24. /* Cancel timers, when they are not required. */
  25. #undef INET_CSK_CLEAR_TIMERS
  26. struct inet_bind_bucket;
  27. struct tcp_congestion_ops;
  28. /*
  29. * Pointers to address related TCP functions
  30. * (i.e. things that depend on the address family)
  31. */
  32. struct inet_connection_sock_af_ops {
  33. int (*queue_xmit)(struct sk_buff *skb, struct flowi *fl);
  34. void (*send_check)(struct sock *sk, struct sk_buff *skb);
  35. int (*rebuild_header)(struct sock *sk);
  36. int (*conn_request)(struct sock *sk, struct sk_buff *skb);
  37. struct sock *(*syn_recv_sock)(struct sock *sk, struct sk_buff *skb,
  38. struct request_sock *req,
  39. struct dst_entry *dst);
  40. struct inet_peer *(*get_peer)(struct sock *sk, bool *release_it);
  41. u16 net_header_len;
  42. u16 sockaddr_len;
  43. int (*setsockopt)(struct sock *sk, int level, int optname,
  44. char __user *optval, unsigned int optlen);
  45. int (*getsockopt)(struct sock *sk, int level, int optname,
  46. char __user *optval, int __user *optlen);
  47. #ifdef CONFIG_COMPAT
  48. int (*compat_setsockopt)(struct sock *sk,
  49. int level, int optname,
  50. char __user *optval, unsigned int optlen);
  51. int (*compat_getsockopt)(struct sock *sk,
  52. int level, int optname,
  53. char __user *optval, int __user *optlen);
  54. #endif
  55. void (*addr2sockaddr)(struct sock *sk, struct sockaddr *);
  56. int (*bind_conflict)(const struct sock *sk,
  57. const struct inet_bind_bucket *tb);
  58. };
  59. /** inet_connection_sock - INET connection oriented sock
  60. *
  61. * @icsk_accept_queue: FIFO of established children
  62. * @icsk_bind_hash: Bind node
  63. * @icsk_timeout: Timeout
  64. * @icsk_retransmit_timer: Resend (no ack)
  65. * @icsk_rto: Retransmit timeout
  66. * @icsk_pmtu_cookie Last pmtu seen by socket
  67. * @icsk_ca_ops Pluggable congestion control hook
  68. * @icsk_af_ops Operations which are AF_INET{4,6} specific
  69. * @icsk_ca_state: Congestion control state
  70. * @icsk_retransmits: Number of unrecovered [RTO] timeouts
  71. * @icsk_pending: Scheduled timer event
  72. * @icsk_backoff: Backoff
  73. * @icsk_syn_retries: Number of allowed SYN (or equivalent) retries
  74. * @icsk_probes_out: unanswered 0 window probes
  75. * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options)
  76. * @icsk_ack: Delayed ACK control data
  77. * @icsk_mtup; MTU probing control data
  78. */
  79. struct inet_connection_sock {
  80. /* inet_sock has to be the first member! */
  81. struct inet_sock icsk_inet;
  82. struct request_sock_queue icsk_accept_queue;
  83. struct inet_bind_bucket *icsk_bind_hash;
  84. unsigned long icsk_timeout;
  85. struct timer_list icsk_retransmit_timer;
  86. struct timer_list icsk_delack_timer;
  87. __u32 icsk_rto;
  88. __u32 icsk_pmtu_cookie;
  89. const struct tcp_congestion_ops *icsk_ca_ops;
  90. const struct inet_connection_sock_af_ops *icsk_af_ops;
  91. unsigned int (*icsk_sync_mss)(struct sock *sk, u32 pmtu);
  92. __u8 icsk_ca_state;
  93. __u8 icsk_retransmits;
  94. __u8 icsk_pending;
  95. __u8 icsk_backoff;
  96. __u8 icsk_syn_retries;
  97. __u8 icsk_probes_out;
  98. __u16 icsk_ext_hdr_len;
  99. struct {
  100. __u8 pending; /* ACK is pending */
  101. __u8 quick; /* Scheduled number of quick acks */
  102. __u8 pingpong; /* The session is interactive */
  103. __u8 blocked; /* Delayed ACK was blocked by socket lock */
  104. __u32 ato; /* Predicted tick of soft clock */
  105. unsigned long timeout; /* Currently scheduled timeout */
  106. __u32 lrcvtime; /* timestamp of last received data packet */
  107. __u16 last_seg_size; /* Size of last incoming segment */
  108. __u16 rcv_mss; /* MSS used for delayed ACK decisions */
  109. } icsk_ack;
  110. struct {
  111. int enabled;
  112. /* Range of MTUs to search */
  113. int search_high;
  114. int search_low;
  115. /* Information on the current probe. */
  116. int probe_size;
  117. } icsk_mtup;
  118. u32 icsk_ca_priv[16];
  119. u32 icsk_user_timeout;
  120. #define ICSK_CA_PRIV_SIZE (16 * sizeof(u32))
  121. };
  122. #define ICSK_TIME_RETRANS 1 /* Retransmit timer */
  123. #define ICSK_TIME_DACK 2 /* Delayed ack timer */
  124. #define ICSK_TIME_PROBE0 3 /* Zero window probe timer */
  125. static inline struct inet_connection_sock *inet_csk(const struct sock *sk)
  126. {
  127. return (struct inet_connection_sock *)sk;
  128. }
  129. static inline void *inet_csk_ca(const struct sock *sk)
  130. {
  131. return (void *)inet_csk(sk)->icsk_ca_priv;
  132. }
  133. extern struct sock *inet_csk_clone_lock(const struct sock *sk,
  134. const struct request_sock *req,
  135. const gfp_t priority);
  136. enum inet_csk_ack_state_t {
  137. ICSK_ACK_SCHED = 1,
  138. ICSK_ACK_TIMER = 2,
  139. ICSK_ACK_PUSHED = 4,
  140. ICSK_ACK_PUSHED2 = 8
  141. };
  142. extern void inet_csk_init_xmit_timers(struct sock *sk,
  143. void (*retransmit_handler)(unsigned long),
  144. void (*delack_handler)(unsigned long),
  145. void (*keepalive_handler)(unsigned long));
  146. extern void inet_csk_clear_xmit_timers(struct sock *sk);
  147. static inline void inet_csk_schedule_ack(struct sock *sk)
  148. {
  149. inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED;
  150. }
  151. static inline int inet_csk_ack_scheduled(const struct sock *sk)
  152. {
  153. return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
  154. }
  155. static inline void inet_csk_delack_init(struct sock *sk)
  156. {
  157. memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
  158. }
  159. extern void inet_csk_delete_keepalive_timer(struct sock *sk);
  160. extern void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
  161. #ifdef INET_CSK_DEBUG
  162. extern const char inet_csk_timer_bug_msg[];
  163. #endif
  164. static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
  165. {
  166. struct inet_connection_sock *icsk = inet_csk(sk);
  167. if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
  168. icsk->icsk_pending = 0;
  169. #ifdef INET_CSK_CLEAR_TIMERS
  170. sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
  171. #endif
  172. } else if (what == ICSK_TIME_DACK) {
  173. icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0;
  174. #ifdef INET_CSK_CLEAR_TIMERS
  175. sk_stop_timer(sk, &icsk->icsk_delack_timer);
  176. #endif
  177. }
  178. #ifdef INET_CSK_DEBUG
  179. else {
  180. pr_debug("%s", inet_csk_timer_bug_msg);
  181. }
  182. #endif
  183. }
  184. /*
  185. * Reset the retransmission timer
  186. */
  187. static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what,
  188. unsigned long when,
  189. const unsigned long max_when)
  190. {
  191. struct inet_connection_sock *icsk = inet_csk(sk);
  192. if (when > max_when) {
  193. #ifdef INET_CSK_DEBUG
  194. pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
  195. sk, what, when, current_text_addr());
  196. #endif
  197. when = max_when;
  198. }
  199. if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
  200. icsk->icsk_pending = what;
  201. icsk->icsk_timeout = jiffies + when;
  202. sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
  203. } else if (what == ICSK_TIME_DACK) {
  204. icsk->icsk_ack.pending |= ICSK_ACK_TIMER;
  205. icsk->icsk_ack.timeout = jiffies + when;
  206. sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
  207. }
  208. #ifdef INET_CSK_DEBUG
  209. else {
  210. pr_debug("%s", inet_csk_timer_bug_msg);
  211. }
  212. #endif
  213. }
  214. extern struct sock *inet_csk_accept(struct sock *sk, int flags, int *err);
  215. extern struct request_sock *inet_csk_search_req(const struct sock *sk,
  216. struct request_sock ***prevp,
  217. const __be16 rport,
  218. const __be32 raddr,
  219. const __be32 laddr);
  220. extern int inet_csk_bind_conflict(const struct sock *sk,
  221. const struct inet_bind_bucket *tb);
  222. extern int inet_csk_get_port(struct sock *sk, unsigned short snum);
  223. extern struct dst_entry* inet_csk_route_req(struct sock *sk,
  224. struct flowi4 *fl4,
  225. const struct request_sock *req);
  226. extern struct dst_entry* inet_csk_route_child_sock(struct sock *sk,
  227. struct sock *newsk,
  228. const struct request_sock *req);
  229. static inline void inet_csk_reqsk_queue_add(struct sock *sk,
  230. struct request_sock *req,
  231. struct sock *child)
  232. {
  233. reqsk_queue_add(&inet_csk(sk)->icsk_accept_queue, req, sk, child);
  234. }
  235. extern void inet_csk_reqsk_queue_hash_add(struct sock *sk,
  236. struct request_sock *req,
  237. unsigned long timeout);
  238. static inline void inet_csk_reqsk_queue_removed(struct sock *sk,
  239. struct request_sock *req)
  240. {
  241. if (reqsk_queue_removed(&inet_csk(sk)->icsk_accept_queue, req) == 0)
  242. inet_csk_delete_keepalive_timer(sk);
  243. }
  244. static inline void inet_csk_reqsk_queue_added(struct sock *sk,
  245. const unsigned long timeout)
  246. {
  247. if (reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue) == 0)
  248. inet_csk_reset_keepalive_timer(sk, timeout);
  249. }
  250. static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
  251. {
  252. return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
  253. }
  254. static inline int inet_csk_reqsk_queue_young(const struct sock *sk)
  255. {
  256. return reqsk_queue_len_young(&inet_csk(sk)->icsk_accept_queue);
  257. }
  258. static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
  259. {
  260. return reqsk_queue_is_full(&inet_csk(sk)->icsk_accept_queue);
  261. }
  262. static inline void inet_csk_reqsk_queue_unlink(struct sock *sk,
  263. struct request_sock *req,
  264. struct request_sock **prev)
  265. {
  266. reqsk_queue_unlink(&inet_csk(sk)->icsk_accept_queue, req, prev);
  267. }
  268. static inline void inet_csk_reqsk_queue_drop(struct sock *sk,
  269. struct request_sock *req,
  270. struct request_sock **prev)
  271. {
  272. inet_csk_reqsk_queue_unlink(sk, req, prev);
  273. inet_csk_reqsk_queue_removed(sk, req);
  274. reqsk_free(req);
  275. }
  276. extern void inet_csk_reqsk_queue_prune(struct sock *parent,
  277. const unsigned long interval,
  278. const unsigned long timeout,
  279. const unsigned long max_rto);
  280. extern void inet_csk_destroy_sock(struct sock *sk);
  281. extern void inet_csk_prepare_forced_close(struct sock *sk);
  282. /*
  283. * LISTEN is a special case for poll..
  284. */
  285. static inline unsigned int inet_csk_listen_poll(const struct sock *sk)
  286. {
  287. return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
  288. (POLLIN | POLLRDNORM) : 0;
  289. }
  290. extern int inet_csk_listen_start(struct sock *sk, const int nr_table_entries);
  291. extern void inet_csk_listen_stop(struct sock *sk);
  292. extern void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr);
  293. extern int inet_csk_compat_getsockopt(struct sock *sk, int level, int optname,
  294. char __user *optval, int __user *optlen);
  295. extern int inet_csk_compat_setsockopt(struct sock *sk, int level, int optname,
  296. char __user *optval, unsigned int optlen);
  297. #endif /* _INET_CONNECTION_SOCK_H */