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