* Copyright (c) Sun Microsystems, Inc. 1993-1998 All rights reserved.

/* $NetBSD: altq_cbq.c,v 1.42 2025/01/08 13:00:04 joe Exp $ */
/* $KAME: altq_cbq.c,v 1.21 2005/04/13 03:44:24 suz Exp $ */

/*
* Copyright (c) Sun Microsystems, Inc. 1993-1998 All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the SMCC Technology
* Development Group at Sun Microsystems, Inc.
*
* 4. The name of the Sun Microsystems, Inc nor may not be used to endorse or
* promote products derived from this software without specific prior
* written permission.
*
* SUN MICROSYSTEMS DOES NOT CLAIM MERCHANTABILITY OF THIS SOFTWARE OR THE
* SUITABILITY OF THIS SOFTWARE FOR ANY PARTICULAR PURPOSE. The software is
* provided "as is" without express or implied warranty of any kind.
*
* These notices must be retained in any copies of any part of this software.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: altq_cbq.c,v 1.42 2025/01/08 13:00:04 joe Exp $");

#ifdef _KERNEL_OPT
#include "opt_altq.h"
#include "opt_inet.h"
#include "pf.h"
#endif

#ifdef ALTQ_CBQ /* cbq is enabled by ALTQ_CBQ option in opt_altq.h */

#include <sys/param.h>
#include <sys/malloc.h>
#include <sys/mbuf.h>
#include <sys/socket.h>
#include <sys/systm.h>
#include <sys/proc.h>
#include <sys/errno.h>
#include <sys/time.h>
#ifdef ALTQ3_COMPAT
#include <sys/uio.h>
#include <sys/kernel.h>
#endif
#include <sys/kauth.h>

#include <net/if.h>
#include <netinet/in.h>

#if NPF > 0
#include <net/pfvar.h>
#endif
#include <altq/altq.h>
#include <altq/altq_cbq.h>
#ifdef ALTQ3_COMPAT
#include <altq/altq_conf.h>
#endif

#ifdef ALTQ3_COMPAT
/*
* Local Data structures.
*/
static cbq_state_t *cbq_list = NULL;
#endif

/*
* Forward Declarations.
*/
static int cbq_class_destroy(cbq_state_t *, struct rm_class *);
static struct rm_class *clh_to_clp(cbq_state_t *, u_int32_t);
static int cbq_clear_interface(cbq_state_t *);
static int cbq_request(struct ifaltq *, int, void *);
static int cbq_enqueue(struct ifaltq *, struct mbuf *);
static struct mbuf *cbq_dequeue(struct ifaltq *, int);
static void cbqrestart(struct ifaltq *);
static void get_class_stats(class_stats_t *, struct rm_class *);
static void cbq_purge(cbq_state_t *);
#ifdef ALTQ3_COMPAT
static int cbq_add_class(struct cbq_add_class *);
static int cbq_delete_class(struct cbq_delete_class *);
static int cbq_modify_class(struct cbq_modify_class *);
static int cbq_class_create(cbq_state_t *, struct cbq_add_class *,
struct rm_class *, struct rm_class *);
static int cbq_clear_hierarchy(struct cbq_interface *);
static int cbq_set_enable(struct cbq_interface *, int);
static int cbq_ifattach(struct cbq_interface *);
static int cbq_ifdetach(struct cbq_interface *);
static int cbq_getstats(struct cbq_getstats *);

static int cbq_add_filter(struct cbq_add_filter *);
static int cbq_delete_filter(struct cbq_delete_filter *);
#endif /* ALTQ3_COMPAT */

/*
* int
* cbq_class_destroy(cbq_mod_state_t *, struct rm_class *) - This
* function destroys a given traffic class. Before destroying
* the class, all traffic for that class is released.
*/
static int
cbq_class_destroy(cbq_state_t *cbqp, struct rm_class *cl)
{
int i;

/* delete the class */
rmc_delete_class(&cbqp->ifnp, cl);

/*
* free the class handle
*/
for (i = 0; i < CBQ_MAX_CLASSES; i++)
if (cbqp->cbq_class_tbl[i] == cl)
cbqp->cbq_class_tbl[i] = NULL;

if (cl == cbqp->ifnp.root_)
cbqp->ifnp.root_ = NULL;
if (cl == cbqp->ifnp.default_)
cbqp->ifnp.default_ = NULL;
#ifdef ALTQ3_COMPAT
if (cl == cbqp->ifnp.ctl_)
cbqp->ifnp.ctl_ = NULL;
#endif
return 0;
}

