[dragonfly.git] / sys / net / altq / if_altq.h

/*	$KAME: if_altq.h,v 1.11 2003/07/10 12:07:50 kjc Exp $	*/

/*
 * Copyright (C) 1997-2003
 *	Sony Computer Science Laboratories Inc.  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.
 *
 * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
#ifndef _NET_ALTQ_IF_ALTQ_H_
#define	_NET_ALTQ_IF_ALTQ_H_

#ifndef _SYS_SERIALIZE_H_
#include <sys/serialize.h>
#endif

struct altq_pktattr;

/*
 * Structure defining a queue for a network interface.
 */
struct	ifaltq {
	/* fields compatible with struct ifqueue */
	struct	mbuf *ifq_head;
	struct	mbuf *ifq_tail;
	int	ifq_len;
	int	ifq_maxlen;
	int	ifq_drops;

	/* alternate queueing related fields */
	int	altq_type;		/* discipline type */
	int	altq_flags;		/* flags (e.g. ready, in-use) */
	void	*altq_disc;		/* for discipline-specific use */
	struct	ifnet *altq_ifp;	/* back pointer to interface */

	int	(*altq_enqueue)(struct ifaltq *, struct mbuf *,
				struct altq_pktattr *);
	struct	mbuf *(*altq_dequeue)(struct ifaltq *, struct mbuf *, int);
	int	(*altq_request)(struct ifaltq *, int, void *);

	/* classifier fields */
	void	*altq_clfier;		/* classifier-specific use */
	void	*(*altq_classify)(struct ifaltq *, struct mbuf *,
				  struct altq_pktattr *);

	/* token bucket regulator */
	struct	tb_regulator *altq_tbr;

	struct	lwkt_serialize altq_lock;
	struct	mbuf *altq_prepended;	/* mbuf dequeued, but not yet xmit */
	int	altq_started;		/* ifnet.if_start interlock */
};

#define ALTQ_ASSERT_LOCKED(ifq)	ASSERT_SERIALIZED(&(ifq)->altq_lock)
#define ALTQ_LOCK_INIT(ifq)	lwkt_serialize_init(&(ifq)->altq_lock)
#define ALTQ_LOCK(ifq)		lwkt_serialize_adaptive_enter(&(ifq)->altq_lock)
#define ALTQ_UNLOCK(ifq)	lwkt_serialize_exit(&(ifq)->altq_lock)

#ifdef _KERNEL

/*
 * packet attributes used by queueing disciplines.
 * pattr_class is a discipline-dependent scheduling class that is
 * set by a classifier.
 * pattr_hdr and pattr_af may be used by a discipline to access
 * the header within a mbuf.  (e.g. ECN needs to update the CE bit)
 * note that pattr_hdr could be stale after m_pullup, though link
 * layer output routines usually don't use m_pullup.  link-level
 * compression also invalidates these fields.  thus, pattr_hdr needs
 * to be verified when a discipline touches the header.
 */
struct altq_pktattr {
	void	*pattr_class;		/* sched class set by classifier */
	int	pattr_af;		/* address family */
	caddr_t	pattr_hdr;		/* saved header position in mbuf */
};

/*
 * a token-bucket regulator limits the rate that a network driver can
 * dequeue packets from the output queue.
 * modern cards are able to buffer a large amount of packets and dequeue
 * too many packets at a time.  this bursty dequeue behavior makes it
 * impossible to schedule packets by queueing disciplines.
 * a token-bucket is used to control the burst size in a device
 * independent manner.
 */
struct tb_regulator {
	int64_t		tbr_rate;	/* (scaled) token bucket rate */
	int64_t		tbr_depth;	/* (scaled) token bucket depth */

	int64_t		tbr_token;	/* (scaled) current token */
	int64_t		tbr_filluptime;	/* (scaled) time to fill up bucket */
	uint64_t	tbr_last;	/* last time token was updated */

	int		tbr_lastop;	/* last dequeue operation type
					   needed for poll-and-dequeue */
};

/* if_altqflags */
#define	ALTQF_READY	 0x01	/* driver supports alternate queueing */
#define	ALTQF_ENABLED	 0x02	/* altq is in use */
#define	ALTQF_CLASSIFY	 0x04	/* classify packets */
#define	ALTQF_DRIVER1	 0x40	/* driver specific */

