xref: /freebsd/release/packages/ucl/netmap-all.ucl (revision 24e4dcf4ba5e9dedcf89efd358ea3e1fe5867020)
1/*
2 * SPDX-License-Identifier: ISC
3 *
4 * Copyright (c) 2025 Lexi Winter <ivy@FreeBSD.org>
5 *
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19comment = "Userland netmap support"
20
21desc = <<EOD
22The netmap(4) kernel facility allows userland applications to send and receive
23data on a network interface using a memory-mapped ring buffer.  netmap offers
24significantly better performance for this task than similar interfaces such as
25bpf(4), tap(4), or raw sockets.
26
27This package provides libnetmap, a library used by applications to interact
28with netmap, and valectl(8), a utility to manage vale(4) network switches.
29EOD
30
31annotations {
32	set = "optional,optional-jail"
33}
34