1 /* $Id: vserver.h 2415 2006-12-08 13:24:49Z dhozac $
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>
35 # define VC_ATTR_UNUSED __attribute__((__unused__))
36 # define VC_ATTR_NORETURN __attribute__((__noreturn__))
37 # define VC_ATTR_CONST __attribute__((__const__))
38 # define VC_ATTR_DEPRECATED __attribute__((__deprecated__))
39 # if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30300
40 # define VC_ATTR_NONNULL(ARGS) __attribute__((__nonnull__ ARGS))
41 # define VC_ATTR_ALWAYSINLINE __attribute__((__always_inline__))
43 # define VC_ATTR_NONNULL(ARGS)
44 # define VC_ATTR_ALWAYSINLINE
46 # if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30303
47 # define VC_ATTR_PURE __attribute__((__pure__))
52 # define VC_ATTR_NONNULL(ARGS)
53 # define VC_ATTR_UNUSED
54 # define VC_ATTR_NORETURN
55 # define VC_ATTR_ALWAYSINLINE
56 # define VC_ATTR_DEPRECATED
58 # define VC_ATTR_CONST
62 /** the value which is returned in error-case (no ctx found) */
63 #define VC_NOCTX ((xid_t)(-1))
64 #define VC_NOXID ((xid_t)(-1))
65 /** the value which means a random (the next free) ctx */
66 #define VC_DYNAMIC_XID ((xid_t)(-1))
67 /** the value which means the current ctx */
68 #define VC_SAMECTX ((xid_t)(-2))
70 #define VC_NONID ((nid_t)(-1))
71 #define VC_DYNAMIC_NID ((nid_t)(-1))
73 #define VC_LIM_INFINITY (~0ULL)
74 #define VC_LIM_KEEP (~1ULL)
76 #define VC_CDLIM_UNSET (0U)
77 #define VC_CDLIM_INFINITY (~0U)
78 #define VC_CDLIM_KEEP (~1U)
80 #ifndef S_CTX_INFO_LOCK
81 # define S_CTX_INFO_LOCK 1
84 #ifndef S_CTX_INFO_SCHED
85 # define S_CTX_INFO_SCHED 2
88 #ifndef S_CTX_INFO_NPROC
89 # define S_CTX_INFO_NPROC 4
92 #ifndef S_CTX_INFO_PRIVATE
93 # define S_CTX_INFO_PRIVATE 8
96 #ifndef S_CTX_INFO_INIT
97 # define S_CTX_INFO_INIT 16
100 #ifndef S_CTX_INFO_HIDEINFO
101 # define S_CTX_INFO_HIDEINFO 32
104 #ifndef S_CTX_INFO_ULIMIT
105 # define S_CTX_INFO_ULIMIT 64
108 #ifndef S_CTX_INFO_NAMESPACE
109 # define S_CTX_INFO_NAMESPACE 128
112 #define VC_CAP_CHOWN 0
113 #define VC_CAP_DAC_OVERRIDE 1
114 #define VC_CAP_DAC_READ_SEARCH 2
115 #define VC_CAP_FOWNER 3
116 #define VC_CAP_FSETID 4
117 #define VC_CAP_KILL 5
118 #define VC_CAP_SETGID 6
119 #define VC_CAP_SETUID 7
120 #define VC_CAP_SETPCAP 8
121 #define VC_CAP_LINUX_IMMUTABLE 9
122 #define VC_CAP_NET_BIND_SERVICE 10
123 #define VC_CAP_NET_BROADCAST 11
124 #define VC_CAP_NET_ADMIN 12
125 #define VC_CAP_NET_RAW 13
126 #define VC_CAP_IPC_LOCK 14
127 #define VC_CAP_IPC_OWNER 15
128 #define VC_CAP_SYS_MODULE 16
129 #define VC_CAP_SYS_RAWIO 17
130 #define VC_CAP_SYS_CHROOT 18
131 #define VC_CAP_SYS_PTRACE 19
132 #define VC_CAP_SYS_PACCT 20
133 #define VC_CAP_SYS_ADMIN 21
134 #define VC_CAP_SYS_BOOT 22
135 #define VC_CAP_SYS_NICE 23
136 #define VC_CAP_SYS_RESOURCE 24
137 #define VC_CAP_SYS_TIME 25
138 #define VC_CAP_SYS_TTY_CONFIG 26
139 #define VC_CAP_MKNOD 27
140 #define VC_CAP_LEASE 28
141 #define VC_CAP_AUDIT_WRITE 29
142 #define VC_CAP_AUDIT_CONTROL 30
144 #define VC_IMMUTABLE_FILE_FL 0x0000010lu
145 #define VC_IMMUTABLE_LINK_FL 0x0808000lu
146 #define VC_IMMUTABLE_ALL (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
148 #define VC_IATTR_XID 0x01000000u
150 #define VC_IATTR_ADMIN 0x00000001u
151 #define VC_IATTR_WATCH 0x00000002u
152 #define VC_IATTR_HIDE 0x00000004u
153 #define VC_IATTR_FLAGS 0x00000007u
155 #define VC_IATTR_BARRIER 0x00010000u
156 #define VC_IATTR_IUNLINK 0x00020000u
157 #define VC_IATTR_IMMUTABLE 0x00040000u
161 #define VC_VXF_INFO_LOCK 0x00000001ull
162 #define VC_VXF_INFO_NPROC 0x00000004ull
163 #define VC_VXF_INFO_PRIVATE 0x00000008ull
164 #define VC_VXF_INFO_INIT 0x00000010ull
166 #define VC_VXF_INFO_HIDEINFO 0x00000020ull
167 #define VC_VXF_INFO_ULIMIT 0x00000040ull
168 #define VC_VXF_INFO_NAMESPACE 0x00000080ull
170 #define VC_VXF_SCHED_HARD 0x00000100ull
171 #define VC_VXF_SCHED_PRIO 0x00000200ull
172 #define VC_VXF_SCHED_PAUSE 0x00000400ull
173 #define VC_VXF_SCHED_SHARE 0x00000800ull
175 #define VC_VXF_VIRT_MEM 0x00010000ull
176 #define VC_VXF_VIRT_UPTIME 0x00020000ull
177 #define VC_VXF_VIRT_CPU 0x00040000ull
178 #define VC_VXF_VIRT_LOAD 0x00080000ull
179 #define VC_VXF_VIRT_TIME 0x00100000ull
181 #define VC_VXF_HIDE_MOUNT 0x01000000ull
182 #define VC_VXF_HIDE_NETIF 0x02000000ull
183 #define VC_VXF_HIDE_VINFO 0x04000000ull
185 #define VC_VXF_STATE_SETUP (1ULL<<32)
186 #define VC_VXF_STATE_INIT (1ULL<<33)
187 #define VC_VXF_STATE_ADMIN (1ULL<<34)
189 #define VC_VXF_SC_HELPER (1ULL<<36)
190 #define VC_VXF_REBOOT_KILL (1ULL<<37)
191 #define VC_VXF_PERSISTENT (1ULL<<38)
193 #define VC_VXF_FORK_RSS (1ULL<<48)
194 #define VC_VXF_PROLIFIC (1ULL<<49)
196 #define VC_VXF_IGNEG_NICE (1ULL<<52)
200 #define VC_VXC_SET_UTSNAME 0x00000001ull
201 #define VC_VXC_SET_RLIMIT 0x00000002ull
203 #define VC_VXC_RAW_ICMP 0x00000100ull
204 #define VC_VXC_SYSLOG 0x00001000ull
206 #define VC_VXC_SECURE_MOUNT 0x00010000ull
207 #define VC_VXC_SECURE_REMOUNT 0x00020000ull
208 #define VC_VXC_BINARY_MOUNT 0x00040000ull
210 #define VC_VXC_QUOTA_CTL 0x00100000ull
211 #define VC_VXC_ADMIN_MAPPER 0x00200000ull
212 #define VC_VXC_ADMIN_CLOOP 0x00400000ull
215 // the scheduler flags
216 #define VC_VXSM_FILL_RATE 0x0001
217 #define VC_VXSM_INTERVAL 0x0002
218 #define VC_VXSM_FILL_RATE2 0x0004
219 #define VC_VXSM_INTERVAL2 0x0008
220 #define VC_VXSM_TOKENS 0x0010
221 #define VC_VXSM_TOKENS_MIN 0x0020
222 #define VC_VXSM_TOKENS_MAX 0x0040
223 #define VC_VXSM_PRIO_BIAS 0x0100
224 #define VC_VXSM_CPU_ID 0x1000
225 #define VC_VXSM_BUCKET_ID 0x2000
227 #define VC_VXSM_IDLE_TIME 0x0200
228 #define VC_VXSM_FORCE 0x0400
230 #define VC_VXSM_V3_MASK 0x0173
234 #define VC_NXF_INFO_LOCK 0x00000001ull
235 #define VC_NXF_INFO_PRIVATE 0x00000008ull
237 #define VC_NXF_SINGLE_IP 0x00000100ull
239 #define VC_NXF_HIDE_NETIF 0x02000000ull
241 #define VC_NXF_STATE_SETUP (1ULL<<32)
242 #define VC_NXF_STATE_ADMIN (1ULL<<34)
244 #define VC_NXF_SC_HELPER (1ULL<<36)
245 #define VC_NXF_PERSISTENT (1ULL<<38)
248 // the vserver specific limits
249 #define VC_VLIMIT_NSOCK 16
250 #define VC_VLIMIT_OPENFD 17
251 #define VC_VLIMIT_ANON 18
252 #define VC_VLIMIT_SHMEM 19
253 #define VC_VLIMIT_SEMARY 20
254 #define VC_VLIMIT_NSEMS 21
255 #define VC_VLIMIT_DENTRY 22
256 #define VC_VLIMIT_MAPPED 23
259 // the VCI bit values
260 #define VC_VCI_NO_DYNAMIC (1 << 0)
261 #define VC_VCI_SPACES (1 << 10)
265 # define CLONE_NEWNS 0x00020000
268 # define CLONE_NEWUTS 0x04000000
271 # define CLONE_NEWIPC 0x08000000
276 #define VC_BAD_PERSONALITY ((uint_least32_t)(-1))
279 /** \defgroup syscalls Syscall wrappers
280 * Functions which are calling the vserver syscall directly. */
282 /** \defgroup helper Helper functions
283 * Functions which are doing general helper tasks like parameter parsing. */
285 /** \typedef an_unsigned_integer_type xid_t
286 * The identifier of a context. */
289 typedef an_unsigned_integer_type xid_t;
290 typedef an_unsigned_integer_type nid_t;
297 struct vc_ip_mask_pair {
302 /** \brief The generic vserver syscall
305 * This function executes the generic vserver syscall. It uses the
306 * correct syscallnumber (which may differ between the different
309 * \param cmd the command to be executed
310 * \param xid the xid on which the cmd shall be applied
311 * \param data additional arguments; depends on \c cmd
312 * \returns depends on \c cmd; usually, -1 stands for an error
314 int vc_syscall(uint32_t cmd, xid_t xid, void *data);
316 /** \brief Returns the version of the current kernel API.
318 * \returns The versionnumber of the kernel API
320 int vc_get_version();
322 /** \brief Returns the kernel configuration bits
324 * \returns The kernel configuration bits
328 /** \brief Moves current process into a context
331 * Puts current process into context \a ctx, removes the capabilities
332 * given in \a remove_cap and sets \a flags.
334 * \param ctx The new context; special values for are
335 * - VC_SAMECTX which means the current context (just for changing caps and flags)
336 * - VC_DYNAMIC_XID which means the next free context; this value can be used by
337 * ordinary users also
338 * \param remove_cap The linux capabilities which will be \b removed.
339 * \param flags Special flags which will be set.
341 * \returns The new context-id, or VC_NOCTX on errors; \c errno
342 * will be set appropriately
344 * See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
345 xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
347 /** \brief Sets the ipv4root information.
349 * \pre \a nb < NB_IPV4ROOT && \a ips != 0 */
350 int vc_set_ipv4root(uint32_t bcast, size_t nb,
351 struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
353 /** \brief Returns the value of NB_IPV4ROOT.
356 * This function returns the value of NB_IPV4ROOT which was used when the
357 * library was built, but \b not the value which is used by the currently
359 size_t vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
361 /** \brief Creates a context without starting it.
364 * This functions initializes a new context. When already in a freshly
365 * created context, this old context will be discarded.
367 * \param xid The new context; special values are:
368 * - VC_DYNAMIC_XID which means to create a dynamic context
370 * \returns the xid of the created context, or VC_NOCTX on errors. \c errno
371 * will be set appropriately. */
372 xid_t vc_ctx_create(xid_t xid);
374 /** \brief Moves the current process into the specified context.
377 * \param xid The new context
378 * \returns 0 on success, -1 on errors */
379 int vc_ctx_migrate(xid_t xid);
381 /** \brief Statistics about a context */
383 uint_least32_t usecnt; ///< number of uses
384 uint_least32_t tasks; ///< number of tasks
387 /** \brief Get some statistics about a context.
390 * \param xid The context to get stats about
391 * \param stat Where to store the result
393 * \returns 0 on success, -1 on errors. */
394 int vc_ctx_stat(xid_t xid, struct vc_ctx_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
396 /** \brief Contains further statistics about a context. */
397 struct vc_virt_stat {
398 uint_least64_t offset;
399 uint_least32_t uptime;
400 uint_least32_t nr_threads;
401 uint_least32_t nr_running;
402 uint_least32_t nr_uninterruptible;
403 uint_least32_t nr_onhold;
404 uint_least32_t nr_forks;
405 uint_least32_t load[3];
408 /** \brief Get more statistics about a context.
411 * \param xid The context to get stats about
412 * \param stat Where to store the result
414 * \returns 0 on success, -1 on errors. */
415 int vc_virt_stat(xid_t xid, struct vc_virt_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
417 /* rlimit related functions */
419 /** \brief The type which is used for a single limit value.
422 * - VC_LIM_INFINITY ... which is the infinite value
423 * - VC_LIM_KEEP ... which is used to mark values which shall not be
424 * modified by the vc_set_rlimit() operation.
426 * Else, the interpretation of the value depends on the corresponding
427 * resource; it might be bytes, pages, seconds or litres of beer. */
428 typedef uint_least64_t vc_limit_t;
430 /** \brief The limits of a resources.
432 * This is a triple consisting of a minimum, soft and hardlimit. */
434 vc_limit_t min; ///< the guaranted minimum of a resources
435 vc_limit_t soft; ///< the softlimit of a resource
436 vc_limit_t hard; ///< the absolute hardlimit of a resource
439 /** \brief Masks describing the supported limits. */
440 struct vc_rlimit_mask {
441 uint_least32_t min; ///< masks the resources supporting a minimum limit
442 uint_least32_t soft; ///< masks the resources supporting a soft limit
443 uint_least32_t hard; ///< masks the resources supporting a hard limit
446 /** \brief Statistics for a resource limit. */
447 struct vc_rlimit_stat {
448 uint_least32_t hits; ///< number of hits on the limit
449 uint_least64_t value; ///< current value
450 uint_least64_t minimum; ///< minimum value observed
451 uint_least64_t maximum; ///< maximum value observed
454 /** \brief Returns the limits of \a resource.
457 * \param xid The id of the context
458 * \param resource The resource which will be queried
459 * \param lim The result which will be filled with the limits
461 * \returns 0 on success, and -1 on errors. */
462 int vc_get_rlimit(xid_t xid, int resource,
463 struct vc_rlimit /*@out@*/ *lim) VC_ATTR_NONNULL((3));
464 /** \brief Sets the limits of \a resource.
467 * \param xid The id of the context
468 * \param resource The resource which will be queried
469 * \param lim The new limits
471 * \returns 0 on success, and -1 on errors. */
472 int vc_set_rlimit(xid_t xid, int resource,
473 struct vc_rlimit const /*@in@*/ *lim) VC_ATTR_NONNULL((3));
474 int vc_get_rlimit_mask(xid_t xid,
475 struct vc_rlimit_mask *lim) VC_ATTR_NONNULL((2));
476 /** \brief Returns the current stats of \a resource.
479 * \param xid The id of the context
480 * \param resource The resource which will be queried
481 * \param stat The result which will be filled with the stats
483 * \returns 0 on success, and -1 on errors. */
484 int vc_rlimit_stat(xid_t xid, int resource,
485 struct vc_rlimit_stat /*@out@*/ *stat) VC_ATTR_NONNULL((3));
486 /** \brief Resets the minimum and maximum observed values for all resources.
489 * \param xid The id of the context
491 * \returns 0 on success, and -1 on errors. */
492 int vc_reset_minmax(xid_t xid);
493 /** \brief Parses a string describing a limit
496 * This function parses \a str and interprets special words like \p "inf"
497 * or suffixes. Valid suffixes are
503 * \param str The string which shall be parsed
504 * \param res Will be filled with the interpreted value; in errorcase,
505 * this value is undefined.
507 * \returns \a true, iff the string \a str could be parsed. \a res will
508 * be filled with the interpreted value in this case.
510 * \pre \a str!=0 && \a res!=0
512 bool vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res) VC_ATTR_NONNULL((1,2));
515 /** \brief Sends a signal to a context/pid
518 * Special values for \a pid are:
519 * - -1 which means every process in ctx except the init-process
520 * - 0 which means every process in ctx inclusive the init-process */
521 int vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
528 nid_t vc_get_task_nid(pid_t pid);
529 int vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
531 typedef enum { vcNET_IPV4=1, vcNET_IPV6=2,
532 vcNET_IPV4B=0x101, vcNET_IPV6B=0x102,
533 vcNET_ANY=~0 } vc_net_nx_type;
542 nid_t vc_net_create(nid_t nid);
543 int vc_net_migrate(nid_t nid);
545 int vc_net_add(nid_t nid, struct vc_net_nx const *info);
546 int vc_net_remove(nid_t nid, struct vc_net_nx const *info);
548 struct vc_net_flags {
549 uint_least64_t flagword;
553 int vc_get_nflags(nid_t, struct vc_net_flags *);
554 int vc_set_nflags(nid_t, struct vc_net_flags const *);
558 uint_least64_t ncaps;
559 uint_least64_t cmask;
562 int vc_get_ncaps(nid_t, struct vc_net_caps *);
563 int vc_set_ncaps(nid_t, struct vc_net_caps const *);
568 int vc_set_iattr(char const *filename, xid_t xid,
569 uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
571 /** \brief Returns information about attributes and assigned context of a file.
574 * This function returns the VC_IATTR_XXX flags and about the assigned
575 * context of a file. To request an information, the appropriate bit in
576 * \c mask must be set and the corresponding parameter (\a xid or \a
577 * flags) must not be NULL.
579 * E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
580 * set in \a mask, and \a xid must point to valid memory.
582 * Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
583 * \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
585 * \param filename The name of the file whose attributes shall be determined.
587 * \param xid When non-zero and the VC_IATTR_XID bit is set in \a mask,
588 * the assigned context of \a filename will be stored there.
589 * \param flags When non-zero, a bitmask of current attributes will be
590 * stored there. These attributes must be requested explicitly
591 * by setting the appropriate bit in \a mask
592 * \param mask Points to a bitmask which tells which attributes shall be
593 * determined. On return, it will masquerade the attributes
594 * which were determined.
596 * \pre mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
597 int vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
598 uint_least32_t * /*@null@*/ flags,
599 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
606 /** \brief Returns the context of the given process.
609 * \param pid the process-id whose xid shall be determined;
610 * pid==0 means the current process.
611 * \returns the xid of process \c pid or -1 on errors
613 xid_t vc_get_task_xid(pid_t pid);
614 int vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
617 typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
618 vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
619 vcVHI_DOMAINNAME } vc_uts_type;
621 int vc_set_vhi_name(xid_t xid, vc_uts_type type,
622 char const *val, size_t len) VC_ATTR_NONNULL((3));
623 int vc_get_vhi_name(xid_t xid, vc_uts_type type,
624 char *val, size_t len) VC_ATTR_NONNULL((3));
626 /** Returns true iff \a xid is a dynamic xid */
627 bool vc_is_dynamic_xid(xid_t xid);
629 int vc_enter_namespace(xid_t xid, uint_least64_t mask);
630 int vc_set_namespace(xid_t xid, uint_least64_t mask);
631 int vc_cleanup_namespace();
632 uint_least64_t vc_get_space_mask();
635 /** \brief Flags of process-contexts
637 struct vc_ctx_flags {
638 /** \brief Mask of set context flags */
639 uint_least64_t flagword;
640 /** \brief Mask of set and unset context flags when used by set
641 * operations, or modifiable flags when used by get
646 /** \brief Capabilities of process-contexts */
648 /** \brief Mask of set common system capabilities */
649 uint_least64_t bcaps;
650 /** \brief Mask of set and unset common system capabilities when used by
651 * set operations, or the modifiable capabilities when used by
653 uint_least64_t bmask;
654 /** \brief Mask of set process context capabilities */
655 uint_least64_t ccaps;
656 /** \brief Mask of set and unset process context capabilities when used
657 * by set operations, or the modifiable capabilities when used
658 * by get operations */
659 uint_least64_t cmask;
662 /** \brief Information about parsing errors
665 struct vc_err_listparser {
666 char const *ptr; ///< Pointer to the first character of an erroneous string
667 size_t len; ///< Length of the erroneous string
670 int vc_get_cflags(xid_t xid, struct vc_ctx_flags *) VC_ATTR_NONNULL((2));
671 int vc_set_cflags(xid_t xid, struct vc_ctx_flags const *) VC_ATTR_NONNULL((2));
673 int vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
674 int vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
676 /** \brief Converts a single string into bcapability
679 * \param str The string to be parsed;
680 * both "CAP_xxx" and "xxx" will be accepted
681 * \param len The length of the string, or \c 0 for automatic detection
683 * \returns 0 on error; a bitmask on success
686 uint_least64_t vc_text2bcap(char const *str, size_t len);
688 /** \brief Converts the lowest bit of a bcapability or the entire value
689 * (when possible) to a textual representation
692 * \param val The string to be converted; on success, the detected bit(s)
693 * will be unset, in errorcase only the lowest set bit
695 * \returns A textual representation of \a val resp. of its lowest set bit;
696 * or \c NULL in errorcase.
698 * \post \a *val<sub>old</sub> \c != 0 \c <-->
699 * \a *val<sub>old</sub> > \a *val<sub>new</sub>
700 * \post \a *val<sub>old</sub> \c == 0 \c ---> \a result == 0
702 char const * vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
704 /** \brief Converts a string into a bcapability-bitmask
707 * Syntax of \a str: \verbinclude list2xxx.syntax
709 * When the \c `~' prefix is used, the bits will be unset and a `~' after
710 * another `~' will cancel both ones. The \c `^' prefix specifies a
711 * bitnumber instead of a bitmask.
713 * "literal name" is everything which will be accepted by the
714 * vc_text2bcap() function. The special values for \c NAME will be
715 * recognized case insensitively
717 * \param str The string to be parsed
718 * \param len The length of the string, or \c 0 for automatic detection
719 * \param err Pointer to a structure for error-information, or \c NULL.
720 * \param cap Pointer to a vc_ctx_caps structure holding the results;
721 * only the \a bcaps and \a bmask fields will be changed and
722 * already set values will not be honored. When an error
723 * occured, \a cap will have the value of all processed valid
726 * \returns 0 on success, -1 on error. In error case, \a err will hold
727 * position and length of the first not understood BCAP part
728 * \pre \a str != 0 && \a cap != 0;
729 * \a cap->bcaps and \a cap->bmask must be initialized
731 int vc_list2bcap(char const *str, size_t len,
732 struct vc_err_listparser *err,
733 struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
735 uint_least64_t vc_text2ccap(char const *, size_t len);
736 char const * vc_loccap2text(uint_least64_t *);
737 int vc_list2ccap(char const *, size_t len,
738 struct vc_err_listparser *err,
739 struct vc_ctx_caps *);
741 int vc_list2cflag(char const *, size_t len,
742 struct vc_err_listparser *err,
743 struct vc_ctx_flags *flags);
744 uint_least64_t vc_text2cflag(char const *, size_t len);
745 char const * vc_locflag2text(uint_least64_t *);
747 uint_least32_t vc_list2cflag_compat(char const *, size_t len,
748 struct vc_err_listparser *err);
749 uint_least32_t vc_text2cflag_compat(char const *, size_t len);
750 char const * vc_hicflag2text_compat(uint_least32_t);
752 int vc_text2cap(char const *);
753 char const * vc_cap2text(unsigned int);
756 int vc_list2nflag(char const *, size_t len,
757 struct vc_err_listparser *err,
758 struct vc_net_flags *flags);
759 uint_least64_t vc_text2nflag(char const *, size_t len);
760 char const * vc_lonflag2text(uint_least64_t *);
762 uint_least64_t vc_text2ncap(char const *, size_t len);
763 char const * vc_loncap2text(uint_least64_t *);
764 int vc_list2ncap(char const *, size_t len,
765 struct vc_err_listparser *err,
766 struct vc_net_caps *);
768 uint_least64_t vc_get_insecurebcaps() VC_ATTR_CONST;
769 inline static uint_least64_t vc_get_insecureccaps() {
770 return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP);
773 inline static int vc_setfilecontext(char const *filename, xid_t xid) {
774 return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
778 uint_least32_t vc_text2personalityflag(char const *str,
779 size_t len) VC_ATTR_NONNULL((1));
781 char const * vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
783 int vc_list2personalityflag(char const /*@in@*/ *,
785 uint_least32_t /*@out@*/ *personality,
786 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
788 uint_least32_t vc_str2personalitytype(char const /*@in@*/*,
789 size_t len) VC_ATTR_NONNULL((1));
791 /** \brief Returns the context of \c filename
794 * This function calls vc_get_iattr() with appropriate arguments to
795 * determine the context of \c filename. In error-case or when no context
796 * is assigned, \c VC_NOCTX will be returned. To differ between both cases,
797 * \c errno must be examined.
799 * \b WARNING: this function can modify \c errno although no error happened.
801 * \param filename The file to check
802 * \returns The assigned context, or VC_NOCTX when an error occured or no
803 * such assignment exists. \c errno will be 0 in the latter case */
804 xid_t vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
807 struct vc_set_sched {
808 uint_least32_t set_mask;
809 int_least32_t fill_rate;
810 int_least32_t interval;
811 int_least32_t fill_rate2;
812 int_least32_t interval2;
813 int_least32_t tokens;
814 int_least32_t tokens_min;
815 int_least32_t tokens_max;
816 int_least32_t priority_bias;
817 int_least32_t cpu_id;
818 int_least32_t bucket_id;
821 int vc_set_sched(xid_t xid, struct vc_set_sched const *);
824 struct vc_ctx_dlimit {
825 uint_least32_t space_used;
826 uint_least32_t space_total;
827 uint_least32_t inodes_used;
828 uint_least32_t inodes_total;
829 uint_least32_t reserved;
833 /** Add a disk limit to a file system. */
834 int vc_add_dlimit(char const *filename, xid_t xid,
835 uint_least32_t flags) VC_ATTR_NONNULL((1));
836 /** Remove a disk limit from a file system. */
837 int vc_rem_dlimit(char const *filename, xid_t xid,
838 uint_least32_t flags) VC_ATTR_NONNULL((1));
840 /** Set a disk limit. */
841 int vc_set_dlimit(char const *filename, xid_t xid,
842 uint_least32_t flags,
843 struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
844 /** Get a disk limit. */
845 int vc_get_dlimit(char const *filename, xid_t xid,
846 uint_least32_t flags,
847 struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
849 /** \brief Waits for the end of a context
852 int vc_wait_exit(xid_t xid);
854 typedef enum { vcFEATURE_VKILL, vcFEATURE_IATTR, vcFEATURE_RLIMIT,
855 vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
856 vcFEATURE_SCHED, vcFEATURE_VINFO, vcFEATURE_VHI,
857 vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
861 bool vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
862 bool vc_isSupportedString(char const *);
865 typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
866 vcTYPE_STATIC, vcTYPE_DYNAMIC }
869 vcXidType vc_getXIDType(xid_t xid) VC_ATTR_CONST;
871 /* The management part */
873 #define VC_LIMIT_VSERVER_NAME_LEN 1024
875 typedef enum { vcCFG_NONE, vcCFG_AUTO,
878 vcCFG_RECENT_FULL } vcCfgStyle;
881 /** Maps an xid given at '--xid' options to an xid_t */
882 xid_t vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
883 /** Maps a nid given at '--nid' options to a nid_t */
884 nid_t vc_nidopt2nid(char const *, bool honor_static, char const **err_info);
886 vcCfgStyle vc_getVserverCfgStyle(char const *id);
888 /** Resolves the name of the vserver. The result will be allocated and must
889 be freed by the caller. */
890 char * vc_getVserverName(char const *id, vcCfgStyle style);
892 /** Returns the path of the vserver configuration directory. When the given
893 * vserver does not exist, or when it does not have such a directory, NULL
894 * will be returned. Else, the result will be allocated and must be freed
896 char * vc_getVserverCfgDir(char const *id, vcCfgStyle style);
898 /** Returns the path of the configuration directory for the given
899 * application. The result will be allocated and must be freed by the
901 char * vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
903 /** Returns the path to the vserver root-directory. The result will be
904 * allocated and must be freed by the caller. */
905 char * vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
907 /** Returns the ctx of the given vserver. When vserver is not running and
908 * 'honor_static' is false, VC_NOCTX will be returned. Else, when
909 * 'honor_static' is true and a static assignment exists, those value will
910 * be returned. Else, the result will be VC_NOCTX.
912 * When 'is_running' is not null, the status of the vserver will be
913 * assigned to this variable. */
914 xid_t vc_getVserverCtx(char const *id, vcCfgStyle style,
915 bool honor_static, bool /*@null@*/ *is_running);
917 /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
918 be used as the directory holding the mapping-links; when NULL, the
919 default value will be assumed. The result will be allocated and must be
920 freed by the caller. */
921 char * vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
922 /*@null@*/char const *revdir);
924 int vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
925 char const *rhs, vcCfgStyle rhs_style);
927 #define vcSKEL_INTERFACES 1u
928 #define vcSKEL_PKGMGMT 2u
929 #define vcSKEL_FILESYSTEM 4u
931 /** Create a basic configuration skeleton for a vserver plus toplevel
932 * directories for pkgmanagemt and filesystem (when requested). */
933 int vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
941 #undef VC_ATTR_ALWAYSINLINE
942 #undef VC_ATTR_NORETURN
943 #undef VC_ATTR_UNUSED
944 #undef VC_ATTR_NONNULL