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