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