Line data    Source code

       1             : #ifndef HEADER_fd_src_disco_quic_fd_tpu_reasm_private_h
       2             : #define HEADER_fd_src_disco_quic_fd_tpu_reasm_private_h
       3             : 
       4             : #include "fd_tpu.h"
       5             : 
       6             : /* fd_tpu_reasm_private.h contains reusable logic of fd_tpu_reasm such
       7             :    that it can be included in test cases. */
       8             : 
       9           0 : #define FD_TPU_REASM_MAGIC (0xb4ef0d5ea766713cUL) /* random */
      10             : 
      11             : /* FIXME use a doubly-linked map_chain here to optimize for fast removes */
      12             : #define MAP_NAME  fd_tpu_reasm_map
      13             : #define MAP_KEY_T fd_tpu_reasm_key_t
      14             : #define MAP_ELE_T fd_tpu_reasm_slot_t
      15           0 : #define MAP_IDX_T uint
      16           0 : #define MAP_KEY   k
      17           0 : #define MAP_KEY_EQ(a,b) (((a)->conn_uid==(b)->conn_uid) & ((a)->stream_id==(b)->stream_id))
      18           0 : #define MAP_KEY_HASH(key,seed) fd_tpu_reasm_key_hash( key, seed )
      19           0 : #define MAP_NEXT  chain_next
      20             : #include "../../util/tmpl/fd_map_chain.c"
      21             : 
      22             : static inline FD_FN_PURE fd_tpu_reasm_map_t *
      23           0 : fd_tpu_reasm_map_laddr( fd_tpu_reasm_t * reasm ) {
      24           0 :   return (fd_tpu_reasm_map_t *)( (ulong)reasm + reasm->map_off );
      25           0 : }
      26             : 
      27             : /* Slot class methods *************************************************/
      28             : 
      29             : static inline uint
      30             : slot_get_idx( fd_tpu_reasm_t const *      reasm,
      31           0 :               fd_tpu_reasm_slot_t const * slot ) {
      32           0 :   ulong slot_idx = (ulong)( slot - fd_tpu_reasm_slots_laddr_const( reasm ) );
      33           0 :   if( FD_UNLIKELY( slot_idx >= (reasm->depth + reasm->burst) ) ) {
      34           0 :     FD_LOG_CRIT(( "invalid slot pointer! slot_idx=%lu, depth+burst=%u\n",
      35           0 :                   slot_idx, reasm->depth + reasm->burst ));
      36           0 :   }
      37           0 :   return (uint)slot_idx;
      38           0 : }
      39             : 
      40             : static FD_FN_UNUSED void
      41           0 : slot_begin( fd_tpu_reasm_slot_t * slot ) {
      42           0 :   memset( slot, 0, sizeof(fd_tpu_reasm_slot_t) );
      43           0 :   slot->k.state     = FD_TPU_REASM_STATE_BUSY;
      44           0 :   slot->k.conn_uid  = ULONG_MAX;
      45           0 :   slot->k.stream_id = FD_TPU_REASM_SID_MASK;
      46           0 : }
      47             : 
      48             : /* Slot queue methods **************************************************
      49             : 
      50             :    slotq is an LRU cache implemented by a doubly linked list.
      51             :    tpu_reasm uses it to allocate and evict reassembly slots. */
      52             : 
      53             : /* slotq_push_head adds the given slot to the reassembly queue head.
      54             :    Assumes queue element count > 2. */
      55             : 
      56             : static FD_FN_UNUSED void
      57             : slotq_push_head( fd_tpu_reasm_t *      reasm,
      58           0 :                  fd_tpu_reasm_slot_t * slot ) {
      59             : 
      60           0 :   uint slot_idx = slot_get_idx( reasm, slot );
      61           0 :   uint head_idx = reasm->head;
      62             : 
      63           0 :   fd_tpu_reasm_slot_t * head = fd_tpu_reasm_slots_laddr( reasm ) + head_idx;
      64             : 
      65           0 :   head->lru_prev = slot_idx;
      66           0 :   slot->lru_prev = UINT_MAX;
      67           0 :   slot->lru_next = head_idx;
      68           0 :   reasm->head    = slot_idx;
      69           0 : }
      70             : 
      71             : /* slotq_push_tail adds the given slot to the reassembly queue tail.
      72             :    Assumes queue element count > 2. */
      73             : 
      74             : static FD_FN_UNUSED void
      75             : slotq_push_tail( fd_tpu_reasm_t *      reasm,
      76           0 :                  fd_tpu_reasm_slot_t * slot ) {
      77             : 
      78           0 :   uint slot_idx = slot_get_idx( reasm, slot );
      79           0 :   uint tail_idx = reasm->tail;
      80           0 :   FD_TEST( tail_idx < reasm->slot_cnt );
      81             : 
      82           0 :   fd_tpu_reasm_slot_t * tail = fd_tpu_reasm_slots_laddr( reasm ) + tail_idx;
      83             : 
      84           0 :   tail->lru_next = slot_idx;
      85           0 :   slot->lru_prev = tail_idx;
      86           0 :   slot->lru_next = UINT_MAX;
      87           0 :   reasm->tail    = slot_idx;
      88           0 : }
      89             : 
      90             : /* slotq_pop_tail removes a slot from the reassembly queue tail.
      91             :    Assumes queue element count > 2. */
      92             : 
      93             : static FD_FN_UNUSED fd_tpu_reasm_slot_t *
      94           0 : slotq_pop_tail( fd_tpu_reasm_t * reasm ) {
      95             : 
      96           0 :   uint                  tail_idx = reasm->tail;
      97           0 :   fd_tpu_reasm_slot_t * tail     = fd_tpu_reasm_slots_laddr( reasm ) + tail_idx;
      98           0 :   uint                  slot_idx = tail->lru_prev;
      99           0 :   fd_tpu_reasm_slot_t * slot     = fd_tpu_reasm_slots_laddr( reasm ) + slot_idx;
     100             : 
     101           0 :   slot->lru_next = UINT_MAX;
     102           0 :   reasm->tail    = slot_idx;
     103           0 :   return tail;
     104           0 : }
     105             : 
     106             : /* slotq_remove removes a slot at an arbitrary position in the
     107             :    reassembly queue.  Aborts the process if the slot is not part of the
     108             :    queue.  Assumes queue element count > 2. */
     109             : 
     110             : static FD_FN_UNUSED void
     111             : slotq_remove( fd_tpu_reasm_t *      reasm,
     112           0 :               fd_tpu_reasm_slot_t * slot ) {
     113             : 
     114           0 :   uint slot_idx = slot_get_idx( reasm, slot );
     115           0 :   uint lru_prev = slot->lru_prev;
     116           0 :   uint lru_next = slot->lru_next;
     117             : 
     118           0 :   slot->lru_prev = UINT_MAX;
     119           0 :   slot->lru_next = UINT_MAX;
     120             : 
     121           0 :   fd_tpu_reasm_slot_t * prev = fd_tpu_reasm_slots_laddr( reasm ) + lru_prev;
     122           0 :   fd_tpu_reasm_slot_t * next = fd_tpu_reasm_slots_laddr( reasm ) + lru_next;
     123             : 
     124           0 :   if( slot_idx==reasm->head ) {
     125           0 :     if( FD_UNLIKELY( lru_next >= reasm->slot_cnt ) ) {
     126           0 :       FD_LOG_ERR(( "OOB lru_next (lru_next=%u, slot_cnt=%u)", lru_next, reasm->slot_cnt ));
     127           0 :     }
     128           0 :     reasm->head    = lru_next;
     129           0 :     next->lru_prev = UINT_MAX;
     130           0 :     return;
     131           0 :   }
     132           0 :   if( slot_idx==reasm->tail ) {
     133           0 :     if( FD_UNLIKELY( lru_prev >= reasm->slot_cnt ) ) {
     134           0 :       FD_LOG_ERR(( "OOB lru_prev (lru_prev=%u, slot_cnt=%u)", lru_prev, reasm->slot_cnt ));
     135           0 :     }
     136           0 :     reasm->tail    = lru_prev;
     137           0 :     prev->lru_next = UINT_MAX;
     138           0 :     return;
     139           0 :   }
     140             : 
     141           0 :   FD_DCHECK_CRIT( lru_prev < reasm->slot_cnt, "memory corruption detected" );
     142           0 :   FD_DCHECK_CRIT( lru_next < reasm->slot_cnt, "memory corruption detected" );
     143           0 :   prev->lru_next = lru_next;
     144           0 :   next->lru_prev = lru_prev;
     145           0 : }
     146             : 
     147             : static FD_FN_UNUSED void
     148             : smap_insert( fd_tpu_reasm_t *      reasm,
     149           0 :              fd_tpu_reasm_slot_t * slot ) {
     150           0 :   fd_tpu_reasm_map_ele_insert(
     151           0 :       fd_tpu_reasm_map_laddr( reasm ),
     152           0 :       slot,
     153           0 :       fd_tpu_reasm_slots_laddr( reasm )
     154           0 :   );
     155           0 : }
     156             : 
     157             : static FD_FN_UNUSED fd_tpu_reasm_slot_t *
     158             : smap_query( fd_tpu_reasm_t * reasm,
     159             :             ulong            conn_uid,
     160           0 :             ulong            stream_id ) {
     161           0 :   fd_tpu_reasm_key_t k = {
     162           0 :     .conn_uid  = conn_uid,
     163           0 :     .stream_id = stream_id & FD_TPU_REASM_SID_MASK
     164           0 :   };
     165           0 :   return fd_tpu_reasm_map_ele_query(
     166           0 :       fd_tpu_reasm_map_laddr( reasm ),
     167           0 :       &k,
     168           0 :       NULL,
     169           0 :       fd_tpu_reasm_slots_laddr( reasm )
     170           0 :   );
     171           0 : }
     172             : 
     173             : static FD_FN_UNUSED void
     174             : smap_remove( fd_tpu_reasm_t *      reasm,
     175           0 :              fd_tpu_reasm_slot_t * slot ) {
     176             :   /* FIXME use a doubly linked list remove */
     177           0 :   fd_tpu_reasm_map_idx_remove(
     178           0 :       fd_tpu_reasm_map_laddr( reasm ),
     179           0 :       &slot->k,
     180           0 :       ULONG_MAX,
     181           0 :       fd_tpu_reasm_slots_laddr( reasm )
     182           0 :   );
     183           0 : }
     184             : 
     185             : #endif /* HEADER_fd_src_disco_quic_fd_tpu_reasm_private_h */