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
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)
263 #define VC_VCI_NETV2 (1 << 11)
266 // the device mapping flags
267 #define VC_DATTR_CREATE 0x00000001
268 #define VC_DATTR_OPEN 0x00000002
270 #define VC_DATTR_REMAP 0x00000010
273 // the process context migration flags
274 #define VC_VXM_SET_INIT 0x00000001
275 #define VC_VXM_SET_REAPER 0x00000002
278 // the network address flags
279 #define VC_NXA_TYPE_IPV4 0x0001
280 #define VC_NXA_TYPE_IPV6 0x0002
282 #define VC_NXA_TYPE_NONE 0x0000
283 #define VC_NXA_TYPE_ANY 0x00FF
285 #define VC_NXA_TYPE_ADDR 0x0010
286 #define VC_NXA_TYPE_MASK 0x0020
287 #define VC_NXA_TYPE_RANGE 0x0040
289 #define VC_NXA_MOD_BCAST 0x0100
290 #define VC_NXA_MOD_LBACK 0x0200
294 # define CLONE_NEWNS 0x00020000
297 # define CLONE_NEWUTS 0x04000000
300 # define CLONE_NEWIPC 0x08000000
305 #define VC_BAD_PERSONALITY ((uint_least32_t)(-1))
308 /** \defgroup syscalls Syscall wrappers
309 * Functions which are calling the vserver syscall directly. */
311 /** \defgroup helper Helper functions
312 * Functions which are doing general helper tasks like parameter parsing. */
314 /** \typedef an_unsigned_integer_type xid_t
315 * The identifier of a context. */
318 typedef an_unsigned_integer_type xid_t;
319 typedef an_unsigned_integer_type nid_t;
326 /** \brief The generic vserver syscall
329 * This function executes the generic vserver syscall. It uses the
330 * correct syscallnumber (which may differ between the different
333 * \param cmd the command to be executed
334 * \param xid the xid on which the cmd shall be applied
335 * \param data additional arguments; depends on \c cmd
336 * \returns depends on \c cmd; usually, -1 stands for an error
338 int vc_syscall(uint32_t cmd, xid_t xid, void *data);
340 /** \brief Returns the version of the current kernel API.
342 * \returns The versionnumber of the kernel API
344 int vc_get_version();
346 /** \brief Returns the kernel configuration bits
348 * \returns The kernel configuration bits
352 /** \brief Moves current process into a context
355 * Puts current process into context \a ctx, removes the capabilities
356 * given in \a remove_cap and sets \a flags.
358 * \param ctx The new context; special values for are
359 * - VC_SAMECTX which means the current context (just for changing caps and flags)
360 * - VC_DYNAMIC_XID which means the next free context; this value can be used by
361 * ordinary users also
362 * \param remove_cap The linux capabilities which will be \b removed.
363 * \param flags Special flags which will be set.
365 * \returns The new context-id, or VC_NOCTX on errors; \c errno
366 * will be set appropriately
368 * See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
369 xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
371 struct vc_ip_mask_pair {
376 /** \brief Sets the ipv4root information.
378 * \pre \a nb < NB_IPV4ROOT && \a ips != 0 */
379 int vc_set_ipv4root(uint32_t bcast, size_t nb,
380 struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
382 /** \brief Returns the value of NB_IPV4ROOT.
385 * This function returns the value of NB_IPV4ROOT which was used when the
386 * library was built, but \b not the value which is used by the currently
388 size_t vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
390 /* process context */
391 /** \brief Flags of process-contexts
393 struct vc_ctx_flags {
394 /** \brief Mask of set context flags */
395 uint_least64_t flagword;
396 /** \brief Mask of set and unset context flags when used by set
397 * operations, or modifiable flags when used by get
402 /** \brief Creates a context without starting it.
405 * This functions initializes a new context. When already in a freshly
406 * created context, this old context will be discarded.
408 * \param xid The new context; special values are:
409 * - VC_DYNAMIC_XID which means to create a dynamic context
411 * \returns the xid of the created context, or VC_NOCTX on errors. \c errno
412 * will be set appropriately. */
413 xid_t vc_ctx_create(xid_t xid, struct vc_ctx_flags *flags);
415 /** \brief Moves the current process into the specified context.
418 * \param xid The new context
419 * \param flags The flags, see VC_VXM_*
420 * \returns 0 on success, -1 on errors */
421 int vc_ctx_migrate(xid_t xid, uint_least64_t flags);
423 /** \brief Statistics about a context */
425 uint_least32_t usecnt; ///< number of uses
426 uint_least32_t tasks; ///< number of tasks
429 /** \brief Get some statistics about a context.
432 * \param xid The context to get stats about
433 * \param stat Where to store the result
435 * \returns 0 on success, -1 on errors. */
436 int vc_ctx_stat(xid_t xid, struct vc_ctx_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
438 /** \brief Contains further statistics about a context. */
439 struct vc_virt_stat {
440 uint_least64_t offset;
441 uint_least64_t uptime;
442 uint_least32_t nr_threads;
443 uint_least32_t nr_running;
444 uint_least32_t nr_uninterruptible;
445 uint_least32_t nr_onhold;
446 uint_least32_t nr_forks;
447 uint_least32_t load[3];
450 /** \brief Get more statistics about a context.
453 * \param xid The context to get stats about
454 * \param stat Where to store the result
456 * \returns 0 on success, -1 on errors. */
457 int vc_virt_stat(xid_t xid, struct vc_virt_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
459 /** \brief Sends a signal to a context/pid
462 * Special values for \a pid are:
463 * - -1 which means every process in ctx except the init-process
464 * - 0 which means every process in ctx inclusive the init-process */
465 int vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
467 int vc_get_cflags(xid_t xid, struct vc_ctx_flags /*@out@*/ *) VC_ATTR_NONNULL((2));
468 int vc_set_cflags(xid_t xid, struct vc_ctx_flags /*@in@*/ const *) VC_ATTR_NONNULL((2));
470 /** \brief Capabilities of process-contexts */
472 /** \brief Mask of set common system capabilities */
473 uint_least64_t bcaps;
474 /** \brief Mask of set and unset common system capabilities when used by
475 * set operations, or the modifiable capabilities when used by
477 uint_least64_t bmask;
478 /** \brief Mask of set process context capabilities */
479 uint_least64_t ccaps;
480 /** \brief Mask of set and unset process context capabilities when used
481 * by set operations, or the modifiable capabilities when used
482 * by get operations */
483 uint_least64_t cmask;
486 int vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
487 int vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
494 int vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
496 /** \brief Returns the context of the given process.
499 * \param pid the process-id whose xid shall be determined;
500 * pid==0 means the current process.
501 * \returns the xid of process \c pid or -1 on errors
503 xid_t vc_get_task_xid(pid_t pid);
505 /** \brief Waits for the end of a context
508 int vc_wait_exit(xid_t xid);
510 /* rlimit related functions */
512 /** \brief The type which is used for a single limit value.
515 * - VC_LIM_INFINITY ... which is the infinite value
516 * - VC_LIM_KEEP ... which is used to mark values which shall not be
517 * modified by the vc_set_rlimit() operation.
519 * Else, the interpretation of the value depends on the corresponding
520 * resource; it might be bytes, pages, seconds or litres of beer. */
521 typedef uint_least64_t vc_limit_t;
523 /** \brief Masks describing the supported limits. */
524 struct vc_rlimit_mask {
525 uint_least32_t min; ///< masks the resources supporting a minimum limit
526 uint_least32_t soft; ///< masks the resources supporting a soft limit
527 uint_least32_t hard; ///< masks the resources supporting a hard limit
530 /** \brief Returns the limits supported by the kernel */
531 int vc_get_rlimit_mask(xid_t xid,
532 struct vc_rlimit_mask /*@out@*/ *lim) VC_ATTR_NONNULL((2));
534 /** \brief The limits of a resources.
536 * This is a triple consisting of a minimum, soft and hardlimit. */
538 vc_limit_t min; ///< the guaranted minimum of a resources
539 vc_limit_t soft; ///< the softlimit of a resource
540 vc_limit_t hard; ///< the absolute hardlimit of a resource
543 /** \brief Returns the limits of \a resource.
546 * \param xid The id of the context
547 * \param resource The resource which will be queried
548 * \param lim The result which will be filled with the limits
550 * \returns 0 on success, and -1 on errors. */
551 int vc_get_rlimit(xid_t xid, int resource,
552 struct vc_rlimit /*@out@*/ *lim) VC_ATTR_NONNULL((3));
553 /** \brief Sets the limits of \a resource.
556 * \param xid The id of the context
557 * \param resource The resource which will be queried
558 * \param lim The new limits
560 * \returns 0 on success, and -1 on errors. */
561 int vc_set_rlimit(xid_t xid, int resource,
562 struct vc_rlimit const /*@in@*/ *lim) VC_ATTR_NONNULL((3));
564 /** \brief Statistics for a resource limit. */
565 struct vc_rlimit_stat {
566 uint_least32_t hits; ///< number of hits on the limit
567 vc_limit_t value; ///< current value
568 vc_limit_t minimum; ///< minimum value observed
569 vc_limit_t maximum; ///< maximum value observed
572 /** \brief Returns the current stats of \a resource.
575 * \param xid The id of the context
576 * \param resource The resource which will be queried
577 * \param stat The result which will be filled with the stats
579 * \returns 0 on success, and -1 on errors. */
580 int vc_rlimit_stat(xid_t xid, int resource,
581 struct vc_rlimit_stat /*@out@*/ *stat) VC_ATTR_NONNULL((3));
583 /** \brief Resets the minimum and maximum observed values of all resources.
586 * \param xid The id of the context
588 * \returns 0 on success, and -1 on errors. */
589 int vc_reset_minmax(xid_t xid);
591 /** \brief Parses a string describing a limit
594 * This function parses \a str and interprets special words like \p "inf"
595 * or suffixes. Valid suffixes are
601 * \param str The string which shall be parsed
602 * \param res Will be filled with the interpreted value; in errorcase,
603 * this value is undefined.
605 * \returns \a true, iff the string \a str could be parsed. \a res will
606 * be filled with the interpreted value in this case.
608 * \pre \a str!=0 && \a res!=0
610 bool vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res) VC_ATTR_NONNULL((1,2));
613 /* network context */
618 nid_t vc_get_task_nid(pid_t pid);
619 int vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
633 struct in6_addr mask;
636 #define vna_v4_ip u.ipv4.ip
637 #define vna_v4_mask u.ipv4.mask
638 #define vna_v6_ip u.ipv6.ip
639 #define vna_v6_mask u.ipv6.mask
642 struct vc_net_flags {
643 uint_least64_t flagword;
647 nid_t vc_net_create(nid_t nid);
648 int vc_net_migrate(nid_t nid);
650 int vc_net_add(nid_t nid, struct vc_net_addr const *info);
651 int vc_net_remove(nid_t nid, struct vc_net_addr const *info);
653 int vc_get_nflags(nid_t, struct vc_net_flags *);
654 int vc_set_nflags(nid_t, struct vc_net_flags const *);
657 uint_least64_t ncaps;
658 uint_least64_t cmask;
661 int vc_get_ncaps(nid_t, struct vc_net_caps *);
662 int vc_set_ncaps(nid_t, struct vc_net_caps const *);
665 /* iattr related functions */
667 int vc_set_iattr(char const *filename, xid_t xid,
668 uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
670 int vc_fset_iattr(int fd, xid_t xid,
671 uint_least32_t flags, uint_least32_t mask);
673 /** \brief Returns information about attributes and assigned context of a file.
676 * This function returns the VC_IATTR_XXX flags and about the assigned
677 * context of a file. To request an information, the appropriate bit in
678 * \c mask must be set and the corresponding parameter (\a xid or \a
679 * flags) must not be NULL.
681 * E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
682 * set in \a mask, and \a xid must point to valid memory.
684 * Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
685 * \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
687 * \param filename The name of the file whose attributes shall be determined.
689 * \param xid When non-zero and the VC_IATTR_XID bit is set in \a mask,
690 * the assigned context of \a filename will be stored there.
691 * \param flags When non-zero, a bitmask of current attributes will be
692 * stored there. These attributes must be requested explicitly
693 * by setting the appropriate bit in \a mask
694 * \param mask Points to a bitmask which tells which attributes shall be
695 * determined. On return, it will masquerade the attributes
696 * which were determined.
698 * \pre mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
699 int vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
700 uint_least32_t * /*@null@*/ flags,
701 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
703 int vc_fget_iattr(int fd, xid_t * /*@null@*/ xid,
704 uint_least32_t * /*@null@*/ flags,
705 uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((4));
707 /** \brief Returns the context of \c filename
710 * This function calls vc_get_iattr() with appropriate arguments to
711 * determine the context of \c filename. In error-case or when no context
712 * is assigned, \c VC_NOCTX will be returned. To differ between both cases,
713 * \c errno must be examined.
715 * \b WARNING: this function can modify \c errno although no error happened.
717 * \param filename The file to check
718 * \returns The assigned context, or VC_NOCTX when an error occured or no
719 * such assignment exists. \c errno will be 0 in the latter case */
720 xid_t vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
723 /* vhi related functions */
724 typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
725 vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
726 vcVHI_DOMAINNAME } vc_uts_type;
728 int vc_set_vhi_name(xid_t xid, vc_uts_type type,
729 char const *val, size_t len) VC_ATTR_NONNULL((3));
730 int vc_get_vhi_name(xid_t xid, vc_uts_type type,
731 char *val, size_t len) VC_ATTR_NONNULL((3));
733 /* namespace related functions */
734 int vc_enter_namespace(xid_t xid, uint_least64_t mask);
735 int vc_set_namespace(xid_t xid, uint_least64_t mask);
736 int vc_cleanup_namespace();
737 uint_least64_t vc_get_space_mask();
740 /* disk limit related things */
741 struct vc_ctx_dlimit {
742 uint_least32_t space_used;
743 uint_least32_t space_total;
744 uint_least32_t inodes_used;
745 uint_least32_t inodes_total;
746 uint_least32_t reserved;
750 /** Add a disk limit to a file system. */
751 int vc_add_dlimit(char const *filename, xid_t xid,
752 uint_least32_t flags) VC_ATTR_NONNULL((1));
753 /** Remove a disk limit from a file system. */
754 int vc_rem_dlimit(char const *filename, xid_t xid,
755 uint_least32_t flags) VC_ATTR_NONNULL((1));
757 /** Set a disk limit. */
758 int vc_set_dlimit(char const *filename, xid_t xid,
759 uint_least32_t flags,
760 struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
761 /** Get a disk limit. */
762 int vc_get_dlimit(char const *filename, xid_t xid,
763 uint_least32_t flags,
764 struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
766 /* scheduler related syscalls */
767 struct vc_set_sched {
768 uint_least32_t set_mask;
769 int_least32_t fill_rate;
770 int_least32_t interval;
771 int_least32_t fill_rate2;
772 int_least32_t interval2;
773 int_least32_t tokens;
774 int_least32_t tokens_min;
775 int_least32_t tokens_max;
776 int_least32_t priority_bias;
777 int_least32_t cpu_id;
778 int_least32_t bucket_id;
781 int vc_set_sched(xid_t xid, struct vc_set_sched const *) VC_ATTR_NONNULL((2));
782 int vc_get_sched(xid_t xid, struct vc_set_sched *) VC_ATTR_NONNULL((2));
784 struct vc_sched_info {
785 int_least32_t cpu_id;
786 int_least32_t bucket_id;
787 uint_least64_t user_msec;
788 uint_least64_t sys_msec;
789 uint_least64_t hold_msec;
790 uint_least32_t token_usec;
791 int_least32_t vavavoom;
794 int vc_sched_info(xid_t xid, struct vc_sched_info *info) VC_ATTR_NONNULL((2));
797 int vc_set_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
800 /** \brief Information about parsing errors
803 struct vc_err_listparser {
804 char const *ptr; ///< Pointer to the first character of an erroneous string
805 size_t len; ///< Length of the erroneous string
808 /** \brief Converts a single string into bcapability
811 * \param str The string to be parsed;
812 * both "CAP_xxx" and "xxx" will be accepted
813 * \param len The length of the string, or \c 0 for automatic detection
815 * \returns 0 on error; a bitmask on success
818 uint_least64_t vc_text2bcap(char const *str, size_t len);
820 /** \brief Converts the lowest bit of a bcapability or the entire value
821 * (when possible) to a textual representation
824 * \param val The string to be converted; on success, the detected bit(s)
825 * will be unset, in errorcase only the lowest set bit
827 * \returns A textual representation of \a val resp. of its lowest set bit;
828 * or \c NULL in errorcase.
830 * \post \a *val<sub>old</sub> \c != 0 \c <-->
831 * \a *val<sub>old</sub> > \a *val<sub>new</sub>
832 * \post \a *val<sub>old</sub> \c == 0 \c ---> \a result == 0
834 char const * vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
836 /** \brief Converts a string into a bcapability-bitmask
839 * Syntax of \a str: \verbinclude list2xxx.syntax
841 * When the \c `~' prefix is used, the bits will be unset and a `~' after
842 * another `~' will cancel both ones. The \c `^' prefix specifies a
843 * bitnumber instead of a bitmask.
845 * "literal name" is everything which will be accepted by the
846 * vc_text2bcap() function. The special values for \c NAME will be
847 * recognized case insensitively
849 * \param str The string to be parsed
850 * \param len The length of the string, or \c 0 for automatic detection
851 * \param err Pointer to a structure for error-information, or \c NULL.
852 * \param cap Pointer to a vc_ctx_caps structure holding the results;
853 * only the \a bcaps and \a bmask fields will be changed and
854 * already set values will not be honored. When an error
855 * occured, \a cap will have the value of all processed valid
858 * \returns 0 on success, -1 on error. In error case, \a err will hold
859 * position and length of the first not understood BCAP part
860 * \pre \a str != 0 && \a cap != 0;
861 * \a cap->bcaps and \a cap->bmask must be initialized
863 int vc_list2bcap(char const *str, size_t len,
864 struct vc_err_listparser *err,
865 struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
867 uint_least64_t vc_text2ccap(char const *, size_t len);
868 char const * vc_loccap2text(uint_least64_t *);
869 int vc_list2ccap(char const *, size_t len,
870 struct vc_err_listparser *err,
871 struct vc_ctx_caps *);
873 int vc_list2cflag(char const *, size_t len,
874 struct vc_err_listparser *err,
875 struct vc_ctx_flags *flags);
876 uint_least64_t vc_text2cflag(char const *, size_t len);
877 char const * vc_locflag2text(uint_least64_t *);
879 uint_least32_t vc_list2cflag_compat(char const *, size_t len,
880 struct vc_err_listparser *err);
881 uint_least32_t vc_text2cflag_compat(char const *, size_t len);
882 char const * vc_hicflag2text_compat(uint_least32_t);
884 int vc_text2cap(char const *);
885 char const * vc_cap2text(unsigned int);
888 int vc_list2nflag(char const *, size_t len,
889 struct vc_err_listparser *err,
890 struct vc_net_flags *flags);
891 uint_least64_t vc_text2nflag(char const *, size_t len);
892 char const * vc_lonflag2text(uint_least64_t *);
894 uint_least64_t vc_text2ncap(char const *, size_t len);
895 char const * vc_loncap2text(uint_least64_t *);
896 int vc_list2ncap(char const *, size_t len,
897 struct vc_err_listparser *err,
898 struct vc_net_caps *);
900 uint_least64_t vc_get_insecurebcaps() VC_ATTR_CONST;
901 inline static uint_least64_t vc_get_insecureccaps() {
902 return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP);
905 inline static int vc_setfilecontext(char const *filename, xid_t xid) {
906 return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
910 uint_least32_t vc_text2personalityflag(char const *str,
911 size_t len) VC_ATTR_NONNULL((1));
913 char const * vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
915 int vc_list2personalityflag(char const /*@in@*/ *,
917 uint_least32_t /*@out@*/ *personality,
918 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
920 uint_least32_t vc_str2personalitytype(char const /*@in@*/*,
921 size_t len) VC_ATTR_NONNULL((1));
924 typedef enum { vcFEATURE_VKILL, vcFEATURE_IATTR, vcFEATURE_RLIMIT,
925 vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
926 vcFEATURE_SCHED, vcFEATURE_VINFO, vcFEATURE_VHI,
927 vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
928 vcFEATURE_VNET, vcFEATURE_VSTAT }
931 bool vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
932 bool vc_isSupportedString(char const *);
935 typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
936 vcTYPE_STATIC, vcTYPE_DYNAMIC }
939 vcXidType vc_getXIDType(xid_t xid) VC_ATTR_CONST;
941 /** Returns true iff \a xid is a dynamic xid */
942 bool vc_is_dynamic_xid(xid_t xid);
945 /* The management part */
947 #define VC_LIMIT_VSERVER_NAME_LEN 1024
949 typedef enum { vcCFG_NONE, vcCFG_AUTO,
952 vcCFG_RECENT_FULL } vcCfgStyle;
955 /** Maps an xid given at '--xid' options to an xid_t */
956 xid_t vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
957 /** Maps a nid given at '--nid' options to a nid_t */
958 nid_t vc_nidopt2nid(char const *, bool honor_static, char const **err_info);
960 vcCfgStyle vc_getVserverCfgStyle(char const *id);
962 /** Resolves the name of the vserver. The result will be allocated and must
963 be freed by the caller. */
964 char * vc_getVserverName(char const *id, vcCfgStyle style);
966 /** Returns the path of the vserver configuration directory. When the given
967 * vserver does not exist, or when it does not have such a directory, NULL
968 * will be returned. Else, the result will be allocated and must be freed
970 char * vc_getVserverCfgDir(char const *id, vcCfgStyle style);
972 /** Returns the path of the configuration directory for the given
973 * application. The result will be allocated and must be freed by the
975 char * vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
977 /** Returns the path to the vserver root-directory. The result will be
978 * allocated and must be freed by the caller. */
979 char * vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
981 /** Returns the ctx of the given vserver. When vserver is not running and
982 * 'honor_static' is false, VC_NOCTX will be returned. Else, when
983 * 'honor_static' is true and a static assignment exists, those value will
984 * be returned. Else, the result will be VC_NOCTX.
986 * When 'is_running' is not null, the status of the vserver will be
987 * assigned to this variable. */
988 xid_t vc_getVserverCtx(char const *id, vcCfgStyle style,
989 bool honor_static, bool /*@null@*/ *is_running);
991 /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
992 be used as the directory holding the mapping-links; when NULL, the
993 default value will be assumed. The result will be allocated and must be
994 freed by the caller. */
995 char * vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
996 /*@null@*/char const *revdir);
998 int vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
999 char const *rhs, vcCfgStyle rhs_style);
1001 #define vcSKEL_INTERFACES 1u
1002 #define vcSKEL_PKGMGMT 2u
1003 #define vcSKEL_FILESYSTEM 4u
1005 /** Create a basic configuration skeleton for a vserver plus toplevel
1006 * directories for pkgmanagemt and filesystem (when requested). */
1007 int vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
1015 #undef VC_ATTR_ALWAYSINLINE
1016 #undef VC_ATTR_NORETURN
1017 #undef VC_ATTR_UNUSED
1018 #undef VC_ATTR_NONNULL