├── .gitignore
├── CONTRIBUTING
├── LICENSE
├── Makefile.am
├── README.md
├── VERSION
├── bootstrap
├── configure.ac
├── src
├── Makefile.am
├── main.c
├── udp_publisher.c
├── unyte_reuseport_kern.c
├── unyte_reuseport_user.c
└── unyte_reuseport_user.h
└── unyte-reuseport-loadbalancer.pc.in
/.gitignore:
--------------------------------------------------------------------------------
1 | # Prerequisites
2 | *.d
3 |
4 | # Object files
5 | *.o
6 | *.ko
7 | *.obj
8 | *.elf
9 |
10 | # Linker output
11 | *.ilk
12 | *.map
13 | *.exp
14 |
15 | # Precompiled Headers
16 | *.gch
17 | *.pch
18 |
19 | # Libraries
20 | *.lib
21 | *.a
22 | *.la
23 | *.lo
24 |
25 | # Shared objects (inc. Windows DLLs)
26 | *.dll
27 | *.so
28 | *.so.*
29 | *.dylib
30 |
31 | # Executables
32 | *.exe
33 | *.out
34 | *.app
35 | *.i*86
36 | *.x86_64
37 | *.hex
38 |
39 | # Debug files
40 | *.dSYM/
41 | *.su
42 | *.idb
43 | *.pdb
44 |
45 | # Kernel Module Compile Results
46 | *.mod*
47 | *.cmd
48 | .tmp_versions/
49 | modules.order
50 | Module.symvers
51 | Mkfile.old
52 | dkms.conf
53 |
54 | # http://www.gnu.org/software/autoconf
55 | autom4te.cache
56 | /autoscan.log
57 | /autoscan-*.log
58 | /aclocal.m4
59 | /compile
60 | /config.cache
61 | /config.guess
62 | /config.h.in
63 | /config.log
64 | /config.status
65 | /config.sub
66 | /configure
67 | /configure.scan
68 | /depcomp
69 | /install-sh
70 | /missing
71 | /stamp-h1
72 |
73 | # https://www.gnu.org/software/libtool/
74 |
75 | /ltmain.sh
76 |
77 | # http://www.gnu.org/software/texinfo
78 |
79 | /texinfo.tex
80 |
81 | # http://www.gnu.org/software/m4/
82 |
83 | m4/libtool.m4
84 | m4/ltoptions.m4
85 | m4/ltsugar.m4
86 | m4/ltversion.m4
87 | m4/lt~obsolete.m4
88 |
89 | *.lo
90 | Makefile
91 |
92 | build-aux
93 | Makefile.in
94 | /ar-lib
95 | /mdate-sh
96 | /py-compile
97 | /test-driver
98 | /ylwrap
99 | .deps/
100 | .libs/
101 | .dirstamp
102 | build-aux/
103 | build/
104 | libtool
105 | config.h
106 | vmlinux.h
107 | own_commands
108 | unyte-reuseport-loadbalancer.pc
109 |
110 | # executables
111 | main
112 | udp_publisher
113 |
114 | # IDE
115 | .vscode
116 |
--------------------------------------------------------------------------------
/CONTRIBUTING:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | When contributing to this repository, please first discuss the change you wish to make via issue,
4 | email, or any other method with the owners of this repository before making a change.
5 |
6 | Please note we have a code of conduct, please follow it in all your interactions with the project.
7 |
8 | ## Pull Request Process
9 |
10 | 1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11 | build.
12 | 2. Update the README.md with details of changes to the interface, this includes new environment
13 | variables, exposed ports, useful file locations and container parameters.
14 | 3. Increase the version numbers in any examples files and the README.md to the new version that this
15 | Pull Request would represent if a bump version is required.
16 |
17 | ## Code of Conduct
18 |
19 | ### Our Pledge
20 |
21 | In the interest of fostering an open and welcoming environment, we as
22 | contributors and maintainers pledge to making participation in our project and
23 | our community a harassment-free experience for everyone, regardless of age, body
24 | size, disability, ethnicity, gender identity and expression, level of experience,
25 | nationality, personal appearance, race, religion, or sexual identity and
26 | orientation.
27 |
28 | ### Our Standards
29 |
30 | Examples of behavior that contributes to creating a positive environment
31 | include:
32 |
33 | * Using welcoming and inclusive language
34 | * Being respectful of differing viewpoints and experiences
35 | * Gracefully accepting constructive criticism
36 | * Focusing on what is best for the community
37 | * Showing empathy towards other community members
38 |
39 | Examples of unacceptable behavior by participants include:
40 |
41 | * The use of sexualized language or imagery and unwelcome sexual attention or
42 | advances
43 | * Trolling, insulting/derogatory comments, and personal or political attacks
44 | * Public or private harassment
45 | * Publishing others' private information, such as a physical or electronic
46 | address, without explicit permission
47 | * Other conduct which could reasonably be considered inappropriate in a
48 | professional setting
49 |
50 | ### Our Responsibilities
51 |
52 | Project maintainers are responsible for clarifying the standards of acceptable
53 | behavior and are expected to take appropriate and fair corrective action in
54 | response to any instances of unacceptable behavior.
55 |
56 | Project maintainers have the right and responsibility to remove, edit, or
57 | reject comments, commits, code, wiki edits, issues, and other contributions
58 | that are not aligned to this Code of Conduct, or to ban temporarily or
59 | permanently any contributor for other behaviors that they deem inappropriate,
60 | threatening, offensive, or harmful.
61 |
62 | ### Scope
63 |
64 | This Code of Conduct applies both within project spaces and in public spaces
65 | when an individual is representing the project or its community. Examples of
66 | representing a project or community include using an official project e-mail
67 | address, posting via an official social media account, or acting as an appointed
68 | representative at an online or offline event. Representation of a project may be
69 | further defined and clarified by project maintainers.
70 |
71 | ### Enforcement
72 |
73 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
74 | reported by contacting the project team at alex.huang-feng@insa-lyon.fr. All
75 | complaints will be reviewed and investigated and will result in a response that
76 | is deemed necessary and appropriate to the circumstances. The project team is
77 | obligated to maintain confidentiality with regard to the reporter of an incident.
78 | Further details of specific enforcement policies may be posted separately.
79 |
80 | Project maintainers who do not follow or enforce the Code of Conduct in good
81 | faith may face temporary or permanent repercussions as determined by other
82 | members of the project's leadership.
83 |
84 | ### Attribution
85 |
86 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
87 | available at [http://contributor-covenant.org/version/1/4][version]
88 |
89 | [homepage]: http://contributor-covenant.org
90 | [version]: http://contributor-covenant.org/version/1/4/
91 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
--------------------------------------------------------------------------------
/Makefile.am:
--------------------------------------------------------------------------------
1 | AM_LDFLAGS = $(EXTRA_LDFLAGS)
2 |
3 | SUBDIRS = src
4 |
5 | ACLOCAL_AMFLAGS = -I m4
6 |
7 | # PKGCONFIG_USER comes from configure.ac
8 | pkgconfigdir = $(PKGCONFIG_USER)
9 | pkgconfig_DATA = \
10 | unyte-reuseport-loadbalancer.pc \
11 | $(NULL)
12 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # eBPF Load balancer
2 | Linux eBPF load balancer to be attached into SO_REUSEPORT socket group.
3 |
4 | This eBPF program allows load balance packets based on their src IP. All packets from the same src IP will land into the same collector.
5 |
6 | ## Dependencies
7 | This project uses autotools, gcc and clang to compile.
8 |
9 | On Ubuntu:
10 | ```shell
11 | $ sudo apt install autoconf libtool make automake gcc pkg-config
12 | ```
13 |
14 | On Centos (tested on `Centos 8`):
15 | ```shell
16 | $ sudo yum install autoconf libtool make automake pkgconf
17 | ```
18 |
19 | ### eBPF Dependencies
20 |
21 | To use eBPF loadbalancing `Python3` is needed for eBPF compilation.
22 | Another requirement is `libbpf` (github.com/libbpf/libbpf) >= 0.4.0.
23 |
24 | On Ubuntu:
25 | ```shell
26 | $ sudo apt install clang libbpf-dev linux-tools-$(uname -r)
27 | ```
28 |
29 | On Centos (tested on `Centos 8`):
30 | ```shell
31 | $ sudo yum install clang
32 | $ sudo dnf --enablerepo=powertools install libbpf-devel
33 | $ sudo dnf install bpftool
34 | ```
35 |
36 | ## Install
37 | To install src code:
38 | ```shell
39 | $ ./bootstrap
40 | $ ./configure # See ./configure --help for options
41 | $ make
42 | $ make install # Usually needs sudo permissions
43 | ```
44 |
45 | ### Configure options
46 | There are some custom `./configure` options :
47 | - `--with-pkgconfigdir=[/own_path/pkgconfig]`: overwrite pkgconfig directory to install .pc file [default: ${PREFIX}/lib/pkgconfig]
48 | - `--with-linux=[/own_path/linux/src]`: linux source code necesary for eBPF compilation [default: /usr/src/linux]. (On Ubuntu use /usr/src/-generic version)
49 | - `--enable-debug`: enable logs in both user-space and kernel-space eBPF program.
50 |
51 | ## Usage
52 | See [main](src/main.c) example. This example initializes an UDP socket bound to an address/port and attaches the eBPF load balancer to the socket.
53 |
54 | There is a [udp_publisher](src/udp_publisher.c) to test the collector.
55 |
56 | ## Running
57 | To test the loadbalancer, multiple instances should be launched. In this example, messages will be loadbalanced to 3 instances based on their src IP.
58 |
59 | To run 3 collectors:
60 | ```shell
61 | $ cd src
62 | $ sudo bash -c 'ulimit -l unlimited; ./main 10.0.2.15 10001 0 3' // first collector
63 | $ sudo bash -c 'ulimit -l unlimited; ./main 10.0.2.15 10001 1 3' // second collector
64 | $ sudo bash -c 'ulimit -l unlimited; ./main 10.0.2.15 10001 2 3' // third collector
65 | ```
66 |
67 | To see the loadbalancer working, you should instance multiple publishers sending from different src ips, otherwise, all packets will be hashed to the same collector.
68 |
69 | Publisher:
70 | ```shell
71 | $ cd src
72 | $ ./udp_publisher 10.0.2.15 10001 100
73 | ```
74 |
75 | ## Debug
76 | To show the maps:
77 |
78 | (`sudo` may be needed)
79 | ```shell
80 | $ bpftool map dump name tcp_balancing_t
81 | $ bpftool map dump name udp_balancing_t
82 | ```
83 |
84 | Logs in eBPF program can be activated using the flag `--enable-debug` of autotools.
85 | Logs for eBPF program are in `/sys/kernel/debug/tracing/trace`
86 |
87 | ## Credits
88 | This repository is based on [reuseport](https://github.com/eduarrrd/reuseport), a loadbalancer used in pmacct.
89 |
--------------------------------------------------------------------------------
/VERSION:
--------------------------------------------------------------------------------
1 | 0.1.1-git
--------------------------------------------------------------------------------
/bootstrap:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | # create m4 directory if does not exist
4 | [ -d m4 ] || mkdir m4
5 |
6 | AUTORECONF=${AUTORECONF:-autoreconf}
7 |
8 | # Check we have all tools installed
9 | check_command() {
10 | command -v "${1}" > /dev/null 2>&1 || {
11 | >&2 echo "./bootstrap: could not find \`$1'. \`$1' is required to run bootstrap."
12 | exit 1
13 | }
14 | }
15 |
16 | check_command "$AUTORECONF"
17 |
18 | autoreconf --install
19 |
20 | exit 0
21 |
--------------------------------------------------------------------------------
/configure.ac:
--------------------------------------------------------------------------------
1 | AC_INIT([unyte_ebpf_loadbalancer], m4_esyscmd_s(cat VERSION), [alex.huang-feng@insa-lyon.fr])
2 | AC_CONFIG_AUX_DIR([build-aux])
3 |
4 | AM_INIT_AUTOMAKE([-Wall -Werror foreign subdir-objects])
5 |
6 | AC_CONFIG_MACRO_DIR([m4])
7 | AC_PREFIX_DEFAULT([/usr/local])
8 |
9 | AM_PROG_AR
10 | LT_INIT
11 |
12 | AC_LANG([C])
13 | AC_CONFIG_HEADERS([config.h])
14 | AC_PROG_CC([gcc])
15 |
16 | AC_PROG_LN_S
17 |
18 | AC_ARG_WITH([pkgconfigdir],
19 | [AS_HELP_STRING([--with-pkgconfigdir], [pkg-config directory to install the .pc file.])],
20 | [ with_pkgconfigdir=$with_pkgconfigdir ],
21 | [ with_pkgconfigdir=$libdir/pkgconfig ]
22 | )
23 |
24 | PKGCONFIG_USER=$with_pkgconfigdir
25 | AC_SUBST([PKGCONFIG_USER])
26 |
27 | AC_ARG_ENABLE([debug],
28 | [AS_HELP_STRING([--enable-debug], [Enable debug logs in eBPF program.])],
29 | [ debug_enabled=yes ],
30 | [ debug_enabled=no ]
31 | )
32 | AM_CONDITIONAL(DEBUG, test "x$debug_enabled" = "xyes")
33 |
34 | dnl eBPF example
35 | AC_CHECK_LIB(bpf, bpf_object__find_map_by_name, [], [
36 | echo "*** Error! You need to install libbpf first. ***"
37 | exit -1
38 | ])
39 |
40 | AC_CHECK_PROG([CCLANG], [clang], [yes])
41 | AS_IF([ test "x$CCLANG" != xyes ], [
42 | echo "*** Error! eBPF needs CLANG as dependency. Please install it first. ***"
43 | exit -1
44 | ])
45 | AC_CHECK_PROG([BPFTOOL], [bpftool], [yes])
46 | AS_IF([ test "x$BPFTOOL" != xyes ], [
47 | echo "*** Error! eBPF needs bpftool as dependency. Please install it first. ***"
48 | exit -1
49 | ])
50 |
51 | AC_CHECK_FILE([/sys/kernel/btf/vmlinux], [], [
52 | echo "*** Error! eBPF needs vmlinux to compile the eBPF program. ***"
53 | exit -1
54 | ])
55 |
56 | AC_CONFIG_FILES([
57 | Makefile
58 | src/Makefile
59 | unyte-reuseport-loadbalancer.pc
60 | ])
61 | AC_OUTPUT
62 |
--------------------------------------------------------------------------------
/src/Makefile.am:
--------------------------------------------------------------------------------
1 | AM_LDFLAGS = $(EXTRA_LDFLAGS)
2 |
3 | if DEBUG
4 | DEBUG_FLAGS=-D_LOG_DEBUG
5 | endif
6 |
7 | ACLOCAL_AMFLAGS = -I m4
8 |
9 | EBPF_CLDFLAGS=-fcolor-diagnostics -D_FILE_OFFSET_BITS=64 -Wall -Winvalid-pch -g -fPIC -g -O2 -D__KERNEL__ -D__TARGET_ARCH_x86 --target=bpf -Wall -Wno-macro-redefined -D__BPF_TRACING__
10 |
11 | vmlinux.h:
12 | bpftool btf dump file /sys/kernel/btf/vmlinux format c > $@
13 |
14 | unyte_reuseport_kern.o: unyte_reuseport_kern.c vmlinux.h
15 | clang $(EBPF_CLDFLAGS) $(DEBUG_FLAGS) -o $@ -c $<
16 |
17 | all-local: unyte_reuseport_kern.o
18 |
19 | unyte_reuseport_kern_odir = $(libdir)
20 | unyte_reuseport_kern_o_DATA = \
21 | unyte_reuseport_kern.o \
22 | $(NULL)
23 |
24 | unyteincludedir = $(includedir)/unyte-reuseport-loadbalancer
25 | unyteinclude_HEADERS = \
26 | unyte_reuseport_user.h \
27 | $(NULL)
28 |
29 | bin_PROGRAMS = main udp_publisher
30 |
31 | main_SOURCES = main.c unyte_reuseport_user.c
32 | main_CFLAGS = -I$(srcdir)/../../src -Wextra -Wall -ansi -g -std=c11 -D_GNU_SOURCE -fPIC -pthread $(DEBUG_FLAGS)
33 | # main_LDADD = $(srcdir)/../../src/libunyte-reuseport-loadbalancer.la
34 |
35 | udp_publisher_SOURCES = udp_publisher.c
36 | udp_publisher_CFLAGS = -I$(srcdir)/../../src -Wextra -Wall -ansi -g -std=c11 -D_GNU_SOURCE -fPIC -pthread $(DEBUG_FLAGS)
37 |
38 | lib_LTLIBRARIES = libunyte-reuseport-loadbalancer.la
39 |
40 | libunyte_reuseport_loadbalancer_la_SOURCES = \
41 | unyte_reuseport_user.c \
42 | unyte_reuseport_user.h \
43 | $(NULL)
44 |
45 | libunyte_reuseport_loadbalancer_la_CFLAGS = -Wextra -Wall -ansi -g -std=c11 -D_GNU_SOURCE -fPIC $(DEBUG_FLAGS)
46 |
--------------------------------------------------------------------------------
/src/main.c:
--------------------------------------------------------------------------------
1 | /**
2 | * Example of client using a eBPF loadbalancer.
3 | * This allows multiple client instances listening on the same IP/port and receiving consistent data
4 | * (all packets from one src IP will always go on the same collector)
5 | *
6 | * Usage: ./main
7 | *
8 | * Example: launching 3 instances on the same ip port. The index is the index on the map to put the socket
9 | * and the balancer_max is how many max instances are in use.
10 | *
11 | * ./main 192.168.1.17 10001 0 3
12 | * ./main 192.168.1.17 10001 1 3
13 | * ./main 192.168.1.17 10001 2 3
14 | */
15 |
16 | #include
17 | #include
18 | #include
19 | #include
20 | #include
21 | #include
22 | #include "./unyte_reuseport_user.h"
23 |
24 | // if installed in machine
25 | // #include
26 |
27 | #define SK_BUFFER 20971520 // 20MB of socket buffer size
28 | #define UDP_MAX_SIZE 65535
29 |
30 | int main(int argc, char *argv[])
31 | {
32 | if (argc != 5)
33 | {
34 | printf("Error: arguments not valid\n");
35 | printf("Usage: ./main \n");
36 | printf("Example: ./main 10.0.2.15 10001 0 5\n");
37 | exit(1);
38 | }
39 |
40 | printf("Listening on %s:%s\n", argv[1], argv[2]);
41 |
42 | // Create a udp socket with default socket buffer
43 | int socketfd = unyte_create_udp_bound_socket(argv[1], argv[2], SK_BUFFER);
44 |
45 | // Attaching eBPF load balancer to socket
46 | int ret_attach = unyte_attach_ebpf_to_socket(socketfd, atoi(argv[3]), atoi(argv[4]), "unyte_reuseport", "unyte_reuseport_kern.o");
47 |
48 | if (ret_attach != 0)
49 | exit(1);
50 |
51 | struct sockaddr_storage peer_addr;
52 | socklen_t peer_addr_len = sizeof(struct sockaddr_storage);
53 | ssize_t nread;
54 | char buf[UDP_MAX_SIZE];
55 |
56 | while (1)
57 | {
58 | nread = recvfrom(socketfd, buf, UDP_MAX_SIZE, 0,
59 | (struct sockaddr *)&peer_addr, &peer_addr_len);
60 |
61 | if (nread == -1)
62 | continue; // Ignore failed request
63 |
64 | char ip_src_canonical[100];
65 | printf("****** Message ******\n");
66 | if (peer_addr.ss_family == AF_INET)
67 | {
68 | printf("Received %ld bytes from %s:%u\n", (long)nread,
69 | inet_ntop(peer_addr.ss_family, &((struct sockaddr_in *)&peer_addr)->sin_addr.s_addr, ip_src_canonical, sizeof ip_src_canonical),
70 | ntohs(((struct sockaddr_in *)&peer_addr)->sin_port));
71 | }
72 | else
73 | {
74 | printf("Received %ld bytes from %s:%u\n", (long)nread,
75 | inet_ntop(peer_addr.ss_family, &((struct sockaddr_in *)&peer_addr)->sin_addr.s_addr, ip_src_canonical, sizeof ip_src_canonical),
76 | ntohs(((struct sockaddr_in6 *)&peer_addr)->sin6_port));
77 | }
78 | printf("Buffer: %.*s\n", (int)nread, buf);
79 | printf("**** End Message ****\n\n");
80 | }
81 |
82 | return 0;
83 | }
84 |
--------------------------------------------------------------------------------
/src/udp_publisher.c:
--------------------------------------------------------------------------------
1 | /**
2 | * Publisher of udp packets to test main.c
3 | * This code allows sending "Hello World !" messages to a connected IP/port.
4 | *
5 | * Usage: ./udp_publisher
6 | *
7 | * Example for sending 10 message: ./udp_publisher 10.0.2.15 10001 10
8 | * Example for sending infinite messages: ./udp_publisher 10.0.2.15 10001 0
9 | */
10 |
11 | #include
12 | #include
13 | #include
14 | #include
15 | #include
16 | #include
17 | #include
18 | #include
19 |
20 | #define SEND_SK_BUFFER 20971520 // 20MB of socket buffer size
21 | #define UDP_MAX_SIZE 65535
22 |
23 | int create_udp_socket(char *address, char *port, uint64_t buffer_size)
24 | {
25 | struct addrinfo *addr_info;
26 | struct addrinfo hints;
27 |
28 | memset(&hints, 0, sizeof(hints));
29 |
30 | hints.ai_socktype = SOCK_DGRAM;
31 | hints.ai_family = AF_UNSPEC;
32 | hints.ai_flags = AI_PASSIVE | AI_NUMERICSERV;
33 |
34 | int rc = getaddrinfo(address, port, &hints, &addr_info);
35 |
36 | if (rc != 0)
37 | {
38 | printf("getaddrinfo error: %s\n", gai_strerror(rc));
39 | exit(EXIT_FAILURE);
40 | }
41 |
42 | int sockfd = socket(addr_info->ai_family, addr_info->ai_socktype, addr_info->ai_protocol);
43 |
44 | if (sockfd < 0)
45 | {
46 | perror("socket()");
47 | exit(EXIT_FAILURE);
48 | }
49 |
50 | if (setsockopt(sockfd, SOL_SOCKET, SO_SNDBUF, &buffer_size, sizeof(buffer_size)))
51 | {
52 | perror("Set socket buffer size");
53 | exit(EXIT_FAILURE);
54 | }
55 |
56 | // connect socket to destination address
57 | if (connect(sockfd, addr_info->ai_addr, (int)addr_info->ai_addrlen) == -1)
58 | {
59 | perror("Connect failed");
60 | close(sockfd);
61 | exit(EXIT_FAILURE);
62 | }
63 |
64 | // free addr_info after usage
65 | freeaddrinfo(addr_info);
66 |
67 | return sockfd;
68 | }
69 |
70 | int main(int argc, char *argv[])
71 | {
72 | if (argc != 4)
73 | {
74 | printf("Error: arguments not valid\n");
75 | printf("Usage: ./udp_publisher \n");
76 | printf("Example: ./udp_publisher 10.0.2.15 10001 10\n");
77 | exit(1);
78 | }
79 |
80 | printf("Sending on %s:%s\n", argv[1], argv[2]);
81 |
82 | int socket_fd = create_udp_socket(argv[1], argv[2], SEND_SK_BUFFER);
83 |
84 | int messages_to_send = atoi(argv[3]);
85 | bool infinite = false;
86 | if (messages_to_send == 0)
87 | infinite = true;
88 |
89 | char buf[100];
90 | int buf_len = strlen(buf);
91 | int count = 0;
92 | while (1)
93 | {
94 | if (!infinite)
95 | {
96 | messages_to_send--;
97 | if (messages_to_send < 0)
98 | break;
99 | }
100 |
101 | sprintf(buf, "Hello World %d!", count);
102 | buf_len = strlen(buf);
103 | count++;
104 |
105 | if (send(socket_fd, buf, buf_len, 0) < 0)
106 | fprintf(stderr, "Error sending response\n");
107 | sleep(1);
108 | }
109 | return 0;
110 | }
111 |
--------------------------------------------------------------------------------
/src/unyte_reuseport_kern.c:
--------------------------------------------------------------------------------
1 | // clang-format off
2 | #include "vmlinux.h"
3 | // clang-format on
4 | #include
5 | #include
6 |
7 | // https://elixir.bootlin.com/linux/latest/source/include/uapi/linux/if_ether.h#L52
8 | #define ETH_P_IP 0x0800
9 |
10 | #ifndef MAX_BALANCER_COUNT
11 | // Keep in sync with _user.c
12 | #define MAX_BALANCER_COUNT 128
13 | #endif
14 |
15 | // bpf_printk argument limits
16 | #define _STRINGIFY(x) #x
17 | #define STRINGIFY(x) _STRINGIFY(x)
18 | #define LOC __FILE__ ":" STRINGIFY(__LINE__) ": "
19 |
20 | const u32 zero = 0; // array access index
21 | const u32 balancer_max = MAX_BALANCER_COUNT;
22 |
23 | // MAPS
24 |
25 | struct {
26 | __uint(type, BPF_MAP_TYPE_ARRAY);
27 | __type(key, u32);
28 | __type(value, u32);
29 | __uint(max_entries, 1);
30 | __uint(pinning, LIBBPF_PIN_BY_NAME);
31 | } nonce SEC(".maps");
32 |
33 | struct {
34 | __uint(type, BPF_MAP_TYPE_ARRAY);
35 | __type(key, u32);
36 | __type(value, u32);
37 | __uint(max_entries, 1);
38 | __uint(pinning, LIBBPF_PIN_BY_NAME);
39 | } size SEC(".maps");
40 |
41 | struct {
42 | __uint(type, BPF_MAP_TYPE_REUSEPORT_SOCKARRAY);
43 | __type(key, u32);
44 | __type(value, u64);
45 | __uint(max_entries, MAX_BALANCER_COUNT);
46 | __uint(pinning, LIBBPF_PIN_BY_NAME);
47 | } tcp_balancing_targets SEC(".maps");
48 |
49 | struct {
50 | __uint(type, BPF_MAP_TYPE_REUSEPORT_SOCKARRAY);
51 | __type(key, u32);
52 | __type(value, u64);
53 | __uint(max_entries, MAX_BALANCER_COUNT);
54 | __uint(pinning, LIBBPF_PIN_BY_NAME);
55 | } udp_balancing_targets SEC(".maps");
56 |
57 | // HASHING
58 |
59 | #define __jhash_final(a, b, c) \
60 | { \
61 | c ^= b; \
62 | c -= rol32(b, 14); \
63 | a ^= c; \
64 | a -= rol32(c, 11); \
65 | b ^= a; \
66 | b -= rol32(a, 25); \
67 | c ^= b; \
68 | c -= rol32(b, 16); \
69 | a ^= c; \
70 | a -= rol32(c, 4); \
71 | b ^= a; \
72 | b -= rol32(a, 14); \
73 | c ^= b; \
74 | c -= rol32(b, 24); \
75 | }
76 | #define JHASH_INITVAL 0xdeadbeef
77 |
78 | static inline __u32 rol32(__u32 word, unsigned int shift) { return (word << (shift & 31)) | (word >> ((-shift) & 31)); }
79 |
80 | static inline u32 hash(u32 ip_p1, u32 ip_p2, u32 ip_p3, u32 ip_p4) {
81 | u32 a, b, c, initval, *n;
82 |
83 | // Initialize nonce if not done already
84 | n = bpf_map_lookup_elem(&nonce, &zero);
85 | if (n == 0) {
86 | // Cannot happen as BPF_MAP_TYPE_ARRAY always resolves
87 | return SK_DROP;
88 | }
89 |
90 | if (*n == 0) {
91 | // TODO: Handle bpf_get_prandom_u32() == 0
92 | *n = bpf_get_prandom_u32();
93 |
94 | #ifdef _LOG_DEBUG
95 | bpf_printk(LOC "Updating nonce to %x\n", *n);
96 | #endif
97 | }
98 |
99 | initval = *n;
100 |
101 | initval += JHASH_INITVAL + (3 << 2);
102 | a = ip_p1 + ip_p2 + ip_p3 + ip_p4 + initval;
103 | b = initval;
104 | c = initval;
105 |
106 | __jhash_final(a, b, c);
107 | return c;
108 | }
109 |
110 | // CORE LOGIC
111 | // sk_reuseport_md: https://elixir.bootlin.com/linux/latest/source/include/uapi/linux/bpf.h#L5655
112 | // https://git.yoctoproject.org/linux-yocto-contrib/plain/tools/testing/selftests/bpf/progs/test_select_reuseport_kern.c
113 |
114 | SEC("sk_reuseport/selector")
115 | enum sk_action _selector(struct sk_reuseport_md *reuse) {
116 | enum sk_action action;
117 | struct iphdr ip;
118 | struct ipv6hdr ipv6;
119 |
120 | u32 key;
121 | // https://en.wikipedia.org/wiki/EtherType
122 | int is_ipv4 = reuse->eth_protocol == bpf_htons(ETH_P_IP);
123 | void *targets;
124 |
125 | // initialization -- resolve invalid indirect read from the stack (https://stackoverflow.com/questions/71529801/ebpf-bpf-map-update-returns-the-invalid-indirect-read-from-stack-error)
126 | __builtin_memset(&ipv6, 0, sizeof(struct ipv6hdr));
127 | __builtin_memset(&ip, 0, sizeof(struct iphdr));
128 |
129 | switch (reuse->ip_protocol) {
130 | case IPPROTO_TCP:
131 | targets = &tcp_balancing_targets;
132 | break;
133 | case IPPROTO_UDP:
134 | targets = &udp_balancing_targets;
135 | break;
136 | default:
137 | #ifdef _LOG_DEBUG
138 | bpf_printk(LOC "Unsupported IPPROTO=%d\n", reuse->ip_protocol);
139 | #endif
140 | return SK_DROP;
141 | }
142 |
143 | if(is_ipv4){
144 | bpf_skb_load_bytes_relative(reuse, 0, &ip, sizeof(struct iphdr), (u32)BPF_HDR_START_NET);
145 | } else {
146 | bpf_skb_load_bytes_relative(reuse, 0, &ipv6, sizeof(struct ipv6hdr), (u32)BPF_HDR_START_NET);
147 | }
148 |
149 | const u32 *balancer_count = bpf_map_lookup_elem(&size, &zero);
150 | if (!balancer_count || *balancer_count == 0) { // uninitialized by userspace
151 | balancer_count = &balancer_max;
152 | bpf_map_update_elem(&size, &zero, balancer_count, BPF_ANY);
153 | }
154 |
155 | #ifdef _LOG_DEBUG
156 | bpf_printk(LOC "Balancing across %d hash buckets\n", *balancer_count);
157 | #endif
158 |
159 | // hash on the IP only
160 | if(is_ipv4){
161 | key = hash(__builtin_bswap32(ip.saddr),0,0,0) % *balancer_count;
162 | } else {
163 | key = hash(
164 | __builtin_bswap32(ipv6.saddr.in6_u.u6_addr32[0]),
165 | __builtin_bswap32(ipv6.saddr.in6_u.u6_addr32[1]),
166 | __builtin_bswap32(ipv6.saddr.in6_u.u6_addr32[2]),
167 | __builtin_bswap32(ipv6.saddr.in6_u.u6_addr32[3])
168 | ) % *balancer_count;
169 | }
170 |
171 | #ifdef _LOG_DEBUG
172 | if(is_ipv4){
173 | bpf_printk(LOC "src4: %x, dest4: %x, key: %d\n", __builtin_bswap32(ip.saddr), __builtin_bswap32(ip.daddr), key);
174 | }else{
175 | bpf_printk(LOC "[Last 32b] src6: %x, dest6: %x, key: %d\n", __builtin_bswap32(ipv6.saddr.in6_u.u6_addr32[3]), __builtin_bswap32(ipv6.daddr.in6_u.u6_addr32[3]), key);
176 | }
177 | #endif
178 |
179 | // side-effect sets dst socket if found
180 | if (bpf_sk_select_reuseport(reuse, targets, &key, 0) == 0) {
181 | action = SK_PASS;
182 | #ifdef _LOG_DEBUG
183 | bpf_printk(LOC "=> action: pass\n\n");
184 | #endif
185 | } else {
186 | action = SK_DROP;
187 | #ifdef _LOG_DEBUG
188 | bpf_printk(LOC "=> action: drop\n\n");
189 | #endif
190 | }
191 |
192 | return action;
193 | }
194 |
195 | char _license[] SEC("license") = "GPL";
196 |
--------------------------------------------------------------------------------
/src/unyte_reuseport_user.c:
--------------------------------------------------------------------------------
1 |
2 | #include
3 | #include
4 | #include
5 | #include
6 | #include
7 | #include
8 | #include
9 | #include
10 | #include
11 | #include
12 | #include
13 |
14 | #define USED_VLEN 1
15 | #define MAX_TO_RECEIVE 20
16 |
17 | #ifndef MAX_BALANCER_COUNT
18 | // Keep in sync with _kern.c
19 | #define MAX_BALANCER_COUNT 128
20 | #endif
21 |
22 | int unyte_create_udp_bound_socket(char *address, char *port, uint64_t buffer_size)
23 | {
24 | assert(address != NULL);
25 | assert(port != NULL);
26 | assert(buffer_size > 0);
27 |
28 | struct addrinfo *addr_info;
29 | struct addrinfo hints;
30 |
31 | memset(&hints, 0, sizeof(hints));
32 |
33 | hints.ai_socktype = SOCK_DGRAM;
34 | hints.ai_family = AF_UNSPEC;
35 | hints.ai_flags = AI_PASSIVE | AI_NUMERICSERV;
36 |
37 | // Using getaddrinfo to support both IPv4 and IPv6
38 | int rc = getaddrinfo(address, port, &hints, &addr_info);
39 |
40 | if (rc != 0)
41 | {
42 | printf("getaddrinfo error: %s\n", gai_strerror(rc));
43 | exit(EXIT_FAILURE);
44 | }
45 |
46 | printf("Address type: %s | %d\n", (addr_info->ai_family == AF_INET) ? "IPv4" : "IPv6", ntohs(((struct sockaddr_in *)addr_info->ai_addr)->sin_port));
47 |
48 | // create socket on UDP protocol
49 | int sockfd = socket(addr_info->ai_family, addr_info->ai_socktype, addr_info->ai_protocol);
50 |
51 | // handle error
52 | if (sockfd < 0)
53 | {
54 | perror("Cannot create socket");
55 | exit(EXIT_FAILURE);
56 | }
57 |
58 | // Use SO_REUSEPORT to be able to launch multiple collector on the same address
59 | int optval = 1;
60 | if (setsockopt(sockfd, SOL_SOCKET, SO_REUSEPORT, &optval, sizeof(int)) < 0)
61 | {
62 | perror("Cannot set SO_REUSEPORT option on socket");
63 | exit(EXIT_FAILURE);
64 | }
65 |
66 | uint64_t receive_buf_size = buffer_size;
67 | if (setsockopt(sockfd, SOL_SOCKET, SO_RCVBUF, &receive_buf_size, sizeof(receive_buf_size)) < 0)
68 | {
69 | perror("Cannot set buffer size");
70 | exit(EXIT_FAILURE);
71 | }
72 |
73 | if (bind(sockfd, addr_info->ai_addr, (int)addr_info->ai_addrlen) == -1)
74 | {
75 | perror("Bind failed");
76 | close(sockfd);
77 | exit(EXIT_FAILURE);
78 | }
79 |
80 | // free addr_info after usage
81 | freeaddrinfo(addr_info);
82 |
83 | return sockfd;
84 | }
85 |
86 | #ifdef _LOG_DEBUG
87 | static int libbpf_print_fn(enum libbpf_print_level level, const char *format, va_list args) {
88 | return level <= LIBBPF_DEBUG ? vfprintf(stderr, format, args) : 0;
89 | }
90 | #endif
91 |
92 | int unyte_attach_ebpf_to_socket(int socketfd, uint32_t key, uint32_t balancer_count, const char pin_root_path[], const char bpf_kernel_prg_filename[])
93 | {
94 | int umap_fd, size_map_fd, prog_fd;
95 | int64_t usock = socketfd;
96 | long err = 0;
97 |
98 | assert(!balancer_count || key < balancer_count);
99 | assert(balancer_count <= MAX_BALANCER_COUNT);
100 | assert(usock >= 0);
101 |
102 | printf("from args: Using hash bucket index %u", key);
103 | if (balancer_count > 0) printf(" (%u buckets in total)", balancer_count);
104 | puts("");
105 |
106 | #ifdef _LOG_DEBUG
107 | // set log
108 | libbpf_set_print(libbpf_print_fn);
109 | #endif
110 |
111 | char pin_path[100];
112 | sprintf(pin_path, "/sys/fs/bpf/%s", pin_root_path);
113 |
114 | // Open reuseport_udp_kern.o
115 | struct bpf_object_open_opts opts = {.sz = sizeof(struct bpf_object_open_opts),
116 | .pin_root_path = pin_path};
117 | struct bpf_object *obj = bpf_object__open_file(bpf_kernel_prg_filename, &opts);
118 |
119 | err = libbpf_get_error(obj);
120 | if (err) {
121 | perror("Failed to open BPF elf file");
122 | return 1;
123 | }
124 |
125 | struct bpf_map *udpmap = bpf_object__find_map_by_name(obj, "udp_balancing_targets");
126 | assert(udpmap);
127 |
128 | // Load reuseport_udp_kern.o to the kernel
129 | if (bpf_object__load(obj) != 0) {
130 | perror("Error loading BPF object into kernel");
131 | return 1;
132 | }
133 |
134 | struct bpf_program *prog = bpf_object__find_program_by_name(obj, "_selector");
135 | if (!prog) {
136 | perror("Could not find BPF program in BPF object");
137 | return 1;
138 | }
139 |
140 | prog_fd = bpf_program__fd(prog);
141 | assert(prog_fd);
142 |
143 | umap_fd = bpf_map__fd(udpmap);
144 | assert(umap_fd);
145 |
146 | if (setsockopt(usock, SOL_SOCKET, SO_ATTACH_REUSEPORT_EBPF, &prog_fd, sizeof(prog_fd)) != 0) {
147 | perror("Could not attach BPF prog");
148 | return 1;
149 | }
150 |
151 | printf("UDP sockfd: %ld\n", usock);
152 | if (bpf_map_update_elem(umap_fd, &key, &usock, BPF_ANY) != 0) {
153 | perror("Could not update reuseport array");
154 | return 1;
155 | }
156 |
157 | // Determine intended number of hash buckets
158 | // Assumption: static during lifetime of this process
159 | struct bpf_map *size_map = bpf_object__find_map_by_name(obj, "size");
160 | assert(size_map);
161 | size_map_fd = bpf_map__fd(size_map);
162 | assert(size_map_fd);
163 |
164 | uint32_t index = 0;
165 | if (balancer_count == 0) { // no user-supplied limit
166 | bpf_map_lookup_elem(size_map_fd, &index, &balancer_count);
167 | if (balancer_count == 0) { // BPF program hasn't run yet to initalize this
168 | balancer_count = MAX_BALANCER_COUNT;
169 | if (bpf_map_update_elem(size_map_fd, &index, &balancer_count, BPF_ANY) != 0) {
170 | perror("Could not update balancer count");
171 | return 1;
172 | }
173 | }
174 | } else { // Overwrite global count with user supplied one
175 | if (bpf_map_update_elem(size_map_fd, &index, &balancer_count, BPF_ANY) != 0) {
176 | perror("Could not update balancer count");
177 | return 1;
178 | }
179 | }
180 |
181 | return 0;
182 | }
183 |
--------------------------------------------------------------------------------
/src/unyte_reuseport_user.h:
--------------------------------------------------------------------------------
1 | #ifndef UNYTE_REUSEPORT_USER_H
2 | #define UNYTE_REUSEPORT_USER_H
3 |
4 | #include
5 |
6 | /**
7 | * Creates a datagram socket with SO_REUSEPORT activated and already bound to addres/port
8 | */
9 | int unyte_create_udp_bound_socket(char *address, char *port, uint64_t buffer_size);
10 |
11 | /**
12 | * Open socket, loads eBPF program and attaches it to the opened socket.
13 | * int socketfd : socket file descriptor to listen to.
14 | * uint32_t key : index of the socket to be filled in the eBPF hash table.
15 | * uint32_t balancer_count : max values to be used in eBPF reuse. Should be <= MAX_BALANCER_COUNT.
16 | * const char pin_root_path[] : pin root path of eBPFFS (/sys/fs/bpf/)
17 | * const char bpf_kernel_prg_filename[] : BPF kernel .o program
18 | */
19 | int unyte_attach_ebpf_to_socket(int socketfd, uint32_t key, uint32_t balancer_count, const char pin_root_path[], const char bpf_kernel_prg[]);
20 |
21 | #endif
22 |
--------------------------------------------------------------------------------
/unyte-reuseport-loadbalancer.pc.in:
--------------------------------------------------------------------------------
1 | prefix=@prefix@
2 | exec_prefix=@exec_prefix@
3 | includedir=@includedir@
4 | libdir=@libdir@
5 |
6 | Name: unyte-reuseport-loadbalancer
7 | Description: Unyte eBPF reuseport loadbalancer library
8 | Version: @VERSION@
9 | Cflags: -I${includedir}/unyte-reuseport-loadbalancer
10 | Libs: -L${libdir} -lunyte-reuseport-loadbalancer
11 |
--------------------------------------------------------------------------------