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 # define VC_ATTR_CONST __attribute__((__const__))
37 # define VC_ATTR_DEPRECATED __attribute__((__deprecated__))
38 # if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30300
39 # define VC_ATTR_NONNULL(ARGS) __attribute__((__nonnull__ ARGS))
40 # define VC_ATTR_ALWAYSINLINE __attribute__((__always_inline__))
42 # define VC_ATTR_NONNULL(ARGS)
43 # define VC_ATTR_ALWAYSINLINE
45 # if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30303
46 # define VC_ATTR_PURE __attribute__((__pure__))
51 # define VC_ATTR_NONNULL(ARGS)
52 # define VC_ATTR_UNUSED
53 # define VC_ATTR_NORETURN
54 # define VC_ATTR_ALWAYSINLINE
55 # define VC_ATTR_DEPRECATED
57 # define VC_ATTR_CONST
61 /** the value which is returned in error-case (no ctx found) */
62 #define VC_NOCTX ((xid_t)(-1))
63 #define VC_NOXID ((xid_t)(-1))
64 /** the value which means a random (the next free) ctx */
65 #define VC_DYNAMIC_XID ((xid_t)(-1))
66 /** the value which means the current ctx */
67 #define VC_SAMECTX ((xid_t)(-2))
69 #define VC_NONID ((nid_t)(-1))
70 #define VC_DYNAMIC_NID ((nid_t)(-1))
72 #define VC_LIM_INFINITY (~0ULL)
73 #define VC_LIM_KEEP (~1ULL)
75 #define VC_CDLIM_UNSET (0U)
76 #define VC_CDLIM_INFINITY (~0U)
77 #define VC_CDLIM_KEEP (~1U)
79 #ifndef S_CTX_INFO_LOCK
80 # define S_CTX_INFO_LOCK 1
83 #ifndef S_CTX_INFO_SCHED
84 # define S_CTX_INFO_SCHED 2
87 #ifndef S_CTX_INFO_NPROC
88 # define S_CTX_INFO_NPROC 4
91 #ifndef S_CTX_INFO_PRIVATE
92 # define S_CTX_INFO_PRIVATE 8
95 #ifndef S_CTX_INFO_INIT
96 # define S_CTX_INFO_INIT 16
99 #ifndef S_CTX_INFO_HIDEINFO
100 # define S_CTX_INFO_HIDEINFO 32
103 #ifndef S_CTX_INFO_ULIMIT
104 # define S_CTX_INFO_ULIMIT 64
107 #ifndef S_CTX_INFO_NAMESPACE
108 # define S_CTX_INFO_NAMESPACE 128
111 #define VC_CAP_CHOWN 0
112 #define VC_CAP_DAC_OVERRIDE 1
113 #define VC_CAP_DAC_READ_SEARCH 2
114 #define VC_CAP_FOWNER 3
115 #define VC_CAP_FSETID 4
116 #define VC_CAP_KILL 5
117 #define VC_CAP_SETGID 6
118 #define VC_CAP_SETUID 7
119 #define VC_CAP_SETPCAP 8
120 #define VC_CAP_LINUX_IMMUTABLE 9
121 #define VC_CAP_NET_BIND_SERVICE 10
122 #define VC_CAP_NET_BROADCAST 11
123 #define VC_CAP_NET_ADMIN 12
124 #define VC_CAP_NET_RAW 13
125 #define VC_CAP_IPC_LOCK 14
126 #define VC_CAP_IPC_OWNER 15
127 #define VC_CAP_SYS_MODULE 16
128 #define VC_CAP_SYS_RAWIO 17
129 #define VC_CAP_SYS_CHROOT 18
130 #define VC_CAP_SYS_PTRACE 19
131 #define VC_CAP_SYS_PACCT 20
132 #define VC_CAP_SYS_ADMIN 21
133 #define VC_CAP_SYS_BOOT 22
134 #define VC_CAP_SYS_NICE 23
135 #define VC_CAP_SYS_RESOURCE 24
136 #define VC_CAP_SYS_TIME 25
137 #define VC_CAP_SYS_TTY_CONFIG 26
138 #define VC_CAP_MKNOD 27
139 #define VC_CAP_LEASE 28
140 #define VC_CAP_AUDIT_WRITE 29
141 #define VC_CAP_AUDIT_CONTROL 30
143 #define VC_IMMUTABLE_FILE_FL 0x0000010lu
144 #define VC_IMMUTABLE_LINK_FL 0x0008000lu
145 #define VC_IMMUTABLE_ALL (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
147 #define VC_IATTR_XID 0x01000000u
149 #define VC_IATTR_ADMIN 0x00000001u
150 #define VC_IATTR_WATCH 0x00000002u
151 #define VC_IATTR_HIDE 0x00000004u
152 #define VC_IATTR_FLAGS 0x00000007u
154 #define VC_IATTR_BARRIER 0x00010000u
155 #define VC_IATTR_IUNLINK 0x00020000u
156 #define VC_IATTR_IMMUTABLE 0x00040000u
160 #define VC_VXF_INFO_LOCK 0x00000001ull
161 #define VC_VXF_INFO_NPROC 0x00000004ull
162 #define VC_VXF_INFO_PRIVATE 0x00000008ull
163 #define VC_VXF_INFO_INIT 0x00000010ull
165 #define VC_VXF_INFO_HIDEINFO 0x00000020ull
166 #define VC_VXF_INFO_ULIMIT 0x00000040ull
167 #define VC_VXF_INFO_NAMESPACE 0x00000080ull
169 #define VC_VXF_SCHED_HARD 0x00000100ull
170 #define VC_VXF_SCHED_PRIO 0x00000200ull
171 #define VC_VXF_SCHED_PAUSE 0x00000400ull
173 #define VC_VXF_VIRT_MEM 0x00010000ull
174 #define VC_VXF_VIRT_UPTIME 0x00020000ull
175 #define VC_VXF_VIRT_CPU 0x00040000ull
176 #define VC_VXF_VIRT_LOAD 0x00080000ull
177 #define VC_VXF_VIRT_TIME 0x00100000ull
179 #define VC_VXF_HIDE_MOUNT 0x01000000ull
180 #define VC_VXF_HIDE_NETIF 0x02000000ull
181 #define VC_VXF_HIDE_VINFO 0x04000000ull
183 #define VC_VXF_STATE_SETUP (1ULL<<32)
184 #define VC_VXF_STATE_INIT (1ULL<<33)
185 #define VC_VXF_STATE_ADMIN (1ULL<<34)
187 #define VC_VXF_SC_HELPER (1ULL<<36)
188 #define VC_VXF_REBOOT_KILL (1ULL<<37)
189 #define VC_VXF_PERSISTENT (1ULL<<38)
191 #define VC_VXF_FORK_RSS (1ULL<<48)
192 #define VC_VXF_PROLIFIC (1ULL<<49)
194 #define VC_VXF_IGNEG_NICE (1ULL<<52)
198 #define VC_VXC_SET_UTSNAME 0x00000001ull
199 #define VC_VXC_SET_RLIMIT 0x00000002ull
201 #define VC_VXC_RAW_ICMP 0x00000100ull
202 #define VC_VXC_SYSLOG 0x00001000ull
204 #define VC_VXC_SECURE_MOUNT 0x00010000ull
205 #define VC_VXC_SECURE_REMOUNT 0x00020000ull
206 #define VC_VXC_BINARY_MOUNT 0x00040000ull
208 #define VC_VXC_QUOTA_CTL 0x00100000ull
209 #define VC_VXC_ADMIN_MAPPER 0x00200000ull
210 #define VC_VXC_ADMIN_CLOOP 0x00400000ull
213 // the scheduler flags
214 #define VC_VXSM_FILL_RATE 0x0001
215 #define VC_VXSM_INTERVAL 0x0002
216 #define VC_VXSM_FILL_RATE2 0x0004
217 #define VC_VXSM_INTERVAL2 0x0008
218 #define VC_VXSM_TOKENS 0x0010
219 #define VC_VXSM_TOKENS_MIN 0x0020
220 #define VC_VXSM_TOKENS_MAX 0x0040
221 #define VC_VXSM_PRIO_BIAS 0x0100
222 #define VC_VXSM_CPU_ID 0x1000
223 #define VC_VXSM_BUCKET_ID 0x2000
225 #define VC_VXSM_IDLE_TIME 0x0200
226 #define VC_VXSM_FORCE 0x0400
228 #define VC_VXSM_V3_MASK 0x0173
232 #define VC_NXF_INFO_LOCK 0x00000001ull
234 #define VC_NXF_STATE_SETUP (1ULL<<32)
235 #define VC_NXF_STATE_ADMIN (1ULL<<34)
237 #define VC_NXF_SC_HELPER (1ULL<<36)
238 #define VC_NXF_PERSISTENT (1ULL<<38)
241 // the vserver specific limits
242 #define VC_VLIMIT_NSOCK 16
243 #define VC_VLIMIT_OPENFD 17
244 #define VC_VLIMIT_ANON 18
245 #define VC_VLIMIT_SHMEM 19
246 #define VC_VLIMIT_SEMARY 20
247 #define VC_VLIMIT_NSEMS 21
248 #define VC_VLIMIT_DENTRY 22
252 #define VC_BAD_PERSONALITY ((uint_least32_t)(-1))
255 /** \defgroup syscalls Syscall wrappers
256 * Functions which are calling the vserver syscall directly. */
258 /** \defgroup helper Helper functions
259 * Functions which are doing general helper tasks like parameter parsing. */
261 /** \typedef an_unsigned_integer_type xid_t
262 * The identifier of a context. */
265 typedef an_unsigned_integer_type xid_t;
266 typedef an_unsigned_integer_type nid_t;
273 struct vc_ip_mask_pair {
278 /** \brief The generic vserver syscall
281 * This function executes the generic vserver syscall. It uses the
282 * correct syscallnumber (which may differ between the different
285 * \param cmd the command to be executed
286 * \param xid the xid on which the cmd shall be applied
287 * \param data additional arguments; depends on \c cmd
288 * \returns depends on \c cmd; usually, -1 stands for an error
290 int vc_syscall(uint32_t cmd, xid_t xid, void *data);
292 /** \brief Returns the version of the current kernel API.
294 * \returns The versionnumber of the kernel API
296 int vc_get_version();
298 /** \brief Returns the kernel configuration bits
300 * \returns The kernel configuration bits
304 /** \brief Moves current process into a context
307 * Puts current process into context \a ctx, removes the capabilities
308 * given in \a remove_cap and sets \a flags.
310 * \param ctx The new context; special values for are
311 * - VC_SAMECTX which means the current context (just for changing caps and flags)
312 * - VC_DYNAMIC_XID which means the next free context; this value can be used by
313 * ordinary users also
314 * \param remove_cap The linux capabilities which will be \b removed.
315 * \param flags Special flags which will be set.
317 * \returns The new context-id, or VC_NOCTX on errors; \c errno
318 * will be set appropriately
320 * See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
321 xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
323 /** \brief Sets the ipv4root information.
325 * \pre \a nb < NB_IPV4ROOT && \a ips != 0 */
326 int vc_set_ipv4root(uint32_t bcast, size_t nb,
327 struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
329 /** \brief Returns the value of NB_IPV4ROOT.
332 * This function returns the value of NB_IPV4ROOT which was used when the
333 * library was built, but \b not the value which is used by the currently
335 size_t vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
337 /** \brief Creates a context without starting it.
340 * This functions initializes a new context. When already in a freshly
341 * created context, this old context will be discarded.
343 * \param xid The new context; special values are:
344 * - VC_DYNAMIC_XID which means to create a dynamic context
346 * \returns the xid of the created context, or VC_NOCTX on errors. \c errno
347 * will be set appropriately. */
348 xid_t vc_ctx_create(xid_t xid);
350 /** \brief Moves the current process into the specified context.
353 * \param xid The new context
354 * \returns 0 on success, -1 on errors */
355 int vc_ctx_migrate(xid_t xid);
357 /** \brief Statistics about a context */
359 uint_least32_t usecnt; ///< number of uses
360 uint_least32_t tasks; ///< number of tasks
363 /** \brief Get some statistics about a context.
366 * \param xid The context to get stats about
367 * \param stat Where to store the result
369 * \returns 0 on success, -1 on errors. */
370 int vc_ctx_stat(xid_t xid, struct vc_ctx_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
372 /** \brief Contains further statistics about a context. */
373 struct vc_virt_stat {
374 uint_least64_t offset;
375 uint_least32_t uptime;
376 uint_least32_t nr_threads;
377 uint_least32_t nr_running;
378 uint_least32_t nr_uninterruptible;
379 uint_least32_t nr_onhold;
380 uint_least32_t nr_forks;
381 uint_least32_t load[3];
384 /** \brief Get more statistics about a context.
387 * \param xid The context to get stats about
388 * \param stat Where to store the result
390 * \returns 0 on success, -1 on errors. */
391 int vc_virt_stat(xid_t xid, struct vc_virt_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
393 /* rlimit related functions */
395 /** \brief The type which is used for a single limit value.
398 * - VC_LIM_INFINITY ... which is the infinite value
399 * - VC_LIM_KEEP ... which is used to mark values which shall not be
400 * modified by the vc_set_rlimit() operation.
402 * Else, the interpretation of the value depends on the corresponding
403 * resource; it might be bytes, pages, seconds or litres of beer. */
404 typedef uint_least64_t vc_limit_t;
406 /** \brief The limits of a resources.
408 * This is a triple consisting of a minimum, soft and hardlimit. */
410 vc_limit_t min; ///< the guaranted minimum of a resources
411 vc_limit_t soft; ///< the softlimit of a resource
412 vc_limit_t hard; ///< the absolute hardlimit of a resource
415 /** \brief Masks describing the supported limits. */
416 struct vc_rlimit_mask {
417 uint_least32_t min; ///< masks the resources supporting a minimum limit
418 uint_least32_t soft; ///< masks the resources supporting a soft limit
419 uint_least32_t hard; ///< masks the resources supporting a hard limit
422 /** \brief Statistics for a resource limit. */
423 struct vc_rlimit_stat {
424 uint_least32_t hits; ///< number of hits on the limit
425 uint_least64_t value; ///< current value
426 uint_least64_t minimum; ///< minimum value observed
427 uint_least64_t maximum; ///< maximum value observed
430 /** \brief Returns the limits of \a resource.
433 * \param xid The id of the context
434 * \param resource The resource which will be queried
435 * \param lim The result which will be filled with the limits
437 * \returns 0 on success, and -1 on errors. */
438 int vc_get_rlimit(xid_t xid, int resource,
439 struct vc_rlimit /*@out@*/ *lim) VC_ATTR_NONNULL((3));
440 /** \brief Sets the limits of \a resource.
443 * \param xid The id of the context
444 * \param resource The resource which will be queried
445 * \param lim The new limits
447 * \returns 0 on success, and -1 on errors. */
448 int vc_set_rlimit(xid_t xid, int resource,
449 struct vc_rlimit const /*@in@*/ *lim) VC_ATTR_NONNULL((3));
450 int vc_get_rlimit_mask(xid_t xid,
451 struct vc_rlimit_mask *lim) VC_ATTR_NONNULL((2));
452 /** \brief Returns the current stats of \a resource.
455 * \param xid The id of the context
456 * \param resource The resource which will be queried
457 * \param stat The result which will be filled with the stats
459 * \returns 0 on success, and -1 on errors. */
460 int vc_rlimit_stat(xid_t xid, int resource,
461 struct vc_rlimit_stat /*@out@*/ *stat) VC_ATTR_NONNULL((3));
462 /** \brief Resets the minimum and maximum observed values for all resources.
465 * \param xid The id of the context
467 * \returns 0 on success, and -1 on errors. */
468 int vc_reset_minmax(xid_t xid);
469 /** \brief Parses a string describing a limit
472 * This function parses \a str and interprets special words like \p "inf"
473 * or suffixes. Valid suffixes are
479 * \param str The string which shall be parsed
480 * \param res Will be filled with the interpreted value; in errorcase,
481 * this value is undefined.
483 * \returns \a true, iff the string \a str could be parsed. \a res will
484 * be filled with the interpreted value in this case.
486 * \pre \a str!=0 && \a res!=0
488 bool vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res) VC_ATTR_NONNULL((1,2));
491 /** \brief Sends a signal to a context/pid
494 * Special values for \a pid are:
495 * - -1 which means every process in ctx except the init-process
496 * - 0 which means every process in ctx inclusive the init-process */
497 int vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
504 nid_t vc_get_task_nid(pid_t pid);
505 int vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
507 typedef enum { vcNET_IPV4=1, vcNET_IPV6=2,
508 vcNET_IPV4B=0x101, vcNET_IPV6B=0x102,
509 vcNET_ANY=~0 } vc_net_nx_type;
518 nid_t vc_net_create(nid_t nid);
519 int vc_net_migrate(nid_t nid);
521 int vc_net_add(nid_t nid, struct vc_net_nx const *info);
522 int vc_net_remove(nid_t nid, struct vc_net_nx const *info);
524 struct vc_net_flags {
525 uint_least64_t flagword;
529 int vc_get_nflags(nid_t, struct vc_net_flags *);
530 int vc_set_nflags(nid_t, struct vc_net_flags const *);
534 uint_least64_t ncaps;
535 uint_least64_t cmask;
538 int vc_get_ncaps(nid_t, struct vc_net_caps *);
539 int vc_set_ncaps(nid_t, struct vc_net_caps const *);
544 int vc_set_iattr(char const *filename, xid_t xid,
545 uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
547 /** \brief Returns information about attributes and assigned context of a file.
550 * This function returns the VC_IATTR_XXX flags and about the assigned
551 * context of a file. To request an information, the appropriate bit in
552 * \c mask must be set and the corresponding parameter (\a xid or \a
553 * flags) must not be NULL.
555 * E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
556 * set in \a mask, and \a xid must point to valid memory.
558 * Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
559 * \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
561 * \param filename The name of the file whose attributes shall be determined.
563 * \param xid When non-zero and the VC_IATTR_XID bit is set in \a mask,
564 * the assigned context of \a filename will be stored there.
565 * \param flags When non-zero, a bitmask of current attributes will be
566 * stored there. These attributes must be requested explicitly
567 * by setting the appropriate bit in \a mask
568 * \param mask Points to a bitmask which tells which attributes shall be
569 * determined. On return, it will masquerade the attributes
570 * which were determined.
572 * \pre mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
573 int vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
574 uint_least32_t * /*@null@*/ flags,
575 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
582 /** \brief Returns the context of the given process.
585 * \param pid the process-id whose xid shall be determined;
586 * pid==0 means the current process.
587 * \returns the xid of process \c pid or -1 on errors
589 xid_t vc_get_task_xid(pid_t pid);
590 int vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
593 typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
594 vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
595 vcVHI_DOMAINNAME } vc_uts_type;
597 int vc_set_vhi_name(xid_t xid, vc_uts_type type,
598 char const *val, size_t len) VC_ATTR_NONNULL((3));
599 int vc_get_vhi_name(xid_t xid, vc_uts_type type,
600 char *val, size_t len) VC_ATTR_NONNULL((3));
602 /** Returns true iff \a xid is a dynamic xid */
603 bool vc_is_dynamic_xid(xid_t xid);
605 int vc_enter_namespace(xid_t xid);
606 int vc_set_namespace();
607 int vc_cleanup_namespace();
610 /** \brief Flags of process-contexts
612 struct vc_ctx_flags {
613 /** \brief Mask of set context flags */
614 uint_least64_t flagword;
615 /** \brief Mask of set and unset context flags when used by set
616 * operations, or modifiable flags when used by get
621 /** \brief Capabilities of process-contexts */
623 /** \brief Mask of set common system capabilities */
624 uint_least64_t bcaps;
625 /** \brief Mask of set and unset common system capabilities when used by
626 * set operations, or the modifiable capabilities when used by
628 uint_least64_t bmask;
629 /** \brief Mask of set process context capabilities */
630 uint_least64_t ccaps;
631 /** \brief Mask of set and unset process context capabilities when used
632 * by set operations, or the modifiable capabilities when used
633 * by get operations */
634 uint_least64_t cmask;
637 /** \brief Information about parsing errors
640 struct vc_err_listparser {
641 char const *ptr; ///< Pointer to the first character of an erroneous string
642 size_t len; ///< Length of the erroneous string
645 int vc_get_cflags(xid_t xid, struct vc_ctx_flags *) VC_ATTR_NONNULL((2));
646 int vc_set_cflags(xid_t xid, struct vc_ctx_flags const *) VC_ATTR_NONNULL((2));
648 int vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
649 int vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
651 /** \brief Converts a single string into bcapability
654 * \param str The string to be parsed;
655 * both "CAP_xxx" and "xxx" will be accepted
656 * \param len The length of the string, or \c 0 for automatic detection
658 * \returns 0 on error; a bitmask on success
661 uint_least64_t vc_text2bcap(char const *str, size_t len);
663 /** \brief Converts the lowest bit of a bcapability or the entire value
664 * (when possible) to a textual representation
667 * \param val The string to be converted; on success, the detected bit(s)
668 * will be unset, in errorcase only the lowest set bit
670 * \returns A textual representation of \a val resp. of its lowest set bit;
671 * or \c NULL in errorcase.
673 * \post \a *val<sub>old</sub> \c != 0 \c <-->
674 * \a *val<sub>old</sub> > \a *val<sub>new</sub>
675 * \post \a *val<sub>old</sub> \c == 0 \c ---> \a result == 0
677 char const * vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
679 /** \brief Converts a string into a bcapability-bitmask
682 * Syntax of \a str: \verbinclude list2xxx.syntax
684 * When the \c `~' prefix is used, the bits will be unset and a `~' after
685 * another `~' will cancel both ones. The \c `^' prefix specifies a
686 * bitnumber instead of a bitmask.
688 * "literal name" is everything which will be accepted by the
689 * vc_text2bcap() function. The special values for \c NAME will be
690 * recognized case insensitively
692 * \param str The string to be parsed
693 * \param len The length of the string, or \c 0 for automatic detection
694 * \param err Pointer to a structure for error-information, or \c NULL.
695 * \param cap Pointer to a vc_ctx_caps structure holding the results;
696 * only the \a bcaps and \a bmask fields will be changed and
697 * already set values will not be honored. When an error
698 * occured, \a cap will have the value of all processed valid
701 * \returns 0 on success, -1 on error. In error case, \a err will hold
702 * position and length of the first not understood BCAP part
703 * \pre \a str != 0 && \a cap != 0;
704 * \a cap->bcaps and \a cap->bmask must be initialized
706 int vc_list2bcap(char const *str, size_t len,
707 struct vc_err_listparser *err,
708 struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
710 uint_least64_t vc_text2ccap(char const *, size_t len);
711 char const * vc_loccap2text(uint_least64_t *);
712 int vc_list2ccap(char const *, size_t len,
713 struct vc_err_listparser *err,
714 struct vc_ctx_caps *);
716 int vc_list2cflag(char const *, size_t len,
717 struct vc_err_listparser *err,
718 struct vc_ctx_flags *flags);
719 uint_least64_t vc_text2cflag(char const *, size_t len);
720 char const * vc_locflag2text(uint_least64_t *);
722 uint_least32_t vc_list2cflag_compat(char const *, size_t len,
723 struct vc_err_listparser *err);
724 uint_least32_t vc_text2cflag_compat(char const *, size_t len);
725 char const * vc_hicflag2text_compat(uint_least32_t);
727 int vc_text2cap(char const *);
728 char const * vc_cap2text(unsigned int);
731 int vc_list2nflag(char const *, size_t len,
732 struct vc_err_listparser *err,
733 struct vc_net_flags *flags);
734 uint_least64_t vc_text2nflag(char const *, size_t len);
735 char const * vc_lonflag2text(uint_least64_t *);
737 uint_least64_t vc_text2ncap(char const *, size_t len);
738 char const * vc_loncap2text(uint_least64_t *);
739 int vc_list2ncap(char const *, size_t len,
740 struct vc_err_listparser *err,
741 struct vc_net_caps *);
743 uint_least64_t vc_get_insecurebcaps() VC_ATTR_CONST;
744 inline static uint_least64_t vc_get_insecureccaps() {
745 return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP);
748 inline static int vc_setfilecontext(char const *filename, xid_t xid) {
749 return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
753 uint_least32_t vc_text2personalityflag(char const *str,
754 size_t len) VC_ATTR_NONNULL((1));
756 char const * vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
758 int vc_list2personalityflag(char const /*@in@*/ *,
760 uint_least32_t /*@out@*/ *personality,
761 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
763 uint_least32_t vc_str2personalitytype(char const /*@in@*/*,
764 size_t len) VC_ATTR_NONNULL((1));
766 /** \brief Returns the context of \c filename
769 * This function calls vc_get_iattr() with appropriate arguments to
770 * determine the context of \c filename. In error-case or when no context
771 * is assigned, \c VC_NOCTX will be returned. To differ between both cases,
772 * \c errno must be examined.
774 * \b WARNING: this function can modify \c errno although no error happened.
776 * \param filename The file to check
777 * \returns The assigned context, or VC_NOCTX when an error occured or no
778 * such assignment exists. \c errno will be 0 in the latter case */
779 xid_t vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
782 struct vc_set_sched {
783 uint_least32_t set_mask;
784 int_least32_t fill_rate;
785 int_least32_t interval;
786 int_least32_t fill_rate2;
787 int_least32_t interval2;
788 int_least32_t tokens;
789 int_least32_t tokens_min;
790 int_least32_t tokens_max;
791 int_least32_t priority_bias;
792 int_least32_t cpu_id;
793 int_least32_t bucket_id;
796 int vc_set_sched(xid_t xid, struct vc_set_sched const *);
799 struct vc_ctx_dlimit {
800 uint_least32_t space_used;
801 uint_least32_t space_total;
802 uint_least32_t inodes_used;
803 uint_least32_t inodes_total;
804 uint_least32_t reserved;
808 /** Add a disk limit to a file system. */
809 int vc_add_dlimit(char const *filename, xid_t xid,
810 uint_least32_t flags) VC_ATTR_NONNULL((1));
811 /** Remove a disk limit from a file system. */
812 int vc_rem_dlimit(char const *filename, xid_t xid,
813 uint_least32_t flags) VC_ATTR_NONNULL((1));
815 /** Set a disk limit. */
816 int vc_set_dlimit(char const *filename, xid_t xid,
817 uint_least32_t flags,
818 struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
819 /** Get a disk limit. */
820 int vc_get_dlimit(char const *filename, xid_t xid,
821 uint_least32_t flags,
822 struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
824 /** \brief Waits for the end of a context
827 int vc_wait_exit(xid_t xid);
829 typedef enum { vcFEATURE_VKILL, vcFEATURE_IATTR, vcFEATURE_RLIMIT,
830 vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
831 vcFEATURE_SCHED, vcFEATURE_VINFO, vcFEATURE_VHI,
832 vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
836 bool vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
837 bool vc_isSupportedString(char const *);
840 typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
841 vcTYPE_STATIC, vcTYPE_DYNAMIC }
844 vcXidType vc_getXIDType(xid_t xid) VC_ATTR_CONST;
846 /* The management part */
848 #define VC_LIMIT_VSERVER_NAME_LEN 1024
850 typedef enum { vcCFG_NONE, vcCFG_AUTO,
853 vcCFG_RECENT_FULL } vcCfgStyle;
856 /** Maps an xid given at '--xid' options to an xid_t */
857 xid_t vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
858 /** Maps a nid given at '--nid' options to a nid_t */
859 nid_t vc_nidopt2nid(char const *, bool honor_static, char const **err_info);
861 vcCfgStyle vc_getVserverCfgStyle(char const *id);
863 /** Resolves the name of the vserver. The result will be allocated and must
864 be freed by the caller. */
865 char * vc_getVserverName(char const *id, vcCfgStyle style);
867 /** Returns the path of the vserver configuration directory. When the given
868 * vserver does not exist, or when it does not have such a directory, NULL
869 * will be returned. Else, the result will be allocated and must be freed
871 char * vc_getVserverCfgDir(char const *id, vcCfgStyle style);
873 /** Returns the path of the configuration directory for the given
874 * application. The result will be allocated and must be freed by the
876 char * vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
878 /** Returns the path to the vserver root-directory. The result will be
879 * allocated and must be freed by the caller. */
880 char * vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
882 /** Returns the ctx of the given vserver. When vserver is not running and
883 * 'honor_static' is false, VC_NOCTX will be returned. Else, when
884 * 'honor_static' is true and a static assignment exists, those value will
885 * be returned. Else, the result will be VC_NOCTX.
887 * When 'is_running' is not null, the status of the vserver will be
888 * assigned to this variable. */
889 xid_t vc_getVserverCtx(char const *id, vcCfgStyle style,
890 bool honor_static, bool /*@null@*/ *is_running);
892 /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
893 be used as the directory holding the mapping-links; when NULL, the
894 default value will be assumed. The result will be allocated and must be
895 freed by the caller. */
896 char * vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
897 /*@null@*/char const *revdir);
899 int vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
900 char const *rhs, vcCfgStyle rhs_style);
902 #define vcSKEL_INTERFACES 1u
903 #define vcSKEL_PKGMGMT 2u
904 #define vcSKEL_FILESYSTEM 4u
906 /** Create a basic configuration skeleton for a vserver plus toplevel
907 * directories for pkgmanagemt and filesystem (when requested). */
908 int vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
916 #undef VC_ATTR_ALWAYSINLINE
917 #undef VC_ATTR_NORETURN
918 #undef VC_ATTR_UNUSED
919 #undef VC_ATTR_NONNULL