/* convert class handle to class pointer */
static struct rm_class *
clh_to_clp(cbq_state_t *cbqp, u_int32_t chandle)
{
int i;
struct rm_class *cl;

if (chandle == 0)
return NULL;
/*
* first, try optimistically the slot matching the lower bits of
* the handle. if it fails, do the linear table search.
*/
i = chandle % CBQ_MAX_CLASSES;
if ((cl = cbqp->cbq_class_tbl[i]) != NULL &&
cl->stats_.handle == chandle)
return (cl);
for (i = 0; i < CBQ_MAX_CLASSES; i++)
if ((cl = cbqp->cbq_class_tbl[i]) != NULL &&
cl->stats_.handle == chandle)
return cl;
return NULL;
}

static int
cbq_clear_interface(cbq_state_t *cbqp)
{
int again, i;
struct rm_class *cl;

#ifdef ALTQ3_CLFIER_COMPAT
/* free the filters for this interface */
acc_discard_filters(&cbqp->cbq_classifier, NULL, 1);
#endif

/* clear out the classes now */
do {
again = 0;
for (i = 0; i < CBQ_MAX_CLASSES; i++) {
if ((cl = cbqp->cbq_class_tbl[i]) != NULL) {
if (is_a_parent_class(cl))
again++;
else {
cbq_class_destroy(cbqp, cl);
cbqp->cbq_class_tbl[i] = NULL;
if (cl == cbqp->ifnp.root_)
cbqp->ifnp.root_ = NULL;
if (cl == cbqp->ifnp.default_)
cbqp->ifnp.default_ = NULL;
#ifdef ALTQ3_COMPAT
if (cl == cbqp->ifnp.ctl_)
cbqp->ifnp.ctl_ = NULL;
#endif
}
}
}
} while (again);

return 0;
}

static int
cbq_request(struct ifaltq *ifq, int req, void *arg)
{
cbq_state_t *cbqp = (cbq_state_t *)ifq->altq_disc;

switch (req) {
case ALTRQ_PURGE:
cbq_purge(cbqp);
break;
}
return 0;
}

/* copy the stats info in rm_class to class_states_t */
static void
get_class_stats(class_stats_t *statsp, struct rm_class *cl)
{
statsp->xmit_cnt = cl->stats_.xmit_cnt;
statsp->drop_cnt = cl->stats_.drop_cnt;
statsp->over = cl->stats_.over;
statsp->borrows = cl->stats_.borrows;
statsp->overactions = cl->stats_.overactions;
statsp->delays = cl->stats_.delays;

statsp->depth = cl->depth_;
statsp->priority = cl->pri_;
statsp->maxidle = cl->maxidle_;
statsp->minidle = cl->minidle_;
statsp->offtime = cl->offtime_;
statsp->qmax = qlimit(cl->q_);
statsp->ps_per_byte = cl->ps_per_byte_;
statsp->wrr_allot = cl->w_allotment_;
statsp->qcnt = qlen(cl->q_);
statsp->avgidle = cl->avgidle_;

statsp->qtype = qtype(cl->q_);
#ifdef ALTQ_RED
if (q_is_red(cl->q_))
red_getstats(cl->red_, &statsp->red[0]);
#endif
#ifdef ALTQ_RIO
if (q_is_rio(cl->q_))
rio_getstats((rio_t *)cl->red_, &statsp->red[0]);
#endif
}

#if NPF > 0
int
cbq_pfattach(struct pf_altq *a)
{
struct ifnet *ifp;
int s, error;

if ((ifp = ifunit(a->ifname)) == NULL || a->altq_disc == NULL)
return (EINVAL);
s = splnet();
error = altq_attach(&ifp->if_snd, ALTQT_CBQ, a->altq_disc,
cbq_enqueue, cbq_dequeue, cbq_request, NULL, NULL);
splx(s);
return error;
}

