xref: /freebsd/lib/librss/librss.h (revision 005cca8361a4932d03bd93fefa998fff69a1e136)
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  * $FreeBSD$
27  */
28 
29 #ifndef	__LIBRSS_H__
30 #define	__LIBRSS_H__
31 
32 struct rss_config {
33 	int rss_ncpus;
34 	int rss_nbuckets;
35 	int rss_basecpu;
36 	int *rss_bucket_map;
37 };
38 
39 typedef enum {
40 	RSS_BUCKET_TYPE_NONE = 0,
41 	RSS_BUCKET_TYPE_KERNEL_ALL = 1,
42 	RSS_BUCKET_TYPE_KERNEL_TX = 2,
43 	RSS_BUCKET_TYPE_KERNEL_RX = 3,
44 	RSS_BUCKET_TYPE_MAX = 3,
45 } rss_bucket_type_t;
46 
47 typedef void rss_bucket_rebalance_cb_t(void *arg);
48 
49 /*
50  * Enable or disable receiving RSS/flowid information on
51  * received UDP frames.
52  */
53 extern	int rss_sock_set_recvrss(int fd, int af, int val);
54 
55 /*
56  * Fetch RSS configuration information.
57  */
58 extern	struct rss_config * rss_config_get(void);
59 
60 /*
61  * Free an RSS configuration structure.
62  */
63 extern	void rss_config_free(struct rss_config *rc);
64 
65 /*
66  * Return how many RSS buckets there are.
67  */
68 extern	int rss_config_get_bucket_count(struct rss_config *rc);
69 
70 /*
71  * Fetch the cpuset configuration for the given RSS bucket and
72  * type.
73  */
74 extern	int rss_get_bucket_cpuset(struct rss_config *rc,
75     rss_bucket_type_t btype, int bucket, cpuset_t *cs);
76 
77 /*
78  * Set a callback for bucket rebalancing.
79  *
80  * This will occur in a separate thread context rather than
81  * a signal handler.
82  */
83 extern	int rss_set_bucket_rebalance_cb(rss_bucket_rebalance_cb_t *cb,
84 	    void *cbdata);
85 
86 #endif /* __LIBRSS_H__ */
87