sys/dev/cxgbe/t4_mp_ring.h

   1 /*-
   2  * Copyright (c) 2014 Chelsio Communications, Inc.
   3  * All rights reserved.
   4  * Written by: Navdeep Parhar <np@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  */
  28
  29 #ifndef __CXGBE_MP_RING_H
  30 #define __CXGBE_MP_RING_H
  31
  32 #ifndef _KERNEL
  33 #error "no user-serviceable parts inside"
  34 #endif
  35
  36 struct mp_ring;
  37 typedef u_int (*ring_drain_t)(struct mp_ring *, u_int, u_int, bool *);
  38 typedef u_int (*ring_can_drain_t)(struct mp_ring *);
  39
  40 struct mp_ring {
  41         volatile uint64_t       state __aligned(CACHE_LINE_SIZE);
  42         struct malloc_type *    mt;
  43
  44         int                     size __aligned(CACHE_LINE_SIZE);
  45         void *                  cookie;
  46         ring_drain_t            drain;
  47         ring_can_drain_t        can_drain;      /* cheap, may be unreliable */
  48         struct mtx *            cons_lock;
  49         counter_u64_t           dropped;
  50         counter_u64_t           consumer[4];
  51         counter_u64_t           not_consumer;
  52         counter_u64_t           abdications;
  53         counter_u64_t           consumed;
  54         counter_u64_t           cons_idle;
  55         counter_u64_t           cons_idle2;
  56         counter_u64_t           stalls;
  57
  58         void * volatile         items[] __aligned(CACHE_LINE_SIZE);
  59 };
  60
  61 int mp_ring_alloc(struct mp_ring **, int, void *, ring_drain_t,
  62     ring_can_drain_t, struct malloc_type *, struct mtx *, int);
  63 void mp_ring_free(struct mp_ring *);
  64 int mp_ring_enqueue(struct mp_ring *, void **, int, int);
  65 void mp_ring_check_drainage(struct mp_ring *, int);
  66 void mp_ring_reset_stats(struct mp_ring *);
  67 bool mp_ring_is_idle(struct mp_ring *);
  68 void mp_ring_sysctls(struct mp_ring *, struct sysctl_ctx_list *,
  69     struct sysctl_oid_list *);
  70
  71 #endif