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>
32 #include <netinet/in.h>
36 # define VC_ATTR_UNUSED __attribute__((__unused__))
37 # define VC_ATTR_NORETURN __attribute__((__noreturn__))
38 # define VC_ATTR_CONST __attribute__((__const__))
39 # define VC_ATTR_DEPRECATED __attribute__((__deprecated__))
40 # if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30300
41 # define VC_ATTR_NONNULL(ARGS) __attribute__((__nonnull__ ARGS))
42 # define VC_ATTR_ALWAYSINLINE __attribute__((__always_inline__))
44 # define VC_ATTR_NONNULL(ARGS)
45 # define VC_ATTR_ALWAYSINLINE
47 # if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30303
48 # define VC_ATTR_PURE __attribute__((__pure__))
53 # define VC_ATTR_NONNULL(ARGS)
54 # define VC_ATTR_UNUSED
55 # define VC_ATTR_NORETURN
56 # define VC_ATTR_ALWAYSINLINE
57 # define VC_ATTR_DEPRECATED
59 # define VC_ATTR_CONST
63 /** the value which is returned in error-case (no ctx found) */
64 #define VC_NOCTX ((xid_t)(-1))
65 #define VC_NOXID ((xid_t)(-1))
66 /** the value which means a random (the next free) ctx */
67 #define VC_DYNAMIC_XID ((xid_t)(-1))
68 /** the value which means the current ctx */
69 #define VC_SAMECTX ((xid_t)(-2))
71 #define VC_NONID ((nid_t)(-1))
72 #define VC_DYNAMIC_NID ((nid_t)(-1))
74 #define VC_LIM_INFINITY (~0ULL)
75 #define VC_LIM_KEEP (~1ULL)
77 #define VC_CDLIM_UNSET (0U)
78 #define VC_CDLIM_INFINITY (~0U)
79 #define VC_CDLIM_KEEP (~1U)
81 #ifndef S_CTX_INFO_LOCK
82 # define S_CTX_INFO_LOCK 1
85 #ifndef S_CTX_INFO_SCHED
86 # define S_CTX_INFO_SCHED 2
89 #ifndef S_CTX_INFO_NPROC
90 # define S_CTX_INFO_NPROC 4
93 #ifndef S_CTX_INFO_PRIVATE
94 # define S_CTX_INFO_PRIVATE 8
97 #ifndef S_CTX_INFO_INIT
98 # define S_CTX_INFO_INIT 16
101 #ifndef S_CTX_INFO_HIDEINFO
102 # define S_CTX_INFO_HIDEINFO 32
105 #ifndef S_CTX_INFO_ULIMIT
106 # define S_CTX_INFO_ULIMIT 64
109 #ifndef S_CTX_INFO_NAMESPACE
110 # define S_CTX_INFO_NAMESPACE 128
113 #define VC_CAP_CHOWN 0
114 #define VC_CAP_DAC_OVERRIDE 1
115 #define VC_CAP_DAC_READ_SEARCH 2
116 #define VC_CAP_FOWNER 3
117 #define VC_CAP_FSETID 4
118 #define VC_CAP_KILL 5
119 #define VC_CAP_SETGID 6
120 #define VC_CAP_SETUID 7
121 #define VC_CAP_SETPCAP 8
122 #define VC_CAP_LINUX_IMMUTABLE 9
123 #define VC_CAP_NET_BIND_SERVICE 10
124 #define VC_CAP_NET_BROADCAST 11
125 #define VC_CAP_NET_ADMIN 12
126 #define VC_CAP_NET_RAW 13
127 #define VC_CAP_IPC_LOCK 14
128 #define VC_CAP_IPC_OWNER 15
129 #define VC_CAP_SYS_MODULE 16
130 #define VC_CAP_SYS_RAWIO 17
131 #define VC_CAP_SYS_CHROOT 18
132 #define VC_CAP_SYS_PTRACE 19
133 #define VC_CAP_SYS_PACCT 20
134 #define VC_CAP_SYS_ADMIN 21
135 #define VC_CAP_SYS_BOOT 22
136 #define VC_CAP_SYS_NICE 23
137 #define VC_CAP_SYS_RESOURCE 24
138 #define VC_CAP_SYS_TIME 25
139 #define VC_CAP_SYS_TTY_CONFIG 26
140 #define VC_CAP_MKNOD 27
141 #define VC_CAP_LEASE 28
142 #define VC_CAP_AUDIT_WRITE 29
143 #define VC_CAP_AUDIT_CONTROL 30
144 #define VC_CAP_SETFCAP 31
145 #define VC_CAP_MAC_OVERRIDE 32
146 #define VC_CAP_MAC_ADMIN 33
148 #define VC_IMMUTABLE_FILE_FL 0x0000010lu
149 #define VC_IMMUTABLE_LINK_FL 0x0008000lu
150 #define VC_IMMUTABLE_ALL (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
152 #define VC_IATTR_XID 0x01000000u
154 #define VC_IATTR_ADMIN 0x00000001u
155 #define VC_IATTR_WATCH 0x00000002u
156 #define VC_IATTR_HIDE 0x00000004u
157 #define VC_IATTR_WRITE 0x00000008u
158 #define VC_IATTR_FLAGS 0x0000000fu
160 #define VC_IATTR_BARRIER 0x00010000u
161 #define VC_IATTR_IUNLINK 0x00020000u
162 #define VC_IATTR_IMMUTABLE 0x00040000u
163 #define VC_IATTR_COW 0x00080000u
167 #define VC_VXF_INFO_LOCK 0x00000001ull
168 #define VC_VXF_INFO_NPROC 0x00000004ull
169 #define VC_VXF_INFO_PRIVATE 0x00000008ull
170 #define VC_VXF_INFO_INIT 0x00000010ull
172 #define VC_VXF_INFO_HIDEINFO 0x00000020ull
173 #define VC_VXF_INFO_ULIMIT 0x00000040ull
174 #define VC_VXF_INFO_NAMESPACE 0x00000080ull
176 #define VC_VXF_SCHED_HARD 0x00000100ull
177 #define VC_VXF_SCHED_PRIO 0x00000200ull
178 #define VC_VXF_SCHED_PAUSE 0x00000400ull
180 #define VC_VXF_VIRT_MEM 0x00010000ull
181 #define VC_VXF_VIRT_UPTIME 0x00020000ull
182 #define VC_VXF_VIRT_CPU 0x00040000ull
183 #define VC_VXF_VIRT_LOAD 0x00080000ull
184 #define VC_VXF_VIRT_TIME 0x00100000ull
186 #define VC_VXF_HIDE_MOUNT 0x01000000ull
187 #define VC_VXF_HIDE_NETIF 0x02000000ull
188 #define VC_VXF_HIDE_VINFO 0x04000000ull
190 #define VC_VXF_STATE_SETUP (1ULL<<32)
191 #define VC_VXF_STATE_INIT (1ULL<<33)
192 #define VC_VXF_STATE_ADMIN (1ULL<<34)
194 #define VC_VXF_SC_HELPER (1ULL<<36)
195 #define VC_VXF_REBOOT_KILL (1ULL<<37)
196 #define VC_VXF_PERSISTENT (1ULL<<38)
198 #define VC_VXF_FORK_RSS (1ULL<<48)
199 #define VC_VXF_PROLIFIC (1ULL<<49)
201 #define VC_VXF_IGNEG_NICE (1ULL<<52)
202 #define VC_VXF_IGNEG_IONICE (1ULL<<53)
206 #define VC_VXC_SET_UTSNAME 0x00000001ull
207 #define VC_VXC_SET_RLIMIT 0x00000002ull
208 #define VC_VXC_FS_SECURITY 0x00000004ull
210 #define VC_VXC_RAW_ICMP 0x00000100ull
211 #define VC_VXC_SYSLOG 0x00001000ull
212 #define VC_VXC_OOM_ADJUST 0x00002000ull
213 #define VC_VXC_AUDIT_CONTROL 0x00004000ull
215 #define VC_VXC_SECURE_MOUNT 0x00010000ull
216 #define VC_VXC_SECURE_REMOUNT 0x00020000ull
217 #define VC_VXC_BINARY_MOUNT 0x00040000ull
219 #define VC_VXC_QUOTA_CTL 0x00100000ull
220 #define VC_VXC_ADMIN_MAPPER 0x00200000ull
221 #define VC_VXC_ADMIN_CLOOP 0x00400000ull
223 #define VC_VXC_KTHREAD 0x01000000ull
226 // the scheduler flags
227 #define VC_VXSM_FILL_RATE 0x0001
228 #define VC_VXSM_INTERVAL 0x0002
229 #define VC_VXSM_FILL_RATE2 0x0004
230 #define VC_VXSM_INTERVAL2 0x0008
231 #define VC_VXSM_TOKENS 0x0010
232 #define VC_VXSM_TOKENS_MIN 0x0020
233 #define VC_VXSM_TOKENS_MAX 0x0040
234 #define VC_VXSM_PRIO_BIAS 0x0100
235 #define VC_VXSM_CPU_ID 0x1000
236 #define VC_VXSM_BUCKET_ID 0x2000
238 #define VC_VXSM_IDLE_TIME 0x0200
239 #define VC_VXSM_FORCE 0x0400
240 #define VC_VXSM_MSEC 0x4000
242 #define VC_VXSM_V3_MASK 0x0173
246 #define VC_NXF_INFO_LOCK 0x00000001ull
247 #define VC_NXF_INFO_PRIVATE 0x00000008ull
249 #define VC_NXF_SINGLE_IP 0x00000100ull
250 #define VC_NXF_LBACK_REMAP 0x00000200ull
251 #define VC_NXF_LBACK_ALLOW 0x00000400ull
253 #define VC_NXF_HIDE_NETIF 0x02000000ull
254 #define VC_NXF_HIDE_LBACK 0x04000000ull
256 #define VC_NXF_STATE_SETUP (1ULL<<32)
257 #define VC_NXF_STATE_ADMIN (1ULL<<34)
259 #define VC_NXF_SC_HELPER (1ULL<<36)
260 #define VC_NXF_PERSISTENT (1ULL<<38)
263 // the network capabilities
264 #define VC_NXC_TUN_CREATE 0x00000001ull
266 #define VC_NXC_RAW_ICMP 0x00000100ull
269 // the vserver specific limits
270 #define VC_VLIMIT_NSOCK 16
271 #define VC_VLIMIT_OPENFD 17
272 #define VC_VLIMIT_ANON 18
273 #define VC_VLIMIT_SHMEM 19
274 #define VC_VLIMIT_SEMARY 20
275 #define VC_VLIMIT_NSEMS 21
276 #define VC_VLIMIT_DENTRY 22
277 #define VC_VLIMIT_MAPPED 23
280 // the VCI bit values
281 #define VC_VCI_NO_DYNAMIC (1 << 0)
282 #define VC_VCI_SPACES (1 << 10)
283 #define VC_VCI_NETV2 (1 << 11)
284 #define VC_VCI_PPTAG (1 << 28)
287 // the device mapping flags
288 #define VC_DATTR_CREATE 0x00000001
289 #define VC_DATTR_OPEN 0x00000002
291 #define VC_DATTR_REMAP 0x00000010
294 // the process context migration flags
295 #define VC_VXM_SET_INIT 0x00000001
296 #define VC_VXM_SET_REAPER 0x00000002
299 // the network address flags
300 #define VC_NXA_TYPE_IPV4 0x0001
301 #define VC_NXA_TYPE_IPV6 0x0002
303 #define VC_NXA_TYPE_NONE 0x0000
304 #define VC_NXA_TYPE_ANY 0x00FF
306 #define VC_NXA_TYPE_ADDR 0x0010
307 #define VC_NXA_TYPE_MASK 0x0020
308 #define VC_NXA_TYPE_RANGE 0x0040
310 #define VC_NXA_MOD_BCAST 0x0100
311 #define VC_NXA_MOD_LBACK 0x0200
315 # define CLONE_NEWNS 0x00020000
318 # define CLONE_NEWUTS 0x04000000
321 # define CLONE_NEWIPC 0x08000000
323 #ifndef CLONE_NEWUSER
324 # define CLONE_NEWUSER 0x10000000
327 # define CLONE_NEWPID 0x20000000
330 # define CLONE_NEWNET 0x40000000
334 #define VC_BAD_PERSONALITY ((uint_least32_t)(-1))
337 /** \defgroup syscalls Syscall wrappers
338 * Functions which are calling the vserver syscall directly. */
340 /** \defgroup helper Helper functions
341 * Functions which are doing general helper tasks like parameter parsing. */
343 /** \typedef an_unsigned_integer_type xid_t
344 * The identifier of a context. */
347 typedef an_unsigned_integer_type xid_t;
348 typedef an_unsigned_integer_type nid_t;
349 typedef an_unsigned_integer_type tag_t;
356 /** \brief The generic vserver syscall
359 * This function executes the generic vserver syscall. It uses the
360 * correct syscallnumber (which may differ between the different
363 * \param cmd the command to be executed
364 * \param xid the xid on which the cmd shall be applied
365 * \param data additional arguments; depends on \c cmd
366 * \returns depends on \c cmd; usually, -1 stands for an error
368 int vc_syscall(uint32_t cmd, xid_t xid, void *data);
370 /** \brief Returns the version of the current kernel API.
372 * \returns The versionnumber of the kernel API
374 int vc_get_version();
376 typedef uint64_t vc_vci_t;
377 /** \brief Returns the kernel configuration bits
379 * \returns The kernel configuration bits
381 vc_vci_t vc_get_vci();
383 /** \brief Moves current process into a context
386 * Puts current process into context \a ctx, removes the capabilities
387 * given in \a remove_cap and sets \a flags.
389 * \param ctx The new context; special values for are
390 * - VC_SAMECTX which means the current context (just for changing caps and flags)
391 * - VC_DYNAMIC_XID which means the next free context; this value can be used by
392 * ordinary users also
393 * \param remove_cap The linux capabilities which will be \b removed.
394 * \param flags Special flags which will be set.
396 * \returns The new context-id, or VC_NOCTX on errors; \c errno
397 * will be set appropriately
399 * See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
400 xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
402 struct vc_ip_mask_pair {
407 /** \brief Sets the ipv4root information.
409 * \pre \a nb < NB_IPV4ROOT && \a ips != 0 */
410 int vc_set_ipv4root(uint32_t bcast, size_t nb,
411 struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
413 /** \brief Returns the value of NB_IPV4ROOT.
416 * This function returns the value of NB_IPV4ROOT which was used when the
417 * library was built, but \b not the value which is used by the currently
419 size_t vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
421 /* process context */
422 /** \brief Flags of process-contexts
424 struct vc_ctx_flags {
425 /** \brief Mask of set context flags */
426 uint_least64_t flagword;
427 /** \brief Mask of set and unset context flags when used by set
428 * operations, or modifiable flags when used by get
433 /** \brief Creates a context without starting it.
436 * This functions initializes a new context. When already in a freshly
437 * created context, this old context will be discarded.
439 * \param xid The new context; special values are:
440 * - VC_DYNAMIC_XID which means to create a dynamic context
442 * \returns the xid of the created context, or VC_NOCTX on errors. \c errno
443 * will be set appropriately. */
444 xid_t vc_ctx_create(xid_t xid, struct vc_ctx_flags *flags);
446 /** \brief Moves the current process into the specified context.
449 * \param xid The new context
450 * \param flags The flags, see VC_VXM_*
451 * \returns 0 on success, -1 on errors */
452 int vc_ctx_migrate(xid_t xid, uint_least64_t flags);
454 /** \brief Statistics about a context */
456 uint_least32_t usecnt; ///< number of uses
457 uint_least32_t tasks; ///< number of tasks
460 /** \brief Get some statistics about a context.
463 * \param xid The context to get stats about
464 * \param stat Where to store the result
466 * \returns 0 on success, -1 on errors. */
467 int vc_ctx_stat(xid_t xid, struct vc_ctx_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
469 /** \brief Contains further statistics about a context. */
470 struct vc_virt_stat {
471 uint_least64_t offset;
472 uint_least64_t uptime;
473 uint_least32_t nr_threads;
474 uint_least32_t nr_running;
475 uint_least32_t nr_uninterruptible;
476 uint_least32_t nr_onhold;
477 uint_least32_t nr_forks;
478 uint_least32_t load[3];
481 /** \brief Get more statistics about a context.
484 * \param xid The context to get stats about
485 * \param stat Where to store the result
487 * \returns 0 on success, -1 on errors. */
488 int vc_virt_stat(xid_t xid, struct vc_virt_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
490 /** \brief Sends a signal to a context/pid
493 * Special values for \a pid are:
494 * - -1 which means every process in ctx except the init-process
495 * - 0 which means every process in ctx inclusive the init-process */
496 int vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
498 int vc_get_cflags(xid_t xid, struct vc_ctx_flags /*@out@*/ *) VC_ATTR_NONNULL((2));
499 int vc_set_cflags(xid_t xid, struct vc_ctx_flags /*@in@*/ const *) VC_ATTR_NONNULL((2));
501 /** \brief Capabilities of process-contexts */
503 /** \brief Mask of set common system capabilities */
504 uint_least64_t bcaps;
505 /** \brief Mask of set and unset common system capabilities when used by
506 * set operations, or the modifiable capabilities when used by
508 uint_least64_t bmask;
509 /** \brief Mask of set process context capabilities */
510 uint_least64_t ccaps;
511 /** \brief Mask of set and unset process context capabilities when used
512 * by set operations, or the modifiable capabilities when used
513 * by get operations */
514 uint_least64_t cmask;
517 int vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
518 int vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
525 int vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
527 /** \brief Returns the context of the given process.
530 * \param pid the process-id whose xid shall be determined;
531 * pid==0 means the current process.
532 * \returns the xid of process \c pid or -1 on errors
534 xid_t vc_get_task_xid(pid_t pid);
536 /** \brief Waits for the end of a context
539 int vc_wait_exit(xid_t xid);
541 /* rlimit related functions */
543 /** \brief The type which is used for a single limit value.
546 * - VC_LIM_INFINITY ... which is the infinite value
547 * - VC_LIM_KEEP ... which is used to mark values which shall not be
548 * modified by the vc_set_rlimit() operation.
550 * Else, the interpretation of the value depends on the corresponding
551 * resource; it might be bytes, pages, seconds or litres of beer. */
552 typedef uint_least64_t vc_limit_t;
554 /** \brief Masks describing the supported limits. */
555 struct vc_rlimit_mask {
556 uint_least32_t min; ///< masks the resources supporting a minimum limit
557 uint_least32_t soft; ///< masks the resources supporting a soft limit
558 uint_least32_t hard; ///< masks the resources supporting a hard limit
561 /** \brief Returns the limits supported by the kernel */
562 int vc_get_rlimit_mask(xid_t xid,
563 struct vc_rlimit_mask /*@out@*/ *lim) VC_ATTR_NONNULL((2));
565 /** \brief The limits of a resources.
567 * This is a triple consisting of a minimum, soft and hardlimit. */
569 vc_limit_t min; ///< the guaranted minimum of a resources
570 vc_limit_t soft; ///< the softlimit of a resource
571 vc_limit_t hard; ///< the absolute hardlimit of a resource
574 /** \brief Returns the limits of \a resource.
577 * \param xid The id of the context
578 * \param resource The resource which will be queried
579 * \param lim The result which will be filled with the limits
581 * \returns 0 on success, and -1 on errors. */
582 int vc_get_rlimit(xid_t xid, int resource,
583 struct vc_rlimit /*@out@*/ *lim) VC_ATTR_NONNULL((3));
584 /** \brief Sets the limits of \a resource.
587 * \param xid The id of the context
588 * \param resource The resource which will be queried
589 * \param lim The new limits
591 * \returns 0 on success, and -1 on errors. */
592 int vc_set_rlimit(xid_t xid, int resource,
593 struct vc_rlimit const /*@in@*/ *lim) VC_ATTR_NONNULL((3));
595 /** \brief Statistics for a resource limit. */
596 struct vc_rlimit_stat {
597 uint_least32_t hits; ///< number of hits on the limit
598 vc_limit_t value; ///< current value
599 vc_limit_t minimum; ///< minimum value observed
600 vc_limit_t maximum; ///< maximum value observed
603 /** \brief Returns the current stats of \a resource.
606 * \param xid The id of the context
607 * \param resource The resource which will be queried
608 * \param stat The result which will be filled with the stats
610 * \returns 0 on success, and -1 on errors. */
611 int vc_rlimit_stat(xid_t xid, int resource,
612 struct vc_rlimit_stat /*@out@*/ *stat) VC_ATTR_NONNULL((3));
614 /** \brief Resets the minimum and maximum observed values of all resources.
617 * \param xid The id of the context
619 * \returns 0 on success, and -1 on errors. */
620 int vc_reset_minmax(xid_t xid);
622 /** \brief Parses a string describing a limit
625 * This function parses \a str and interprets special words like \p "inf"
626 * or suffixes. Valid suffixes are
632 * \param str The string which shall be parsed
633 * \param res Will be filled with the interpreted value; in errorcase,
634 * this value is undefined.
636 * \returns \a true, iff the string \a str could be parsed. \a res will
637 * be filled with the interpreted value in this case.
639 * \pre \a str!=0 && \a res!=0
641 bool vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res) VC_ATTR_NONNULL((1,2));
644 /* network context */
649 nid_t vc_get_task_nid(pid_t pid);
650 int vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
671 #define vna_v4_ip s.ip.v4
672 #define vna_v4_ip2 s.ip2.v4
673 #define vna_v4_mask s.mask.v4
674 #define vna_v6_ip s.ip.v6
675 #define vna_v6_ip2 s.ip2.v6
676 #define vna_v6_mask s.mask.v6
679 struct vc_net_flags {
680 uint_least64_t flagword;
684 nid_t vc_net_create(nid_t nid);
685 int vc_net_migrate(nid_t nid);
687 int vc_net_add(nid_t nid, struct vc_net_addr const *info);
688 int vc_net_remove(nid_t nid, struct vc_net_addr const *info);
690 int vc_get_nflags(nid_t, struct vc_net_flags *);
691 int vc_set_nflags(nid_t, struct vc_net_flags const *);
694 uint_least64_t ncaps;
695 uint_least64_t cmask;
698 int vc_get_ncaps(nid_t, struct vc_net_caps *);
699 int vc_set_ncaps(nid_t, struct vc_net_caps const *);
702 /* iattr related functions */
704 int vc_set_iattr(char const *filename, xid_t xid,
705 uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
707 int vc_fset_iattr(int fd, xid_t xid,
708 uint_least32_t flags, uint_least32_t mask);
710 /** \brief Returns information about attributes and assigned context of a file.
713 * This function returns the VC_IATTR_XXX flags and about the assigned
714 * context of a file. To request an information, the appropriate bit in
715 * \c mask must be set and the corresponding parameter (\a xid or \a
716 * flags) must not be NULL.
718 * E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
719 * set in \a mask, and \a xid must point to valid memory.
721 * Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
722 * \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
724 * \param filename The name of the file whose attributes shall be determined.
726 * \param xid When non-zero and the VC_IATTR_XID bit is set in \a mask,
727 * the assigned context of \a filename will be stored there.
728 * \param flags When non-zero, a bitmask of current attributes will be
729 * stored there. These attributes must be requested explicitly
730 * by setting the appropriate bit in \a mask
731 * \param mask Points to a bitmask which tells which attributes shall be
732 * determined. On return, it will masquerade the attributes
733 * which were determined.
735 * \pre mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
736 int vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
737 uint_least32_t * /*@null@*/ flags,
738 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
740 int vc_fget_iattr(int fd, xid_t * /*@null@*/ xid,
741 uint_least32_t * /*@null@*/ flags,
742 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((4));
744 /** \brief Returns the context of \c filename
747 * This function calls vc_get_iattr() with appropriate arguments to
748 * determine the context of \c filename. In error-case or when no context
749 * is assigned, \c VC_NOCTX will be returned. To differ between both cases,
750 * \c errno must be examined.
752 * \b WARNING: this function can modify \c errno although no error happened.
754 * \param filename The file to check
755 * \returns The assigned context, or VC_NOCTX when an error occured or no
756 * such assignment exists. \c errno will be 0 in the latter case */
757 xid_t vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
760 /* vhi related functions */
761 typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
762 vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
763 vcVHI_DOMAINNAME } vc_uts_type;
765 int vc_set_vhi_name(xid_t xid, vc_uts_type type,
766 char const *val, size_t len) VC_ATTR_NONNULL((3));
767 int vc_get_vhi_name(xid_t xid, vc_uts_type type,
768 char *val, size_t len) VC_ATTR_NONNULL((3));
770 /* namespace related functions */
771 int vc_enter_namespace(xid_t xid, uint_least64_t mask, uint32_t index);
772 int vc_set_namespace(xid_t xid, uint_least64_t mask, uint32_t index);
773 int vc_cleanup_namespace(void);
774 uint_least64_t vc_get_space_mask(void);
775 uint_least64_t vc_get_space_default(void);
778 /* disk limit related things */
779 struct vc_ctx_dlimit {
780 uint_least32_t space_used;
781 uint_least32_t space_total;
782 uint_least32_t inodes_used;
783 uint_least32_t inodes_total;
784 uint_least32_t reserved;
788 /** Add a disk limit to a file system. */
789 int vc_add_dlimit(char const *filename, xid_t xid,
790 uint_least32_t flags) VC_ATTR_NONNULL((1));
791 /** Remove a disk limit from a file system. */
792 int vc_rem_dlimit(char const *filename, xid_t xid,
793 uint_least32_t flags) VC_ATTR_NONNULL((1));
795 /** Set a disk limit. */
796 int vc_set_dlimit(char const *filename, xid_t xid,
797 uint_least32_t flags,
798 struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
799 /** Get a disk limit. */
800 int vc_get_dlimit(char const *filename, xid_t xid,
801 uint_least32_t flags,
802 struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
804 /** Get the filesystem tag for a process. */
805 tag_t vc_get_task_tag(pid_t pid);
807 /** Create a new filesystem tag space. */
808 int vc_tag_create(tag_t tag);
810 /** Migrate to an existing filesystem tag space. */
811 int vc_tag_migrate(tag_t tag);
813 /* scheduler related syscalls */
814 struct vc_set_sched {
815 uint_least32_t set_mask;
816 int_least32_t fill_rate;
817 int_least32_t interval;
818 int_least32_t fill_rate2;
819 int_least32_t interval2;
820 int_least32_t tokens;
821 int_least32_t tokens_min;
822 int_least32_t tokens_max;
823 int_least32_t priority_bias;
824 int_least32_t cpu_id;
825 int_least32_t bucket_id;
828 int vc_set_sched(xid_t xid, struct vc_set_sched const *) VC_ATTR_NONNULL((2));
829 int vc_get_sched(xid_t xid, struct vc_set_sched *) VC_ATTR_NONNULL((2));
831 struct vc_sched_info {
832 int_least32_t cpu_id;
833 int_least32_t bucket_id;
834 uint_least64_t user_msec;
835 uint_least64_t sys_msec;
836 uint_least64_t hold_msec;
837 uint_least32_t token_usec;
838 int_least32_t vavavoom;
841 int vc_sched_info(xid_t xid, struct vc_sched_info *info) VC_ATTR_NONNULL((2));
844 int vc_set_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
845 int vc_unset_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
847 int vc_get_badness(xid_t xid, int64_t *badness);
848 int vc_set_badness(xid_t xid, int64_t badness);
851 /** \brief Information about parsing errors
854 struct vc_err_listparser {
855 char const *ptr; ///< Pointer to the first character of an erroneous string
856 size_t len; ///< Length of the erroneous string
859 /** \brief Converts a single string into bcapability
862 * \param str The string to be parsed;
863 * both "CAP_xxx" and "xxx" will be accepted
864 * \param len The length of the string, or \c 0 for automatic detection
866 * \returns 0 on error; a bitmask on success
869 uint_least64_t vc_text2bcap(char const *str, size_t len);
871 /** \brief Converts the lowest bit of a bcapability or the entire value
872 * (when possible) to a textual representation
875 * \param val The string to be converted; on success, the detected bit(s)
876 * will be unset, in errorcase only the lowest set bit
878 * \returns A textual representation of \a val resp. of its lowest set bit;
879 * or \c NULL in errorcase.
881 * \post \a *val<sub>old</sub> \c != 0 \c <-->
882 * \a *val<sub>old</sub> > \a *val<sub>new</sub>
883 * \post \a *val<sub>old</sub> \c == 0 \c ---> \a result == 0
885 char const * vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
887 /** \brief Converts a string into a bcapability-bitmask
890 * Syntax of \a str: \verbinclude list2xxx.syntax
892 * When the \c `~' prefix is used, the bits will be unset and a `~' after
893 * another `~' will cancel both ones. The \c `^' prefix specifies a
894 * bitnumber instead of a bitmask.
896 * "literal name" is everything which will be accepted by the
897 * vc_text2bcap() function. The special values for \c NAME will be
898 * recognized case insensitively
900 * \param str The string to be parsed
901 * \param len The length of the string, or \c 0 for automatic detection
902 * \param err Pointer to a structure for error-information, or \c NULL.
903 * \param cap Pointer to a vc_ctx_caps structure holding the results;
904 * only the \a bcaps and \a bmask fields will be changed and
905 * already set values will not be honored. When an error
906 * occured, \a cap will have the value of all processed valid
909 * \returns 0 on success, -1 on error. In error case, \a err will hold
910 * position and length of the first not understood BCAP part
911 * \pre \a str != 0 && \a cap != 0;
912 * \a cap->bcaps and \a cap->bmask must be initialized
914 int vc_list2bcap(char const *str, size_t len,
915 struct vc_err_listparser *err,
916 struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
918 uint_least64_t vc_text2ccap(char const *, size_t len);
919 char const * vc_loccap2text(uint_least64_t *);
920 int vc_list2ccap(char const *, size_t len,
921 struct vc_err_listparser *err,
922 struct vc_ctx_caps *);
924 int vc_list2cflag(char const *, size_t len,
925 struct vc_err_listparser *err,
926 struct vc_ctx_flags *flags);
927 uint_least64_t vc_text2cflag(char const *, size_t len);
928 char const * vc_locflag2text(uint_least64_t *);
930 uint_least32_t vc_list2cflag_compat(char const *, size_t len,
931 struct vc_err_listparser *err);
932 uint_least32_t vc_text2cflag_compat(char const *, size_t len);
933 char const * vc_hicflag2text_compat(uint_least32_t);
935 int vc_text2cap(char const *);
936 char const * vc_cap2text(unsigned int);
939 int vc_list2nflag(char const *, size_t len,
940 struct vc_err_listparser *err,
941 struct vc_net_flags *flags);
942 uint_least64_t vc_text2nflag(char const *, size_t len);
943 char const * vc_lonflag2text(uint_least64_t *);
945 uint_least64_t vc_text2ncap(char const *, size_t len);
946 char const * vc_loncap2text(uint_least64_t *);
947 int vc_list2ncap(char const *, size_t len,
948 struct vc_err_listparser *err,
949 struct vc_net_caps *);
951 uint_least64_t vc_get_insecurebcaps() VC_ATTR_CONST;
952 inline static uint_least64_t vc_get_insecureccaps() {
953 return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP|VC_VXC_AUDIT_CONTROL);
956 inline static int vc_setfilecontext(char const *filename, xid_t xid) {
957 return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
961 uint_least32_t vc_text2personalityflag(char const *str,
962 size_t len) VC_ATTR_NONNULL((1));
964 char const * vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
966 int vc_list2personalityflag(char const /*@in@*/ *,
968 uint_least32_t /*@out@*/ *personality,
969 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
971 uint_least32_t vc_str2personalitytype(char const /*@in@*/*,
972 size_t len) VC_ATTR_NONNULL((1));
975 typedef enum { vcFEATURE_VKILL, vcFEATURE_IATTR, vcFEATURE_RLIMIT,
976 vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
977 vcFEATURE_SCHED, vcFEATURE_VINFO, vcFEATURE_VHI,
978 vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
979 vcFEATURE_VNET, vcFEATURE_VSTAT, vcFEATURE_PPTAG,
980 vcFEATURE_PIDSPACE, vcFEATURE_SPACES, vcFEATURE_PERSISTENT,
981 vcFEATURE_PIVOT_ROOT,
985 bool vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
986 bool vc_isSupportedString(char const *);
989 typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
990 vcTYPE_STATIC, vcTYPE_DYNAMIC }
993 vcXidType vc_getXIDType(xid_t xid) VC_ATTR_CONST;
995 /** Returns true iff \a xid is a dynamic xid */
996 bool vc_is_dynamic_xid(xid_t xid);
999 /* The management part */
1001 #define VC_LIMIT_VSERVER_NAME_LEN 1024
1003 typedef enum { vcCFG_NONE, vcCFG_AUTO,
1006 vcCFG_RECENT_FULL } vcCfgStyle;
1009 /** Maps an xid given at '--xid' options to an xid_t */
1010 xid_t vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
1011 /** Maps a nid given at '--nid' options to a nid_t */
1012 nid_t vc_nidopt2nid(char const *, bool honor_static, char const **err_info);
1013 /** Maps a tag given at '--tag' options to a tag_t */
1014 tag_t vc_tagopt2tag(char const *, bool honor_static, char const **err_info);
1016 vcCfgStyle vc_getVserverCfgStyle(char const *id);
1018 /** Resolves the name of the vserver. The result will be allocated and must
1019 be freed by the caller. */
1020 char * vc_getVserverName(char const *id, vcCfgStyle style);
1022 /** Returns the path of the vserver configuration directory. When the given
1023 * vserver does not exist, or when it does not have such a directory, NULL
1024 * will be returned. Else, the result will be allocated and must be freed
1026 char * vc_getVserverCfgDir(char const *id, vcCfgStyle style);
1028 /** Returns the path of the configuration directory for the given
1029 * application. The result will be allocated and must be freed by the
1031 char * vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
1033 /** Returns the path to the vserver root-directory. The result will be
1034 * allocated and must be freed by the caller. */
1035 char * vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
1037 typedef enum { vcCTX_XID = 1,
1042 /** Returns the ctx of the given vserver. When vserver is not running and
1043 * 'honor_static' is false, VC_NOCTX will be returned. Else, when
1044 * 'honor_static' is true and a static assignment exists, those value will
1045 * be returned. Else, the result will be VC_NOCTX.
1047 * When 'is_running' is not null, the status of the vserver will be
1048 * assigned to this variable. */
1049 xid_t vc_getVserverCtx(char const *id, vcCfgStyle style,
1050 bool honor_static, bool /*@null@*/ *is_running,
1053 /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
1054 be used as the directory holding the mapping-links; when NULL, the
1055 default value will be assumed. The result will be allocated and must be
1056 freed by the caller. */
1057 char * vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
1058 /*@null@*/char const *revdir);
1060 int vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
1061 char const *rhs, vcCfgStyle rhs_style);
1063 void vc_exitLikeProcess(int pid, int ret) VC_ATTR_NORETURN;
1065 #define vcSKEL_INTERFACES 1u
1066 #define vcSKEL_PKGMGMT 2u
1067 #define vcSKEL_FILESYSTEM 4u
1069 /** Create a basic configuration skeleton for a vserver plus toplevel
1070 * directories for pkgmanagemt and filesystem (when requested). */
1071 int vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
1079 #undef VC_ATTR_ALWAYSINLINE
1080 #undef VC_ATTR_NORETURN
1081 #undef VC_ATTR_UNUSED
1082 #undef VC_ATTR_NONNULL