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