int
cbq_add_altq(struct pf_altq *a)
{
cbq_state_t *cbqp;
struct ifnet *ifp;

if ((ifp = ifunit(a->ifname)) == NULL)
return EINVAL;
if (!ALTQ_IS_READY(&ifp->if_snd))
return ENODEV;

/* allocate and initialize cbq_state_t */
cbqp = malloc(sizeof(cbq_state_t), M_DEVBUF, M_WAITOK|M_ZERO);
if (cbqp == NULL)
return ENOMEM;
(void)memset(cbqp, 0, sizeof(cbq_state_t));
CALLOUT_INIT(&cbqp->cbq_callout);
cbqp->cbq_qlen = 0;
cbqp->ifnp.ifq_ = &ifp->if_snd; /* keep the ifq */

/* keep the state in pf_altq */
a->altq_disc = cbqp;

return 0;
}

int
cbq_remove_altq(struct pf_altq *a)
{
cbq_state_t *cbqp;

if ((cbqp = a->altq_disc) == NULL)
return EINVAL;
a->altq_disc = NULL;

cbq_clear_interface(cbqp);

if (cbqp->ifnp.default_)
cbq_class_destroy(cbqp, cbqp->ifnp.default_);
if (cbqp->ifnp.root_)
cbq_class_destroy(cbqp, cbqp->ifnp.root_);

/* deallocate cbq_state_t */
free(cbqp, M_DEVBUF);

return 0;
}

#define NSEC_TO_PSEC(s) ((uint64_t)(s) * 1000)
int
cbq_add_queue(struct pf_altq *a)
{
struct rm_class *borrow, *parent;
cbq_state_t *cbqp;
struct rm_class *cl;
struct cbq_opts *opts;
int i, error;

if ((cbqp = a->altq_disc) == NULL)
return EINVAL;
if (a->qid == 0)
return EINVAL;

/*
* find a free slot in the class table. if the slot matching
* the lower bits of qid is free, use this slot. otherwise,
* use the first free slot.
*/
i = a->qid % CBQ_MAX_CLASSES;
if (cbqp->cbq_class_tbl[i] != NULL) {
for (i = 0; i < CBQ_MAX_CLASSES; i++)
if (cbqp->cbq_class_tbl[i] == NULL)
break;
if (i == CBQ_MAX_CLASSES)
return (EINVAL);
}

opts = &a->pq_u.cbq_opts;
/* check parameters */
if (a->priority >= CBQ_MAXPRI)
return EINVAL;

/* Get pointers to parent and borrow classes. */
parent = clh_to_clp(cbqp, a->parent_qid);
if (opts->flags & CBQCLF_BORROW)
borrow = parent;
else
borrow = NULL;

/*
* A class must borrow from its parent or it can not
* borrow at all. Hence, borrow can be null.
*/
if (parent == NULL && (opts->flags & CBQCLF_ROOTCLASS) == 0) {
printf("cbq_add_queue: no parent class!\n");
return EINVAL;
}

if ((borrow != parent) && (borrow != NULL)) {
printf("cbq_add_class: borrow class != parent\n");
return EINVAL;
}

/*
* check parameters
*/
if ((opts->flags & CBQCLF_ROOTCLASS) != 0) {
if (parent != NULL)
return EINVAL;
if (cbqp->ifnp.root_)
return EINVAL;
}
if ((opts->flags & CBQCLF_DEFCLASS) != 0) {
if (cbqp->ifnp.default_)
return EINVAL;
}
if ((opts->flags & CBQCLF_CLASSMASK) == 0) {
if (a->qid == 0)
return EINVAL;
}

/*
* create a class. if this is a root class, initialize the
* interface.
*/
if ((opts->flags & CBQCLF_ROOTCLASS) != 0) {
error = rmc_init(cbqp->ifnp.ifq_, &cbqp->ifnp,
NSEC_TO_PSEC(opts->ns_per_byte), cbqrestart, a->qlimit, RM_MAXQUEUED,
opts->maxidle, opts->minidle, opts->offtime,
opts->flags);
if (error != 0)
return error;
cl = cbqp->ifnp.root_;
} else {
cl = rmc_newclass(a->priority,
&cbqp->ifnp, NSEC_TO_PSEC(opts->ns_per_byte),
rmc_delay_action, a->qlimit, parent, borrow,
opts->maxidle, opts->minidle, opts->offtime,
opts->pktsize, opts->flags);
}
if (cl == NULL)
return ENOMEM;

/* return handle to user space. */
cl->stats_.handle = a->qid;
cl->stats_.depth = cl->depth_;

/* save the allocated class */
cbqp->cbq_class_tbl[i] = cl;

if ((opts->flags & CBQCLF_DEFCLASS) != 0)
cbqp->ifnp.default_ = cl;

return 0;
}

