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
32struct rss_config {
33	int rss_ncpus;
34	int rss_nbuckets;
35	int rss_basecpu;
36	int *rss_bucket_map;
37};
38
39typedef 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
47typedef void rss_bucket_rebalance_cb_t(void *arg);
48
49/*
50 * Enable/disable whether to allow for multiple bind()s to the
51 * given PCB entry.
52 *
53 * This must be done before bind().
54 */
55extern	int rss_sock_set_bindmulti(int fd, int af, int val);
56
57/*
58 * Set the RSS bucket for the given file descriptor.
59 *
60 * This must be done before bind().
61 */
62extern	int rss_sock_set_rss_bucket(int fd, int af, int rss_bucket);
63
64/*
65 * Enable or disable receiving RSS/flowid information on
66 * received UDP frames.
67 */
68extern	int rss_sock_set_recvrss(int fd, int af, int val);
69
70/*
71 * Fetch RSS configuration information.
72 */
73extern	struct rss_config * rss_config_get(void);
74
75/*
76 * Free an RSS configuration structure.
77 */
78extern	void rss_config_free(struct rss_config *rc);
79
80/*
81 * Return how many RSS buckets there are.
82 */
83extern	int rss_config_get_bucket_count(struct rss_config *rc);
84
85/*
86 * Fetch the cpuset configuration for the given RSS bucket and
87 * type.
88 */
89extern	int rss_get_bucket_cpuset(struct rss_config *rc,
90    rss_bucket_type_t btype, int bucket, cpuset_t *cs);
91
92/*
93 * Set a callback for bucket rebalancing.
94 *
95 * This will occur in a separate thread context rather than
96 * a signal handler.
97 */
98extern	int rss_set_bucket_rebalance_cb(rss_bucket_rebalance_cb_t *cb,
99	    void *cbdata);
100
101#endif /* __LIBRSS_H__ */
102