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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
# SPDX-License-Identifier: MPL-2.0 OR LGPL-3.0-or-later
#
# libpathrs: safe path resolution on Linux
# Copyright (C) 2019-2025 Aleksa Sarai <cyphar@cyphar.com>
# Copyright (C) 2019-2025 SUSE LLC
#
# == MPL-2.0 ==
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
#
# Alternatively, this Source Code Form may also (at your option) be used
# under the terms of the GNU Lesser General Public License Version 3, as
# described below:
#
# == LGPL-3.0-or-later ==
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
#
# This program 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 Lesser General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
language = "C"
header = """
// SPDX-License-Identifier: MPL-2.0 OR LGPL-3.0-or-later
/*
* libpathrs: safe path resolution on Linux
* Copyright (C) 2019-2025 Aleksa Sarai <cyphar@cyphar.com>
* Copyright (C) 2019-2025 SUSE LLC
*
* == MPL-2.0 ==
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
*
* Alternatively, this Source Code Form may also (at your option) be used
* under the terms of the GNU Lesser General Public License Version 3, as
* described below:
*
* == LGPL-3.0-or-later ==
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at
* your option) any later version.
*
* This program 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 Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#ifdef __CBINDGEN_ALIGNED
#undef __CBINDGEN_ALIGNED
#endif
#define __CBINDGEN_ALIGNED(n) __attribute__((aligned(n)))
"""
trailer = """
#ifdef __CBINDGEN_ALIGNED
#undef __CBINDGEN_ALIGNED
#endif
"""
include_guard = "LIBPATHRS_H"
autogen_warning = """
/*
* WARNING: This file was auto-generated by rust-cbindgen. Don't modify it.
* Instead, re-generate it with:
* % cbindgen -c cbindgen.toml -o include/pathrs.h
*/
"""
sys_includes = [
# Needed for dev_t.
"sys/types.h",
]
after_includes = """
/*
* Returns whether the given numerical value is a libpathrs error (which can be
* passed to pathrs_errorinfo()). Users are recommended to use this instead of
* a bare `<0` comparison because some functions may return a negative number
* even in a success condition.
*/
#define IS_PATHRS_ERR(ret) ((ret) < __PATHRS_MAX_ERR_VALUE)
/*
* Used to construct pathrs_proc_base_t values for a PID (or TID). Passing
* PATHRS_PROC_PID(pid) to pathrs_proc_*() as pathrs_proc_base_t will cause
* libpathrs to use /proc/$pid as the base of the operation.
*
* This is essentially functionally equivalent to prefixing "$pid/" to the
* subpath argument and using PATHRS_PROC_ROOT.
*
* Note that this operation is inherently racy -- the process referenced by this
* PID may have died and the PID recycled with a different process. In
* principle, this means that it is only really safe to use this with:
*
* - PID 1 (the init process), as that PID cannot ever get recycled.
* - Your current PID (though you should just use PATHRS_PROC_SELF).
* - Your current TID (though you should just use PATHRS_PROC_THREAD_SELF),
* or _possibly_ other TIDs in your thread-group if you are absolutely sure
* they have not been reaped (typically with pthread_join(3), though there
* are other ways).
* - PIDs of child processes (as long as you are sure that no other part of
* your program incorrectly catches or ignores SIGCHLD, and that you do it
* *before* you call wait(2) or any equivalent method that could reap
* zombies).
*
* Outside of those specific uses, users should probably avoid using this.
*/
#define PATHRS_PROC_PID(n) (__PATHRS_PROC_TYPE_PID | (n))
/*
* A sentinel value to tell `pathrs_proc_*` methods to use the default procfs
* root handle (which may be globally cached).
*/
#define PATHRS_PROC_DEFAULT_ROOTFD -9 /* (-EBADF) */
"""
# Basic kernel-style formatting (can't use tabs so just use 4-spaces).
line_length = 80
tab_width = 4
usize_is_size_t = true
style = "type"
[layout]
aligned_n = "__CBINDGEN_ALIGNED"
[export]
exclude = [
# Don't generate a "typedef" for CBorrowedFd -- FFI-wise, CBorrowedFd is
# just an int.
"CBorrowedFd",
# CReturn is a rust-only typedef.
"CReturn",
# Don't export the RESOLVE_* definitions.
"RESOLVE_NO_XDEV",
"RESOLVE_NO_MAGICLINKS",
"RESOLVE_NO_SYMLINKS",
"RESOLVE_BENEATH",
"RESOLVE_IN_ROOT",
]
# Clean up the naming of structs.
[export.rename]
"CProcfsBase" = "pathrs_proc_base_t"
"ProcfsOpenFlags" = "uint64_t"
"ProcfsOpenHow" = "pathrs_procfs_open_how"
# Error API.
"CError" = "pathrs_error_t"
# The bare return values used for "kernel-like" APIs.
"RawFd" = "int"
"BorrowedFd" = "int"
"CBorrowedFd" = "int"
|
