Ranges might want masks too.
[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 #include <sched.h>
32 #include <netinet/in.h>
33
34 #ifndef IS_DOXYGEN
35 #if defined(__GNUC__)
36 #  define VC_ATTR_UNUSED                __attribute__((__unused__))
37 #  define VC_ATTR_NORETURN              __attribute__((__noreturn__))
38 #  define VC_ATTR_CONST                 __attribute__((__const__))
39 #  define VC_ATTR_DEPRECATED            __attribute__((__deprecated__))
40 #  if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30300
41 #    define VC_ATTR_NONNULL(ARGS)       __attribute__((__nonnull__ ARGS))
42 #    define VC_ATTR_ALWAYSINLINE        __attribute__((__always_inline__))
43 #  else
44 #    define VC_ATTR_NONNULL(ARGS)
45 #    define VC_ATTR_ALWAYSINLINE
46 #  endif
47 #  if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30303
48 #    define VC_ATTR_PURE                __attribute__((__pure__))
49 #  else
50 #    define VC_ATTR_PURE
51 #  endif
52 #else
53 #  define VC_ATTR_NONNULL(ARGS)
54 #  define VC_ATTR_UNUSED
55 #  define VC_ATTR_NORETURN
56 #  define VC_ATTR_ALWAYSINLINE
57 #  define VC_ATTR_DEPRECATED
58 #  define VC_ATTR_PURE
59 #  define VC_ATTR_CONST
60 #endif
61 #endif  // IS_DOXYGEN
62
63 /** the value which is returned in error-case (no ctx found) */
64 #define VC_NOCTX                ((xid_t)(-1))
65 #define VC_NOXID                ((xid_t)(-1))
66 /** the value which means a random (the next free) ctx */
67 #define VC_DYNAMIC_XID          ((xid_t)(-1))
68 /** the value which means the current ctx */
69 #define VC_SAMECTX              ((xid_t)(-2))
70
71 #define VC_NONID                ((nid_t)(-1))
72 #define VC_DYNAMIC_NID          ((nid_t)(-1))
73
74 #define VC_LIM_INFINITY         (~0ULL)
75 #define VC_LIM_KEEP             (~1ULL)
76
77 #define VC_CDLIM_UNSET          (0U)
78 #define VC_CDLIM_INFINITY       (~0U)
79 #define VC_CDLIM_KEEP           (~1U)
80   
81 #ifndef S_CTX_INFO_LOCK
82 #  define S_CTX_INFO_LOCK       1
83 #endif
84
85 #ifndef S_CTX_INFO_SCHED
86 #  define S_CTX_INFO_SCHED      2
87 #endif
88
89 #ifndef S_CTX_INFO_NPROC
90 #  define S_CTX_INFO_NPROC      4
91 #endif
92
93 #ifndef S_CTX_INFO_PRIVATE
94 #  define S_CTX_INFO_PRIVATE    8
95 #endif
96
97 #ifndef S_CTX_INFO_INIT
98 #  define S_CTX_INFO_INIT       16
99 #endif
100
101 #ifndef S_CTX_INFO_HIDEINFO
102 #  define S_CTX_INFO_HIDEINFO   32
103 #endif
104
105 #ifndef S_CTX_INFO_ULIMIT
106 #  define S_CTX_INFO_ULIMIT     64
107 #endif
108
109 #ifndef S_CTX_INFO_NAMESPACE
110 #  define S_CTX_INFO_NAMESPACE  128
111 #endif
112
113 #define VC_CAP_CHOWN                     0
114 #define VC_CAP_DAC_OVERRIDE              1
115 #define VC_CAP_DAC_READ_SEARCH           2
116 #define VC_CAP_FOWNER                    3
117 #define VC_CAP_FSETID                    4
118 #define VC_CAP_KILL                      5
119 #define VC_CAP_SETGID                    6
120 #define VC_CAP_SETUID                    7
121 #define VC_CAP_SETPCAP                   8
122 #define VC_CAP_LINUX_IMMUTABLE           9
123 #define VC_CAP_NET_BIND_SERVICE         10
124 #define VC_CAP_NET_BROADCAST            11
125 #define VC_CAP_NET_ADMIN                12
126 #define VC_CAP_NET_RAW                  13
127 #define VC_CAP_IPC_LOCK                 14
128 #define VC_CAP_IPC_OWNER                15
129 #define VC_CAP_SYS_MODULE               16
130 #define VC_CAP_SYS_RAWIO                17
131 #define VC_CAP_SYS_CHROOT               18
132 #define VC_CAP_SYS_PTRACE               19
133 #define VC_CAP_SYS_PACCT                20
134 #define VC_CAP_SYS_ADMIN                21
135 #define VC_CAP_SYS_BOOT                 22
136 #define VC_CAP_SYS_NICE                 23
137 #define VC_CAP_SYS_RESOURCE             24
138 #define VC_CAP_SYS_TIME                 25
139 #define VC_CAP_SYS_TTY_CONFIG           26
140 #define VC_CAP_MKNOD                    27
141 #define VC_CAP_LEASE                    28
142 #define VC_CAP_AUDIT_WRITE              29
143 #define VC_CAP_AUDIT_CONTROL            30
144
145 #define VC_IMMUTABLE_FILE_FL            0x0000010lu
146 #define VC_IMMUTABLE_LINK_FL            0x0008000lu
147 #define VC_IMMUTABLE_ALL                (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
148
149 #define VC_IATTR_XID                    0x01000000u
150
151 #define VC_IATTR_ADMIN                  0x00000001u
152 #define VC_IATTR_WATCH                  0x00000002u
153 #define VC_IATTR_HIDE                   0x00000004u
154 #define VC_IATTR_FLAGS                  0x00000007u
155
156 #define VC_IATTR_BARRIER                0x00010000u
157 #define VC_IATTR_IUNLINK                0x00020000u
158 #define VC_IATTR_IMMUTABLE              0x00040000u
159
160
161 // the flags
162 #define VC_VXF_INFO_LOCK                0x00000001ull
163 #define VC_VXF_INFO_NPROC               0x00000004ull
164 #define VC_VXF_INFO_PRIVATE             0x00000008ull
165 #define VC_VXF_INFO_INIT                0x00000010ull
166
167 #define VC_VXF_INFO_HIDEINFO            0x00000020ull
168 #define VC_VXF_INFO_ULIMIT              0x00000040ull
169 #define VC_VXF_INFO_NAMESPACE           0x00000080ull
170
171 #define VC_VXF_SCHED_HARD               0x00000100ull
172 #define VC_VXF_SCHED_PRIO               0x00000200ull
173 #define VC_VXF_SCHED_PAUSE              0x00000400ull
174
175 #define VC_VXF_VIRT_MEM                 0x00010000ull
176 #define VC_VXF_VIRT_UPTIME              0x00020000ull
177 #define VC_VXF_VIRT_CPU                 0x00040000ull
178 #define VC_VXF_VIRT_LOAD                0x00080000ull
179 #define VC_VXF_VIRT_TIME                0x00100000ull
180
181 #define VC_VXF_HIDE_MOUNT               0x01000000ull
182 #define VC_VXF_HIDE_NETIF               0x02000000ull
183 #define VC_VXF_HIDE_VINFO               0x04000000ull
184
185 #define VC_VXF_STATE_SETUP              (1ULL<<32)
186 #define VC_VXF_STATE_INIT               (1ULL<<33)
187 #define VC_VXF_STATE_ADMIN              (1ULL<<34)
188
189 #define VC_VXF_SC_HELPER                (1ULL<<36)
190 #define VC_VXF_REBOOT_KILL              (1ULL<<37)
191 #define VC_VXF_PERSISTENT               (1ULL<<38)
192
193 #define VC_VXF_FORK_RSS                 (1ULL<<48)
194 #define VC_VXF_PROLIFIC                 (1ULL<<49)
195
196 #define VC_VXF_IGNEG_NICE               (1ULL<<52)
197
198
199 // the ccapabilities
200 #define VC_VXC_SET_UTSNAME              0x00000001ull
201 #define VC_VXC_SET_RLIMIT               0x00000002ull
202
203 #define VC_VXC_RAW_ICMP                 0x00000100ull
204 #define VC_VXC_SYSLOG                   0x00001000ull
205
206 #define VC_VXC_SECURE_MOUNT             0x00010000ull
207 #define VC_VXC_SECURE_REMOUNT           0x00020000ull
208 #define VC_VXC_BINARY_MOUNT             0x00040000ull
209
210 #define VC_VXC_QUOTA_CTL                0x00100000ull
211 #define VC_VXC_ADMIN_MAPPER             0x00200000ull
212 #define VC_VXC_ADMIN_CLOOP              0x00400000ull
213
214
215 // the scheduler flags
216 #define VC_VXSM_FILL_RATE               0x0001
217 #define VC_VXSM_INTERVAL                0x0002
218 #define VC_VXSM_FILL_RATE2              0x0004
219 #define VC_VXSM_INTERVAL2               0x0008
220 #define VC_VXSM_TOKENS                  0x0010
221 #define VC_VXSM_TOKENS_MIN              0x0020
222 #define VC_VXSM_TOKENS_MAX              0x0040
223 #define VC_VXSM_PRIO_BIAS               0x0100
224 #define VC_VXSM_CPU_ID                  0x1000
225 #define VC_VXSM_BUCKET_ID               0x2000
226
227 #define VC_VXSM_IDLE_TIME               0x0200
228 #define VC_VXSM_FORCE                   0x0400
229 #define VC_VXSM_MSEC                    0x4000
230
231 #define VC_VXSM_V3_MASK                 0x0173
232
233
234 // the network flags
235 #define VC_NXF_INFO_LOCK                0x00000001ull
236 #define VC_NXF_INFO_PRIVATE             0x00000008ull
237
238 #define VC_NXF_SINGLE_IP                0x00000100ull
239 #define VC_NXF_LBACK_REMAP              0x00000200ull
240
241 #define VC_NXF_HIDE_NETIF               0x02000000ull
242 #define VC_NXF_HIDE_LBACK               0x04000000ull
243
244 #define VC_NXF_STATE_SETUP              (1ULL<<32)
245 #define VC_NXF_STATE_ADMIN              (1ULL<<34)
246
247 #define VC_NXF_SC_HELPER                (1ULL<<36)
248 #define VC_NXF_PERSISTENT               (1ULL<<38)
249
250
251 // the network capabilities
252 #define VC_NXC_RAW_ICMP                 0x00000100ull
253
254
255 // the vserver specific limits
256 #define VC_VLIMIT_NSOCK                 16
257 #define VC_VLIMIT_OPENFD                17
258 #define VC_VLIMIT_ANON                  18
259 #define VC_VLIMIT_SHMEM                 19
260 #define VC_VLIMIT_SEMARY                20
261 #define VC_VLIMIT_NSEMS                 21
262 #define VC_VLIMIT_DENTRY                22
263 #define VC_VLIMIT_MAPPED                23
264
265
266 // the VCI bit values
267 #define VC_VCI_NO_DYNAMIC               (1 << 0)
268 #define VC_VCI_SPACES                   (1 << 10)
269 #define VC_VCI_NETV2                    (1 << 11)
270 #define VC_VCI_PPTAG                    (1 << 28)
271
272
273 // the device mapping flags
274 #define VC_DATTR_CREATE                 0x00000001
275 #define VC_DATTR_OPEN                   0x00000002
276
277 #define VC_DATTR_REMAP                  0x00000010
278
279
280 // the process context migration flags
281 #define VC_VXM_SET_INIT                 0x00000001
282 #define VC_VXM_SET_REAPER               0x00000002
283
284
285 // the network address flags
286 #define VC_NXA_TYPE_IPV4                0x0001
287 #define VC_NXA_TYPE_IPV6                0x0002
288
289 #define VC_NXA_TYPE_NONE                0x0000
290 #define VC_NXA_TYPE_ANY                 0x00FF
291
292 #define VC_NXA_TYPE_ADDR                0x0010
293 #define VC_NXA_TYPE_MASK                0x0020
294 #define VC_NXA_TYPE_RANGE               0x0040
295
296 #define VC_NXA_MOD_BCAST                0x0100
297 #define VC_NXA_MOD_LBACK                0x0200
298
299
300 #ifndef CLONE_NEWNS
301 #  define CLONE_NEWNS                   0x00020000
302 #endif
303 #ifndef CLONE_NEWUTS
304 #  define CLONE_NEWUTS                  0x04000000
305 #endif
306 #ifndef CLONE_NEWIPC
307 #  define CLONE_NEWIPC                  0x08000000
308 #endif
309
310
311
312 #define VC_BAD_PERSONALITY              ((uint_least32_t)(-1))
313
314
315 /** \defgroup  syscalls Syscall wrappers
316  *  Functions which are calling the vserver syscall directly. */
317
318 /** \defgroup  helper   Helper functions
319  *  Functions which are doing general helper tasks like parameter parsing. */
320
321 /** \typedef  an_unsigned_integer_type  xid_t
322  *  The identifier of a context. */
323
324 #ifdef IS_DOXYGEN
325 typedef an_unsigned_integer_type        xid_t;
326 typedef an_unsigned_integer_type        nid_t;
327 typedef an_unsigned_integer_type        tag_t;
328 #endif
329
330 #ifdef __cplusplus
331 extern "C" {
332 #endif
333
334     /** \brief   The generic vserver syscall
335      *  \ingroup syscalls
336      *
337      *  This function executes the generic vserver syscall. It uses the
338      *  correct syscallnumber (which may differ between the different
339      *  architectures).
340      *
341      *  \param   cmd  the command to be executed
342      *  \param   xid  the xid on which the cmd shall be applied
343      *  \param   data additional arguments; depends on \c cmd
344      *  \returns depends on \c cmd; usually, -1 stands for an error
345      */
346   int           vc_syscall(uint32_t cmd, xid_t xid, void *data);
347
348     /** \brief   Returns the version of the current kernel API.
349      *  \ingroup syscalls
350      *  \returns The versionnumber of the kernel API
351      */
352   int           vc_get_version();
353
354   typedef       uint64_t vc_vci_t;
355     /** \brief   Returns the kernel configuration bits
356      *  \ingroup syscalls
357      *  \returns The kernel configuration bits
358      */
359   vc_vci_t      vc_get_vci();
360
361     /** \brief   Moves current process into a context
362      *  \ingroup syscalls
363      *
364      *  Puts current process into context \a ctx, removes the capabilities
365      *  given in \a remove_cap and sets \a flags.
366      *
367      *  \param ctx         The new context; special values for are
368      *  - VC_SAMECTX      which means the current context (just for changing caps and flags)
369      *  - VC_DYNAMIC_XID  which means the next free context; this value can be used by
370      *                    ordinary users also
371      *  \param remove_cap  The linux capabilities which will be \b removed.
372      *  \param flags       Special flags which will be set.
373      *
374      *  \returns  The new context-id, or VC_NOCTX on errors; \c errno
375      *            will be set appropriately
376      *
377      *  See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
378   xid_t         vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
379
380   struct vc_ip_mask_pair {
381       uint32_t  ip;
382       uint32_t  mask;
383   };
384
385     /** \brief  Sets the ipv4root information.
386      *  \ingroup syscalls
387      *  \pre    \a nb < NB_IPV4ROOT && \a ips != 0 */
388   int           vc_set_ipv4root(uint32_t  bcast, size_t nb,
389                         struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
390
391     /** \brief  Returns the value of NB_IPV4ROOT.
392      *  \ingroup helper
393      *
394      *  This function returns the value of NB_IPV4ROOT which was used when the
395      *  library was built, but \b not the value which is used by the currently
396      *  running kernel. */
397   size_t        vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
398
399     /* process context */
400   /** \brief    Flags of process-contexts
401    */
402   struct  vc_ctx_flags {
403       /** \brief Mask of set context flags */
404       uint_least64_t    flagword;
405       /** \brief Mask of set and unset context flags when used by set
406        *         operations, or modifiable flags when used by get
407        *         operations */
408       uint_least64_t    mask;
409   };
410
411     /** \brief   Creates a context without starting it.
412      *  \ingroup syscalls
413      *
414      *  This functions initializes a new context. When already in a freshly
415      *  created context, this old context will be discarded.
416      *
417      *  \param xid  The new context; special values are:
418      *  - VC_DYNAMIC_XID which means to create a dynamic context
419      *
420      *  \returns the xid of the created context, or VC_NOCTX on errors. \c errno
421      *           will be set appropriately. */
422   xid_t         vc_ctx_create(xid_t xid, struct vc_ctx_flags *flags);
423
424     /** \brief   Moves the current process into the specified context.
425      *  \ingroup syscalls
426      *
427      *  \param   xid    The new context
428      *  \param   flags  The flags, see VC_VXM_*
429      *  \returns 0 on success, -1 on errors */
430   int           vc_ctx_migrate(xid_t xid, uint_least64_t flags);
431
432     /** \brief   Statistics about a context */
433   struct vc_ctx_stat {
434       uint_least32_t    usecnt; ///< number of uses
435       uint_least32_t    tasks;  ///< number of tasks
436   };
437
438     /** \brief   Get some statistics about a context.
439      *  \ingroup syscalls
440      *
441      *  \param   xid   The context to get stats about
442      *  \param   stat  Where to store the result
443      *
444      *  \returns 0 on success, -1 on errors. */
445   int           vc_ctx_stat(xid_t xid, struct vc_ctx_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
446
447     /** \brief   Contains further statistics about a context. */
448   struct vc_virt_stat {
449       uint_least64_t    offset;
450       uint_least64_t    uptime;
451       uint_least32_t    nr_threads;
452       uint_least32_t    nr_running;
453       uint_least32_t    nr_uninterruptible;
454       uint_least32_t    nr_onhold;
455       uint_least32_t    nr_forks;
456       uint_least32_t    load[3];
457   };
458
459     /** \brief   Get more statistics about a context.
460      *  \ingroup syscalls
461      *
462      *  \param xid   The context to get stats about
463      *  \param stat  Where to store the result
464      *
465      *  \returns 0 on success, -1 on errors. */
466   int           vc_virt_stat(xid_t xid, struct vc_virt_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
467
468   /** \brief    Sends a signal to a context/pid
469    *  \ingroup  syscalls
470    *
471    *  Special values for \a pid are:
472    *  - -1   which means every process in ctx except the init-process
473    *  -  0   which means every process in ctx inclusive the init-process */
474   int           vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
475  
476   int           vc_get_cflags(xid_t xid, struct vc_ctx_flags /*@out@*/ *)       VC_ATTR_NONNULL((2));
477   int           vc_set_cflags(xid_t xid, struct vc_ctx_flags /*@in@*/ const *)  VC_ATTR_NONNULL((2));
478
479   /** \brief    Capabilities of process-contexts */
480   struct  vc_ctx_caps {
481       /** \brief  Mask of set common system capabilities */
482       uint_least64_t    bcaps;
483       /** \brief Mask of set and unset common system capabilities when used by
484        *         set operations, or the modifiable capabilities when used by
485        *         get operations */
486       uint_least64_t    bmask;
487       /** \brief Mask of set process context capabilities */
488       uint_least64_t    ccaps;
489       /** \brief Mask of set and unset process context capabilities when used
490        *         by set operations, or the modifiable capabilities when used
491        *         by get operations */
492       uint_least64_t    cmask;
493   };
494
495   int           vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
496   int           vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
497
498   struct vc_vx_info {
499       xid_t     xid;
500       pid_t     initpid;
501   };
502
503   int           vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
504   
505     /** \brief   Returns the context of the given process.
506      *  \ingroup syscalls
507      *
508      *  \param  pid  the process-id whose xid shall be determined;
509      *               pid==0 means the current process.
510      *  \returns     the xid of process \c pid or -1 on errors
511      */
512   xid_t         vc_get_task_xid(pid_t pid);
513
514   /** \brief   Waits for the end of a context
515    *  \ingroup syscalls
516    */
517   int           vc_wait_exit(xid_t xid);
518   
519     /* rlimit related functions */
520   
521     /** \brief  The type which is used for a single limit value.
522      *
523      *  Special values are
524      *  - VC_LIM_INFINITY ... which is the infinite value
525      *  - VC_LIM_KEEP     ... which is used to mark values which shall not be
526      *                        modified by the vc_set_rlimit() operation.
527      *
528      *  Else, the interpretation of the value depends on the corresponding
529      *  resource; it might be bytes, pages, seconds or litres of beer. */
530   typedef uint_least64_t        vc_limit_t;
531
532     /** \brief  Masks describing the supported limits. */
533   struct  vc_rlimit_mask {
534       uint_least32_t    min;    ///< masks the resources supporting a minimum limit
535       uint_least32_t    soft;   ///< masks the resources supporting a soft limit
536       uint_least32_t    hard;   ///< masks the resources supporting a hard limit
537   };
538
539     /** \brief  Returns the limits supported by the kernel */
540   int           vc_get_rlimit_mask(xid_t xid,
541                            struct vc_rlimit_mask /*@out@*/ *lim) VC_ATTR_NONNULL((2));
542
543     /** \brief  The limits of a resources.
544      *
545      *  This is a triple consisting of a minimum, soft and hardlimit. */
546   struct vc_rlimit {
547       vc_limit_t        min;    ///< the guaranted minimum of a resources
548       vc_limit_t        soft;   ///< the softlimit of a resource
549       vc_limit_t        hard;   ///< the absolute hardlimit of a resource
550   };
551
552     /** \brief   Returns the limits of \a resource.
553      *  \ingroup syscalls
554      *
555      *  \param  xid       The id of the context
556      *  \param  resource  The resource which will be queried
557      *  \param  lim       The result which will be filled with the limits
558      *
559      *  \returns 0 on success, and -1 on errors. */
560   int           vc_get_rlimit(xid_t xid, int resource,
561                       struct vc_rlimit       /*@out@*/ *lim) VC_ATTR_NONNULL((3));
562     /** \brief   Sets the limits of \a resource.
563      *  \ingroup syscalls
564      *
565      *  \param  xid       The id of the context
566      *  \param  resource  The resource which will be queried
567      *  \param  lim       The new limits
568      *
569      *  \returns 0 on success, and -1 on errors. */
570   int           vc_set_rlimit(xid_t xid, int resource,
571                       struct vc_rlimit const /*@in@*/  *lim) VC_ATTR_NONNULL((3));
572
573     /** \brief Statistics for a resource limit. */
574   struct  vc_rlimit_stat {
575       uint_least32_t    hits;    ///< number of hits on the limit
576       vc_limit_t        value;   ///< current value
577       vc_limit_t        minimum; ///< minimum value observed
578       vc_limit_t        maximum; ///< maximum value observed
579   };
580
581     /** \brief   Returns the current stats of \a resource.
582      *  \ingroup syscalls
583      *
584      *  \param  xid       The id of the context
585      *  \param  resource  The resource which will be queried
586      *  \param  stat      The result which will be filled with the stats
587      *
588      *  \returns 0 on success, and -1 on errors. */
589   int           vc_rlimit_stat(xid_t xid, int resource,
590                        struct vc_rlimit_stat /*@out@*/ *stat) VC_ATTR_NONNULL((3));
591
592     /** \brief   Resets the minimum and maximum observed values of all resources.
593      *  \ingroup syscalls
594      *
595      *  \param xid      The id of the context
596      *
597      *  \returns 0 on success, and -1 on errors. */
598   int           vc_reset_minmax(xid_t xid);
599
600     /** \brief   Parses a string describing a limit
601      *  \ingroup helper
602      *
603      *  This function parses \a str and interprets special words like \p "inf"
604      *  or suffixes. Valid suffixes are
605      *  - \p k ... 1000
606      *  - \p m ... 1000000
607      *  - \p K ... 1024
608      *  - \p M ... 1048576
609      *
610      *  \param str  The string which shall be parsed
611      *  \param res  Will be filled with the interpreted value; in errorcase,
612      *              this value is undefined.
613      *
614      *  \returns \a true, iff the string \a str could be parsed. \a res will
615      *  be filled with the interpreted value in this case. 
616      *
617      *  \pre \a str!=0 && \a res!=0
618      */
619   bool          vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res)      VC_ATTR_NONNULL((1,2));
620
621
622     /* network context */
623   struct vc_nx_info {
624       nid_t     nid;
625   };
626
627   nid_t         vc_get_task_nid(pid_t pid);
628   int           vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
629
630   struct vc_net_addr {
631       uint16_t                  vna_type;
632       uint16_t                  vna_flags;
633       uint16_t                  vna_prefix;
634       uint16_t                  vna_parent;
635       struct {
636         union {
637           struct in_addr        v4;
638           struct in6_addr       v6;
639         } ip;
640         union {
641           struct in_addr        v4;
642           struct in6_addr       v6;
643         } ip2;
644         union {
645           struct in_addr        v4;
646           struct in6_addr       v6;
647         } mask;
648       } s;
649 #define vna_v4_ip       s.ip.v4
650 #define vna_v4_ip2      s.ip2.v6
651 #define vna_v4_mask     s.mask.v4
652 #define vna_v6_ip       s.ip.v6
653 #define vna_v6_ip2      s.ip2.v6
654 #define vna_v6_mask     s.mask.v6
655   };
656
657   struct vc_net_flags {
658       uint_least64_t    flagword;
659       uint_least64_t    mask;
660   };
661
662   nid_t         vc_net_create(nid_t nid);
663   int           vc_net_migrate(nid_t nid);
664
665   int           vc_net_add(nid_t nid, struct vc_net_addr const *info);
666   int           vc_net_remove(nid_t nid, struct vc_net_addr const *info);
667
668   int           vc_get_nflags(nid_t, struct vc_net_flags *);
669   int           vc_set_nflags(nid_t, struct vc_net_flags const *);
670
671   struct vc_net_caps {
672       uint_least64_t    ncaps;
673       uint_least64_t    cmask;
674   };
675
676   int           vc_get_ncaps(nid_t, struct vc_net_caps *);
677   int           vc_set_ncaps(nid_t, struct vc_net_caps const *);
678
679
680     /* iattr related functions */
681
682   int           vc_set_iattr(char const *filename, xid_t xid,
683                              uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
684
685   int           vc_fset_iattr(int fd, xid_t xid,
686                               uint_least32_t flags, uint_least32_t mask);
687
688     /** \brief   Returns information about attributes and assigned context of a file.
689      *  \ingroup syscalls
690      *
691      *  This function returns the VC_IATTR_XXX flags and about the assigned
692      *  context of a file. To request an information, the appropriate bit in
693      *  \c mask must be set and the corresponding parameter (\a xid or \a
694      *  flags) must not be NULL.
695      *
696      *  E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
697      *  set in \a mask, and \a xid must point to valid memory.
698      *
699      *  Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
700      *  \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
701      *
702      *  \param filename  The name of the file whose attributes shall be determined.
703
704      *  \param xid       When non-zero and the VC_IATTR_XID bit is set in \a mask,
705      *                   the assigned context of \a filename will be stored there.
706      *  \param flags     When non-zero, a bitmask of current attributes will be
707      *                   stored there. These attributes must be requested explicitly
708      *                   by setting the appropriate bit in \a mask
709      *  \param mask      Points to a bitmask which tells which attributes shall be
710      *                   determined. On return, it will masquerade the attributes
711      *                   which were determined.
712      *
713      *  \pre  mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
714   int           vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
715                              uint_least32_t * /*@null@*/ flags,
716                              uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
717
718   int           vc_fget_iattr(int fd, xid_t * /*@null@*/ xid,
719                               uint_least32_t * /*@null@*/ flags,
720                               uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((4));
721   
722   /** \brief   Returns the context of \c filename
723    *  \ingroup syscalls
724    *
725    *  This function calls vc_get_iattr() with appropriate arguments to
726    *  determine the context of \c filename. In error-case or when no context
727    *  is assigned, \c VC_NOCTX will be returned. To differ between both cases,
728    *  \c errno must be examined.
729    *
730    *  \b WARNING: this function can modify \c errno although no error happened.
731    *
732    *  \param   filename  The file to check
733    *  \returns The assigned context, or VC_NOCTX when an error occured or no
734    *           such assignment exists. \c errno will be 0 in the latter case */
735   xid_t         vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
736
737
738     /* vhi related functions */
739   typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
740                  vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
741                  vcVHI_DOMAINNAME }             vc_uts_type;
742   
743   int           vc_set_vhi_name(xid_t xid, vc_uts_type type,
744                                 char const *val, size_t len) VC_ATTR_NONNULL((3));
745   int           vc_get_vhi_name(xid_t xid, vc_uts_type type,
746                                 char *val, size_t len)       VC_ATTR_NONNULL((3));
747
748     /* namespace related functions */
749   int           vc_enter_namespace(xid_t xid, uint_least64_t mask);
750   int           vc_set_namespace(xid_t xid, uint_least64_t mask);
751   int           vc_cleanup_namespace();
752   uint_least64_t vc_get_space_mask();
753
754
755     /* disk limit related things */
756   struct vc_ctx_dlimit {
757       uint_least32_t    space_used;
758       uint_least32_t    space_total;
759       uint_least32_t    inodes_used;
760       uint_least32_t    inodes_total;
761       uint_least32_t    reserved;
762   };
763   
764
765   /** Add a disk limit to a file system. */
766   int           vc_add_dlimit(char const *filename, xid_t xid,
767                               uint_least32_t flags) VC_ATTR_NONNULL((1));
768   /** Remove a disk limit from a file system. */
769   int           vc_rem_dlimit(char const *filename, xid_t xid,
770                               uint_least32_t flags) VC_ATTR_NONNULL((1));
771
772   /** Set a disk limit. */
773   int           vc_set_dlimit(char const *filename, xid_t xid,
774                               uint_least32_t flags,
775                               struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
776   /** Get a disk limit. */
777   int           vc_get_dlimit(char const *filename, xid_t xid,
778                               uint_least32_t flags,
779                               struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
780
781   /** Get the filesystem tag for a process. */
782   tag_t         vc_get_task_tag(pid_t pid);
783
784   /** Create a new filesystem tag space. */
785   int           vc_tag_create(tag_t tag);
786
787   /** Migrate to an existing filesystem tag space. */
788   int           vc_tag_migrate(tag_t tag);
789
790     /* scheduler related syscalls */
791   struct vc_set_sched {
792       uint_least32_t    set_mask;
793       int_least32_t     fill_rate;
794       int_least32_t     interval;
795       int_least32_t     fill_rate2;
796       int_least32_t     interval2;
797       int_least32_t     tokens;
798       int_least32_t     tokens_min;
799       int_least32_t     tokens_max;
800       int_least32_t     priority_bias;
801       int_least32_t     cpu_id;
802       int_least32_t     bucket_id;
803   };
804
805   int           vc_set_sched(xid_t xid, struct vc_set_sched const *) VC_ATTR_NONNULL((2));
806   int           vc_get_sched(xid_t xid, struct vc_set_sched *) VC_ATTR_NONNULL((2));
807
808   struct vc_sched_info {
809       int_least32_t     cpu_id;
810       int_least32_t     bucket_id;
811       uint_least64_t    user_msec;
812       uint_least64_t    sys_msec;
813       uint_least64_t    hold_msec;
814       uint_least32_t    token_usec;
815       int_least32_t     vavavoom;
816   };
817
818   int           vc_sched_info(xid_t xid, struct vc_sched_info *info) VC_ATTR_NONNULL((2));
819
820     /* misc. syscalls */
821   int           vc_set_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
822   int           vc_unset_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
823
824
825   /** \brief    Information about parsing errors
826    *  \ingroup  helper
827    */
828   struct vc_err_listparser {
829       char const        *ptr;           ///< Pointer to the first character of an erroneous string
830       size_t            len;            ///< Length of the erroneous string
831   };
832
833   /** \brief   Converts a single string into bcapability
834    *  \ingroup helper
835    *
836    *  \param   str   The string to be parsed;
837    *                 both "CAP_xxx" and "xxx" will be accepted
838    *  \param   len   The length of the string, or \c 0 for automatic detection
839    *
840    *  \returns 0 on error; a bitmask on success
841    *  \pre     \a str != 0
842    */
843   uint_least64_t        vc_text2bcap(char const *str, size_t len);
844
845   /** \brief   Converts the lowest bit of a bcapability or the entire value
846    *           (when possible) to a textual representation
847    *  \ingroup helper
848    *
849    *  \param   val  The string to be converted; on success, the detected bit(s)
850    *                will be unset, in errorcase only the lowest set bit
851    *
852    *  \returns A textual representation of \a val resp. of its lowest set bit;
853    *           or \c NULL in errorcase.
854    *  \pre     \a val!=0
855    *  \post    \a *val<sub>old</sub> \c != 0  \c <-->
856    *               \a *val<sub>old</sub> > \a *val<sub>new</sub>
857    *  \post    \a *val<sub>old</sub> \c == 0  \c --->  \a result == 0
858    */
859   char const *  vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
860
861   /** \brief   Converts a string into a bcapability-bitmask
862    *  \ingroup helper
863    *
864    *  Syntax of \a str: \verbinclude list2xxx.syntax
865    *
866    *  When the \c `~' prefix is used, the bits will be unset and a `~' after
867    *  another `~' will cancel both ones. The \c `^' prefix specifies a
868    *  bitnumber instead of a bitmask.
869    *
870    *  "literal name" is everything which will be accepted by the
871    *  vc_text2bcap() function. The special values for \c NAME will be
872    *  recognized case insensitively
873    *
874    *  \param  str   The string to be parsed
875    *  \param  len   The length of the string, or \c 0 for automatic detection
876    *  \param  err   Pointer to a structure for error-information, or \c NULL.
877    *  \param  cap   Pointer to a vc_ctx_caps structure holding the results;
878    *                only the \a bcaps and \a bmask fields will be changed and
879    *                already set values will not be honored. When an error
880    *                occured, \a cap will have the value of all processed valid
881    *                \c BCAP parts.
882    *
883    *  \returns 0 on success, -1 on error. In error case, \a err will hold
884    *           position and length of the first not understood BCAP part
885    *  \pre     \a str != 0 && \a cap != 0;
886    *           \a cap->bcaps and \a cap->bmask must be initialized
887    */
888   int                   vc_list2bcap(char const *str, size_t len,
889                                      struct vc_err_listparser *err,
890                                      struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
891
892   uint_least64_t        vc_text2ccap(char const *, size_t len);
893   char const *          vc_loccap2text(uint_least64_t *);
894   int                   vc_list2ccap(char const *, size_t len,
895                                      struct vc_err_listparser *err,
896                                      struct vc_ctx_caps *);
897
898   int                   vc_list2cflag(char const *, size_t len,
899                                      struct vc_err_listparser *err,
900                                      struct vc_ctx_flags *flags);
901   uint_least64_t        vc_text2cflag(char const *, size_t len);
902   char const *          vc_locflag2text(uint_least64_t *);
903   
904   uint_least32_t        vc_list2cflag_compat(char const *, size_t len,
905                                             struct vc_err_listparser *err);
906   uint_least32_t        vc_text2cflag_compat(char const *, size_t len);
907   char const *          vc_hicflag2text_compat(uint_least32_t);
908
909   int                   vc_text2cap(char const *);
910   char const *          vc_cap2text(unsigned int);
911
912   
913   int                   vc_list2nflag(char const *, size_t len,
914                                      struct vc_err_listparser *err,
915                                      struct vc_net_flags *flags);
916   uint_least64_t        vc_text2nflag(char const *, size_t len);
917   char const *          vc_lonflag2text(uint_least64_t *);
918
919   uint_least64_t        vc_text2ncap(char const *, size_t len);
920   char const *          vc_loncap2text(uint_least64_t *);
921   int                   vc_list2ncap(char const *, size_t len,
922                                      struct vc_err_listparser *err,
923                                      struct vc_net_caps *);
924
925   uint_least64_t                vc_get_insecurebcaps() VC_ATTR_CONST;
926   inline static uint_least64_t  vc_get_insecureccaps() {
927     return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP);
928   }
929   
930   inline static int     vc_setfilecontext(char const *filename, xid_t xid) {
931     return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
932   }
933
934
935   uint_least32_t        vc_text2personalityflag(char const *str,
936                                                 size_t len) VC_ATTR_NONNULL((1));
937
938   char const *          vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
939   
940   int                   vc_list2personalityflag(char const /*@in@*/ *,
941                                                 size_t len,
942                                                 uint_least32_t /*@out@*/ *personality,
943                                                 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
944
945   uint_least32_t        vc_str2personalitytype(char const /*@in@*/*,
946                                                size_t len) VC_ATTR_NONNULL((1));
947
948     
949   typedef enum { vcFEATURE_VKILL,  vcFEATURE_IATTR,   vcFEATURE_RLIMIT,
950                  vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
951                  vcFEATURE_SCHED,  vcFEATURE_VINFO,   vcFEATURE_VHI,
952                  vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
953                  vcFEATURE_VNET, vcFEATURE_VSTAT,     vcFEATURE_PPTAG, }
954     vcFeatureSet;
955
956   bool          vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
957   bool          vc_isSupportedString(char const *);
958
959   
960   typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
961                  vcTYPE_STATIC, vcTYPE_DYNAMIC }
962     vcXidType;
963   
964   vcXidType     vc_getXIDType(xid_t xid) VC_ATTR_CONST;
965
966     /** Returns true iff \a xid is a dynamic xid */
967   bool          vc_is_dynamic_xid(xid_t xid);
968
969
970   /* The management part */
971
972 #define VC_LIMIT_VSERVER_NAME_LEN       1024
973   
974   typedef enum { vcCFG_NONE, vcCFG_AUTO,
975                  vcCFG_LEGACY,
976                  vcCFG_RECENT_SHORT,
977                  vcCFG_RECENT_FULL }            vcCfgStyle;
978
979
980   /** Maps an xid given at '--xid' options to an xid_t */
981   xid_t         vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
982   /** Maps a  nid given at '--nid' options to a  nid_t */
983   nid_t         vc_nidopt2nid(char const *, bool honor_static, char const **err_info);
984   /** Maps a  tag given at '--tag' options to a  tag_t */
985   tag_t         vc_tagopt2tag(char const *, bool honor_static, char const **err_info);
986
987   vcCfgStyle    vc_getVserverCfgStyle(char const *id);
988   
989   /** Resolves the name of the vserver. The result will be allocated and must
990       be freed by the caller. */
991   char *        vc_getVserverName(char const *id, vcCfgStyle style);
992
993   /** Returns the path of the vserver configuration directory. When the given
994    *  vserver does not exist, or when it does not have such a directory, NULL
995    *  will be returned. Else, the result will be allocated and must be freed
996    *  by the caller. */
997   char *        vc_getVserverCfgDir(char const *id, vcCfgStyle style);
998
999   /** Returns the path of the configuration directory for the given
1000    *  application. The result will be allocated and must be freed by the
1001    *  caller. */
1002   char *        vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
1003
1004   /** Returns the path to the vserver root-directory. The result will be
1005    *  allocated and must be freed by the caller. */
1006   char *        vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
1007
1008   typedef enum { vcCTX_XID = 1,
1009                  vcCTX_NID,
1010                  vcCTX_TAG,
1011         } vcCtxType;
1012
1013   /** Returns the ctx of the given vserver. When vserver is not running and
1014    *  'honor_static' is false, VC_NOCTX will be returned. Else, when
1015    *  'honor_static' is true and a static assignment exists, those value will
1016    *  be returned. Else, the result will be VC_NOCTX.
1017    *
1018    *  When 'is_running' is not null, the status of the vserver will be
1019    *  assigned to this variable. */
1020   xid_t         vc_getVserverCtx(char const *id, vcCfgStyle style,
1021                                  bool honor_static, bool /*@null@*/ *is_running,
1022                                  vcCtxType type);
1023
1024   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
1025       be used as the directory holding the mapping-links; when NULL, the
1026       default value will be assumed.  The result will be allocated and must be
1027       freed by the caller. */
1028   char *        vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
1029                                    /*@null@*/char const *revdir);
1030
1031   int           vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
1032                                       char const *rhs, vcCfgStyle rhs_style);
1033  
1034 #define vcSKEL_INTERFACES       1u
1035 #define vcSKEL_PKGMGMT          2u
1036 #define vcSKEL_FILESYSTEM       4u
1037
1038   /** Create a basic configuration skeleton for a vserver plus toplevel
1039    *  directories for pkgmanagemt and filesystem (when requested). */
1040   int           vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
1041
1042
1043 #ifdef __cplusplus
1044 }
1045 #endif
1046
1047 #undef VC_ATTR_PURE
1048 #undef VC_ATTR_ALWAYSINLINE
1049 #undef VC_ATTR_NORETURN
1050 #undef VC_ATTR_UNUSED
1051 #undef VC_ATTR_NONNULL
1052
1053 #endif