int
cbq_remove_queue(struct pf_altq *a)
{
struct rm_class *cl;
cbq_state_t *cbqp;
int i;

if ((cbqp = a->altq_disc) == NULL)
return EINVAL;

if ((cl = clh_to_clp(cbqp, a->qid)) == NULL)
return EINVAL;

/* if we are a parent class, then return an error. */
if (is_a_parent_class(cl))
return EINVAL;

/* delete the class */
rmc_delete_class(&cbqp->ifnp, cl);

/*
* free the class handle
*/
for (i = 0; i < CBQ_MAX_CLASSES; i++)
if (cbqp->cbq_class_tbl[i] == cl) {
cbqp->cbq_class_tbl[i] = NULL;
if (cl == cbqp->ifnp.root_)
cbqp->ifnp.root_ = NULL;
if (cl == cbqp->ifnp.default_)
cbqp->ifnp.default_ = NULL;
break;
}

return 0;
}

int
cbq_getqstats(struct pf_altq *a, void *ubuf, int *nbytes)
{
cbq_state_t *cbqp;
struct rm_class *cl;
class_stats_t stats;
int error = 0;

if ((cbqp = altq_lookup(a->ifname, ALTQT_CBQ)) == NULL)
return EBADF;

if ((cl = clh_to_clp(cbqp, a->qid)) == NULL)
return EINVAL;

if (*nbytes < sizeof(stats))
return EINVAL;

memset(&stats, 0, sizeof(stats));
get_class_stats(&stats, cl);

if ((error = copyout((void *)&stats, ubuf, sizeof(stats))) != 0)
return error;
*nbytes = sizeof(stats);
return (0);
}
#endif /* NPF > 0 */

/*
* int
* cbq_enqueue(struct ifaltq *ifq, struct mbuf *m)
* - Queue data packets.
*
* cbq_enqueue is set to ifp->if_altqenqueue and called by an upper
* layer (e.g. ether_output). cbq_enqueue queues the given packet
* to the cbq, then invokes the driver's start routine.
*
* Assumptions: called in splnet
* Returns: 0 if the queueing is successful.
* ENOBUFS if a packet dropping occurred as a result of
* the queueing.
*/

static int
cbq_enqueue(struct ifaltq *ifq, struct mbuf *m)
{
struct altq_pktattr pktattr;
cbq_state_t *cbqp = (cbq_state_t *)ifq->altq_disc;
struct rm_class *cl;
struct m_tag *t;
int len;

/* grab class set by classifier */
if ((m->m_flags & M_PKTHDR) == 0) {
/* should not happen */
printf("altq: packet for %s does not have pkthdr\n",
ifq->altq_ifp->if_xname);
m_freem(m);
return ENOBUFS;
}
cl = NULL;
if ((t = m_tag_find(m, PACKET_TAG_ALTQ_QID)) != NULL)
cl = clh_to_clp(cbqp, ((struct altq_tag *)(t+1))->qid);
#ifdef ALTQ3_COMPAT
else if (ifq->altq_flags & ALTQF_CLASSIFY)
cl = m->m_pkthdr.pattr_class;
#endif
if (cl == NULL) {
cl = cbqp->ifnp.default_;
if (cl == NULL) {
m_freem(m);
return ENOBUFS;
}
}
#ifdef ALTQ3_COMPAT
if (m->m_pkthdr.pattr_af != AF_UNSPEC) {
pktattr.pattr_class = m->m_pkthdr.pattr_class;
pktattr.pattr_af = m->m_pkthdr.pattr_af;
pktattr.pattr_hdr = m->m_pkthdr.pattr_hdr;

cl->pktattr_ = &pktattr; /* save proto hdr used by ECN */
} else
#endif
cl->pktattr_ = NULL;
len = m_pktlen(m);
if (rmc_queue_packet(cl, m) != 0) {
/* drop occurred. some mbuf was freed in rmc_queue_packet. */
PKTCNTR_ADD(&cl->stats_.drop_cnt, len);
return ENOBUFS;
}

/* successfully queued. */
++cbqp->cbq_qlen;
IFQ_INC_LEN(ifq);
return 0;
}

