3 * Copyright (C) 2003 Enrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2, or (at your option)
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 * \brief The public interface of the the libvserver library.
24 #ifndef H_VSERVER_SYSCALL_H
25 #define H_VSERVER_SYSCALL_H
30 #include <sys/types.h>
34 # define VC_ATTR_UNUSED __attribute__((__unused__))
35 # define VC_ATTR_NORETURN __attribute__((__noreturn__))
36 # if __GNUC__>3 || (__GNUC__==3 && __GNUC_MINOR__>=3)
37 # define VC_ATTR_NONNULL(ARGS) __attribute__((__nonnull__ ARGS))
38 # define VC_ATTR_ALWAYSINLINE __attribute__((__always_inline__))
40 # define VC_ATTR_NONNULL(ARGS)
41 # define VC_ATTR_ALWAYSINLINE
44 # define VC_ATTR_PURE __attribute__((__pure__))
49 # define VC_ATTR_NONNULL(ARGS)
50 # define VC_ATTR_UNUSED
51 # define VC_ATTR_NORETURN
52 # define VC_ATTR_ALWAYSINLINE
57 /** the value which is returned in error-case (no ctx found) */
58 #define VC_NOCTX ((xid_t)(-1))
59 /** the value which means a random (the next free) ctx */
60 #define VC_DYNAMIC_XID ((xid_t)(-1))
61 /** the value which means the current ctx */
62 #define VC_SAMECTX ((xid_t)(-2))
64 #define VC_LIM_INFINITY (~0ULL)
65 #define VC_LIM_KEEP (~1ULL)
68 #ifndef S_CTX_INFO_LOCK
69 # define S_CTX_INFO_LOCK 1
72 #ifndef S_CTX_INFO_SCHED
73 # define S_CTX_INFO_SCHED 2
76 #ifndef S_CTX_INFO_NPROC
77 # define S_CTX_INFO_NPROC 4
80 #ifndef S_CTX_INFO_PRIVATE
81 # define S_CTX_INFO_PRIVATE 8
84 #ifndef S_CTX_INFO_INIT
85 # define S_CTX_INFO_INIT 16
88 #ifndef S_CTX_INFO_HIDEINFO
89 # define S_CTX_INFO_HIDEINFO 32
92 #ifndef S_CTX_INFO_ULIMIT
93 # define S_CTX_INFO_ULIMIT 64
96 #ifndef S_CTX_INFO_NAMESPACE
97 # define S_CTX_INFO_NAMESPACE 128
100 #define VC_CAP_CHOWN 0
101 #define VC_CAP_DAC_OVERRIDE 1
102 #define VC_CAP_DAC_READ_SEARCH 2
103 #define VC_CAP_FOWNER 3
104 #define VC_CAP_FSETID 4
105 #define VC_CAP_KILL 5
106 #define VC_CAP_SETGID 6
107 #define VC_CAP_SETUID 7
108 #define VC_CAP_SETPCAP 8
109 #define VC_CAP_LINUX_IMMUTABLE 9
110 #define VC_CAP_NET_BIND_SERVICE 10
111 #define VC_CAP_NET_BROADCAST 11
112 #define VC_CAP_NET_ADMIN 12
113 #define VC_CAP_NET_RAW 13
114 #define VC_CAP_IPC_LOCK 14
115 #define VC_CAP_IPC_OWNER 15
116 #define VC_CAP_SYS_MODULE 16
117 #define VC_CAP_SYS_RAWIO 17
118 #define VC_CAP_SYS_CHROOT 18
119 #define VC_CAP_SYS_PTRACE 19
120 #define VC_CAP_SYS_PACCT 20
121 #define VC_CAP_SYS_ADMIN 21
122 #define VC_CAP_SYS_BOOT 22
123 #define VC_CAP_SYS_NICE 23
124 #define VC_CAP_SYS_RESOURCE 24
125 #define VC_CAP_SYS_TIME 25
126 #define VC_CAP_SYS_TTY_CONFIG 26
127 #define VC_CAP_MKNOD 27
128 #define VC_CAP_LEASE 28
129 #define VC_CAP_QUOTACTL 29
131 #define VC_IMMUTABLE_FILE_FL 0x00000010l
132 #define VC_IMMUTABLE_LINK_FL 0x00008000l
133 #define VC_IMMUTABLE_ALL (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
135 #define VC_IATTR_XID 0x01000000
137 #define VC_IATTR_ADMIN 0x00000001
138 #define VC_IATTR_WATCH 0x00000002
139 #define VC_IATTR_HIDE 0x00000004
140 #define VC_IATTR_FLAGS 0x00000007
142 #define VC_IATTR_BARRIER 0x00010000
143 #define VC_IATTR_IUNLINK 0x00020000
144 #define VC_IATTR_IMMUTABLE 0x00040000
150 struct vc_ip_mask_pair {
155 /** \brief Returns the version of the current kernel API.
156 \returns The versionnumber of the kernel API
158 int vc_get_version();
160 /** \brief Moves current process into a context
162 * Puts current process into context \a ctx, removes the capabilities
163 * given in \a remove_cap and sets \a flags.
165 * \param ctx The new context; special values for are
166 * - VC_SAMECTX which means the current context (just for changing caps and flags)
167 * - VC_DYNAMIC_XID which means the next free context; this value can be used by
168 * ordinary users also
169 * \param remove_cap The linux capabilities which will be \b removed.
170 * \param flags Special flags which will be set.
172 * \returns The new context-id, or VC_NOCTX on errors; errno
173 * will be set appropriately
175 * See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
176 xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
178 /** \brief Sets the ipv4root information.
179 * \pre \a nb < NB_IPV4ROOT && \a ips != 0 */
180 int vc_set_ipv4root(uint32_t bcast, size_t nb,
181 struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
183 /** \brief Creates a context without starting it.
185 * This functions initializes a new context. When already in a freshly
186 * created context, this old context will be discarded.
188 * \param xid The new context; special values are:
189 * - VC_DYNAMIC_XID which means to create a dynamic context
191 * \returns the xid of the created context, or VC_NOCTX on errors. errno
192 * will be set appropriately. */
193 xid_t vc_create_context(xid_t xid);
195 /** \brief Moves the current process into the specified context.
197 * \param xid The new context
198 * \returns 0 on success, -1 on errors */
199 int vc_migrate_context(xid_t xid);
201 /* rlimit related functions */
202 typedef uint_least64_t vc_limit_t;
205 vc_limit_t min; //< the guaranted minimum of a resources
206 vc_limit_t soft; //< the softlimit of a resource
207 vc_limit_t hard; //< the absolute hardlimit of a resource
210 struct vc_rlimit_mask {
211 uint_least32_t min; //< mask of resources supporting a minimum limit
212 uint_least32_t soft; //< mask of resources supporting a soft limit
213 uint_least32_t hard; //< mask of resources supporting a hard limit
216 /** \brief Returns the current limits of \a resource.
218 * \param xid The id of the context
219 * \param resource The resource which will be queried
220 * \param lim The result which will be filled with the limits
222 * \returns 0 on success, and -1 on errors. */
223 int vc_get_rlimit(xid_t xid, int resource,
224 struct vc_rlimit /*@out@*/ *lim) VC_ATTR_NONNULL((3));
225 int vc_set_rlimit(xid_t xid, int resource,
226 struct vc_rlimit const /*@in@*/ *lim) VC_ATTR_NONNULL((3));
227 int vc_get_rlimit_mask(xid_t xid,
228 struct vc_rlimit_mask *lim) VC_ATTR_NONNULL((2));
229 bool vc_parseLimit(char const *str, vc_limit_t *res) VC_ATTR_NONNULL((1,2));
232 /** sends a signal to a context/pid
233 Special values for pid are:
234 * -1 which means every process in ctx except the init-process
235 * 0 which means every process in ctx inclusive the init-process */
236 int vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
240 int vc_set_iattr(char const *filename, xid_t xid,
241 uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
242 int vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
243 uint_least32_t * /*@null@*/ flags,
244 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
251 /** Returns the context of the given process. pid==0 means the current process. */
252 xid_t vc_get_task_xid(pid_t pid);
253 int vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
256 typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
257 vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
258 vcVHI_DOMAINNAME } vc_uts_type;
260 int vc_set_vhi_name(xid_t xid, vc_uts_type type,
261 char const *val, size_t len) VC_ATTR_NONNULL((3));
262 int vc_get_vhi_name(xid_t xid, vc_uts_type type,
263 char *val, size_t len) VC_ATTR_NONNULL((3));
266 int vc_enter_namespace(xid_t xid);
267 int vc_set_namespace();
268 int vc_cleanup_namespace();
270 struct vc_ctx_flags {
271 uint_least64_t flagword;
276 uint_least64_t bcaps;
277 uint_least64_t ccaps;
278 uint_least64_t cmask;
281 struct vc_err_listparser {
286 int vc_get_flags(xid_t xid, struct vc_ctx_flags *) VC_ATTR_NONNULL((2));
287 int vc_set_flags(xid_t xid, struct vc_ctx_flags const *) VC_ATTR_NONNULL((2));
289 int vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
290 int vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
292 uint_least64_t vc_text2bcap(char const *, size_t len);
293 char const * vc_lobcap2text(uint_least64_t *);
294 int vc_list2bcap(char const *, size_t len,
295 struct vc_err_listparser *err,
296 struct vc_ctx_caps *);
298 uint_least64_t vc_text2ccap(char const *, size_t len);
299 char const * vc_loccap2text(uint_least64_t *);
300 int vc_list2ccap(char const *, size_t len,
301 struct vc_err_listparser *err,
302 struct vc_ctx_caps *);
304 int vc_list2flag(char const *, size_t len,
305 struct vc_err_listparser *err,
306 struct vc_ctx_flags *flags);
307 uint_least64_t vc_text2flag(char const *, size_t len);
308 char const * vc_loflag2text(uint_least64_t *);
310 uint_least32_t vc_list2flag_compat(char const *, size_t len,
311 struct vc_err_listparser *err);
312 uint_least32_t vc_text2flag_compat(char const *, size_t len);
313 char const * vc_hiflag2text_compat(uint_least32_t);
315 int vc_text2cap(char const *);
316 char const * vc_cap2text(unsigned int);
318 inline static uint_least32_t vc_get_securecaps() {
319 return ( (1<<VC_CAP_LINUX_IMMUTABLE) | (1<<VC_CAP_NET_BROADCAST) |
320 (1<<VC_CAP_NET_ADMIN) | (1<<VC_CAP_NET_RAW) |
321 (1<<VC_CAP_IPC_LOCK) | (1<<VC_CAP_IPC_OWNER) |
322 (1<<VC_CAP_SYS_MODULE) | (1<<VC_CAP_SYS_RAWIO) |
323 (1<<VC_CAP_SYS_PACCT) | (1<<VC_CAP_SYS_ADMIN) |
324 (1<<VC_CAP_SYS_BOOT) | (1<<VC_CAP_SYS_NICE) |
325 (1<<VC_CAP_SYS_RESOURCE) | (1<<VC_CAP_SYS_TIME) |
326 (1<<VC_CAP_MKNOD) | (1<<VC_CAP_QUOTACTL) );
329 inline static int vc_setfilecontext(char const *filename, xid_t xid) {
330 return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
333 inline static xid_t vc_getfilecontext(char const *filename) {
335 if (vc_get_iattr(filename, &res, 0,0)==-1) return VC_NOCTX;
340 struct vc_set_sched {
347 int vc_set_sched(xid_t xid, struct vc_set_sched const *);
350 typedef enum { vcFEATURE_VKILL, vcFEATURE_IATTR, vcFEATURE_RLIMIT,
351 vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
352 vcFEATURE_SCHED, vcFEATURE_VINFO, vcFEATURE_VHI }
355 bool vc_isSupported(vcFeatureSet);
356 bool vc_isSupportedString(char const *);
358 /* The management part */
360 #define VC_LIMIT_VSERVER_NAME_LEN 1024
362 typedef enum { vcCFG_NONE, vcCFG_AUTO,
365 vcCFG_RECENT_FULL } vcCfgStyle;
367 vcCfgStyle vc_getVserverCfgStyle(char const *id);
369 /** Resolves the name of the vserver. The result will be allocated and must
370 be freed by the caller. */
371 char * vc_getVserverName(char const *id, vcCfgStyle style);
373 /** Returns the path of the vserver configuration directory. When the given
374 * vserver does not exist, or when it does not have such a directory, NULL
375 * will be returned. Else, the result will be allocated and must be freed
377 char * vc_getVserverCfgDir(char const *id, vcCfgStyle style);
379 /** Returns the path of the configuration directory for the given
380 * application. The result will be allocated and must be freed by the
382 char * vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
384 /** Returns the path to the vserver root-directory. The result will be
385 * allocated and must be freed by the caller. */
386 char * vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
388 /** Returns the ctx of the given vserver. When vserver is not running and
389 * 'honor_static' is false, VC_NOCTX will be returned. Else, when
390 * 'honor_static' is true and a static assignment exists, those value will
391 * be returned. Else, the result will be VC_NOCTX.
393 * When 'is_running' is not null, the status of the vserver will be
394 * assigned to this variable. */
395 xid_t vc_getVserverCtx(char const *id, vcCfgStyle style,
396 bool honor_static, bool /*@null@*/ *is_running);
398 /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
399 be used as the directory holding the mapping-links; when NULL, the
400 default value will be assumed. The result will be allocated and must be
401 freed by the caller. */
402 char * vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
403 /*@null@*/char const *revdir);
405 #define vcSKEL_INTERFACES 1u
406 #define vcSKEL_PKGMGMT 2u
407 #define vcSKEL_FILESYSTEM 4u
409 /** Create a basic configuration skeleton for a vserver plus toplevel
410 * directories for pkgmanagemt and filesystem (when requested). */
411 int vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
418 #undef VC_ATTR_ALWAYSINLINE
419 #undef VC_ATTR_NORETURN
420 #undef VC_ATTR_UNUSED
421 #undef VC_ATTR_NONNULL