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