/* if_altqflags set internally only: */
#define	ALTQF_CANTCHANGE 	(ALTQF_READY)

/* altq_dequeue 2nd arg */
#define	ALTDQ_REMOVE		1	/* dequeue mbuf from the queue */
#define	ALTDQ_POLL		2	/* don't dequeue mbuf from the queue */

/* altq request types (currently only purge is defined) */
#define	ALTRQ_PURGE		1	/* purge all packets */

int	altq_attach(struct ifaltq *, int, void *,
		    int (*)(struct ifaltq *, struct mbuf *, struct altq_pktattr *),
		    struct mbuf *(*)(struct ifaltq *, struct mbuf *, int),
		    int (*)(struct ifaltq *, int, void *),
		    void *, void *(*)(struct ifaltq *, struct mbuf *,
				      struct altq_pktattr *));
int	altq_detach(struct ifaltq *);
int	altq_enable(struct ifaltq *);
int	altq_disable(struct ifaltq *);
struct mbuf *tbr_dequeue(struct ifaltq *, struct mbuf *, int);
extern int	(*altq_input)(struct mbuf *, int);
#endif /* _KERNEL */

#endif /* _NET_ALTQ_IF_ALTQ_H_ */
Commit	Line	Data
4d723e5a	1	/* $KAME: if_altq.h,v 1.11 2003/07/10 12:07:50 kjc Exp $ */
4d723e5a JS	2
	3	/*
	4	* Copyright (C) 1997-2003
	5	* Sony Computer Science Laboratories Inc. All rights reserved.
	6	*
	7	* Redistribution and use in source and binary forms, with or without
	8	* modification, are permitted provided that the following conditions
	9	* are met:
	10	* 1. Redistributions of source code must retain the above copyright
	11	* notice, this list of conditions and the following disclaimer.
	12	* 2. Redistributions in binary form must reproduce the above copyright
	13	* notice, this list of conditions and the following disclaimer in the
	14	* documentation and/or other materials provided with the distribution.
	15	*
	16	* THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
	17	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	18	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	19	* ARE DISCLAIMED. IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
	20	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	21	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	22	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	23	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	24	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	25	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	26	* SUCH DAMAGE.
	27	*/
1bd40720 MD	28	#ifndef _NET_ALTQ_IF_ALTQ_H_
1bd40720 MD	29	#define _NET_ALTQ_IF_ALTQ_H_
4d723e5a	30
9db4b353 SZ	31	#ifndef _SYS_SERIALIZE_H_
	32	#include <sys/serialize.h>
	33	#endif
	34
4d723e5a JS	35	struct altq_pktattr;
	36
	37	/*
	38	* Structure defining a queue for a network interface.
	39	*/
	40	struct ifaltq {
	41	/* fields compatible with struct ifqueue */
	42	struct mbuf *ifq_head;
	43	struct mbuf *ifq_tail;
	44	int ifq_len;
	45	int ifq_maxlen;
	46	int ifq_drops;
	47
	48	/* alternate queueing related fields */
	49	int altq_type; /* discipline type */
	50	int altq_flags; /* flags (e.g. ready, in-use) */
	51	void altq_disc; / for discipline-specific use */
	52	struct ifnet altq_ifp; / back pointer to interface */
	53
	54	int (altq_enqueue)(struct ifaltq , struct mbuf *,
	55	struct altq_pktattr *);
d2c71fa0	56	struct mbuf (altq_dequeue)(struct ifaltq , struct mbuf , int);
4d723e5a JS	57	int (altq_request)(struct ifaltq , int, void *);
	58
	59	/* classifier fields */
	60	void altq_clfier; / classifier-specific use */
	61	void (altq_classify)(struct ifaltq , struct mbuf ,
	62	struct altq_pktattr *);
	63
	64	/* token bucket regulator */
	65	struct tb_regulator *altq_tbr;
9db4b353 SZ	66
	67	struct lwkt_serialize altq_lock;
	68	struct mbuf altq_prepended; / mbuf dequeued, but not yet xmit */
	69	int altq_started; /* ifnet.if_start interlock */
4d723e5a JS	70	};
4d723e5a JS	71
9db4b353 SZ	72	#define ALTQ_ASSERT_LOCKED(ifq) ASSERT_SERIALIZED(&(ifq)->altq_lock)
	73	#define ALTQ_LOCK_INIT(ifq) lwkt_serialize_init(&(ifq)->altq_lock)
	74	#define ALTQ_LOCK(ifq) lwkt_serialize_adaptive_enter(&(ifq)->altq_lock)
	75	#define ALTQ_UNLOCK(ifq) lwkt_serialize_exit(&(ifq)->altq_lock)