static struct mbuf *
cbq_dequeue(struct ifaltq *ifq, int op)
{
cbq_state_t *cbqp = (cbq_state_t *)ifq->altq_disc;
struct mbuf *m;

m = rmc_dequeue_next(&cbqp->ifnp, op);

if (m && op == ALTDQ_REMOVE) {
--cbqp->cbq_qlen; /* decrement # of packets in cbq */
IFQ_DEC_LEN(ifq);

/* Update the class. */
rmc_update_class_util(&cbqp->ifnp);
}
return m;
}

/*
* void
* cbqrestart(queue_t *) - Restart sending of data.
* called from rmc_restart in splnet via timeout after waking up
* a suspended class.
* Returns: NONE
*/

static void
cbqrestart(struct ifaltq *ifq)
{
cbq_state_t *cbqp;
struct ifnet *ifp;

if (!ALTQ_IS_ENABLED(ifq))
/* cbq must have been detached */
return;

if ((cbqp = (cbq_state_t *)ifq->altq_disc) == NULL)
/* should not happen */
return;

ifp = ifq->altq_ifp;
if (ifp->if_start &&
cbqp->cbq_qlen > 0 && (ifp->if_flags & IFF_OACTIVE) == 0)
if_start_lock(ifp);
}

static void
cbq_purge(cbq_state_t *cbqp)
{
struct rm_class *cl;
int i;

for (i = 0; i < CBQ_MAX_CLASSES; i++)
if ((cl = cbqp->cbq_class_tbl[i]) != NULL)
rmc_dropall(cl);
if (ALTQ_IS_ENABLED(cbqp->ifnp.ifq_))
cbqp->ifnp.ifq_->ifq_len = 0;
}
#ifdef ALTQ3_COMPAT

static int
cbq_add_class(struct cbq_add_class *acp)
{
char *ifacename;
struct rm_class *borrow, *parent;
cbq_state_t *cbqp;

ifacename = acp->cbq_iface.cbq_ifacename;
if ((cbqp = altq_lookup(ifacename, ALTQT_CBQ)) == NULL)
return EBADF;

/* check parameters */
if (acp->cbq_class.priority >= CBQ_MAXPRI ||
acp->cbq_class.maxq > CBQ_MAXQSIZE)
return EINVAL;

/* Get pointers to parent and borrow classes. */
parent = clh_to_clp(cbqp, acp->cbq_class.parent_class_handle);
borrow = clh_to_clp(cbqp, acp->cbq_class.borrow_class_handle);

/*
* A class must borrow from its parent or it can not
* borrow at all. Hence, borrow can be null.
*/
if (parent == NULL && (acp->cbq_class.flags & CBQCLF_ROOTCLASS) == 0) {
printf("cbq_add_class: no parent class!\n");
return EINVAL;
}

if ((borrow != parent) && (borrow != NULL)) {
printf("cbq_add_class: borrow class != parent\n");
return EINVAL;
}

return cbq_class_create(cbqp, acp, parent, borrow);
}

static int
cbq_delete_class(struct cbq_delete_class *dcp)
{
char *ifacename;
struct rm_class *cl;
cbq_state_t *cbqp;

ifacename = dcp->cbq_iface.cbq_ifacename;
if ((cbqp = altq_lookup(ifacename, ALTQT_CBQ)) == NULL)
return EBADF;

if ((cl = clh_to_clp(cbqp, dcp->cbq_class_handle)) == NULL)
return EINVAL;

/* if we are a parent class, then return an error. */
if (is_a_parent_class(cl))
return EINVAL;

/* if a filter has a reference to this class delete the filter */
acc_discard_filters(&cbqp->cbq_classifier, cl, 0);

return cbq_class_destroy(cbqp, cl);
}

static int
cbq_modify_class(struct cbq_modify_class *acp)
{
char *ifacename;
struct rm_class *cl;
cbq_state_t *cbqp;

ifacename = acp->cbq_iface.cbq_ifacename;
if ((cbqp = altq_lookup(ifacename, ALTQT_CBQ)) == NULL)
return EBADF;

/* Get pointer to this class */
if ((cl = clh_to_clp(cbqp, acp->cbq_class_handle)) == NULL)
return EINVAL;

if (rmc_modclass(cl, acp->cbq_class.pico_sec_per_byte,
acp->cbq_class.maxq, acp->cbq_class.maxidle,
acp->cbq_class.minidle, acp->cbq_class.offtime,
acp->cbq_class.pktsize) < 0)
return EINVAL;
return 0;
}

