1d0d2e523SLutz Donnerhacke /*- 2*4d846d26SWarner Losh * SPDX-License-Identifier: BSD-2-Clause 3d0d2e523SLutz Donnerhacke * 4d0d2e523SLutz Donnerhacke * Copyright (c) 2019 Lutz Donnerhacke <lutz@donnerhacke.de> 5d0d2e523SLutz Donnerhacke * 6d0d2e523SLutz Donnerhacke * Redistribution and use in source and binary forms, with or without 7d0d2e523SLutz Donnerhacke * modification, are permitted provided that the following conditions 8d0d2e523SLutz Donnerhacke * are met: 9d0d2e523SLutz Donnerhacke * 1. Redistributions of source code must retain the above copyright 10d0d2e523SLutz Donnerhacke * notice, this list of conditions and the following disclaimer. 11d0d2e523SLutz Donnerhacke * 2. Redistributions in binary form must reproduce the above copyright 12d0d2e523SLutz Donnerhacke * notice, this list of conditions and the following disclaimer in the 13d0d2e523SLutz Donnerhacke * documentation and/or other materials provided with the distribution. 14d0d2e523SLutz Donnerhacke * 15d0d2e523SLutz Donnerhacke * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16d0d2e523SLutz Donnerhacke * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17d0d2e523SLutz Donnerhacke * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18d0d2e523SLutz Donnerhacke * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 19d0d2e523SLutz Donnerhacke * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20d0d2e523SLutz Donnerhacke * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21d0d2e523SLutz Donnerhacke * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22d0d2e523SLutz Donnerhacke * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23d0d2e523SLutz Donnerhacke * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24d0d2e523SLutz Donnerhacke * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25d0d2e523SLutz Donnerhacke * SUCH DAMAGE. 26d0d2e523SLutz Donnerhacke */ 27d0d2e523SLutz Donnerhacke 28d0d2e523SLutz Donnerhacke #ifndef _NETGRAPH_QOS_H_ 29d0d2e523SLutz Donnerhacke #define _NETGRAPH_QOS_H_ 30d0d2e523SLutz Donnerhacke 31d0d2e523SLutz Donnerhacke #include <sys/mbuf.h> 32d0d2e523SLutz Donnerhacke 33d0d2e523SLutz Donnerhacke /* ABI cookie */ 34d0d2e523SLutz Donnerhacke #define M_QOS_COOKIE 1571268051 35d0d2e523SLutz Donnerhacke #define MTAG_SIZE(X) ( sizeof(struct X) - sizeof(struct m_tag) ) 36d0d2e523SLutz Donnerhacke 37d0d2e523SLutz Donnerhacke /* 38d0d2e523SLutz Donnerhacke * Definition of types within this ABI: 39d0d2e523SLutz Donnerhacke * - Choose a type (16bit) by i.e. "echo $((1000+$(date +%s)%64536))" 40d0d2e523SLutz Donnerhacke * - Retry if the type is already in use 41d0d2e523SLutz Donnerhacke * - Define the structure for the type according to mbuf_tags(9) 42d0d2e523SLutz Donnerhacke * struct m_qos_foo { 43d0d2e523SLutz Donnerhacke * struct m_tag tag; 44d0d2e523SLutz Donnerhacke * ... 45d0d2e523SLutz Donnerhacke * }; 46d0d2e523SLutz Donnerhacke * Preferred usage: 47d0d2e523SLutz Donnerhacke * struct m_qos_foo *p = (void *)m_tag_locate(m, 48d0d2e523SLutz Donnerhacke * M_QOS_COOKIE, M_QOS_FOO, ...); 49d0d2e523SLutz Donnerhacke * or 50d0d2e523SLutz Donnerhacke * p = (void *)m_tag_alloc( 51d0d2e523SLutz Donnerhacke * M_QOS_COOKIE, M_QOS_FOO, MTAG_SIZE(foo), ...); 52d0d2e523SLutz Donnerhacke m_tag_prepend(m, &p->tag); 53d0d2e523SLutz Donnerhacke */ 54d0d2e523SLutz Donnerhacke 55d0d2e523SLutz Donnerhacke /* Color marking type */ 56d0d2e523SLutz Donnerhacke #define M_QOS_COLOR 23568 57d0d2e523SLutz Donnerhacke /* Keep colors ordered semantically in order to allow use of "<=" or ">=" */ 58d0d2e523SLutz Donnerhacke enum qos_color { 59d0d2e523SLutz Donnerhacke QOS_COLOR_GREEN, 60d0d2e523SLutz Donnerhacke QOS_COLOR_YELLOW, 61d0d2e523SLutz Donnerhacke QOS_COLOR_RED 62d0d2e523SLutz Donnerhacke }; 63d0d2e523SLutz Donnerhacke struct m_qos_color { 64d0d2e523SLutz Donnerhacke struct m_tag tag; 65d0d2e523SLutz Donnerhacke enum qos_color color; 66d0d2e523SLutz Donnerhacke }; 67d0d2e523SLutz Donnerhacke 68d0d2e523SLutz Donnerhacke /* 69d0d2e523SLutz Donnerhacke * Priority class 70d0d2e523SLutz Donnerhacke * 71d0d2e523SLutz Donnerhacke * Processing per priority requires an overhead, which should 72d0d2e523SLutz Donnerhacke * be static (i.e. for alloctating queues) and small (for memory) 73d0d2e523SLutz Donnerhacke * So keep your chosen range limited. 74d0d2e523SLutz Donnerhacke */ 75d0d2e523SLutz Donnerhacke #define M_QOS_PRIORITY 28858 76d0d2e523SLutz Donnerhacke struct m_qos_priority { 77d0d2e523SLutz Donnerhacke struct m_tag tag; 78d0d2e523SLutz Donnerhacke uint8_t priority; /* 0 - lowest */ 79d0d2e523SLutz Donnerhacke }; 80d0d2e523SLutz Donnerhacke 81d0d2e523SLutz Donnerhacke #endif /* _NETGRAPH_QOS_H_ */ 82