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