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
148 #define VC_VXF_INFO_LOCK 0x00000001
149 #define VC_VXF_INFO_NPROC 0x00000002
150 #define VC_VXF_INFO_PRIVATE 0x00000004
151 #define VC_VXF_INFO_INIT 0x00000008
153 #define VC_VXF_INFO_HIDE 0x00000010
154 #define VC_VXF_INFO_ULIMIT 0x00000020
155 #define VC_VXF_INFO_NSPACE 0x00000040
157 #define VC_VXF_SCHED_HARD 0x00000100
158 #define VC_VXF_SCHED_PRIO 0x00000200
159 #define VC_VXF_SCHED_PAUSE 0x00000400
161 #define VC_VXF_VIRT_MEM 0x00010000
162 #define VC_VXF_VIRT_UPTIME 0x00020000
164 #define VC_VXF_STATE_SETUP (1ULL<<32)
165 #define VC_VXF_STATE_INIT (1ULL<<33)
168 /** \defgroup syscalls Syscall wrappers
169 * Functions which are calling the vserver syscall directly. */
171 /** \defgroup helper Helper functions
172 * Functions which are doing general helper tasks like parameter parsing. */
174 /** \typedef an_unsigned_integer_type xid_t
175 * The identifier of a context. */
178 typedef an_unsigned_integer_type xid_t;
185 struct vc_ip_mask_pair {
190 /** \brief Returns the version of the current kernel API.
192 * \returns The versionnumber of the kernel API
194 int vc_get_version();
196 /** \brief Moves current process into a context
199 * Puts current process into context \a ctx, removes the capabilities
200 * given in \a remove_cap and sets \a flags.
202 * \param ctx The new context; special values for are
203 * - VC_SAMECTX which means the current context (just for changing caps and flags)
204 * - VC_DYNAMIC_XID which means the next free context; this value can be used by
205 * ordinary users also
206 * \param remove_cap The linux capabilities which will be \b removed.
207 * \param flags Special flags which will be set.
209 * \returns The new context-id, or VC_NOCTX on errors; errno
210 * will be set appropriately
212 * See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
213 xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
215 /** \brief Sets the ipv4root information.
217 * \pre \a nb < NB_IPV4ROOT && \a ips != 0 */
218 int vc_set_ipv4root(uint32_t bcast, size_t nb,
219 struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
221 /** \brief Creates a context without starting it.
224 * This functions initializes a new context. When already in a freshly
225 * created context, this old context will be discarded.
227 * \param xid The new context; special values are:
228 * - VC_DYNAMIC_XID which means to create a dynamic context
230 * \returns the xid of the created context, or VC_NOCTX on errors. errno
231 * will be set appropriately. */
232 xid_t vc_create_context(xid_t xid);
234 /** \brief Moves the current process into the specified context.
237 * \param xid The new context
238 * \returns 0 on success, -1 on errors */
239 int vc_migrate_context(xid_t xid);
241 /* rlimit related functions */
243 /** \brief The type which is used for a single limit value.
246 * - VC_LIM_INFINITY ... which is the infinite value
247 * - VC_LIM_KEEP ... which is used to mark values which shall not be
248 * modified by the vc_set_rlimit() operation.
250 * Else, the interpretation of the value depends on the corresponding
251 * resource; it might be bytes, pages, seconds or litres of beer.
253 typedef uint_least64_t vc_limit_t;
255 /** \brief The limits of a resources.
257 * This is a triple consisting of a minimum, soft and hardlimit. */
259 vc_limit_t min; ///< the guaranted minimum of a resources
260 vc_limit_t soft; ///< the softlimit of a resource
261 vc_limit_t hard; ///< the absolute hardlimit of a resource
264 /** \brief Masks describing the supported limits. */
265 struct vc_rlimit_mask {
266 uint_least32_t min; ///< masks the resources supporting a minimum limit
267 uint_least32_t soft; ///< masks the resources supporting a soft limit
268 uint_least32_t hard; ///< masks the resources supporting a hard limit
271 /** \brief Returns the limits of \a resource.
274 * \param xid The id of the context
275 * \param resource The resource which will be queried
276 * \param lim The result which will be filled with the limits
278 * \returns 0 on success, and -1 on errors. */
279 int vc_get_rlimit(xid_t xid, int resource,
280 struct vc_rlimit /*@out@*/ *lim) VC_ATTR_NONNULL((3));
281 /** \brief Sets the limits of \a resource.
284 * \param xid The id of the context
285 * \param resource The resource which will be queried
286 * \param lim The new limits
288 * \returns 0 on success, and -1 on errors. */
289 int vc_set_rlimit(xid_t xid, int resource,
290 struct vc_rlimit const /*@in@*/ *lim) VC_ATTR_NONNULL((3));
291 int vc_get_rlimit_mask(xid_t xid,
292 struct vc_rlimit_mask *lim) VC_ATTR_NONNULL((2));
293 /** \brief Parses a string describing a limit
296 * This function parses \a str and interprets special words like \p "inf"
297 * or suffixes. Valid suffixes are
303 * \param str The string which shall be parsed
304 * \param res Will be filled with the interpreted value; in errorcase,
305 * this value is undefined.
307 * \returns \a true, iff the string \a str could be parsed. \a res will
308 * be filled with the interpreted value in this case.
310 * \pre \a str!=0 && \a res!=0
312 bool vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res) VC_ATTR_NONNULL((1,2));
315 /** \brief Sends a signal to a context/pid
318 * Special values for \a pid are:
319 * - -1 which means every process in ctx except the init-process
320 * - 0 which means every process in ctx inclusive the init-process */
321 int vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
325 int vc_set_iattr(char const *filename, xid_t xid,
326 uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
327 int vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
328 uint_least32_t * /*@null@*/ flags,
329 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
336 /** Returns the context of the given process. pid==0 means the current process. */
337 xid_t vc_get_task_xid(pid_t pid);
338 int vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
341 typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
342 vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
343 vcVHI_DOMAINNAME } vc_uts_type;
345 int vc_set_vhi_name(xid_t xid, vc_uts_type type,
346 char const *val, size_t len) VC_ATTR_NONNULL((3));
347 int vc_get_vhi_name(xid_t xid, vc_uts_type type,
348 char *val, size_t len) VC_ATTR_NONNULL((3));
350 /** Returns true iff \a xid is a dynamic xid */
351 bool vc_is_dynamic_xid(xid_t xid);
353 int vc_enter_namespace(xid_t xid);
354 int vc_set_namespace();
355 int vc_cleanup_namespace();
357 struct vc_ctx_flags {
358 uint_least64_t flagword;
363 uint_least64_t bcaps;
364 uint_least64_t ccaps;
365 uint_least64_t cmask;
368 struct vc_err_listparser {
373 int vc_get_flags(xid_t xid, struct vc_ctx_flags *) VC_ATTR_NONNULL((2));
374 int vc_set_flags(xid_t xid, struct vc_ctx_flags const *) VC_ATTR_NONNULL((2));
376 int vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
377 int vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
379 uint_least64_t vc_text2bcap(char const *, size_t len);
380 char const * vc_lobcap2text(uint_least64_t *);
381 int vc_list2bcap(char const *, size_t len,
382 struct vc_err_listparser *err,
383 struct vc_ctx_caps *);
385 uint_least64_t vc_text2ccap(char const *, size_t len);
386 char const * vc_loccap2text(uint_least64_t *);
387 int vc_list2ccap(char const *, size_t len,
388 struct vc_err_listparser *err,
389 struct vc_ctx_caps *);
391 int vc_list2flag(char const *, size_t len,
392 struct vc_err_listparser *err,
393 struct vc_ctx_flags *flags);
394 uint_least64_t vc_text2flag(char const *, size_t len);
395 char const * vc_loflag2text(uint_least64_t *);
397 uint_least32_t vc_list2flag_compat(char const *, size_t len,
398 struct vc_err_listparser *err);
399 uint_least32_t vc_text2flag_compat(char const *, size_t len);
400 char const * vc_hiflag2text_compat(uint_least32_t);
402 int vc_text2cap(char const *);
403 char const * vc_cap2text(unsigned int);
405 inline static uint_least32_t vc_get_securecaps() {
406 return ( (1<<VC_CAP_LINUX_IMMUTABLE) | (1<<VC_CAP_NET_BROADCAST) |
407 (1<<VC_CAP_NET_ADMIN) | (1<<VC_CAP_NET_RAW) |
408 (1<<VC_CAP_IPC_LOCK) | (1<<VC_CAP_IPC_OWNER) |
409 (1<<VC_CAP_SYS_MODULE) | (1<<VC_CAP_SYS_RAWIO) |
410 (1<<VC_CAP_SYS_PACCT) | (1<<VC_CAP_SYS_ADMIN) |
411 (1<<VC_CAP_SYS_BOOT) | (1<<VC_CAP_SYS_NICE) |
412 (1<<VC_CAP_SYS_RESOURCE) | (1<<VC_CAP_SYS_TIME) |
413 (1<<VC_CAP_MKNOD) | (1<<VC_CAP_QUOTACTL) );
416 inline static int vc_setfilecontext(char const *filename, xid_t xid) {
417 return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
420 inline static xid_t vc_getfilecontext(char const *filename) {
422 if (vc_get_iattr(filename, &res, 0,0)==-1) return VC_NOCTX;
427 struct vc_set_sched {
436 int vc_set_sched(xid_t xid, struct vc_set_sched const *);
439 typedef enum { vcFEATURE_VKILL, vcFEATURE_IATTR, vcFEATURE_RLIMIT,
440 vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
441 vcFEATURE_SCHED, vcFEATURE_VINFO, vcFEATURE_VHI }
444 bool vc_isSupported(vcFeatureSet);
445 bool vc_isSupportedString(char const *);
447 /* The management part */
449 #define VC_LIMIT_VSERVER_NAME_LEN 1024
451 typedef enum { vcCFG_NONE, vcCFG_AUTO,
454 vcCFG_RECENT_FULL } vcCfgStyle;
456 vcCfgStyle vc_getVserverCfgStyle(char const *id);
458 /** Resolves the name of the vserver. The result will be allocated and must
459 be freed by the caller. */
460 char * vc_getVserverName(char const *id, vcCfgStyle style);
462 /** Returns the path of the vserver configuration directory. When the given
463 * vserver does not exist, or when it does not have such a directory, NULL
464 * will be returned. Else, the result will be allocated and must be freed
466 char * vc_getVserverCfgDir(char const *id, vcCfgStyle style);
468 /** Returns the path of the configuration directory for the given
469 * application. The result will be allocated and must be freed by the
471 char * vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
473 /** Returns the path to the vserver root-directory. The result will be
474 * allocated and must be freed by the caller. */
475 char * vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
477 /** Returns the ctx of the given vserver. When vserver is not running and
478 * 'honor_static' is false, VC_NOCTX will be returned. Else, when
479 * 'honor_static' is true and a static assignment exists, those value will
480 * be returned. Else, the result will be VC_NOCTX.
482 * When 'is_running' is not null, the status of the vserver will be
483 * assigned to this variable. */
484 xid_t vc_getVserverCtx(char const *id, vcCfgStyle style,
485 bool honor_static, bool /*@null@*/ *is_running);
487 /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
488 be used as the directory holding the mapping-links; when NULL, the
489 default value will be assumed. The result will be allocated and must be
490 freed by the caller. */
491 char * vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
492 /*@null@*/char const *revdir);
494 #define vcSKEL_INTERFACES 1u
495 #define vcSKEL_PKGMGMT 2u
496 #define vcSKEL_FILESYSTEM 4u
498 /** Create a basic configuration skeleton for a vserver plus toplevel
499 * directories for pkgmanagemt and filesystem (when requested). */
500 int vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
507 #undef VC_ATTR_ALWAYSINLINE
508 #undef VC_ATTR_NORETURN
509 #undef VC_ATTR_UNUSED
510 #undef VC_ATTR_NONNULL