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
145 #define VC_IMMUTABLE_FILE_FL 0x0000010lu
146 #define VC_IMMUTABLE_LINK_FL 0x0008000lu
147 #define VC_IMMUTABLE_ALL (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
149 #define VC_IATTR_XID 0x01000000u
151 #define VC_IATTR_ADMIN 0x00000001u
152 #define VC_IATTR_WATCH 0x00000002u
153 #define VC_IATTR_HIDE 0x00000004u
154 #define VC_IATTR_FLAGS 0x00000007u
156 #define VC_IATTR_BARRIER 0x00010000u
157 #define VC_IATTR_IUNLINK 0x00020000u
158 #define VC_IATTR_IMMUTABLE 0x00040000u
162 #define VC_VXF_INFO_LOCK 0x00000001ull
163 #define VC_VXF_INFO_NPROC 0x00000004ull
164 #define VC_VXF_INFO_PRIVATE 0x00000008ull
165 #define VC_VXF_INFO_INIT 0x00000010ull
167 #define VC_VXF_INFO_HIDEINFO 0x00000020ull
168 #define VC_VXF_INFO_ULIMIT 0x00000040ull
169 #define VC_VXF_INFO_NAMESPACE 0x00000080ull
171 #define VC_VXF_SCHED_HARD 0x00000100ull
172 #define VC_VXF_SCHED_PRIO 0x00000200ull
173 #define VC_VXF_SCHED_PAUSE 0x00000400ull
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
239 #define VC_NXF_LBACK_REMAP 0x00000200ull
241 #define VC_NXF_HIDE_NETIF 0x02000000ull
242 #define VC_NXF_HIDE_LBACK 0x04000000ull
244 #define VC_NXF_STATE_SETUP (1ULL<<32)
245 #define VC_NXF_STATE_ADMIN (1ULL<<34)
247 #define VC_NXF_SC_HELPER (1ULL<<36)
248 #define VC_NXF_PERSISTENT (1ULL<<38)
251 // the network capabilities
252 #define VC_NXC_RAW_ICMP 0x00000100ull
255 // the vserver specific limits
256 #define VC_VLIMIT_NSOCK 16
257 #define VC_VLIMIT_OPENFD 17
258 #define VC_VLIMIT_ANON 18
259 #define VC_VLIMIT_SHMEM 19
260 #define VC_VLIMIT_SEMARY 20
261 #define VC_VLIMIT_NSEMS 21
262 #define VC_VLIMIT_DENTRY 22
263 #define VC_VLIMIT_MAPPED 23
266 // the VCI bit values
267 #define VC_VCI_NO_DYNAMIC (1 << 0)
268 #define VC_VCI_SPACES (1 << 10)
269 #define VC_VCI_NETV2 (1 << 11)
270 #define VC_VCI_PPTAG (1 << 28)
273 // the device mapping flags
274 #define VC_DATTR_CREATE 0x00000001
275 #define VC_DATTR_OPEN 0x00000002
277 #define VC_DATTR_REMAP 0x00000010
280 // the process context migration flags
281 #define VC_VXM_SET_INIT 0x00000001
282 #define VC_VXM_SET_REAPER 0x00000002
285 // the network address flags
286 #define VC_NXA_TYPE_IPV4 0x0001
287 #define VC_NXA_TYPE_IPV6 0x0002
289 #define VC_NXA_TYPE_NONE 0x0000
290 #define VC_NXA_TYPE_ANY 0x00FF
292 #define VC_NXA_TYPE_ADDR 0x0010
293 #define VC_NXA_TYPE_MASK 0x0020
294 #define VC_NXA_TYPE_RANGE 0x0040
296 #define VC_NXA_MOD_BCAST 0x0100
297 #define VC_NXA_MOD_LBACK 0x0200
301 # define CLONE_NEWNS 0x00020000
304 # define CLONE_NEWUTS 0x04000000
307 # define CLONE_NEWIPC 0x08000000
309 #ifndef CLONE_NEWUSER
310 # define CLONE_NEWUSER 0x10000000
314 #define VC_BAD_PERSONALITY ((uint_least32_t)(-1))
317 /** \defgroup syscalls Syscall wrappers
318 * Functions which are calling the vserver syscall directly. */
320 /** \defgroup helper Helper functions
321 * Functions which are doing general helper tasks like parameter parsing. */
323 /** \typedef an_unsigned_integer_type xid_t
324 * The identifier of a context. */
327 typedef an_unsigned_integer_type xid_t;
328 typedef an_unsigned_integer_type nid_t;
329 typedef an_unsigned_integer_type tag_t;
336 /** \brief The generic vserver syscall
339 * This function executes the generic vserver syscall. It uses the
340 * correct syscallnumber (which may differ between the different
343 * \param cmd the command to be executed
344 * \param xid the xid on which the cmd shall be applied
345 * \param data additional arguments; depends on \c cmd
346 * \returns depends on \c cmd; usually, -1 stands for an error
348 int vc_syscall(uint32_t cmd, xid_t xid, void *data);
350 /** \brief Returns the version of the current kernel API.
352 * \returns The versionnumber of the kernel API
354 int vc_get_version();
356 typedef uint64_t vc_vci_t;
357 /** \brief Returns the kernel configuration bits
359 * \returns The kernel configuration bits
361 vc_vci_t vc_get_vci();
363 /** \brief Moves current process into a context
366 * Puts current process into context \a ctx, removes the capabilities
367 * given in \a remove_cap and sets \a flags.
369 * \param ctx The new context; special values for are
370 * - VC_SAMECTX which means the current context (just for changing caps and flags)
371 * - VC_DYNAMIC_XID which means the next free context; this value can be used by
372 * ordinary users also
373 * \param remove_cap The linux capabilities which will be \b removed.
374 * \param flags Special flags which will be set.
376 * \returns The new context-id, or VC_NOCTX on errors; \c errno
377 * will be set appropriately
379 * See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
380 xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
382 struct vc_ip_mask_pair {
387 /** \brief Sets the ipv4root information.
389 * \pre \a nb < NB_IPV4ROOT && \a ips != 0 */
390 int vc_set_ipv4root(uint32_t bcast, size_t nb,
391 struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
393 /** \brief Returns the value of NB_IPV4ROOT.
396 * This function returns the value of NB_IPV4ROOT which was used when the
397 * library was built, but \b not the value which is used by the currently
399 size_t vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
401 /* process context */
402 /** \brief Flags of process-contexts
404 struct vc_ctx_flags {
405 /** \brief Mask of set context flags */
406 uint_least64_t flagword;
407 /** \brief Mask of set and unset context flags when used by set
408 * operations, or modifiable flags when used by get
413 /** \brief Creates a context without starting it.
416 * This functions initializes a new context. When already in a freshly
417 * created context, this old context will be discarded.
419 * \param xid The new context; special values are:
420 * - VC_DYNAMIC_XID which means to create a dynamic context
422 * \returns the xid of the created context, or VC_NOCTX on errors. \c errno
423 * will be set appropriately. */
424 xid_t vc_ctx_create(xid_t xid, struct vc_ctx_flags *flags);
426 /** \brief Moves the current process into the specified context.
429 * \param xid The new context
430 * \param flags The flags, see VC_VXM_*
431 * \returns 0 on success, -1 on errors */
432 int vc_ctx_migrate(xid_t xid, uint_least64_t flags);
434 /** \brief Statistics about a context */
436 uint_least32_t usecnt; ///< number of uses
437 uint_least32_t tasks; ///< number of tasks
440 /** \brief Get some statistics about a context.
443 * \param xid The context to get stats about
444 * \param stat Where to store the result
446 * \returns 0 on success, -1 on errors. */
447 int vc_ctx_stat(xid_t xid, struct vc_ctx_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
449 /** \brief Contains further statistics about a context. */
450 struct vc_virt_stat {
451 uint_least64_t offset;
452 uint_least64_t uptime;
453 uint_least32_t nr_threads;
454 uint_least32_t nr_running;
455 uint_least32_t nr_uninterruptible;
456 uint_least32_t nr_onhold;
457 uint_least32_t nr_forks;
458 uint_least32_t load[3];
461 /** \brief Get more statistics about a context.
464 * \param xid The context to get stats about
465 * \param stat Where to store the result
467 * \returns 0 on success, -1 on errors. */
468 int vc_virt_stat(xid_t xid, struct vc_virt_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
470 /** \brief Sends a signal to a context/pid
473 * Special values for \a pid are:
474 * - -1 which means every process in ctx except the init-process
475 * - 0 which means every process in ctx inclusive the init-process */
476 int vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
478 int vc_get_cflags(xid_t xid, struct vc_ctx_flags /*@out@*/ *) VC_ATTR_NONNULL((2));
479 int vc_set_cflags(xid_t xid, struct vc_ctx_flags /*@in@*/ const *) VC_ATTR_NONNULL((2));
481 /** \brief Capabilities of process-contexts */
483 /** \brief Mask of set common system capabilities */
484 uint_least64_t bcaps;
485 /** \brief Mask of set and unset common system capabilities when used by
486 * set operations, or the modifiable capabilities when used by
488 uint_least64_t bmask;
489 /** \brief Mask of set process context capabilities */
490 uint_least64_t ccaps;
491 /** \brief Mask of set and unset process context capabilities when used
492 * by set operations, or the modifiable capabilities when used
493 * by get operations */
494 uint_least64_t cmask;
497 int vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
498 int vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
505 int vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
507 /** \brief Returns the context of the given process.
510 * \param pid the process-id whose xid shall be determined;
511 * pid==0 means the current process.
512 * \returns the xid of process \c pid or -1 on errors
514 xid_t vc_get_task_xid(pid_t pid);
516 /** \brief Waits for the end of a context
519 int vc_wait_exit(xid_t xid);
521 /* rlimit related functions */
523 /** \brief The type which is used for a single limit value.
526 * - VC_LIM_INFINITY ... which is the infinite value
527 * - VC_LIM_KEEP ... which is used to mark values which shall not be
528 * modified by the vc_set_rlimit() operation.
530 * Else, the interpretation of the value depends on the corresponding
531 * resource; it might be bytes, pages, seconds or litres of beer. */
532 typedef uint_least64_t vc_limit_t;
534 /** \brief Masks describing the supported limits. */
535 struct vc_rlimit_mask {
536 uint_least32_t min; ///< masks the resources supporting a minimum limit
537 uint_least32_t soft; ///< masks the resources supporting a soft limit
538 uint_least32_t hard; ///< masks the resources supporting a hard limit
541 /** \brief Returns the limits supported by the kernel */
542 int vc_get_rlimit_mask(xid_t xid,
543 struct vc_rlimit_mask /*@out@*/ *lim) VC_ATTR_NONNULL((2));
545 /** \brief The limits of a resources.
547 * This is a triple consisting of a minimum, soft and hardlimit. */
549 vc_limit_t min; ///< the guaranted minimum of a resources
550 vc_limit_t soft; ///< the softlimit of a resource
551 vc_limit_t hard; ///< the absolute hardlimit of a resource
554 /** \brief Returns the limits of \a resource.
557 * \param xid The id of the context
558 * \param resource The resource which will be queried
559 * \param lim The result which will be filled with the limits
561 * \returns 0 on success, and -1 on errors. */
562 int vc_get_rlimit(xid_t xid, int resource,
563 struct vc_rlimit /*@out@*/ *lim) VC_ATTR_NONNULL((3));
564 /** \brief Sets the limits of \a resource.
567 * \param xid The id of the context
568 * \param resource The resource which will be queried
569 * \param lim The new limits
571 * \returns 0 on success, and -1 on errors. */
572 int vc_set_rlimit(xid_t xid, int resource,
573 struct vc_rlimit const /*@in@*/ *lim) VC_ATTR_NONNULL((3));
575 /** \brief Statistics for a resource limit. */
576 struct vc_rlimit_stat {
577 uint_least32_t hits; ///< number of hits on the limit
578 vc_limit_t value; ///< current value
579 vc_limit_t minimum; ///< minimum value observed
580 vc_limit_t maximum; ///< maximum value observed
583 /** \brief Returns the current stats of \a resource.
586 * \param xid The id of the context
587 * \param resource The resource which will be queried
588 * \param stat The result which will be filled with the stats
590 * \returns 0 on success, and -1 on errors. */
591 int vc_rlimit_stat(xid_t xid, int resource,
592 struct vc_rlimit_stat /*@out@*/ *stat) VC_ATTR_NONNULL((3));
594 /** \brief Resets the minimum and maximum observed values of all resources.
597 * \param xid The id of the context
599 * \returns 0 on success, and -1 on errors. */
600 int vc_reset_minmax(xid_t xid);
602 /** \brief Parses a string describing a limit
605 * This function parses \a str and interprets special words like \p "inf"
606 * or suffixes. Valid suffixes are
612 * \param str The string which shall be parsed
613 * \param res Will be filled with the interpreted value; in errorcase,
614 * this value is undefined.
616 * \returns \a true, iff the string \a str could be parsed. \a res will
617 * be filled with the interpreted value in this case.
619 * \pre \a str!=0 && \a res!=0
621 bool vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res) VC_ATTR_NONNULL((1,2));
624 /* network context */
629 nid_t vc_get_task_nid(pid_t pid);
630 int vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
651 #define vna_v4_ip s.ip.v4
652 #define vna_v4_ip2 s.ip2.v6
653 #define vna_v4_mask s.mask.v4
654 #define vna_v6_ip s.ip.v6
655 #define vna_v6_ip2 s.ip2.v6
656 #define vna_v6_mask s.mask.v6
659 struct vc_net_flags {
660 uint_least64_t flagword;
664 nid_t vc_net_create(nid_t nid);
665 int vc_net_migrate(nid_t nid);
667 int vc_net_add(nid_t nid, struct vc_net_addr const *info);
668 int vc_net_remove(nid_t nid, struct vc_net_addr const *info);
670 int vc_get_nflags(nid_t, struct vc_net_flags *);
671 int vc_set_nflags(nid_t, struct vc_net_flags const *);
674 uint_least64_t ncaps;
675 uint_least64_t cmask;
678 int vc_get_ncaps(nid_t, struct vc_net_caps *);
679 int vc_set_ncaps(nid_t, struct vc_net_caps const *);
682 /* iattr related functions */
684 int vc_set_iattr(char const *filename, xid_t xid,
685 uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
687 int vc_fset_iattr(int fd, xid_t xid,
688 uint_least32_t flags, uint_least32_t mask);
690 /** \brief Returns information about attributes and assigned context of a file.
693 * This function returns the VC_IATTR_XXX flags and about the assigned
694 * context of a file. To request an information, the appropriate bit in
695 * \c mask must be set and the corresponding parameter (\a xid or \a
696 * flags) must not be NULL.
698 * E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
699 * set in \a mask, and \a xid must point to valid memory.
701 * Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
702 * \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
704 * \param filename The name of the file whose attributes shall be determined.
706 * \param xid When non-zero and the VC_IATTR_XID bit is set in \a mask,
707 * the assigned context of \a filename will be stored there.
708 * \param flags When non-zero, a bitmask of current attributes will be
709 * stored there. These attributes must be requested explicitly
710 * by setting the appropriate bit in \a mask
711 * \param mask Points to a bitmask which tells which attributes shall be
712 * determined. On return, it will masquerade the attributes
713 * which were determined.
715 * \pre mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
716 int vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
717 uint_least32_t * /*@null@*/ flags,
718 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
720 int vc_fget_iattr(int fd, xid_t * /*@null@*/ xid,
721 uint_least32_t * /*@null@*/ flags,
722 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((4));
724 /** \brief Returns the context of \c filename
727 * This function calls vc_get_iattr() with appropriate arguments to
728 * determine the context of \c filename. In error-case or when no context
729 * is assigned, \c VC_NOCTX will be returned. To differ between both cases,
730 * \c errno must be examined.
732 * \b WARNING: this function can modify \c errno although no error happened.
734 * \param filename The file to check
735 * \returns The assigned context, or VC_NOCTX when an error occured or no
736 * such assignment exists. \c errno will be 0 in the latter case */
737 xid_t vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
740 /* vhi related functions */
741 typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
742 vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
743 vcVHI_DOMAINNAME } vc_uts_type;
745 int vc_set_vhi_name(xid_t xid, vc_uts_type type,
746 char const *val, size_t len) VC_ATTR_NONNULL((3));
747 int vc_get_vhi_name(xid_t xid, vc_uts_type type,
748 char *val, size_t len) VC_ATTR_NONNULL((3));
750 /* namespace related functions */
751 int vc_enter_namespace(xid_t xid, uint_least64_t mask);
752 int vc_set_namespace(xid_t xid, uint_least64_t mask);
753 int vc_cleanup_namespace();
754 uint_least64_t vc_get_space_mask();
757 /* disk limit related things */
758 struct vc_ctx_dlimit {
759 uint_least32_t space_used;
760 uint_least32_t space_total;
761 uint_least32_t inodes_used;
762 uint_least32_t inodes_total;
763 uint_least32_t reserved;
767 /** Add a disk limit to a file system. */
768 int vc_add_dlimit(char const *filename, xid_t xid,
769 uint_least32_t flags) VC_ATTR_NONNULL((1));
770 /** Remove a disk limit from a file system. */
771 int vc_rem_dlimit(char const *filename, xid_t xid,
772 uint_least32_t flags) VC_ATTR_NONNULL((1));
774 /** Set a disk limit. */
775 int vc_set_dlimit(char const *filename, xid_t xid,
776 uint_least32_t flags,
777 struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
778 /** Get a disk limit. */
779 int vc_get_dlimit(char const *filename, xid_t xid,
780 uint_least32_t flags,
781 struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
783 /** Get the filesystem tag for a process. */
784 tag_t vc_get_task_tag(pid_t pid);
786 /** Create a new filesystem tag space. */
787 int vc_tag_create(tag_t tag);
789 /** Migrate to an existing filesystem tag space. */
790 int vc_tag_migrate(tag_t tag);
792 /* scheduler related syscalls */
793 struct vc_set_sched {
794 uint_least32_t set_mask;
795 int_least32_t fill_rate;
796 int_least32_t interval;
797 int_least32_t fill_rate2;
798 int_least32_t interval2;
799 int_least32_t tokens;
800 int_least32_t tokens_min;
801 int_least32_t tokens_max;
802 int_least32_t priority_bias;
803 int_least32_t cpu_id;
804 int_least32_t bucket_id;
807 int vc_set_sched(xid_t xid, struct vc_set_sched const *) VC_ATTR_NONNULL((2));
808 int vc_get_sched(xid_t xid, struct vc_set_sched *) VC_ATTR_NONNULL((2));
810 struct vc_sched_info {
811 int_least32_t cpu_id;
812 int_least32_t bucket_id;
813 uint_least64_t user_msec;
814 uint_least64_t sys_msec;
815 uint_least64_t hold_msec;
816 uint_least32_t token_usec;
817 int_least32_t vavavoom;
820 int vc_sched_info(xid_t xid, struct vc_sched_info *info) VC_ATTR_NONNULL((2));
823 int vc_set_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
824 int vc_unset_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
826 int vc_get_badness(xid_t xid, int64_t *badness);
827 int vc_set_badness(xid_t xid, int64_t badness);
830 /** \brief Information about parsing errors
833 struct vc_err_listparser {
834 char const *ptr; ///< Pointer to the first character of an erroneous string
835 size_t len; ///< Length of the erroneous string
838 /** \brief Converts a single string into bcapability
841 * \param str The string to be parsed;
842 * both "CAP_xxx" and "xxx" will be accepted
843 * \param len The length of the string, or \c 0 for automatic detection
845 * \returns 0 on error; a bitmask on success
848 uint_least64_t vc_text2bcap(char const *str, size_t len);
850 /** \brief Converts the lowest bit of a bcapability or the entire value
851 * (when possible) to a textual representation
854 * \param val The string to be converted; on success, the detected bit(s)
855 * will be unset, in errorcase only the lowest set bit
857 * \returns A textual representation of \a val resp. of its lowest set bit;
858 * or \c NULL in errorcase.
860 * \post \a *val<sub>old</sub> \c != 0 \c <-->
861 * \a *val<sub>old</sub> > \a *val<sub>new</sub>
862 * \post \a *val<sub>old</sub> \c == 0 \c ---> \a result == 0
864 char const * vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
866 /** \brief Converts a string into a bcapability-bitmask
869 * Syntax of \a str: \verbinclude list2xxx.syntax
871 * When the \c `~' prefix is used, the bits will be unset and a `~' after
872 * another `~' will cancel both ones. The \c `^' prefix specifies a
873 * bitnumber instead of a bitmask.
875 * "literal name" is everything which will be accepted by the
876 * vc_text2bcap() function. The special values for \c NAME will be
877 * recognized case insensitively
879 * \param str The string to be parsed
880 * \param len The length of the string, or \c 0 for automatic detection
881 * \param err Pointer to a structure for error-information, or \c NULL.
882 * \param cap Pointer to a vc_ctx_caps structure holding the results;
883 * only the \a bcaps and \a bmask fields will be changed and
884 * already set values will not be honored. When an error
885 * occured, \a cap will have the value of all processed valid
888 * \returns 0 on success, -1 on error. In error case, \a err will hold
889 * position and length of the first not understood BCAP part
890 * \pre \a str != 0 && \a cap != 0;
891 * \a cap->bcaps and \a cap->bmask must be initialized
893 int vc_list2bcap(char const *str, size_t len,
894 struct vc_err_listparser *err,
895 struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
897 uint_least64_t vc_text2ccap(char const *, size_t len);
898 char const * vc_loccap2text(uint_least64_t *);
899 int vc_list2ccap(char const *, size_t len,
900 struct vc_err_listparser *err,
901 struct vc_ctx_caps *);
903 int vc_list2cflag(char const *, size_t len,
904 struct vc_err_listparser *err,
905 struct vc_ctx_flags *flags);
906 uint_least64_t vc_text2cflag(char const *, size_t len);
907 char const * vc_locflag2text(uint_least64_t *);
909 uint_least32_t vc_list2cflag_compat(char const *, size_t len,
910 struct vc_err_listparser *err);
911 uint_least32_t vc_text2cflag_compat(char const *, size_t len);
912 char const * vc_hicflag2text_compat(uint_least32_t);
914 int vc_text2cap(char const *);
915 char const * vc_cap2text(unsigned int);
918 int vc_list2nflag(char const *, size_t len,
919 struct vc_err_listparser *err,
920 struct vc_net_flags *flags);
921 uint_least64_t vc_text2nflag(char const *, size_t len);
922 char const * vc_lonflag2text(uint_least64_t *);
924 uint_least64_t vc_text2ncap(char const *, size_t len);
925 char const * vc_loncap2text(uint_least64_t *);
926 int vc_list2ncap(char const *, size_t len,
927 struct vc_err_listparser *err,
928 struct vc_net_caps *);
930 uint_least64_t vc_get_insecurebcaps() VC_ATTR_CONST;
931 inline static uint_least64_t vc_get_insecureccaps() {
932 return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP);
935 inline static int vc_setfilecontext(char const *filename, xid_t xid) {
936 return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
940 uint_least32_t vc_text2personalityflag(char const *str,
941 size_t len) VC_ATTR_NONNULL((1));
943 char const * vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
945 int vc_list2personalityflag(char const /*@in@*/ *,
947 uint_least32_t /*@out@*/ *personality,
948 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
950 uint_least32_t vc_str2personalitytype(char const /*@in@*/*,
951 size_t len) VC_ATTR_NONNULL((1));
954 typedef enum { vcFEATURE_VKILL, vcFEATURE_IATTR, vcFEATURE_RLIMIT,
955 vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
956 vcFEATURE_SCHED, vcFEATURE_VINFO, vcFEATURE_VHI,
957 vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
958 vcFEATURE_VNET, vcFEATURE_VSTAT, vcFEATURE_PPTAG, }
961 bool vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
962 bool vc_isSupportedString(char const *);
965 typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
966 vcTYPE_STATIC, vcTYPE_DYNAMIC }
969 vcXidType vc_getXIDType(xid_t xid) VC_ATTR_CONST;
971 /** Returns true iff \a xid is a dynamic xid */
972 bool vc_is_dynamic_xid(xid_t xid);
975 /* The management part */
977 #define VC_LIMIT_VSERVER_NAME_LEN 1024
979 typedef enum { vcCFG_NONE, vcCFG_AUTO,
982 vcCFG_RECENT_FULL } vcCfgStyle;
985 /** Maps an xid given at '--xid' options to an xid_t */
986 xid_t vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
987 /** Maps a nid given at '--nid' options to a nid_t */
988 nid_t vc_nidopt2nid(char const *, bool honor_static, char const **err_info);
989 /** Maps a tag given at '--tag' options to a tag_t */
990 tag_t vc_tagopt2tag(char const *, bool honor_static, char const **err_info);
992 vcCfgStyle vc_getVserverCfgStyle(char const *id);
994 /** Resolves the name of the vserver. The result will be allocated and must
995 be freed by the caller. */
996 char * vc_getVserverName(char const *id, vcCfgStyle style);
998 /** Returns the path of the vserver configuration directory. When the given
999 * vserver does not exist, or when it does not have such a directory, NULL
1000 * will be returned. Else, the result will be allocated and must be freed
1002 char * vc_getVserverCfgDir(char const *id, vcCfgStyle style);
1004 /** Returns the path of the configuration directory for the given
1005 * application. The result will be allocated and must be freed by the
1007 char * vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
1009 /** Returns the path to the vserver root-directory. The result will be
1010 * allocated and must be freed by the caller. */
1011 char * vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
1013 typedef enum { vcCTX_XID = 1,
1018 /** Returns the ctx of the given vserver. When vserver is not running and
1019 * 'honor_static' is false, VC_NOCTX will be returned. Else, when
1020 * 'honor_static' is true and a static assignment exists, those value will
1021 * be returned. Else, the result will be VC_NOCTX.
1023 * When 'is_running' is not null, the status of the vserver will be
1024 * assigned to this variable. */
1025 xid_t vc_getVserverCtx(char const *id, vcCfgStyle style,
1026 bool honor_static, bool /*@null@*/ *is_running,
1029 /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
1030 be used as the directory holding the mapping-links; when NULL, the
1031 default value will be assumed. The result will be allocated and must be
1032 freed by the caller. */
1033 char * vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
1034 /*@null@*/char const *revdir);
1036 int vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
1037 char const *rhs, vcCfgStyle rhs_style);
1039 #define vcSKEL_INTERFACES 1u
1040 #define vcSKEL_PKGMGMT 2u
1041 #define vcSKEL_FILESYSTEM 4u
1043 /** Create a basic configuration skeleton for a vserver plus toplevel
1044 * directories for pkgmanagemt and filesystem (when requested). */
1045 int vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
1053 #undef VC_ATTR_ALWAYSINLINE
1054 #undef VC_ATTR_NORETURN
1055 #undef VC_ATTR_UNUSED
1056 #undef VC_ATTR_NONNULL