1/*	$NetBSD: pktqueue.h,v 1.8 2022/09/02 05:50:36 thorpej Exp $	*/
2
3/*-
4 * Copyright (c) 2014 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Mindaugas Rasiukevicius.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _NET_PKTQUEUE_H_
33#define _NET_PKTQUEUE_H_
34
35#if !defined(_KERNEL)
36#error "not supposed to be exposed to userland."
37#endif
38
39#include <sys/sysctl.h>
40
41struct mbuf;
42
43typedef struct pktqueue pktqueue_t;
44
45typedef enum { PKTQ_MAXLEN, PKTQ_NITEMS, PKTQ_DROPS } pktq_count_t;
46
47typedef uint32_t (*pktq_rps_hash_func_t)(const struct mbuf *);
48#define PKTQ_RPS_HASH_NAME_LEN 32
49
50pktqueue_t *	pktq_create(size_t, void (*)(void *), void *);
51void		pktq_destroy(pktqueue_t *);
52
53bool		pktq_enqueue(pktqueue_t *, struct mbuf *, const u_int);
54struct mbuf *	pktq_dequeue(pktqueue_t *);
55void		pktq_barrier(pktqueue_t *);
56void		pktq_ifdetach(void);
57void		pktq_flush(pktqueue_t *);
58int		pktq_set_maxlen(pktqueue_t *, size_t);
59
60uint32_t	pktq_rps_hash(const pktq_rps_hash_func_t *,
61		    const struct mbuf *);
62extern const pktq_rps_hash_func_t	pktq_rps_hash_default;
63
64void		pktq_sysctl_setup(pktqueue_t *, struct sysctllog **,
65		    const struct sysctlnode *, const int);
66
67int		sysctl_pktq_rps_hash_handler(SYSCTLFN_PROTO);
68
69#endif
70