1 /* $Id: vserver.h 2501 2007-02-20 17:33:35Z 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
229 #define VC_VXSM_MSEC 0x4000
231 #define VC_VXSM_V3_MASK 0x0173
235 #define VC_NXF_INFO_LOCK 0x00000001ull
236 #define VC_NXF_INFO_PRIVATE 0x00000008ull
238 #define VC_NXF_SINGLE_IP 0x00000100ull
240 #define VC_NXF_HIDE_NETIF 0x02000000ull
242 #define VC_NXF_STATE_SETUP (1ULL<<32)
243 #define VC_NXF_STATE_ADMIN (1ULL<<34)
245 #define VC_NXF_SC_HELPER (1ULL<<36)
246 #define VC_NXF_PERSISTENT (1ULL<<38)
249 // the vserver specific limits
250 #define VC_VLIMIT_NSOCK 16
251 #define VC_VLIMIT_OPENFD 17
252 #define VC_VLIMIT_ANON 18
253 #define VC_VLIMIT_SHMEM 19
254 #define VC_VLIMIT_SEMARY 20
255 #define VC_VLIMIT_NSEMS 21
256 #define VC_VLIMIT_DENTRY 22
257 #define VC_VLIMIT_MAPPED 23
260 // the VCI bit values
261 #define VC_VCI_NO_DYNAMIC (1 << 0)
262 #define VC_VCI_SPACES (1 << 10)
265 // the device mapping flags
266 #define VC_DATTR_CREATE 0x00000001
267 #define VC_DATTR_OPEN 0x00000002
269 #define VC_DATTR_REMAP 0x00000010
272 // the process context migration flags
273 #define VC_VXM_SET_INIT 0x00000001
274 #define VC_VXM_SET_REAPER 0x00000002
278 # define CLONE_NEWNS 0x00020000
281 # define CLONE_NEWUTS 0x04000000
284 # define CLONE_NEWIPC 0x08000000
289 #define VC_BAD_PERSONALITY ((uint_least32_t)(-1))
292 /** \defgroup syscalls Syscall wrappers
293 * Functions which are calling the vserver syscall directly. */
295 /** \defgroup helper Helper functions
296 * Functions which are doing general helper tasks like parameter parsing. */
298 /** \typedef an_unsigned_integer_type xid_t
299 * The identifier of a context. */
302 typedef an_unsigned_integer_type xid_t;
303 typedef an_unsigned_integer_type nid_t;
310 /** \brief The generic vserver syscall
313 * This function executes the generic vserver syscall. It uses the
314 * correct syscallnumber (which may differ between the different
317 * \param cmd the command to be executed
318 * \param xid the xid on which the cmd shall be applied
319 * \param data additional arguments; depends on \c cmd
320 * \returns depends on \c cmd; usually, -1 stands for an error
322 int vc_syscall(uint32_t cmd, xid_t xid, void *data);
324 /** \brief Returns the version of the current kernel API.
326 * \returns The versionnumber of the kernel API
328 int vc_get_version();
330 /** \brief Returns the kernel configuration bits
332 * \returns The kernel configuration bits
336 /** \brief Moves current process into a context
339 * Puts current process into context \a ctx, removes the capabilities
340 * given in \a remove_cap and sets \a flags.
342 * \param ctx The new context; special values for are
343 * - VC_SAMECTX which means the current context (just for changing caps and flags)
344 * - VC_DYNAMIC_XID which means the next free context; this value can be used by
345 * ordinary users also
346 * \param remove_cap The linux capabilities which will be \b removed.
347 * \param flags Special flags which will be set.
349 * \returns The new context-id, or VC_NOCTX on errors; \c errno
350 * will be set appropriately
352 * See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
353 xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
355 struct vc_ip_mask_pair {
360 /** \brief Sets the ipv4root information.
362 * \pre \a nb < NB_IPV4ROOT && \a ips != 0 */
363 int vc_set_ipv4root(uint32_t bcast, size_t nb,
364 struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
366 /** \brief Returns the value of NB_IPV4ROOT.
369 * This function returns the value of NB_IPV4ROOT which was used when the
370 * library was built, but \b not the value which is used by the currently
372 size_t vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
374 /* process context */
375 /** \brief Flags of process-contexts
377 struct vc_ctx_flags {
378 /** \brief Mask of set context flags */
379 uint_least64_t flagword;
380 /** \brief Mask of set and unset context flags when used by set
381 * operations, or modifiable flags when used by get
386 /** \brief Creates a context without starting it.
389 * This functions initializes a new context. When already in a freshly
390 * created context, this old context will be discarded.
392 * \param xid The new context; special values are:
393 * - VC_DYNAMIC_XID which means to create a dynamic context
395 * \returns the xid of the created context, or VC_NOCTX on errors. \c errno
396 * will be set appropriately. */
397 xid_t vc_ctx_create(xid_t xid);
399 /** \brief Moves the current process into the specified context.
402 * \param xid The new context
403 * \param flags The flags, see VC_VXM_*
404 * \returns 0 on success, -1 on errors */
405 int vc_ctx_migrate(xid_t xid, uint_least64_t flags);
407 /** \brief Statistics about a context */
409 uint_least32_t usecnt; ///< number of uses
410 uint_least32_t tasks; ///< number of tasks
413 /** \brief Get some statistics about a context.
416 * \param xid The context to get stats about
417 * \param stat Where to store the result
419 * \returns 0 on success, -1 on errors. */
420 int vc_ctx_stat(xid_t xid, struct vc_ctx_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
422 /** \brief Contains further statistics about a context. */
423 struct vc_virt_stat {
424 uint_least64_t offset;
425 uint_least64_t uptime;
426 uint_least32_t nr_threads;
427 uint_least32_t nr_running;
428 uint_least32_t nr_uninterruptible;
429 uint_least32_t nr_onhold;
430 uint_least32_t nr_forks;
431 uint_least32_t load[3];
434 /** \brief Get more statistics about a context.
437 * \param xid The context to get stats about
438 * \param stat Where to store the result
440 * \returns 0 on success, -1 on errors. */
441 int vc_virt_stat(xid_t xid, struct vc_virt_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
443 /** \brief Sends a signal to a context/pid
446 * Special values for \a pid are:
447 * - -1 which means every process in ctx except the init-process
448 * - 0 which means every process in ctx inclusive the init-process */
449 int vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
451 int vc_get_cflags(xid_t xid, struct vc_ctx_flags /*@out@*/ *) VC_ATTR_NONNULL((2));
452 int vc_set_cflags(xid_t xid, struct vc_ctx_flags /*@in@*/ const *) VC_ATTR_NONNULL((2));
454 /** \brief Capabilities of process-contexts */
456 /** \brief Mask of set common system capabilities */
457 uint_least64_t bcaps;
458 /** \brief Mask of set and unset common system capabilities when used by
459 * set operations, or the modifiable capabilities when used by
461 uint_least64_t bmask;
462 /** \brief Mask of set process context capabilities */
463 uint_least64_t ccaps;
464 /** \brief Mask of set and unset process context capabilities when used
465 * by set operations, or the modifiable capabilities when used
466 * by get operations */
467 uint_least64_t cmask;
470 int vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
471 int vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
478 int vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
480 /** \brief Returns the context of the given process.
483 * \param pid the process-id whose xid shall be determined;
484 * pid==0 means the current process.
485 * \returns the xid of process \c pid or -1 on errors
487 xid_t vc_get_task_xid(pid_t pid);
489 /** \brief Waits for the end of a context
492 int vc_wait_exit(xid_t xid);
494 /* rlimit related functions */
496 /** \brief The type which is used for a single limit value.
499 * - VC_LIM_INFINITY ... which is the infinite value
500 * - VC_LIM_KEEP ... which is used to mark values which shall not be
501 * modified by the vc_set_rlimit() operation.
503 * Else, the interpretation of the value depends on the corresponding
504 * resource; it might be bytes, pages, seconds or litres of beer. */
505 typedef uint_least64_t vc_limit_t;
507 /** \brief Masks describing the supported limits. */
508 struct vc_rlimit_mask {
509 uint_least32_t min; ///< masks the resources supporting a minimum limit
510 uint_least32_t soft; ///< masks the resources supporting a soft limit
511 uint_least32_t hard; ///< masks the resources supporting a hard limit
514 /** \brief Returns the limits supported by the kernel */
515 int vc_get_rlimit_mask(xid_t xid,
516 struct vc_rlimit_mask /*@out@*/ *lim) VC_ATTR_NONNULL((2));
518 /** \brief The limits of a resources.
520 * This is a triple consisting of a minimum, soft and hardlimit. */
522 vc_limit_t min; ///< the guaranted minimum of a resources
523 vc_limit_t soft; ///< the softlimit of a resource
524 vc_limit_t hard; ///< the absolute hardlimit of a resource
527 /** \brief Returns the limits of \a resource.
530 * \param xid The id of the context
531 * \param resource The resource which will be queried
532 * \param lim The result which will be filled with the limits
534 * \returns 0 on success, and -1 on errors. */
535 int vc_get_rlimit(xid_t xid, int resource,
536 struct vc_rlimit /*@out@*/ *lim) VC_ATTR_NONNULL((3));
537 /** \brief Sets the limits of \a resource.
540 * \param xid The id of the context
541 * \param resource The resource which will be queried
542 * \param lim The new limits
544 * \returns 0 on success, and -1 on errors. */
545 int vc_set_rlimit(xid_t xid, int resource,
546 struct vc_rlimit const /*@in@*/ *lim) VC_ATTR_NONNULL((3));
548 /** \brief Statistics for a resource limit. */
549 struct vc_rlimit_stat {
550 uint_least32_t hits; ///< number of hits on the limit
551 vc_limit_t value; ///< current value
552 vc_limit_t minimum; ///< minimum value observed
553 vc_limit_t maximum; ///< maximum value observed
556 /** \brief Returns the current stats of \a resource.
559 * \param xid The id of the context
560 * \param resource The resource which will be queried
561 * \param stat The result which will be filled with the stats
563 * \returns 0 on success, and -1 on errors. */
564 int vc_rlimit_stat(xid_t xid, int resource,
565 struct vc_rlimit_stat /*@out@*/ *stat) VC_ATTR_NONNULL((3));
567 /** \brief Resets the minimum and maximum observed values of all resources.
570 * \param xid The id of the context
572 * \returns 0 on success, and -1 on errors. */
573 int vc_reset_minmax(xid_t xid);
575 /** \brief Parses a string describing a limit
578 * This function parses \a str and interprets special words like \p "inf"
579 * or suffixes. Valid suffixes are
585 * \param str The string which shall be parsed
586 * \param res Will be filled with the interpreted value; in errorcase,
587 * this value is undefined.
589 * \returns \a true, iff the string \a str could be parsed. \a res will
590 * be filled with the interpreted value in this case.
592 * \pre \a str!=0 && \a res!=0
594 bool vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res) VC_ATTR_NONNULL((1,2));
597 /* network context */
602 nid_t vc_get_task_nid(pid_t pid);
603 int vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
605 typedef enum { vcNET_IPV4=1, vcNET_IPV6=2,
606 vcNET_IPV4B=0x101, vcNET_IPV6B=0x102,
607 vcNET_IPV4A=0x201, vcNET_IPV6A=0x202,
608 vcNET_ANY=~0 } vc_net_nx_type;
617 struct vc_net_flags {
618 uint_least64_t flagword;
622 nid_t vc_net_create(nid_t nid);
623 int vc_net_migrate(nid_t nid);
625 int vc_net_add(nid_t nid, struct vc_net_nx const *info);
626 int vc_net_remove(nid_t nid, struct vc_net_nx const *info);
628 int vc_get_nflags(nid_t, struct vc_net_flags *);
629 int vc_set_nflags(nid_t, struct vc_net_flags const *);
632 uint_least64_t ncaps;
633 uint_least64_t cmask;
636 int vc_get_ncaps(nid_t, struct vc_net_caps *);
637 int vc_set_ncaps(nid_t, struct vc_net_caps const *);
640 /* iattr related functions */
642 int vc_set_iattr(char const *filename, xid_t xid,
643 uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
645 /** \brief Returns information about attributes and assigned context of a file.
648 * This function returns the VC_IATTR_XXX flags and about the assigned
649 * context of a file. To request an information, the appropriate bit in
650 * \c mask must be set and the corresponding parameter (\a xid or \a
651 * flags) must not be NULL.
653 * E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
654 * set in \a mask, and \a xid must point to valid memory.
656 * Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
657 * \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
659 * \param filename The name of the file whose attributes shall be determined.
661 * \param xid When non-zero and the VC_IATTR_XID bit is set in \a mask,
662 * the assigned context of \a filename will be stored there.
663 * \param flags When non-zero, a bitmask of current attributes will be
664 * stored there. These attributes must be requested explicitly
665 * by setting the appropriate bit in \a mask
666 * \param mask Points to a bitmask which tells which attributes shall be
667 * determined. On return, it will masquerade the attributes
668 * which were determined.
670 * \pre mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
671 int vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
672 uint_least32_t * /*@null@*/ flags,
673 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
675 /** \brief Returns the context of \c filename
678 * This function calls vc_get_iattr() with appropriate arguments to
679 * determine the context of \c filename. In error-case or when no context
680 * is assigned, \c VC_NOCTX will be returned. To differ between both cases,
681 * \c errno must be examined.
683 * \b WARNING: this function can modify \c errno although no error happened.
685 * \param filename The file to check
686 * \returns The assigned context, or VC_NOCTX when an error occured or no
687 * such assignment exists. \c errno will be 0 in the latter case */
688 xid_t vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
691 /* vhi related functions */
692 typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
693 vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
694 vcVHI_DOMAINNAME } vc_uts_type;
696 int vc_set_vhi_name(xid_t xid, vc_uts_type type,
697 char const *val, size_t len) VC_ATTR_NONNULL((3));
698 int vc_get_vhi_name(xid_t xid, vc_uts_type type,
699 char *val, size_t len) VC_ATTR_NONNULL((3));
701 /* namespace related functions */
702 int vc_enter_namespace(xid_t xid, uint_least64_t mask);
703 int vc_set_namespace(xid_t xid, uint_least64_t mask);
704 int vc_cleanup_namespace();
705 uint_least64_t vc_get_space_mask();
708 /* disk limit related things */
709 struct vc_ctx_dlimit {
710 uint_least32_t space_used;
711 uint_least32_t space_total;
712 uint_least32_t inodes_used;
713 uint_least32_t inodes_total;
714 uint_least32_t reserved;
718 /** Add a disk limit to a file system. */
719 int vc_add_dlimit(char const *filename, xid_t xid,
720 uint_least32_t flags) VC_ATTR_NONNULL((1));
721 /** Remove a disk limit from a file system. */
722 int vc_rem_dlimit(char const *filename, xid_t xid,
723 uint_least32_t flags) VC_ATTR_NONNULL((1));
725 /** Set a disk limit. */
726 int vc_set_dlimit(char const *filename, xid_t xid,
727 uint_least32_t flags,
728 struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
729 /** Get a disk limit. */
730 int vc_get_dlimit(char const *filename, xid_t xid,
731 uint_least32_t flags,
732 struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
734 /* scheduler related syscalls */
735 struct vc_set_sched {
736 uint_least32_t set_mask;
737 int_least32_t fill_rate;
738 int_least32_t interval;
739 int_least32_t fill_rate2;
740 int_least32_t interval2;
741 int_least32_t tokens;
742 int_least32_t tokens_min;
743 int_least32_t tokens_max;
744 int_least32_t priority_bias;
745 int_least32_t cpu_id;
746 int_least32_t bucket_id;
749 int vc_set_sched(xid_t xid, struct vc_set_sched const *) VC_ATTR_NONNULL((2));
751 struct vc_sched_info {
752 int_least32_t cpu_id;
753 int_least32_t bucket_id;
754 uint_least64_t user_msec;
755 uint_least64_t sys_msec;
756 uint_least64_t hold_msec;
757 uint_least32_t token_usec;
758 int_least32_t vavavoom;
761 int vc_sched_info(xid_t xid, struct vc_sched_info *info) VC_ATTR_NONNULL((2));
764 int vc_set_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
767 /** \brief Information about parsing errors
770 struct vc_err_listparser {
771 char const *ptr; ///< Pointer to the first character of an erroneous string
772 size_t len; ///< Length of the erroneous string
775 /** \brief Converts a single string into bcapability
778 * \param str The string to be parsed;
779 * both "CAP_xxx" and "xxx" will be accepted
780 * \param len The length of the string, or \c 0 for automatic detection
782 * \returns 0 on error; a bitmask on success
785 uint_least64_t vc_text2bcap(char const *str, size_t len);
787 /** \brief Converts the lowest bit of a bcapability or the entire value
788 * (when possible) to a textual representation
791 * \param val The string to be converted; on success, the detected bit(s)
792 * will be unset, in errorcase only the lowest set bit
794 * \returns A textual representation of \a val resp. of its lowest set bit;
795 * or \c NULL in errorcase.
797 * \post \a *val<sub>old</sub> \c != 0 \c <-->
798 * \a *val<sub>old</sub> > \a *val<sub>new</sub>
799 * \post \a *val<sub>old</sub> \c == 0 \c ---> \a result == 0
801 char const * vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
803 /** \brief Converts a string into a bcapability-bitmask
806 * Syntax of \a str: \verbinclude list2xxx.syntax
808 * When the \c `~' prefix is used, the bits will be unset and a `~' after
809 * another `~' will cancel both ones. The \c `^' prefix specifies a
810 * bitnumber instead of a bitmask.
812 * "literal name" is everything which will be accepted by the
813 * vc_text2bcap() function. The special values for \c NAME will be
814 * recognized case insensitively
816 * \param str The string to be parsed
817 * \param len The length of the string, or \c 0 for automatic detection
818 * \param err Pointer to a structure for error-information, or \c NULL.
819 * \param cap Pointer to a vc_ctx_caps structure holding the results;
820 * only the \a bcaps and \a bmask fields will be changed and
821 * already set values will not be honored. When an error
822 * occured, \a cap will have the value of all processed valid
825 * \returns 0 on success, -1 on error. In error case, \a err will hold
826 * position and length of the first not understood BCAP part
827 * \pre \a str != 0 && \a cap != 0;
828 * \a cap->bcaps and \a cap->bmask must be initialized
830 int vc_list2bcap(char const *str, size_t len,
831 struct vc_err_listparser *err,
832 struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
834 uint_least64_t vc_text2ccap(char const *, size_t len);
835 char const * vc_loccap2text(uint_least64_t *);
836 int vc_list2ccap(char const *, size_t len,
837 struct vc_err_listparser *err,
838 struct vc_ctx_caps *);
840 int vc_list2cflag(char const *, size_t len,
841 struct vc_err_listparser *err,
842 struct vc_ctx_flags *flags);
843 uint_least64_t vc_text2cflag(char const *, size_t len);
844 char const * vc_locflag2text(uint_least64_t *);
846 uint_least32_t vc_list2cflag_compat(char const *, size_t len,
847 struct vc_err_listparser *err);
848 uint_least32_t vc_text2cflag_compat(char const *, size_t len);
849 char const * vc_hicflag2text_compat(uint_least32_t);
851 int vc_text2cap(char const *);
852 char const * vc_cap2text(unsigned int);
855 int vc_list2nflag(char const *, size_t len,
856 struct vc_err_listparser *err,
857 struct vc_net_flags *flags);
858 uint_least64_t vc_text2nflag(char const *, size_t len);
859 char const * vc_lonflag2text(uint_least64_t *);
861 uint_least64_t vc_text2ncap(char const *, size_t len);
862 char const * vc_loncap2text(uint_least64_t *);
863 int vc_list2ncap(char const *, size_t len,
864 struct vc_err_listparser *err,
865 struct vc_net_caps *);
867 uint_least64_t vc_get_insecurebcaps() VC_ATTR_CONST;
868 inline static uint_least64_t vc_get_insecureccaps() {
869 return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP);
872 inline static int vc_setfilecontext(char const *filename, xid_t xid) {
873 return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
877 uint_least32_t vc_text2personalityflag(char const *str,
878 size_t len) VC_ATTR_NONNULL((1));
880 char const * vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
882 int vc_list2personalityflag(char const /*@in@*/ *,
884 uint_least32_t /*@out@*/ *personality,
885 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
887 uint_least32_t vc_str2personalitytype(char const /*@in@*/*,
888 size_t len) VC_ATTR_NONNULL((1));
891 typedef enum { vcFEATURE_VKILL, vcFEATURE_IATTR, vcFEATURE_RLIMIT,
892 vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
893 vcFEATURE_SCHED, vcFEATURE_VINFO, vcFEATURE_VHI,
894 vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
895 vcFEATURE_VNET, vcFEATURE_VSTAT }
898 bool vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
899 bool vc_isSupportedString(char const *);
902 typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
903 vcTYPE_STATIC, vcTYPE_DYNAMIC }
906 vcXidType vc_getXIDType(xid_t xid) VC_ATTR_CONST;
908 /** Returns true iff \a xid is a dynamic xid */
909 bool vc_is_dynamic_xid(xid_t xid);
912 /* The management part */
914 #define VC_LIMIT_VSERVER_NAME_LEN 1024
916 typedef enum { vcCFG_NONE, vcCFG_AUTO,
919 vcCFG_RECENT_FULL } vcCfgStyle;
922 /** Maps an xid given at '--xid' options to an xid_t */
923 xid_t vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
924 /** Maps a nid given at '--nid' options to a nid_t */
925 nid_t vc_nidopt2nid(char const *, bool honor_static, char const **err_info);
927 vcCfgStyle vc_getVserverCfgStyle(char const *id);
929 /** Resolves the name of the vserver. The result will be allocated and must
930 be freed by the caller. */
931 char * vc_getVserverName(char const *id, vcCfgStyle style);
933 /** Returns the path of the vserver configuration directory. When the given
934 * vserver does not exist, or when it does not have such a directory, NULL
935 * will be returned. Else, the result will be allocated and must be freed
937 char * vc_getVserverCfgDir(char const *id, vcCfgStyle style);
939 /** Returns the path of the configuration directory for the given
940 * application. The result will be allocated and must be freed by the
942 char * vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
944 /** Returns the path to the vserver root-directory. The result will be
945 * allocated and must be freed by the caller. */
946 char * vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
948 /** Returns the ctx of the given vserver. When vserver is not running and
949 * 'honor_static' is false, VC_NOCTX will be returned. Else, when
950 * 'honor_static' is true and a static assignment exists, those value will
951 * be returned. Else, the result will be VC_NOCTX.
953 * When 'is_running' is not null, the status of the vserver will be
954 * assigned to this variable. */
955 xid_t vc_getVserverCtx(char const *id, vcCfgStyle style,
956 bool honor_static, bool /*@null@*/ *is_running);
958 /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
959 be used as the directory holding the mapping-links; when NULL, the
960 default value will be assumed. The result will be allocated and must be
961 freed by the caller. */
962 char * vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
963 /*@null@*/char const *revdir);
965 int vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
966 char const *rhs, vcCfgStyle rhs_style);
968 #define vcSKEL_INTERFACES 1u
969 #define vcSKEL_PKGMGMT 2u
970 #define vcSKEL_FILESYSTEM 4u
972 /** Create a basic configuration skeleton for a vserver plus toplevel
973 * directories for pkgmanagemt and filesystem (when requested). */
974 int vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
982 #undef VC_ATTR_ALWAYSINLINE
983 #undef VC_ATTR_NORETURN
984 #undef VC_ATTR_UNUSED
985 #undef VC_ATTR_NONNULL