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