cdf671a3d4b3d5dfd94a4ec98351c4cbfd245ca5
[util-vserver.git] / lib / vserver.h
1 /* $Id$
2
3 *  Copyright (C) 2003 Enrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
4 *   
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)
8 *  any later version.
9 *   
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.
14 *   
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.
18 */
19
20 /** \file vserver.h
21  *  \brief The public interface of the the libvserver library.
22  */
23
24 #ifndef H_VSERVER_SYSCALL_H
25 #define H_VSERVER_SYSCALL_H
26
27 #include <stdint.h>
28 #include <stdlib.h>
29 #include <stdbool.h>
30 #include <sys/types.h>
31
32 #ifndef IS_DOXYGEN
33 #if defined(__GNUC__)
34 #  define VC_ATTR_UNUSED                __attribute__((__unused__))
35 #  define VC_ATTR_NORETURN              __attribute__((__noreturn__))
36 #  define VC_ATTR_CONST                 __attribute__((__const__))
37 #  define VC_ATTR_DEPRECATED            __attribute__((__deprecated__))
38 #  if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30300
39 #    define VC_ATTR_NONNULL(ARGS)       __attribute__((__nonnull__ ARGS))
40 #    define VC_ATTR_ALWAYSINLINE        __attribute__((__always_inline__))
41 #  else
42 #    define VC_ATTR_NONNULL(ARGS)
43 #    define VC_ATTR_ALWAYSINLINE
44 #  endif
45 #  if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30303
46 #    define VC_ATTR_PURE                __attribute__((__pure__))
47 #  else
48 #    define VC_ATTR_PURE
49 #  endif
50 #else
51 #  define VC_ATTR_NONNULL(ARGS)
52 #  define VC_ATTR_UNUSED
53 #  define VC_ATTR_NORETURN
54 #  define VC_ATTR_ALWAYSINLINE
55 #  define VC_ATTR_DEPRECATED
56 #  define VC_ATTR_PURE
57 #  define VC_ATTR_CONST
58 #endif
59 #endif  // IS_DOXYGEN
60
61 /** the value which is returned in error-case (no ctx found) */
62 #define VC_NOCTX                ((xid_t)(-1))
63 #define VC_NOXID                ((xid_t)(-1))
64 /** the value which means a random (the next free) ctx */
65 #define VC_DYNAMIC_XID          ((xid_t)(-1))
66 /** the value which means the current ctx */
67 #define VC_SAMECTX              ((xid_t)(-2))
68
69 #define VC_NONID                ((nid_t)(-1))
70 #define VC_DYNAMIC_NID          ((nid_t)(-1))
71
72 #define VC_LIM_INFINITY         (~0ULL)
73 #define VC_LIM_KEEP             (~1ULL)
74
75 #define VC_CDLIM_UNSET          (0U)
76 #define VC_CDLIM_INFINITY       (~0U)
77 #define VC_CDLIM_KEEP           (~1U)
78   
79 #ifndef S_CTX_INFO_LOCK
80 #  define S_CTX_INFO_LOCK       1
81 #endif
82
83 #ifndef S_CTX_INFO_SCHED
84 #  define S_CTX_INFO_SCHED      2
85 #endif
86
87 #ifndef S_CTX_INFO_NPROC
88 #  define S_CTX_INFO_NPROC      4
89 #endif
90
91 #ifndef S_CTX_INFO_PRIVATE
92 #  define S_CTX_INFO_PRIVATE    8
93 #endif
94
95 #ifndef S_CTX_INFO_INIT
96 #  define S_CTX_INFO_INIT       16
97 #endif
98
99 #ifndef S_CTX_INFO_HIDEINFO
100 #  define S_CTX_INFO_HIDEINFO   32
101 #endif
102
103 #ifndef S_CTX_INFO_ULIMIT
104 #  define S_CTX_INFO_ULIMIT     64
105 #endif
106
107 #ifndef S_CTX_INFO_NAMESPACE
108 #  define S_CTX_INFO_NAMESPACE  128
109 #endif
110
111 #define VC_CAP_CHOWN                     0
112 #define VC_CAP_DAC_OVERRIDE              1
113 #define VC_CAP_DAC_READ_SEARCH           2
114 #define VC_CAP_FOWNER                    3
115 #define VC_CAP_FSETID                    4
116 #define VC_CAP_KILL                      5
117 #define VC_CAP_SETGID                    6
118 #define VC_CAP_SETUID                    7
119 #define VC_CAP_SETPCAP                   8
120 #define VC_CAP_LINUX_IMMUTABLE           9
121 #define VC_CAP_NET_BIND_SERVICE         10
122 #define VC_CAP_NET_BROADCAST            11
123 #define VC_CAP_NET_ADMIN                12
124 #define VC_CAP_NET_RAW                  13
125 #define VC_CAP_IPC_LOCK                 14
126 #define VC_CAP_IPC_OWNER                15
127 #define VC_CAP_SYS_MODULE               16
128 #define VC_CAP_SYS_RAWIO                17
129 #define VC_CAP_SYS_CHROOT               18
130 #define VC_CAP_SYS_PTRACE               19
131 #define VC_CAP_SYS_PACCT                20
132 #define VC_CAP_SYS_ADMIN                21
133 #define VC_CAP_SYS_BOOT                 22
134 #define VC_CAP_SYS_NICE                 23
135 #define VC_CAP_SYS_RESOURCE             24
136 #define VC_CAP_SYS_TIME                 25
137 #define VC_CAP_SYS_TTY_CONFIG           26
138 #define VC_CAP_MKNOD                    27
139 #define VC_CAP_LEASE                    28
140 #define VC_CAP_AUDIT_WRITE              29
141 #define VC_CAP_AUDIT_CONTROL            30
142
143 #define VC_IMMUTABLE_FILE_FL            0x0000010lu
144 #define VC_IMMUTABLE_LINK_FL            0x0008000lu
145 #define VC_IMMUTABLE_ALL                (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
146
147 #define VC_IATTR_XID                    0x01000000u
148
149 #define VC_IATTR_ADMIN                  0x00000001u
150 #define VC_IATTR_WATCH                  0x00000002u
151 #define VC_IATTR_HIDE                   0x00000004u
152 #define VC_IATTR_FLAGS                  0x00000007u
153
154 #define VC_IATTR_BARRIER                0x00010000u
155 #define VC_IATTR_IUNLINK                0x00020000u
156 #define VC_IATTR_IMMUTABLE              0x00040000u
157
158
159 // the flags
160 #define VC_VXF_INFO_LOCK                0x00000001ull
161 #define VC_VXF_INFO_NPROC               0x00000004ull
162 #define VC_VXF_INFO_PRIVATE             0x00000008ull
163 #define VC_VXF_INFO_INIT                0x00000010ull
164
165 #define VC_VXF_INFO_HIDEINFO            0x00000020ull
166 #define VC_VXF_INFO_ULIMIT              0x00000040ull
167 #define VC_VXF_INFO_NAMESPACE           0x00000080ull
168
169 #define VC_VXF_SCHED_HARD               0x00000100ull
170 #define VC_VXF_SCHED_PRIO               0x00000200ull
171 #define VC_VXF_SCHED_PAUSE              0x00000400ull
172
173 #define VC_VXF_VIRT_MEM                 0x00010000ull
174 #define VC_VXF_VIRT_UPTIME              0x00020000ull
175 #define VC_VXF_VIRT_CPU                 0x00040000ull
176 #define VC_VXF_VIRT_LOAD                0x00080000ull
177
178 #define VC_VXF_HIDE_MOUNT               0x01000000ull
179 #define VC_VXF_HIDE_NETIF               0x02000000ull
180
181 #define VC_VXF_STATE_SETUP              (1ULL<<32)
182 #define VC_VXF_STATE_INIT               (1ULL<<33)
183
184 #define VC_VXF_SC_HELPER                (1ULL<<36)
185 #define VC_VXF_REBOOT_KILL              (1ULL<<37)
186 #define VC_VXF_PERSISTENT               (1ULL<<38)
187
188 #define VC_VXF_FORK_RSS                 (1ULL<<48)
189 #define VC_VXF_PROLIFIC                 (1ULL<<49)
190
191 #define VC_VXF_IGNEG_NICE               (1ULL<<52)
192
193
194 // the ccapabilities
195 #define VC_VXC_SET_UTSNAME              0x00000001ull
196 #define VC_VXC_SET_RLIMIT               0x00000002ull
197
198 #define VC_VXC_RAW_ICMP                 0x00000100ull
199 #define VC_VXC_SYSLOG                   0x00001000ull
200
201 #define VC_VXC_SECURE_MOUNT             0x00010000ull
202 #define VC_VXC_SECURE_REMOUNT           0x00020000ull
203 #define VC_VXC_BINARY_MOUNT             0x00040000ull
204
205 #define VC_VXC_QUOTA_CTL                0x00100000ull
206
207
208 #define VC_VXSM_FILL_RATE               0x0001
209 #define VC_VXSM_INTERVAL                0x0002
210 #define VC_VXSM_TOKENS                  0x0010
211 #define VC_VXSM_TOKENS_MIN              0x0020
212 #define VC_VXSM_TOKENS_MAX              0x0040
213 #define VC_VXSM_PRIO_BIAS               0x0100
214
215
216 #define VC_BAD_PERSONALITY              ((uint_least32_t)(-1))
217
218
219 /** \defgroup  syscalls Syscall wrappers
220  *  Functions which are calling the vserver syscall directly. */
221
222 /** \defgroup  helper   Helper functions
223  *  Functions which are doing general helper tasks like parameter parsing. */
224
225 /** \typedef  an_unsigned_integer_type  xid_t
226  *  The identifier of a context. */
227
228 #ifdef IS_DOXYGEN
229 typedef an_unsigned_integer_type        xid_t;
230 typedef an_unsigned_integer_type        nid_t;
231 #endif
232
233 #ifdef __cplusplus
234 extern "C" {
235 #endif
236
237   struct vc_ip_mask_pair {
238       uint32_t  ip;
239       uint32_t  mask;
240   };
241
242     /** \brief   The generic vserver syscall
243      *  \ingroup syscalls
244      *
245      *  This function executes the generic vserver syscall. It uses the
246      *  correct syscallnumber (which may differ between the different
247      *  architectures).
248      *
249      *  \param   cmd  the command to be executed
250      *  \param   xid  the xid on which the cmd shall be applied
251      *  \param   data additional arguments; depends on \c cmd
252      *  \returns depends on \c cmd; usually, -1 stands for an error
253      */
254   int   vc_syscall(uint32_t cmd, xid_t xid, void *data);
255
256     /** \brief   Returns the version of the current kernel API.
257      *  \ingroup syscalls
258      *  \returns The versionnumber of the kernel API
259      */
260   int   vc_get_version();
261   
262     /** \brief   Moves current process into a context
263      *  \ingroup syscalls
264      *
265      *  Puts current process into context \a ctx, removes the capabilities
266      *  given in \a remove_cap and sets \a flags.
267      *
268      *  \param ctx         The new context; special values for are
269      *  - VC_SAMECTX      which means the current context (just for changing caps and flags)
270      *  - VC_DYNAMIC_XID  which means the next free context; this value can be used by
271      *                    ordinary users also
272      *  \param remove_cap  The linux capabilities which will be \b removed.
273      *  \param flags       Special flags which will be set.
274      *
275      *  \returns  The new context-id, or VC_NOCTX on errors; \c errno
276      *            will be set appropriately
277      *
278      *  See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
279   xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
280
281     /** \brief  Sets the ipv4root information.
282      *  \ingroup syscalls
283      *  \pre    \a nb < NB_IPV4ROOT && \a ips != 0 */
284   int   vc_set_ipv4root(uint32_t  bcast, size_t nb,
285                         struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
286
287     /** \brief  Returns the value of NB_IPV4ROOT.
288      *  \ingroup helper
289      *
290      *  This function returns the value of NB_IPV4ROOT which was used when the
291      *  library was built, but \b not the value which is used by the currently
292      *  running kernel. */
293   size_t        vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
294
295     /** \brief   Creates a context without starting it.
296      *  \ingroup syscalls
297      *
298      *  This functions initializes a new context. When already in a freshly
299      *  created context, this old context will be discarded.
300      *
301      *  \param xid  The new context; special values are:
302      *  - VC_DYNAMIC_XID which means to create a dynamic context
303      *
304      *  \returns the xid of the created context, or VC_NOCTX on errors. \c errno
305      *           will be set appropriately. */
306   xid_t vc_ctx_create(xid_t xid);
307
308     /** \brief   Moves the current process into the specified context.
309      *  \ingroup syscalls
310      *
311      *  \param   xid  The new context
312      *  \returns 0 on success, -1 on errors */
313   int   vc_ctx_migrate(xid_t xid);
314   
315     /* rlimit related functions */
316   
317     /** \brief  The type which is used for a single limit value.
318      *
319      *  Special values are
320      *  - VC_LIM_INFINITY ... which is the infinite value
321      *  - VC_LIM_KEEP     ... which is used to mark values which shall not be
322      *                        modified by the vc_set_rlimit() operation.
323      *
324      *  Else, the interpretation of the value depends on the corresponding
325      *  resource; it might be bytes, pages, seconds or litres of beer. */
326   typedef uint_least64_t        vc_limit_t;
327
328     /** \brief  The limits of a resources.
329      *
330      *  This is a triple consisting of a minimum, soft and hardlimit. */
331   struct vc_rlimit {
332       vc_limit_t        min;    ///< the guaranted minimum of a resources
333       vc_limit_t        soft;   ///< the softlimit of a resource
334       vc_limit_t        hard;   ///< the absolute hardlimit of a resource
335   };
336
337     /** \brief  Masks describing the supported limits. */
338   struct  vc_rlimit_mask {
339       uint_least32_t    min;    ///< masks the resources supporting a minimum limit
340       uint_least32_t    soft;   ///< masks the resources supporting a soft limit
341       uint_least32_t    hard;   ///< masks the resources supporting a hard limit
342   };
343
344     /** \brief   Returns the limits of \a resource.
345      *  \ingroup syscalls
346      *
347      *  \param  xid       The id of the context
348      *  \param  resource  The resource which will be queried
349      *  \param  lim       The result which will be filled with the limits
350      *
351      *  \returns 0 on success, and -1 on errors. */
352   int   vc_get_rlimit(xid_t xid, int resource,
353                       struct vc_rlimit       /*@out@*/ *lim) VC_ATTR_NONNULL((3));
354     /** \brief   Sets the limits of \a resource.
355      *  \ingroup syscalls
356      *
357      *  \param  xid       The id of the context
358      *  \param  resource  The resource which will be queried
359      *  \param  lim       The new limits
360      *
361      *  \returns 0 on success, and -1 on errors. */
362   int   vc_set_rlimit(xid_t xid, int resource,
363                       struct vc_rlimit const /*@in@*/  *lim) VC_ATTR_NONNULL((3));
364   int   vc_get_rlimit_mask(xid_t xid,
365                            struct vc_rlimit_mask *lim)       VC_ATTR_NONNULL((2));
366     /** \brief   Parses a string describing a limit
367      *  \ingroup helper
368      *
369      *  This function parses \a str and interprets special words like \p "inf"
370      *  or suffixes. Valid suffixes are
371      *  - \p k ... 1000
372      *  - \p m ... 1000000
373      *  - \p K ... 1024
374      *  - \p M ... 1048576
375      *
376      *  \param str  The string which shall be parsed
377      *  \param res  Will be filled with the interpreted value; in errorcase,
378      *              this value is undefined.
379      *
380      *  \returns \a true, iff the string \a str could be parsed. \a res will
381      *  be filled with the interpreted value in this case. 
382      *
383      *  \pre \a str!=0 && \a res!=0
384      */
385   bool  vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res)      VC_ATTR_NONNULL((1,2));
386
387
388   /** \brief    Sends a signal to a context/pid
389    *  \ingroup  syscalls
390    *
391    *  Special values for \a pid are:
392    *  - -1   which means every process in ctx except the init-process
393    *  -  0   which means every process in ctx inclusive the init-process */
394   int   vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
395
396
397   struct vc_nx_info {
398       nid_t     nid;
399   };
400
401   nid_t         vc_get_task_nid(pid_t pid);
402   int           vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
403
404   typedef enum { vcNET_IPV4=1,      vcNET_IPV6=2,
405                  vcNET_IPV4B=0x101, vcNET_IPV6B=0x102,
406                  vcNET_ANY=~0 }         vc_net_nx_type;
407
408   struct vc_net_nx {
409       vc_net_nx_type    type;
410       size_t            count;
411       uint32_t          ip[4];
412       uint32_t          mask[4];
413   };
414
415   nid_t         vc_net_create(nid_t nid);
416   int           vc_net_migrate(nid_t nid);
417
418   int           vc_net_add(nid_t nid, struct vc_net_nx const *info);
419   int           vc_net_remove(nid_t nid, struct vc_net_nx const *info);
420
421   struct vc_net_flags {
422       uint_least64_t    flagword;
423       uint_least64_t    mask;
424   };
425   
426   int           vc_get_nflags(nid_t, struct vc_net_flags *);
427   int           vc_set_nflags(nid_t, struct vc_net_flags const *);
428
429   
430   struct vc_net_caps {
431       uint_least64_t    ncaps;
432       uint_least64_t    cmask;
433   };
434
435   int           vc_get_ncaps(nid_t, struct vc_net_caps *);
436   int           vc_set_ncaps(nid_t, struct vc_net_caps const *);
437
438
439   
440
441   int           vc_set_iattr(char const *filename, xid_t xid,
442                              uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
443
444     /** \brief   Returns information about attributes and assigned context of a file.
445      *  \ingroup syscalls
446      *
447      *  This function returns the VC_IATTR_XXX flags and about the assigned
448      *  context of a file. To request an information, the appropriate bit in
449      *  \c mask must be set and the corresponding parameter (\a xid or \a
450      *  flags) must not be NULL.
451      *
452      *  E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
453      *  set in \a mask, and \a xid must point to valid memory.
454      *
455      *  Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
456      *  \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
457      *
458      *  \param filename  The name of the file whose attributes shall be determined.
459
460      *  \param xid       When non-zero and the VC_IATTR_XID bit is set in \a mask,
461      *                   the assigned context of \a filename will be stored there.
462      *  \param flags     When non-zero, a bitmask of current attributes will be
463      *                   stored there. These attributes must be requested explicitly
464      *                   by setting the appropriate bit in \a mask
465      *  \param mask      Points to a bitmask which tells which attributes shall be
466      *                   determined. On return, it will masquerade the attributes
467      *                   which were determined.
468      *
469      *  \pre  mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
470   int           vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
471                              uint_least32_t * /*@null@*/ flags,
472                              uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
473
474   struct vc_vx_info {
475       xid_t     xid;
476       pid_t     initpid;
477   };
478   
479     /** \brief   Returns the context of the given process.
480      *  \ingroup syscalls
481      *
482      *  \param  pid  the process-id whose xid shall be determined;
483      *               pid==0 means the current process.
484      *  \returns     the xid of process \c pid or -1 on errors
485      */
486   xid_t         vc_get_task_xid(pid_t pid);
487   int           vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
488
489
490   typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
491                  vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
492                  vcVHI_DOMAINNAME }             vc_uts_type;
493   
494   int           vc_set_vhi_name(xid_t xid, vc_uts_type type,
495                                 char const *val, size_t len) VC_ATTR_NONNULL((3));
496   int           vc_get_vhi_name(xid_t xid, vc_uts_type type,
497                                 char *val, size_t len)       VC_ATTR_NONNULL((3));
498
499     /** Returns true iff \a xid is a dynamic xid */
500   bool          vc_is_dynamic_xid(xid_t xid);
501
502   int           vc_enter_namespace(xid_t xid);
503   int           vc_set_namespace();
504   int           vc_cleanup_namespace();
505
506   
507   /** \brief    Flags of process-contexts
508    */
509   struct  vc_ctx_flags {
510       /** \brief Mask of set context flags */
511       uint_least64_t    flagword;
512       /** \brief Mask of set and unset context flags when used by set
513        *         operations, or modifiable flags when used by get
514        *         operations */
515       uint_least64_t    mask;
516   };
517
518   /** \brief    Capabilities of process-contexts */
519   struct  vc_ctx_caps {
520       /** \brief  Mask of set common system capabilities */
521       uint_least64_t    bcaps;
522       /** \brief Mask of set and unset common system capabilities when used by
523        *         set operations, or the modifiable capabilities when used by
524        *         get operations */
525       uint_least64_t    bmask;
526       /** \brief Mask of set process context capabilities */
527       uint_least64_t    ccaps;
528       /** \brief Mask of set and unset process context capabilities when used
529        *         by set operations, or the modifiable capabilities when used
530        *         by get operations */
531       uint_least64_t    cmask;
532   };
533
534   /** \brief    Information about parsing errors
535    *  \ingroup  helper
536    */
537   struct vc_err_listparser {
538       char const        *ptr;           ///< Pointer to the first character of an erroneous string
539       size_t            len;            ///< Length of the erroneous string
540   };
541  
542   int                   vc_get_cflags(xid_t xid, struct vc_ctx_flags *)       VC_ATTR_NONNULL((2));
543   int                   vc_set_cflags(xid_t xid, struct vc_ctx_flags const *) VC_ATTR_NONNULL((2));
544
545   int                   vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
546   int                   vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
547
548   /** \brief   Converts a single string into bcapability
549    *  \ingroup helper
550    *
551    *  \param   str   The string to be parsed;
552    *                 both "CAP_xxx" and "xxx" will be accepted
553    *  \param   len   The length of the string, or \c 0 for automatic detection
554    *
555    *  \returns 0 on error; a bitmask on success
556    *  \pre     \a str != 0
557    */
558   uint_least64_t        vc_text2bcap(char const *str, size_t len);
559
560   /** \brief   Converts the lowest bit of a bcapability or the entire value
561    *           (when possible) to a textual representation
562    *  \ingroup helper
563    *
564    *  \param   val  The string to be converted; on success, the detected bit(s)
565    *                will be unset, in errorcase only the lowest set bit
566    *
567    *  \returns A textual representation of \a val resp. of its lowest set bit;
568    *           or \c NULL in errorcase.
569    *  \pre     \a val!=0
570    *  \post    \a *val<sub>old</sub> \c != 0  \c <-->
571    *               \a *val<sub>old</sub> > \a *val<sub>new</sub>
572    *  \post    \a *val<sub>old</sub> \c == 0  \c --->  \a result == 0
573    */
574   char const *  vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
575
576   /** \brief   Converts a string into a bcapability-bitmask
577    *  \ingroup helper
578    *
579    *  Syntax of \a str: \verbinclude list2xxx.syntax
580    *
581    *  When the \c `~' prefix is used, the bits will be unset and a `~' after
582    *  another `~' will cancel both ones. The \c `^' prefix specifies a
583    *  bitnumber instead of a bitmask.
584    *
585    *  "literal name" is everything which will be accepted by the
586    *  vc_text2bcap() function. The special values for \c NAME will be
587    *  recognized case insensitively
588    *
589    *  \param  str   The string to be parsed
590    *  \param  len   The length of the string, or \c 0 for automatic detection
591    *  \param  err   Pointer to a structure for error-information, or \c NULL.
592    *  \param  cap   Pointer to a vc_ctx_caps structure holding the results;
593    *                only the \a bcaps and \a bmask fields will be changed and
594    *                already set values will not be honored. When an error
595    *                occured, \a cap will have the value of all processed valid
596    *                \c BCAP parts.
597    *
598    *  \returns 0 on success, -1 on error. In error case, \a err will hold
599    *           position and length of the first not understood BCAP part
600    *  \pre     \a str != 0 && \a cap != 0;
601    *           \a cap->bcaps and \a cap->bmask must be initialized
602    */
603   int                   vc_list2bcap(char const *str, size_t len,
604                                      struct vc_err_listparser *err,
605                                      struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
606
607   uint_least64_t        vc_text2ccap(char const *, size_t len);
608   char const *          vc_loccap2text(uint_least64_t *);
609   int                   vc_list2ccap(char const *, size_t len,
610                                      struct vc_err_listparser *err,
611                                      struct vc_ctx_caps *);
612
613   int                   vc_list2cflag(char const *, size_t len,
614                                      struct vc_err_listparser *err,
615                                      struct vc_ctx_flags *flags);
616   uint_least64_t        vc_text2cflag(char const *, size_t len);
617   char const *          vc_locflag2text(uint_least64_t *);
618   
619   uint_least32_t        vc_list2cflag_compat(char const *, size_t len,
620                                             struct vc_err_listparser *err);
621   uint_least32_t        vc_text2cflag_compat(char const *, size_t len);
622   char const *          vc_hicflag2text_compat(uint_least32_t);
623
624   int                   vc_text2cap(char const *);
625   char const *          vc_cap2text(unsigned int);
626
627   
628   int                   vc_list2nflag(char const *, size_t len,
629                                      struct vc_err_listparser *err,
630                                      struct vc_net_flags *flags);
631   uint_least64_t        vc_text2nflag(char const *, size_t len);
632   char const *          vc_lonflag2text(uint_least64_t *);
633
634   uint_least64_t        vc_text2ncap(char const *, size_t len);
635   char const *          vc_loncap2text(uint_least64_t *);
636   int                   vc_list2ncap(char const *, size_t len,
637                                      struct vc_err_listparser *err,
638                                      struct vc_net_caps *);
639
640   uint_least64_t                vc_get_insecurebcaps() VC_ATTR_CONST;
641   inline static uint_least64_t  vc_get_insecureccaps() {
642     return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP);
643   }
644   
645   inline static int     vc_setfilecontext(char const *filename, xid_t xid) {
646     return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
647   }
648
649
650   uint_least32_t        vc_text2personalityflag(char const *str,
651                                                 size_t len) VC_ATTR_NONNULL((1));
652
653   char const *          vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
654   
655   int                   vc_list2personalityflag(char const /*@in@*/ *,
656                                                 size_t len,
657                                                 uint_least32_t /*@out@*/ *personality,
658                                                 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
659
660   uint_least32_t        vc_str2personalitytype(char const /*@in@*/*,
661                                                size_t len) VC_ATTR_NONNULL((1));
662   
663   /** \brief   Returns the context of \c filename
664    *  \ingroup syscalls
665    *
666    *  This function calls vc_get_iattr() with appropriate arguments to
667    *  determine the context of \c filename. In error-case or when no context
668    *  is assigned, \c VC_NOCTX will be returned. To differ between both cases,
669    *  \c errno must be examined.
670    *
671    *  \b WARNING: this function can modify \c errno although no error happened.
672    *
673    *  \param   filename  The file to check
674    *  \returns The assigned context, or VC_NOCTX when an error occured or no
675    *           such assignment exists. \c errno will be 0 in the latter case */
676   xid_t         vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
677
678
679   struct vc_set_sched {
680       uint_least32_t    set_mask;
681       int_least32_t     fill_rate;
682       int_least32_t     interval;
683       int_least32_t     tokens;
684       int_least32_t     tokens_min;
685       int_least32_t     tokens_max;
686       int_least32_t     priority_bias;
687   };
688
689   int           vc_set_sched(xid_t xid, struct vc_set_sched const *);
690
691
692   struct vc_ctx_dlimit {
693       uint_least32_t    space_used;
694       uint_least32_t    space_total;
695       uint_least32_t    inodes_used;
696       uint_least32_t    inodes_total;
697       uint_least32_t    reserved;
698   };
699   
700
701   /** Add a disk limit to a file system. */
702   int           vc_add_dlimit(char const *filename, xid_t xid,
703                               uint_least32_t flags) VC_ATTR_NONNULL((1));
704   /** Remove a disk limit from a file system. */
705   int           vc_rem_dlimit(char const *filename, xid_t xid,
706                               uint_least32_t flags) VC_ATTR_NONNULL((1));
707
708   /** Set a disk limit. */
709   int           vc_set_dlimit(char const *filename, xid_t xid,
710                               uint_least32_t flags,
711                               struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
712   /** Get a disk limit. */
713   int           vc_get_dlimit(char const *filename, xid_t xid,
714                               uint_least32_t flags,
715                               struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
716
717   /** \brief   Waits for the end of a context
718    *  \ingroup syscalls
719    */
720   int           vc_wait_exit(xid_t xid);
721     
722   typedef enum { vcFEATURE_VKILL,  vcFEATURE_IATTR,   vcFEATURE_RLIMIT,
723                  vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
724                  vcFEATURE_SCHED,  vcFEATURE_VINFO,   vcFEATURE_VHI,
725                  vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
726                  vcFEATURE_VNET }
727     vcFeatureSet;
728
729   bool          vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
730   bool          vc_isSupportedString(char const *);
731
732   
733   typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
734                  vcTYPE_STATIC, vcTYPE_DYNAMIC }
735     vcXidType;
736   
737   vcXidType     vc_getXIDType(xid_t xid) VC_ATTR_CONST;
738
739   /* The management part */
740
741 #define VC_LIMIT_VSERVER_NAME_LEN       1024
742   
743   typedef enum { vcCFG_NONE, vcCFG_AUTO,
744                  vcCFG_LEGACY,
745                  vcCFG_RECENT_SHORT,
746                  vcCFG_RECENT_FULL }            vcCfgStyle;
747
748
749   /** Maps an xid given at '--xid' options to an xid_t */
750   xid_t         vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
751
752   vcCfgStyle    vc_getVserverCfgStyle(char const *id);
753   
754   /** Resolves the name of the vserver. The result will be allocated and must
755       be freed by the caller. */
756   char *        vc_getVserverName(char const *id, vcCfgStyle style);
757
758   /** Returns the path of the vserver configuration directory. When the given
759    *  vserver does not exist, or when it does not have such a directory, NULL
760    *  will be returned. Else, the result will be allocated and must be freed
761    *  by the caller. */
762   char *        vc_getVserverCfgDir(char const *id, vcCfgStyle style);
763
764   /** Returns the path of the configuration directory for the given
765    *  application. The result will be allocated and must be freed by the
766    *  caller. */
767   char *        vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
768
769   /** Returns the path to the vserver root-directory. The result will be
770    *  allocated and must be freed by the caller. */
771   char *        vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
772
773   /** Returns the ctx of the given vserver. When vserver is not running and
774    *  'honor_static' is false, VC_NOCTX will be returned. Else, when
775    *  'honor_static' is true and a static assignment exists, those value will
776    *  be returned. Else, the result will be VC_NOCTX.
777    *
778    *  When 'is_running' is not null, the status of the vserver will be
779    *  assigned to this variable. */
780   xid_t         vc_getVserverCtx(char const *id, vcCfgStyle style,
781                                  bool honor_static, bool /*@null@*/ *is_running);
782
783   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
784       be used as the directory holding the mapping-links; when NULL, the
785       default value will be assumed.  The result will be allocated and must be
786       freed by the caller. */
787   char *        vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
788                                    /*@null@*/char const *revdir);
789
790   int           vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
791                                       char const *rhs, vcCfgStyle rhs_style);
792  
793 #define vcSKEL_INTERFACES       1u
794 #define vcSKEL_PKGMGMT          2u
795 #define vcSKEL_FILESYSTEM       4u
796
797   /** Create a basic configuration skeleton for a vserver plus toplevel
798    *  directories for pkgmanagemt and filesystem (when requested). */
799   int           vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
800
801
802 #ifdef __cplusplus
803 }
804 #endif
805
806 #undef VC_ATTR_PURE
807 #undef VC_ATTR_ALWAYSINLINE
808 #undef VC_ATTR_NORETURN
809 #undef VC_ATTR_UNUSED
810 #undef VC_ATTR_NONNULL
811
812 #endif