/*
* struct rm_class *
* cbq_class_create(cbq_mod_state_t *cbqp, struct cbq_add_class *acp,
* struct rm_class *parent, struct rm_class *borrow)
*
* This function create a new traffic class in the CBQ class hierarchy of
* given parameters. The class that created is either the root, default,
* or a new dynamic class. If CBQ is not initialized, the root class
* will be created.
*/
static int
cbq_class_create(cbq_state_t *cbqp, struct cbq_add_class *acp,
struct rm_class *parent, struct rm_class *borrow)
{
struct rm_class *cl;
cbq_class_spec_t *spec = &acp->cbq_class;
u_int32_t chandle;
int i, error;

/*
* allocate class handle
*/
for (i = 1; i < CBQ_MAX_CLASSES; i++)
if (cbqp->cbq_class_tbl[i] == NULL)
break;
if (i == CBQ_MAX_CLASSES)
return EINVAL;
chandle = i; /* use the slot number as class handle */

/*
* create a class. if this is a root class, initialize the
* interface.
*/
if ((spec->flags & CBQCLF_ROOTCLASS) != 0) {
error = rmc_init(cbqp->ifnp.ifq_, &cbqp->ifnp,
spec->pico_sec_per_byte, cbqrestart, spec->maxq,
RM_MAXQUEUED, spec->maxidle, spec->minidle, spec->offtime,
spec->flags);
if (error)
return error;
cl = cbqp->ifnp.root_;
} else {
cl = rmc_newclass(spec->priority,
&cbqp->ifnp, spec->pico_sec_per_byte,
rmc_delay_action, spec->maxq, parent, borrow,
spec->maxidle, spec->minidle, spec->offtime,
spec->pktsize, spec->flags);
}
if (cl == NULL)
return ENOMEM;

/* return handle to user space. */
acp->cbq_class_handle = chandle;

cl->stats_.handle = chandle;
cl->stats_.depth = cl->depth_;

/* save the allocated class */
cbqp->cbq_class_tbl[i] = cl;

if ((spec->flags & CBQCLF_DEFCLASS) != 0)
cbqp->ifnp.default_ = cl;
if ((spec->flags & CBQCLF_CTLCLASS) != 0)
cbqp->ifnp.ctl_ = cl;

return 0;
}

static int
cbq_add_filter(struct cbq_add_filter *afp)
{
char *ifacename;
cbq_state_t *cbqp;
struct rm_class *cl;

ifacename = afp->cbq_iface.cbq_ifacename;
if ((cbqp = altq_lookup(ifacename, ALTQT_CBQ)) == NULL)
return EBADF;

/* Get the pointer to class. */
if ((cl = clh_to_clp(cbqp, afp->cbq_class_handle)) == NULL)
return EINVAL;

return acc_add_filter(&cbqp->cbq_classifier, &afp->cbq_filter,
cl, &afp->cbq_filter_handle);
}

static int
cbq_delete_filter(struct cbq_delete_filter *dfp)
{
char *ifacename;
cbq_state_t *cbqp;

ifacename = dfp->cbq_iface.cbq_ifacename;
if ((cbqp = altq_lookup(ifacename, ALTQT_CBQ)) == NULL)
return EBADF;

return acc_delete_filter(&cbqp->cbq_classifier,
dfp->cbq_filter_handle);
}

/*
* cbq_clear_hierarchy deletes all classes and their filters on the
* given interface.
*/
static int
cbq_clear_hierarchy(struct cbq_interface *ifacep)
{
char *ifacename;
cbq_state_t *cbqp;

ifacename = ifacep->cbq_ifacename;
if ((cbqp = altq_lookup(ifacename, ALTQT_CBQ)) == NULL)
return EBADF;

return cbq_clear_interface(cbqp);
}

/*
* static int
* cbq_set_enable(struct cbq_enable *ep) - this function processed the
* ioctl request to enable class based queueing. It searches the list
* of interfaces for the specified interface and then enables CBQ on
* that interface.
*
* Returns: 0, for no error.
* EBADF, for specified interface not found.
*/

