sys/netinet/sctp_var.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
   5  * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
   6  * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * a) Redistributions of source code must retain the above copyright notice,
  12  *    this list of conditions and the following disclaimer.
  13  *
  14  * b) Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the distribution.
  17  *
  18  * c) Neither the name of Cisco Systems, Inc. nor the names of its
  19  *    contributors may be used to endorse or promote products derived
  20  *    from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32  * THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #ifndef _NETINET_SCTP_VAR_H_
  39 #define _NETINET_SCTP_VAR_H_
  40
  41 #include <netinet/sctp_uio.h>
  42
  43 #if defined(_KERNEL) || defined(__Userspace__)
  44
  45 extern struct pr_usrreqs sctp_usrreqs;
  46
  47 #define sctp_feature_on(inp, feature)  (inp->sctp_features |= feature)
  48 #define sctp_feature_off(inp, feature) (inp->sctp_features &= ~feature)
  49 #define sctp_is_feature_on(inp, feature) ((inp->sctp_features & feature) == feature)
  50 #define sctp_is_feature_off(inp, feature) ((inp->sctp_features & feature) == 0)
  51
  52 #define sctp_stcb_feature_on(inp, stcb, feature) {\
  53         if (stcb) { \
  54                 stcb->asoc.sctp_features |= feature; \
  55         } else if (inp) { \
  56                 inp->sctp_features |= feature; \
  57         } \
  58 }
  59 #define sctp_stcb_feature_off(inp, stcb, feature) {\
  60         if (stcb) { \
  61                 stcb->asoc.sctp_features &= ~feature; \
  62         } else if (inp) { \
  63                 inp->sctp_features &= ~feature; \
  64         } \
  65 }
  66 #define sctp_stcb_is_feature_on(inp, stcb, feature) \
  67         (((stcb != NULL) && \
  68           ((stcb->asoc.sctp_features & feature) == feature)) || \
  69          ((stcb == NULL) && (inp != NULL) && \
  70           ((inp->sctp_features & feature) == feature)))
  71 #define sctp_stcb_is_feature_off(inp, stcb, feature) \
  72         (((stcb != NULL) && \
  73           ((stcb->asoc.sctp_features & feature) == 0)) || \
  74          ((stcb == NULL) && (inp != NULL) && \
  75           ((inp->sctp_features & feature) == 0)) || \
  76          ((stcb == NULL) && (inp == NULL)))
  77
  78 /* managing mobility_feature in inpcb (by micchie) */
  79 #define sctp_mobility_feature_on(inp, feature)  (inp->sctp_mobility_features |= feature)
  80 #define sctp_mobility_feature_off(inp, feature) (inp->sctp_mobility_features &= ~feature)
  81 #define sctp_is_mobility_feature_on(inp, feature) (inp->sctp_mobility_features & feature)
  82 #define sctp_is_mobility_feature_off(inp, feature) ((inp->sctp_mobility_features & feature) == 0)
  83
  84 #define sctp_maxspace(sb) (max((sb)->sb_hiwat,SCTP_MINIMAL_RWND))
  85
  86 #define sctp_sbspace(asoc, sb) ((long) ((sctp_maxspace(sb) > (asoc)->sb_cc) ? (sctp_maxspace(sb) - (asoc)->sb_cc) : 0))
  87
  88 #define sctp_sbspace_failedmsgs(sb) ((long) ((sctp_maxspace(sb) > (sb)->sb_cc) ? (sctp_maxspace(sb) - (sb)->sb_cc) : 0))
  89
  90 #define sctp_sbspace_sub(a,b) (((a) > (b)) ? ((a) - (b)) : 0)
  91
  92 /*
  93  * I tried to cache the readq entries at one point. But the reality
  94  * is that it did not add any performance since this meant we had to
  95  * lock the STCB on read. And at that point once you have to do an
  96  * extra lock, it really does not matter if the lock is in the ZONE
  97  * stuff or in our code. Note that this same problem would occur with
  98  * an mbuf cache as well so it is not really worth doing, at least
  99  * right now :-D
 100  */
 101 #ifdef INVARIANTS
 102 #define sctp_free_a_readq(_stcb, _readq) { \
 103         if ((_readq)->on_strm_q) \
 104                 panic("On strm q stcb:%p readq:%p", (_stcb), (_readq)); \
 105         SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_readq), (_readq)); \
 106         SCTP_DECR_READQ_COUNT(); \
 107 }
 108 #else
 109 #define sctp_free_a_readq(_stcb, _readq) { \
 110         SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_readq), (_readq)); \
 111         SCTP_DECR_READQ_COUNT(); \
 112 }
 113 #endif
 114
 115 #define sctp_alloc_a_readq(_stcb, _readq) { \
 116         (_readq) = SCTP_ZONE_GET(SCTP_BASE_INFO(ipi_zone_readq), struct sctp_queued_to_read); \
 117         if ((_readq)) { \
 118              SCTP_INCR_READQ_COUNT(); \
 119         } \
 120 }
 121
 122 #define sctp_free_a_strmoq(_stcb, _strmoq, _so_locked) { \
 123         if ((_strmoq)->holds_key_ref) { \
 124                 sctp_auth_key_release(stcb, sp->auth_keyid, _so_locked); \
 125                 (_strmoq)->holds_key_ref = 0; \
 126         } \
 127         SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_strmoq), (_strmoq)); \
 128         SCTP_DECR_STRMOQ_COUNT(); \
 129 }
 130
 131 #define sctp_alloc_a_strmoq(_stcb, _strmoq) { \
 132         (_strmoq) = SCTP_ZONE_GET(SCTP_BASE_INFO(ipi_zone_strmoq), struct sctp_stream_queue_pending); \
 133         if ((_strmoq)) { \
 134                 memset(_strmoq, 0, sizeof(struct sctp_stream_queue_pending)); \
 135                 SCTP_INCR_STRMOQ_COUNT(); \
 136                 (_strmoq)->holds_key_ref = 0; \
 137         } \
 138 }
 139
 140 #define sctp_free_a_chunk(_stcb, _chk, _so_locked) { \
 141         if ((_chk)->holds_key_ref) {\
 142                 sctp_auth_key_release((_stcb), (_chk)->auth_keyid, _so_locked); \
 143                 (_chk)->holds_key_ref = 0; \
 144         } \
 145         if (_stcb) { \
 146                 SCTP_TCB_LOCK_ASSERT((_stcb)); \
 147                 if ((_chk)->whoTo) { \
 148                         sctp_free_remote_addr((_chk)->whoTo); \
 149                         (_chk)->whoTo = NULL; \
 150                 } \
 151                 if (((_stcb)->asoc.free_chunk_cnt > SCTP_BASE_SYSCTL(sctp_asoc_free_resc_limit)) || \
 152                     (SCTP_BASE_INFO(ipi_free_chunks) > SCTP_BASE_SYSCTL(sctp_system_free_resc_limit))) { \
 153                         SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_chunk), (_chk)); \
 154                         SCTP_DECR_CHK_COUNT(); \
 155                 } else { \
 156                         TAILQ_INSERT_TAIL(&(_stcb)->asoc.free_chunks, (_chk), sctp_next); \
 157                         (_stcb)->asoc.free_chunk_cnt++; \
 158                         atomic_add_int(&SCTP_BASE_INFO(ipi_free_chunks), 1); \
 159                 } \
 160         } else { \
 161                 SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_chunk), (_chk)); \
 162                 SCTP_DECR_CHK_COUNT(); \
 163         } \
 164 }
 165
 166 #define sctp_alloc_a_chunk(_stcb, _chk) { \
 167         if (TAILQ_EMPTY(&(_stcb)->asoc.free_chunks)) { \
 168                 (_chk) = SCTP_ZONE_GET(SCTP_BASE_INFO(ipi_zone_chunk), struct sctp_tmit_chunk); \
 169                 if ((_chk)) { \
 170                         SCTP_INCR_CHK_COUNT(); \
 171                         (_chk)->whoTo = NULL; \
 172                         (_chk)->holds_key_ref = 0; \
 173                 } \
 174         } else { \
 175                 (_chk) = TAILQ_FIRST(&(_stcb)->asoc.free_chunks); \
 176                 TAILQ_REMOVE(&(_stcb)->asoc.free_chunks, (_chk), sctp_next); \
 177                 atomic_subtract_int(&SCTP_BASE_INFO(ipi_free_chunks), 1); \
 178                 (_chk)->holds_key_ref = 0; \
 179                 SCTP_STAT_INCR(sctps_cached_chk); \
 180                 (_stcb)->asoc.free_chunk_cnt--; \
 181         } \
 182 }
 183
 184 #define sctp_free_remote_addr(__net) { \
 185         if ((__net)) {  \
 186                 if (SCTP_DECREMENT_AND_CHECK_REFCOUNT(&(__net)->ref_count)) { \
 187                         RO_NHFREE(&(__net)->ro); \
 188                         if ((__net)->src_addr_selected) { \
 189                                 sctp_free_ifa((__net)->ro._s_addr); \
 190                                 (__net)->ro._s_addr = NULL; \
 191                         } \
 192                         (__net)->src_addr_selected = 0; \
 193                         (__net)->dest_state &= ~SCTP_ADDR_REACHABLE; \
 194                         SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_net), (__net)); \
 195                         SCTP_DECR_RADDR_COUNT(); \
 196                 } \
 197         } \
 198 }
 199
 200 #define sctp_sbfree(ctl, stcb, sb, m) { \
 201         SCTP_SAVE_ATOMIC_DECREMENT(&(sb)->sb_cc, SCTP_BUF_LEN((m))); \
 202         SCTP_SAVE_ATOMIC_DECREMENT(&(sb)->sb_mbcnt, MSIZE); \
 203         if (((ctl)->do_not_ref_stcb == 0) && stcb) {\
 204                 SCTP_SAVE_ATOMIC_DECREMENT(&(stcb)->asoc.sb_cc, SCTP_BUF_LEN((m))); \
 205                 SCTP_SAVE_ATOMIC_DECREMENT(&(stcb)->asoc.my_rwnd_control_len, MSIZE); \
 206         } \
 207         if (SCTP_BUF_TYPE(m) != MT_DATA && SCTP_BUF_TYPE(m) != MT_HEADER && \
 208             SCTP_BUF_TYPE(m) != MT_OOBDATA) \
 209                 atomic_subtract_int(&(sb)->sb_ctl,SCTP_BUF_LEN((m))); \
 210 }
 211
 212 #define sctp_sballoc(stcb, sb, m) { \
 213         atomic_add_int(&(sb)->sb_cc,SCTP_BUF_LEN((m))); \
 214         atomic_add_int(&(sb)->sb_mbcnt, MSIZE); \
 215         if (stcb) { \
 216                 atomic_add_int(&(stcb)->asoc.sb_cc, SCTP_BUF_LEN((m))); \
 217                 atomic_add_int(&(stcb)->asoc.my_rwnd_control_len, MSIZE); \
 218         } \
 219         if (SCTP_BUF_TYPE(m) != MT_DATA && SCTP_BUF_TYPE(m) != MT_HEADER && \
 220             SCTP_BUF_TYPE(m) != MT_OOBDATA) \
 221                 atomic_add_int(&(sb)->sb_ctl,SCTP_BUF_LEN((m))); \
 222 }
 223
 224 #define sctp_ucount_incr(val) { \
 225         val++; \
 226 }
 227
 228 #define sctp_ucount_decr(val) { \
 229         if (val > 0) { \
 230                 val--; \
 231         } else { \
 232                 val = 0; \
 233         } \
 234 }
 235
 236 #define sctp_mbuf_crush(data) do { \
 237         struct mbuf *_m; \
 238         _m = (data); \
 239         while (_m && (SCTP_BUF_LEN(_m) == 0)) { \
 240                 (data)  = SCTP_BUF_NEXT(_m); \
 241                 SCTP_BUF_NEXT(_m) = NULL; \
 242                 sctp_m_free(_m); \
 243                 _m = (data); \
 244         } \
 245 } while (0)
 246
 247 #define sctp_flight_size_decrease(tp1) do { \
 248         if (tp1->whoTo->flight_size >= tp1->book_size) \
 249                 tp1->whoTo->flight_size -= tp1->book_size; \
 250         else \
 251                 tp1->whoTo->flight_size = 0; \
 252 } while (0)
 253
 254 #define sctp_flight_size_increase(tp1) do { \
 255         (tp1)->whoTo->flight_size += (tp1)->book_size; \
 256 } while (0)
 257
 258 #ifdef SCTP_FS_SPEC_LOG
 259 #define sctp_total_flight_decrease(stcb, tp1) do { \
 260         if (stcb->asoc.fs_index > SCTP_FS_SPEC_LOG_SIZE) \
 261                 stcb->asoc.fs_index = 0;\
 262         stcb->asoc.fslog[stcb->asoc.fs_index].total_flight = stcb->asoc.total_flight; \
 263         stcb->asoc.fslog[stcb->asoc.fs_index].tsn = tp1->rec.data.tsn; \
 264         stcb->asoc.fslog[stcb->asoc.fs_index].book = tp1->book_size; \
 265         stcb->asoc.fslog[stcb->asoc.fs_index].sent = tp1->sent; \
 266         stcb->asoc.fslog[stcb->asoc.fs_index].incr = 0; \
 267         stcb->asoc.fslog[stcb->asoc.fs_index].decr = 1; \
 268         stcb->asoc.fs_index++; \
 269         tp1->window_probe = 0; \
 270         if (stcb->asoc.total_flight >= tp1->book_size) { \
 271                 stcb->asoc.total_flight -= tp1->book_size; \
 272                 if (stcb->asoc.total_flight_count > 0) \
 273                         stcb->asoc.total_flight_count--; \
 274         } else { \
 275                 stcb->asoc.total_flight = 0; \
 276                 stcb->asoc.total_flight_count = 0; \
 277         } \
 278 } while (0)
 279
 280 #define sctp_total_flight_increase(stcb, tp1) do { \
 281         if (stcb->asoc.fs_index > SCTP_FS_SPEC_LOG_SIZE) \
 282                 stcb->asoc.fs_index = 0;\
 283         stcb->asoc.fslog[stcb->asoc.fs_index].total_flight = stcb->asoc.total_flight; \
 284         stcb->asoc.fslog[stcb->asoc.fs_index].tsn = tp1->rec.data.tsn; \
 285         stcb->asoc.fslog[stcb->asoc.fs_index].book = tp1->book_size; \
 286         stcb->asoc.fslog[stcb->asoc.fs_index].sent = tp1->sent; \
 287         stcb->asoc.fslog[stcb->asoc.fs_index].incr = 1; \
 288         stcb->asoc.fslog[stcb->asoc.fs_index].decr = 0; \
 289         stcb->asoc.fs_index++; \
 290         (stcb)->asoc.total_flight_count++; \
 291         (stcb)->asoc.total_flight += (tp1)->book_size; \
 292 } while (0)
 293
 294 #else
 295
 296 #define sctp_total_flight_decrease(stcb, tp1) do { \
 297         tp1->window_probe = 0; \
 298         if (stcb->asoc.total_flight >= tp1->book_size) { \
 299                 stcb->asoc.total_flight -= tp1->book_size; \
 300                 if (stcb->asoc.total_flight_count > 0) \
 301                         stcb->asoc.total_flight_count--; \
 302         } else { \
 303                 stcb->asoc.total_flight = 0; \
 304                 stcb->asoc.total_flight_count = 0; \
 305         } \
 306 } while (0)
 307
 308 #define sctp_total_flight_increase(stcb, tp1) do { \
 309         (stcb)->asoc.total_flight_count++; \
 310         (stcb)->asoc.total_flight += (tp1)->book_size; \
 311 } while (0)
 312
 313 #endif
 314
 315 #define SCTP_PF_ENABLED(_net) (_net->pf_threshold < _net->failure_threshold)
 316 #define SCTP_NET_IS_PF(_net) (_net->pf_threshold < _net->error_count)
 317
 318 struct sctp_nets;
 319 struct sctp_inpcb;
 320 struct sctp_tcb;
 321 struct sctphdr;
 322
 323 void sctp_close(struct socket *so);
 324 int sctp_disconnect(struct socket *so);
 325 void sctp_ctlinput(int, struct sockaddr *, void *);
 326 int sctp_ctloutput(struct socket *, struct sockopt *);
 327 #ifdef INET
 328 void sctp_input_with_port(struct mbuf *, int, uint16_t);
 329 int sctp_input(struct mbuf **, int *, int);
 330 #endif
 331 void sctp_pathmtu_adjustment(struct sctp_tcb *, uint16_t);
 332 void sctp_drain(void);
 333 void sctp_init(void);
 334 void
 335 sctp_notify(struct sctp_inpcb *, struct sctp_tcb *, struct sctp_nets *,
 336     uint8_t, uint8_t, uint16_t, uint32_t);
 337 int sctp_flush(struct socket *, int);
 338 int sctp_shutdown(struct socket *);
 339 int
 340 sctp_bindx(struct socket *, int, struct sockaddr_storage *,
 341     int, int, struct proc *);
 342
 343 /* can't use sctp_assoc_t here */
 344 int sctp_peeloff(struct socket *, struct socket *, int, caddr_t, int *);
 345 int sctp_ingetaddr(struct socket *, struct sockaddr **);
 346 int sctp_peeraddr(struct socket *, struct sockaddr **);
 347 int sctp_listen(struct socket *, int, struct thread *);
 348 int sctp_accept(struct socket *, struct sockaddr **);
 349
 350 #endif                          /* _KERNEL */
 351
 352 #endif                          /* !_NETINET_SCTP_VAR_H_ */