[linux-block.git] / include / net / fq.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (c) 2016 Qualcomm Atheros, Inc
 *
 * Based on net/sched/sch_fq_codel.c
 */
#ifndef __NET_SCHED_FQ_H
#define __NET_SCHED_FQ_H

#include <linux/skbuff.h>
#include <linux/spinlock.h>
#include <linux/types.h>

struct fq_tin;

/**
 * struct fq_flow - per traffic flow queue
 *
 * @tin: owner of this flow. Used to manage collisions, i.e. when a packet
 *	hashes to an index which points to a flow that is already owned by a
 *	different tin the packet is destined to. In such case the implementer
 *	must provide a fallback flow
 * @flowchain: can be linked to fq_tin's new_flows or old_flows. Used for DRR++
 *	(deficit round robin) based round robin queuing similar to the one
 *	found in net/sched/sch_fq_codel.c
 * @queue: sk_buff queue to hold packets
 * @backlog: number of bytes pending in the queue. The number of packets can be
 *	found in @queue.qlen
 * @deficit: used for DRR++
 */
struct fq_flow {
	struct fq_tin *tin;
	struct list_head flowchain;
	struct sk_buff_head queue;
	u32 backlog;
	int deficit;
};

/**
 * struct fq_tin - a logical container of fq_flows
 *
 * Used to group fq_flows into a logical aggregate. DRR++ scheme is used to
 * pull interleaved packets out of the associated flows.
 *
 * @new_flows: linked list of fq_flow
 * @old_flows: linked list of fq_flow
 */
struct fq_tin {
	struct list_head new_flows;
	struct list_head old_flows;
	struct list_head tin_list;
	struct fq_flow default_flow;
	u32 backlog_bytes;
	u32 backlog_packets;
	u32 overlimit;
	u32 collisions;
	u32 flows;
	u32 tx_bytes;
	u32 tx_packets;
};

/**
 * struct fq - main container for fair queuing purposes
 *
 * @limit: max number of packets that can be queued across all flows
 * @backlog: number of packets queued across all flows
 */
struct fq {
	struct fq_flow *flows;
	unsigned long *flows_bitmap;

	struct list_head tin_backlog;
	spinlock_t lock;
	u32 flows_cnt;
	u32 limit;
	u32 memory_limit;
	u32 memory_usage;
	u32 quantum;
	u32 backlog;
	u32 overlimit;
	u32 overmemory;
	u32 collisions;
};

typedef struct sk_buff *fq_tin_dequeue_t(struct fq *,
					 struct fq_tin *,
					 struct fq_flow *flow);

typedef void fq_skb_free_t(struct fq *,
			   struct fq_tin *,
			   struct fq_flow *,
			   struct sk_buff *);

/* Return %true to filter (drop) the frame. */
typedef bool fq_skb_filter_t(struct fq *,
			     struct fq_tin *,
			     struct fq_flow *,
			     struct sk_buff *,
			     void *);

typedef struct fq_flow *fq_flow_get_default_t(struct fq *,
					      struct fq_tin *,
					      int idx,
					      struct sk_buff *);

#endif
Commit	Line	Data
fb9e53cc	1	/* SPDX-License-Identifier: GPL-2.0-only */
557fc4a0 MK	2	/*
	3	* Copyright (c) 2016 Qualcomm Atheros, Inc
	4	*
557fc4a0 MK	5	* Based on net/sched/sch_fq_codel.c
	6	*/
	7	#ifndef __NET_SCHED_FQ_H
	8	#define __NET_SCHED_FQ_H
	9
949d6b40 JK	10	#include <linux/skbuff.h>
	11	#include <linux/spinlock.h>
	12	#include <linux/types.h>
	13
557fc4a0 MK	14	struct fq_tin;
	15
	16	/**
	17	* struct fq_flow - per traffic flow queue
	18	*
	19	* @tin: owner of this flow. Used to manage collisions, i.e. when a packet
	20	* hashes to an index which points to a flow that is already owned by a
	21	* different tin the packet is destined to. In such case the implementer
	22	* must provide a fallback flow
	23	* @flowchain: can be linked to fq_tin's new_flows or old_flows. Used for DRR++
	24	* (deficit round robin) based round robin queuing similar to the one
	25	* found in net/sched/sch_fq_codel.c
557fc4a0 MK	26	* @queue: sk_buff queue to hold packets
	27	* @backlog: number of bytes pending in the queue. The number of packets can be
	28	* found in @queue.qlen
	29	* @deficit: used for DRR++
	30	*/
	31	struct fq_flow {
	32	struct fq_tin *tin;
	33	struct list_head flowchain;
557fc4a0 MK	34	struct sk_buff_head queue;
	35	u32 backlog;
	36	int deficit;
	37	};
	38
	39	/**
	40	* struct fq_tin - a logical container of fq_flows
	41	*
	42	* Used to group fq_flows into a logical aggregate. DRR++ scheme is used to
	43	* pull interleaved packets out of the associated flows.
	44	*
	45	* @new_flows: linked list of fq_flow
	46	* @old_flows: linked list of fq_flow
	47	*/
	48	struct fq_tin {
	49	struct list_head new_flows;
	50	struct list_head old_flows;
d7b64929	51	struct list_head tin_list;
bf9009bf	52	struct fq_flow default_flow;
557fc4a0 MK	53	u32 backlog_bytes;
	54	u32 backlog_packets;
	55	u32 overlimit;
	56	u32 collisions;
	57	u32 flows;
	58	u32 tx_bytes;
	59	u32 tx_packets;
	60	};
	61
	62	/**
	63	* struct fq - main container for fair queuing purposes
	64	*
557fc4a0 MK	65	* @limit: max number of packets that can be queued across all flows
	66	* @backlog: number of packets queued across all flows
	67	*/
	68	struct fq {
	69	struct fq_flow *flows;
d7b64929 FF	70	unsigned long *flows_bitmap;
	71
	72	struct list_head tin_backlog;
557fc4a0 MK	73	spinlock_t lock;
557fc4a0 MK	74	u32 flows_cnt;
557fc4a0	75	u32 limit;
097b065b THJ	76	u32 memory_limit;
097b065b THJ	77	u32 memory_usage;
557fc4a0 MK	78	u32 quantum;
	79	u32 backlog;
	80	u32 overlimit;
097b065b	81	u32 overmemory;
557fc4a0 MK	82	u32 collisions;
	83	};
	84
	85	typedef struct sk_buff fq_tin_dequeue_t(struct fq ,
	86	struct fq_tin *,
	87	struct fq_flow *flow);
	88
	89	typedef void fq_skb_free_t(struct fq *,
	90	struct fq_tin *,
	91	struct fq_flow *,
	92	struct sk_buff *);
	93
8c418b5b JB	94	/* Return %true to filter (drop) the frame. */
	95	typedef bool fq_skb_filter_t(struct fq *,
	96	struct fq_tin *,
	97	struct fq_flow *,
	98	struct sk_buff *,
	99	void *);
	100
557fc4a0 MK	101	typedef struct fq_flow fq_flow_get_default_t(struct fq ,
	102	struct fq_tin *,
	103	int idx,
	104	struct sk_buff *);
	105
	106	#endif