static int
cbq_set_enable(struct cbq_interface *ep, int enable)
{
int error = 0;
cbq_state_t *cbqp;
char *ifacename;

ifacename = ep->cbq_ifacename;
if ((cbqp = altq_lookup(ifacename, ALTQT_CBQ)) == NULL)
return EBADF;

switch (enable) {
case ENABLE:
if (cbqp->ifnp.root_ == NULL || cbqp->ifnp.default_ == NULL) {
if (cbqp->ifnp.root_ == NULL)
printf("No Root Class for %s\n", ifacename);
if (cbqp->ifnp.default_ == NULL)
printf("No Default Class for %s\n", ifacename);
error = EINVAL;
} else if ((error = altq_enable(cbqp->ifnp.ifq_)) == 0) {
cbqp->cbq_qlen = 0;
}
break;

case DISABLE:
error = altq_disable(cbqp->ifnp.ifq_);
break;
}
return error;
}

static int
cbq_getstats(struct cbq_getstats *gsp)
{
char *ifacename;
int i, n, nclasses;
cbq_state_t *cbqp;
struct rm_class *cl;
class_stats_t stats, *usp;
int error = 0;

ifacename = gsp->iface.cbq_ifacename;
nclasses = gsp->nclasses;
usp = gsp->stats;

if ((cbqp = altq_lookup(ifacename, ALTQT_CBQ)) == NULL)
return EBADF;
if (nclasses <= 0)
return EINVAL;

for (n = 0, i = 0; n < nclasses && i < CBQ_MAX_CLASSES; n++, i++) {
while ((cl = cbqp->cbq_class_tbl[i]) == NULL)
if (++i >= CBQ_MAX_CLASSES)
goto out;

memset(&stats, 0, sizeof(stats));
get_class_stats(&stats, cl);
stats.handle = cl->stats_.handle;

if ((error = copyout((void *)&stats, (void *)usp++,
sizeof(stats))) != 0)
return error;
}

out:
gsp->nclasses = n;
return error;
}

static int
cbq_ifattach(struct cbq_interface *ifacep)
{
int error = 0;
char *ifacename;
cbq_state_t *new_cbqp;
struct ifnet *ifp;

ifacename = ifacep->cbq_ifacename;
if ((ifp = ifunit(ifacename)) == NULL)
return ENXIO;
if (!ALTQ_IS_READY(&ifp->if_snd))
return ENXIO;

/* allocate and initialize cbq_state_t */
new_cbqp = malloc(sizeof(cbq_state_t), M_DEVBUF, M_WAITOK|M_ZERO);
if (new_cbqp == NULL)
return ENOMEM;
CALLOUT_INIT(&new_cbqp->cbq_callout);

new_cbqp->cbq_qlen = 0;
new_cbqp->ifnp.ifq_ = &ifp->if_snd; /* keep the ifq */

/*
* set CBQ to this ifnet structure.
*/
error = altq_attach(&ifp->if_snd, ALTQT_CBQ, new_cbqp,
cbq_enqueue, cbq_dequeue, cbq_request,
&new_cbqp->cbq_classifier, acc_classify);
if (error) {
free(new_cbqp, M_DEVBUF);
return error;
}

/* prepend to the list of cbq_state_t's. */
new_cbqp->cbq_next = cbq_list;
cbq_list = new_cbqp;

return 0;
}

static int
cbq_ifdetach(struct cbq_interface *ifacep)
{
char *ifacename;
cbq_state_t *cbqp;

ifacename = ifacep->cbq_ifacename;
if ((cbqp = altq_lookup(ifacename, ALTQT_CBQ)) == NULL)
return (EBADF);

(void)cbq_set_enable(ifacep, DISABLE);

cbq_clear_interface(cbqp);

/* remove CBQ from the ifnet structure. */
(void)altq_detach(cbqp->ifnp.ifq_);

/* remove from the list of cbq_state_t's. */
if (cbq_list == cbqp)
cbq_list = cbqp->cbq_next;
else {
cbq_state_t *cp;

for (cp = cbq_list; cp != NULL; cp = cp->cbq_next)
if (cp->cbq_next == cbqp) {
cp->cbq_next = cbqp->cbq_next;
break;
}
ASSERT(cp != NULL);
}

/* deallocate cbq_state_t */
free(cbqp, M_DEVBUF);

return 0;
}

/*
* cbq device interface
*/

altqdev_decl(cbq);

int
cbqopen(dev_t dev, int flag, int fmt,
struct lwp *l)
{
return 0;
}

