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