4d723e5a JS	76
	77	#ifdef _KERNEL
	78
	79	/*
	80	* packet attributes used by queueing disciplines.
	81	* pattr_class is a discipline-dependent scheduling class that is
	82	* set by a classifier.
	83	* pattr_hdr and pattr_af may be used by a discipline to access
	84	* the header within a mbuf. (e.g. ECN needs to update the CE bit)
	85	* note that pattr_hdr could be stale after m_pullup, though link
	86	* layer output routines usually don't use m_pullup. link-level
	87	* compression also invalidates these fields. thus, pattr_hdr needs
	88	* to be verified when a discipline touches the header.
	89	*/
	90	struct altq_pktattr {
	91	void pattr_class; / sched class set by classifier */
	92	int pattr_af; /* address family */
	93	caddr_t pattr_hdr; /* saved header position in mbuf */
	94	};
	95
	96	/*
	97	* a token-bucket regulator limits the rate that a network driver can
	98	* dequeue packets from the output queue.
	99	* modern cards are able to buffer a large amount of packets and dequeue
	100	* too many packets at a time. this bursty dequeue behavior makes it
	101	* impossible to schedule packets by queueing disciplines.
	102	* a token-bucket is used to control the burst size in a device
	103	* independent manner.
	104	*/
	105	struct tb_regulator {
	106	int64_t tbr_rate; /* (scaled) token bucket rate */
	107	int64_t tbr_depth; /* (scaled) token bucket depth */
	108
	109	int64_t tbr_token; /* (scaled) current token */
	110	int64_t tbr_filluptime; /* (scaled) time to fill up bucket */
	111	uint64_t tbr_last; /* last time token was updated */
	112
	113	int tbr_lastop; /* last dequeue operation type
	114	needed for poll-and-dequeue */
	115	};
	116
	117	/* if_altqflags */
	118	#define ALTQF_READY 0x01 /* driver supports alternate queueing */
	119	#define ALTQF_ENABLED 0x02 /* altq is in use */
	120	#define ALTQF_CLASSIFY 0x04 /* classify packets */
	121	#define ALTQF_DRIVER1 0x40 /* driver specific */
	122
	123	/* if_altqflags set internally only: */
	124	#define ALTQF_CANTCHANGE (ALTQF_READY)
	125
	126	/* altq_dequeue 2nd arg */
	127	#define ALTDQ_REMOVE 1 /* dequeue mbuf from the queue */
	128	#define ALTDQ_POLL 2 /* don't dequeue mbuf from the queue */
	129
	130	/* altq request types (currently only purge is defined) */
	131	#define ALTRQ_PURGE 1 /* purge all packets */
	132
4d723e5a JS	133	int altq_attach(struct ifaltq , int, void ,
4d723e5a JS	134	int ()(struct ifaltq , struct mbuf , struct altq_pktattr ),
d2c71fa0	135	struct mbuf ()(struct ifaltq , struct mbuf , int),
4d723e5a JS	136	int ()(struct ifaltq , int, void *),
	137	void , void ()(struct ifaltq , struct mbuf *,
	138	struct altq_pktattr *));
	139	int altq_detach(struct ifaltq *);
	140	int altq_enable(struct ifaltq *);
	141	int altq_disable(struct ifaltq *);
d2c71fa0	142	struct mbuf tbr_dequeue(struct ifaltq , struct mbuf *, int);
4d723e5a JS	143	extern int (altq_input)(struct mbuf , int);
	144	#endif /* _KERNEL */
	145
1bd40720	146	#endif /* _NET_ALTQ_IF_ALTQ_H_ */