xref: /freebsd/lib/librss/librss.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1 /*
2  * Copyright (c) 2016 Adrian Chadd <adrian@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #ifndef	__LIBRSS_H__
28 #define	__LIBRSS_H__
29 
30 struct rss_config {
31 	int rss_ncpus;
32 	int rss_nbuckets;
33 	int rss_basecpu;
34 	int *rss_bucket_map;
35 };
36 
37 typedef enum {
38 	RSS_BUCKET_TYPE_NONE = 0,
39 	RSS_BUCKET_TYPE_KERNEL_ALL = 1,
40 	RSS_BUCKET_TYPE_KERNEL_TX = 2,
41 	RSS_BUCKET_TYPE_KERNEL_RX = 3,
42 	RSS_BUCKET_TYPE_MAX = 3,
43 } rss_bucket_type_t;
44 
45 typedef void rss_bucket_rebalance_cb_t(void *arg);
46 
47 /*
48  * Enable or disable receiving RSS/flowid information on
49  * received UDP frames.
50  */
51 extern	int rss_sock_set_recvrss(int fd, int af, int val);
52 
53 /*
54  * Fetch RSS configuration information.
55  */
56 extern	struct rss_config * rss_config_get(void);
57 
58 /*
59  * Free an RSS configuration structure.
60  */
61 extern	void rss_config_free(struct rss_config *rc);
62 
63 /*
64  * Return how many RSS buckets there are.
65  */
66 extern	int rss_config_get_bucket_count(struct rss_config *rc);
67 
68 /*
69  * Fetch the cpuset configuration for the given RSS bucket and
70  * type.
71  */
72 extern	int rss_get_bucket_cpuset(struct rss_config *rc,
73     rss_bucket_type_t btype, int bucket, cpuset_t *cs);
74 
75 /*
76  * Set a callback for bucket rebalancing.
77  *
78  * This will occur in a separate thread context rather than
79  * a signal handler.
80  */
81 extern	int rss_set_bucket_rebalance_cb(rss_bucket_rebalance_cb_t *cb,
82 	    void *cbdata);
83 
84 #endif /* __LIBRSS_H__ */
85