aboutsummaryrefslogtreecommitdiff
path: root/rustables-sys/src/lib.rs
blob: 82125f46c9c922b9b59982d44c9a60f0f4567244 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
// Copyryght (c) 2021 GPL lafleur@boum.org and Simon Thoby
//
// This file is free software: you may copy, redistribute and/or modify it
// under the terms of the GNU General Public License as published by the
// Free Software Foundation, either version 3 of the License, or (at your
// option) any later version.
//
// This file is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see the LICENSE file.
//
// This file incorporates work covered by the following copyright and
// permission notice:
//
//     Copyright 2018 Amagicom AB.
//
//     Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
//     http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
//     <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
//     option. This file may not be copied, modified, or distributed
//     except according to those terms.

//! Low level FFI bindings to [`libnftnl`], a userspace library providing a low-level netlink
//! programming interface (API) to the in-kernel nf_tables subsystem.
//!
//! See [`rustables`] for a higher level safe abstraction.
//!
//! # Linking to libmnl and libnftnl
//!
//! By default this crate uses pkg-config to find and link to its C dependencies, [`libmnl`] and
//! [`libnftnl`]. To manually configure where to look for these libraries, set the environment
//! variables `LIBMNL_LIB_DIR` and `LIBNFTNL_LIB_DIR` to point to the directories where `libmnl.so`
//! (or `libmnl.a`) and `libnftnl.so` (or `libnftnl.a`) reside.
//!
//! # Selecting version of `libnftnl`
//!
//! This crate has bindings for most versions of [`libnftnl`]. All bindings are generated by
//! [`bindgen`] via the `generate_bindings.sh` script in this repository.
//!
//! Only one version of `libnftnl` can be exposed via this crate. By default the crate exports the
//! bindings for the oldest supported version (`libnftnl-1.0.6`). To get newer versions activate the
//! corresponding features. See `Cargo.toml` for available features/versions.
//!
//! So for example, to get bindings to `libnftnl-1.0.9` depend on this crate like this:
//! ```toml
//! [dependencies]
//! rustables-sys = { version = "0.1", features = ["nftnl-1-0-9"] }
//! ```
//!
//! [`libnftnl`]: https://netfilter.org/projects/libnftnl/
//! [`libmnl`]: https://netfilter.org/projects/libmnl/
//! [`rustables`]: https://crates.io/crates/rustables
//! [`bindgen`]: https://crates.io/crates/bindgen

#![no_std]
#![cfg(target_os = "linux")]
#![allow(non_camel_case_types)]

pub use libc;

cfg_if::cfg_if! {
    if #[cfg(feature = "nftnl-1-2-0")] {
        mod nftnl_1_2_0;
        pub use self::nftnl_1_2_0::*;
    } else if #[cfg(feature = "nftnl-1-1-2")] {
        mod nftnl_1_1_2;
        pub use self::nftnl_1_1_2::*;
    } else if #[cfg(feature = "nftnl-1-1-1")] {
        mod nftnl_1_1_1;
        pub use self::nftnl_1_1_1::*;
    } else if #[cfg(feature = "nftnl-1-1-0")] {
        mod nftnl_1_1_0;
        pub use self::nftnl_1_1_0::*;
    } else if #[cfg(feature = "nftnl-1-0-9")] {
        mod nftnl_1_0_9;
        pub use self::nftnl_1_0_9::*;
    } else if #[cfg(feature = "nftnl-1-0-8")] {
        mod nftnl_1_0_8;
        pub use self::nftnl_1_0_8::*;
    } else if #[cfg(feature = "nftnl-1-0-7")] {
        mod nftnl_1_0_7;
        pub use self::nftnl_1_0_7::*;
    } else {
        mod nftnl_1_0_6;
        pub use self::nftnl_1_0_6::*;
    }
}