added 'fmt'
[util-vserver.git] / util-vserver / lib / vserver.h
index d45dc9d..1056494 100644 (file)
@@ -22,6 +22,7 @@
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <stdbool.h>
 #include <sys/types.h>
 
 /** the value which is returned in error-case (no ctx found) */
 #  define S_CTX_INFO_ULIMIT    64
 #endif
 
+#ifndef S_CTX_INFO_NAMESPACE
+#  define S_CTX_INFO_NAMESPACE 128
+#endif
+
 #define VC_CAP_CHOWN                    0
 #define VC_CAP_DAC_OVERRIDE             1
 #define VC_CAP_DAC_READ_SEARCH          2
 #define VC_CAP_LEASE                   28
 #define VC_CAP_QUOTACTL                29
 
+#define VC_IMMUTABLE_FILE_FL           0x00000010l
+#define VC_IMMUTABLE_LINK_FL           0x00008000l
+#define VC_IMMUTABLE_ALL               (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
+
+#define VC_IATTR_XID                   0x01000000
+
+#define VC_IATTR_ADMIN                 0x00000001
+#define VC_IATTR_WATCH                 0x00000002
+#define VC_IATTR_HIDE                  0x00000004
+
+#define VC_IATTR_BARRIER               0x00010000
+#define        VC_IATTR_IUNLINK                0x00020000
+
 
 #ifdef __cplusplus
 extern "C" {
@@ -104,16 +122,17 @@ extern "C" {
     uint32_t   mask;
   };
 
-    /** Returns version of the given API-category */
-  int  vc_get_version(int category);
+    /** Returns the version of the current kernel API. */
+  int  vc_get_version();
   
     /** Puts current process into context <ctx>, removes the given caps and
      *  sets flags.
      *  Special values for ctx are
      *  - VC_SAMECTX  which means the current context (just for changing caps and flags)
      *  - VC_RANDCTX  which means the next free context; this value can be used by
-     *                ordinary users also */
-  int  vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
+     *                ordinary users also
+     *  See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
+  xid_t        vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
 
     /** Sets the ipv4root information.
      *  \precondition: nb<16 */
@@ -147,16 +166,61 @@ extern "C" {
   int  vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
 
 
+
+  int          vc_set_iattr(char const *filename, xid_t xid,  uint32_t flags, uint32_t mask); 
+  int          vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
+                            uint32_t * /*@null@*/ flags, uint32_t * /*@null@*/ mask);
+
+  struct vc_vx_info {
+      xid_t    xid;
+      pid_t    initpid;
+  };
+  
     /** Returns the context of the given process. pid==0 means the current process. */
-  xid_t        vc_X_getctx(pid_t pid);
+  xid_t                vc_get_task_xid(pid_t pid);
+  int          vc_get_vx_info(xid_t xid, struct vc_vx_info *info);
 
-    /** Returns the pid of the 'init' process */
-  pid_t        vc_X_getinitpid(pid_t pid);
 
+  typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
+                vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
+                vcVHI_DOMAINNAME }             vc_uts_type;
+  
+  int          vc_set_vhi_name(xid_t xid, vc_uts_type type, char const *val, size_t len);
+  int          vc_get_vhi_name(xid_t xid, vc_uts_type type, char *val, size_t len);
 
-  int          vc_text2cap(char const *);
-  char const * vc_cap2text(int);
 
+  int          vc_enter_namespace(xid_t xid);
+  
+
+  uint32_t     vc_textlist2flag(char const *, size_t len,
+                                char const **err_ptr, size_t *err_len);
+  uint32_t     vc_text2flag(char const *, size_t len);
+  char const * vc_hiflag2text(unsigned int);
+  
+  int          vc_text2cap(char const *);
+  char const * vc_cap2text(unsigned int);
+
+  inline static int    vc_get_securecaps() {
+    return ( (1<<VC_CAP_LINUX_IMMUTABLE) | (1<<VC_CAP_NET_BROADCAST) |
+            (1<<VC_CAP_NET_ADMIN) | (1<<VC_CAP_NET_RAW) |
+            (1<<VC_CAP_IPC_LOCK) | (1<<VC_CAP_IPC_OWNER) |
+            (1<<VC_CAP_SYS_MODULE) | (1<<VC_CAP_SYS_RAWIO) |
+            (1<<VC_CAP_SYS_PACCT) | (1<<VC_CAP_SYS_ADMIN) |
+            (1<<VC_CAP_SYS_BOOT) | (1<<VC_CAP_SYS_NICE) |
+            (1<<VC_CAP_SYS_RESOURCE) | (1<<VC_CAP_SYS_TIME) |
+            (1<<VC_CAP_MKNOD) | (1<<VC_CAP_QUOTACTL) );
+  }
+
+  inline static int            vc_setfilecontext(char const *filename, xid_t xid) {
+    return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
+  }
+  
+  inline static xid_t          vc_getfilecontext(char const *filename) {
+    xid_t      res;
+    if (vc_get_iattr(filename, &res, 0,0)==-1) return VC_NOCTX;
+    return res;
+  }
+  
   
   /* The management part */
 
@@ -173,11 +237,30 @@ extern "C" {
       be freed by the caller. */
   char *       vc_getVserverName(char const *id, vcCfgStyle style);
 
-  char *       vc_getVserverVdir(char const *id, vcCfgStyle style);
-
-  /** Returns the ctx of the given vserver, or VC_NOCTX if vserver is not
-   *  running */
-  xid_t                vc_getVserverCtx(char const *id, vcCfgStyle style);
+  /** Returns the path of the vserver configuration directory. When the given
+   *  vserver does not exist, or when it does not have such a directory, NULL
+   *  will be returned. Else, the result will be allocated and must be freed
+   *  by the caller. */
+  char *       vc_getVserverCfgDir(char const *id, vcCfgStyle style);
+
+  /** Returns the path of the configuration directory for the given
+   *  application. The result will be allocated and must be freed by the
+   *  caller. */
+  char *       vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
+
+  /** Returns the path to the vserver root-directory. The result will be
+   *  allocated and must be freed by the caller. */
+  char *       vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
+
+  /** Returns the ctx of the given vserver. When vserver is not running and
+   *  'honor_static' is false, VC_NOCTX will be returned. Else, when
+   *  'honor_static' is true and a static assignment exists, those value will
+   *  be returned. Else, the result will be VC_NOCTX.
+   *
+   *  When 'is_running' is not null, the status of the vserver will be
+   *  assigned to this variable. */
+  xid_t                vc_getVserverCtx(char const *id, vcCfgStyle style,
+                                bool honor_static, bool /*@null@*/ *is_running);
 
   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
       be used as the directory holding the mapping-links; when NULL, the
@@ -185,6 +268,14 @@ extern "C" {
       freed by the caller. */
   char *       vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
                                   /*@null@*/char const *revdir);
+
+#define vcSKEL_INTERFACES      1u
+#define vcSKEL_PKGMGMT         2u
+#define vcSKEL_FILESYSTEM      4u
+  
+  /** Create a basic configuration skeleton for a vserver plus toplevel
+   *  directories for pkgmanagemt and filesystem (when requested). */
+  int          vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
   
 #ifdef __cplusplus
 }