lib/vserver.h

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