int
cbqclose(dev_t dev, int flag, int fmt,
struct lwp *l)
{
struct ifnet *ifp;
struct cbq_interface iface;
int err, error = 0;

while (cbq_list) {
ifp = cbq_list->ifnp.ifq_->altq_ifp;
snprintf(iface.cbq_ifacename, sizeof(iface.cbq_ifacename),
"%s", ifp->if_xname);
err = cbq_ifdetach(&iface);
if (err != 0 && error == 0)
error = err;
}

return error;
}

int
cbqioctl(dev_t dev, ioctlcmd_t cmd, void *addr, int flag,
struct lwp *l)
{
int error = 0;

/* check cmd for superuser only */
switch (cmd) {
case CBQ_GETSTATS:
/* currently only command that an ordinary user can call */
break;
default:
error = kauth_authorize_network(l->l_cred,
KAUTH_NETWORK_ALTQ, KAUTH_REQ_NETWORK_ALTQ_CBQ, NULL, NULL,
NULL);
if (error)
return error;
break;
}

switch (cmd) {

case CBQ_ENABLE:
error = cbq_set_enable((struct cbq_interface *)addr, ENABLE);
break;

case CBQ_DISABLE:
error = cbq_set_enable((struct cbq_interface *)addr, DISABLE);
break;

case CBQ_ADD_FILTER:
error = cbq_add_filter((struct cbq_add_filter *)addr);
break;

case CBQ_DEL_FILTER:
error = cbq_delete_filter((struct cbq_delete_filter *)addr);
break;

case CBQ_ADD_CLASS:
error = cbq_add_class((struct cbq_add_class *)addr);
break;

case CBQ_DEL_CLASS:
error = cbq_delete_class((struct cbq_delete_class *)addr);
break;

case CBQ_MODIFY_CLASS:
error = cbq_modify_class((struct cbq_modify_class *)addr);
break;

case CBQ_CLEAR_HIERARCHY:
error = cbq_clear_hierarchy((struct cbq_interface *)addr);
break;

case CBQ_IF_ATTACH:
error = cbq_ifattach((struct cbq_interface *)addr);
break;

case CBQ_IF_DETACH:
error = cbq_ifdetach((struct cbq_interface *)addr);
break;

case CBQ_GETSTATS:
error = cbq_getstats((struct cbq_getstats *)addr);
break;

default:
error = EINVAL;
break;
}

return error;
}

#if 0
/* for debug */
static void cbq_class_dump(int);

static void
cbq_class_dump(int i)
{
struct rm_class *cl;
rm_class_stats_t *s;
struct _class_queue_ *q;

if (cbq_list == NULL) {
printf("cbq_class_dump: no cbq_state found\n");
return;
}
cl = cbq_list->cbq_class_tbl[i];

printf("class %d cl=%p\n", i, cl);
if (cl != NULL) {
s = &cl->stats_;
q = cl->q_;

printf("pri=%d, depth=%d, maxrate=%d, allotment=%d\n",
cl->pri_, cl->depth_, cl->maxrate_, cl->allotment_);
printf("w_allotment=%d, bytes_alloc=%d, avgidle=%d, maxidle=%d\n",
cl->w_allotment_, cl->bytes_alloc_, cl->avgidle_,
cl->maxidle_);
printf("minidle=%d, offtime=%d, sleeping=%d, leaf=%d\n",
cl->minidle_, cl->offtime_, cl->sleeping_, cl->leaf_);
printf("handle=%d, depth=%d, packets=%d, bytes=%d\n",
s->handle, s->depth,
(int)s->xmit_cnt.packets, (int)s->xmit_cnt.bytes);
printf("over=%d\n, borrows=%d, drops=%d, overactions=%d, delays=%d\n",
s->over, s->borrows, (int)s->drop_cnt.packets,
s->overactions, s->delays);
printf("tail=%p, head=%p, qlen=%d, qlim=%d, qthresh=%d,qtype=%d\n",
q->tail_, q->head_, q->qlen_, q->qlim_,
q->qthresh_, q->qtype_);
}
}
#endif /* 0 */

#ifdef KLD_MODULE

static struct altqsw cbq_sw =
{"cbq", cbqopen, cbqclose, cbqioctl};

ALTQ_MODULE(altq_cbq, ALTQT_CBQ, &cbq_sw);
MODULE_DEPEND(altq_cbq, altq_red, 1, 1, 1);
MODULE_DEPEND(altq_cbq, altq_rio, 1, 1, 1);

#endif /* KLD_MODULE */
#endif /* ALTQ3_COMPAT */

#endif /* ALTQ_CBQ */