lib/vserver.h

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