src/vserver-info.c

   1 // $Id$    --*- c -*--
   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; version 2 of the License.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with this program; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17
  18
  19 #ifdef HAVE_CONFIG_H
  20 #  include <config.h>
  21 #endif
  22
  23 #include "lib/utils-legacy.h"
  24 #include "pathconfig.h"
  25 #include "util.h"
  26
  27 #include "internal.h"
  28 #include "vserver.h"
  29
  30 #include <stdlib.h>
  31 #include <getopt.h>
  32 #include <assert.h>
  33 #include <stdbool.h>
  34 #include <fcntl.h>
  35 #include <errno.h>
  36 #include <sys/utsname.h>
  37 #include <dirent.h>
  38 #include <strings.h>
  39
  40 #define ENSC_WRAPPERS_FCNTL     1
  41 #define ENSC_WRAPPERS_IO        1
  42 #define ENSC_WRAPPERS_UNISTD    1
  43 #define ENSC_WRAPPERS_VSERVER   1
  44 #include <wrappers.h>
  45
  46 #undef _POSIX_SOURCE
  47 #include "capability-compat.h"
  48
  49 typedef enum { tgNONE,tgCONTEXT, tgID, tgRUNNING,
  50                tgVDIR, tgNAME, tgCFGDIR, tgAPPDIR,
  51                tgAPIVER, tgPXID,
  52                tgINITPID, tgINITPID_PID,
  53                tgXID, tgUTS, tgSYSINFO,
  54                tgFEATURE, tgCANONIFY,
  55                tgVERIFYCAP, tgXIDTYPE, tgVERIFYPROC,
  56                tgNID, tgTAG,
  57 }       VserverTag;
  58
  59 static struct {
  60     char const * const  tag;
  61     VserverTag const    val;
  62     char const * const  descr;
  63 }  const TAGS[] = {
  64   { "CONTEXT", tgCONTEXT, ("the current and/or assigned context; when an optinal argument "
  65                            "evaluates to false,only the current context will be printed") },
  66   { "ID",      tgID,      "gives out the vserver-id for the context-xid" },
  67   { "RUNNING", tgRUNNING, "gives out '1' when vserver is running; else, it fails without output" },
  68   { "VDIR",    tgVDIR,    "gives out the root-directory of the vserver" },
  69   { "NAME",    tgNAME,    "gives out the name of the vserver" },
  70   { "CFGDIR",  tgCFGDIR,  "gives out the configuration directory of the vserver" },
  71   { "APPDIR",  tgAPPDIR,  "gives out the name of the toplevel application cfgdir" },
  72   { "INITPID",     tgINITPID,     "gives out the initpid of the given context" },
  73   { "INITPID_PID", tgINITPID_PID, "gives out the initpid of the given pid" },
  74   { "XID",         tgXID,         "gives out the context-id of the given pid" },
  75   { "APIVER",      tgAPIVER,      "gives out the version of the kernel API" },
  76   { "UTS",         tgUTS,         ("gives out an uts-entry; possible entries are "
  77                                    "context, sysname, nodename, release, version, "
  78                                    "machine and domainname") },
  79   { "SYSINFO",     tgSYSINFO,     "gives out information about the systen" },
  80   { "FEATURE",     tgFEATURE,     "returns 0 iff the queried feature is supported" },
  81   { "PXID",        tgPXID,        "returns the xid of the parent context" },
  82   { "CANONIFY",    tgCANONIFY,    "canonifies the vserver-name and removes dangerous characters" },
  83   { "VERIFYCAP",   tgVERIFYCAP,   "test if the kernel supports linux capabilities" },
  84   { "VERIFYPROC",  tgVERIFYPROC,  "test if /proc can be read by contexts!=0" },
  85   { "XIDTYPE",     tgXIDTYPE,     "returns the type of the given XID" },
  86   { "NID",         tgNID,         "outputs the network context-id of the given pid" },
  87   { "TAG",         tgTAG,         "outputs the filesystem tag of the given pid" },
  88 };
  89
  90 int wrapper_exit_code = 1;
  91
  92 static struct option const
  93 CMDLINE_OPTIONS[] = {
  94   { "help",     no_argument,  0, 'h' },
  95   { "version",  no_argument,  0, 'v' },
  96   { 0,0,0,0 }
  97 };
  98
  99
 100 static void
 101 showHelp(int fd, char const *cmd, int res)
 102 {
 103   WRITE_MSG(fd, "Usage:  ");
 104   WRITE_STR(fd, cmd);
 105   WRITE_MSG(fd,
 106             " [-ql] <vserver>|<pid>|<context> <tag>\n"
 107             "Please report bugs to " PACKAGE_BUGREPORT "\n");
 108   exit(res);
 109 }
 110
 111 static void
 112 showVersion()
 113 {
 114   WRITE_MSG(1,
 115             "vserver-info " VERSION " -- returns information about vservers\n"
 116             "This program is part of " PACKAGE_STRING "\n\n"
 117             "Copyright (C) 2003 Enrico Scholz\n"
 118             VERSION_COPYRIGHT_DISCLAIMER);
 119   exit(0);
 120 }
 121
 122 static void
 123 showTags()
 124 {
 125   char const *          delim = "";
 126   size_t        i;
 127
 128   WRITE_MSG(1, "Valid tags are: ");
 129   for (i=0; i<DIM_OF(TAGS); ++i) {
 130     WRITE_STR(1, delim);
 131     WRITE_STR(1, TAGS[i].tag);
 132
 133     delim = ", ";
 134   }
 135   WRITE_MSG(1, "\n");
 136   exit(0);
 137 }
 138
 139 static VserverTag
 140 stringToTag(char const *str)
 141 {
 142   size_t        i;
 143   for (i=0; i<DIM_OF(TAGS); ++i)
 144     if (strcmp(TAGS[i].tag, str)==0) return TAGS[i].val;
 145
 146   return tgNONE;
 147 }
 148
 149 static vc_uts_type
 150 utsText2Tag(char const *str)
 151 {
 152   if      (strcmp(str, "context")   ==0) return vcVHI_CONTEXT;
 153   else if (strcmp(str, "sysname")   ==0) return vcVHI_SYSNAME;
 154   else if (strcmp(str, "nodename")  ==0) return vcVHI_NODENAME;
 155   else if (strcmp(str, "release")   ==0) return vcVHI_RELEASE;
 156   else if (strcmp(str, "version")   ==0) return vcVHI_VERSION;
 157   else if (strcmp(str, "machine")   ==0) return vcVHI_MACHINE;
 158   else if (strcmp(str, "domainname")==0) return vcVHI_DOMAINNAME;
 159   else {
 160     WRITE_MSG(2, "Unknown UTS tag\n");
 161     exit(1);
 162   }
 163 }
 164
 165 static bool
 166 verifyProc()
 167 {
 168   char const            *errptr;
 169
 170   if (!switchToWatchXid(&errptr)) {
 171     perror(errptr);
 172     return false;
 173   }
 174
 175   if (access("/proc/uptime", R_OK)==-1) {
 176     if (errno!=ENOENT)
 177       perror("access(\"/proc/uptime\")");
 178
 179     return false;
 180   }
 181
 182   return true;
 183 }
 184
 185 static bool
 186 verifyCap()
 187 {
 188   int retried = 0;
 189   struct __user_cap_header_struct header;
 190   struct __user_cap_data_struct user[2];
 191
 192   header.version = _LINUX_CAPABILITY_VERSION_2;
 193   header.pid     = 0;
 194
 195   if (getuid()!=0) {
 196     WRITE_MSG(2, "'VERIFYCAP' can be executed as root only\n");
 197     return false;
 198   }
 199
 200 //  if( prctl( PR_SET_KEEPCAPS, 1,0,0,0 ) < 0 ) {
 201 //    perror( "prctl:" );
 202 //    return false;
 203 //  }
 204
 205 retry:
 206   if (capget(&header, user)==-1) {
 207     if (!retried &&
 208         header.version != _LINUX_CAPABILITY_VERSION_2) {
 209       header.version = _LINUX_CAPABILITY_VERSION_1;
 210       retried = 1;
 211       goto retry;
 212     }
 213     perror("capget()");
 214     return false;
 215   }
 216
 217   user[0].effective   = user[1].effective   = 0;
 218   user[0].permitted   = user[1].permitted   = 0;
 219   user[0].inheritable = user[1].inheritable = 0;
 220
 221   if (capset(&header, user)==-1) {
 222     perror("capset()");
 223     return false;
 224   }
 225
 226   return chroot("/")==-1;
 227 }
 228
 229 static char *
 230 getAPIVer(char *buf)
 231 {
 232   int           v = vc_get_version();
 233   size_t        l;
 234
 235   if (v==-1) return 0;
 236
 237
 238   l = utilvserver_fmt_xulong(0, (unsigned int)v);
 239   memcpy(buf, "0x00000000", 10);
 240   utilvserver_fmt_xulong(buf+2+8-l, (unsigned int)v);
 241
 242   return buf;
 243 }
 244
 245 static inline char *
 246 getCtxId(char *buf, const char *pid_str, xid_t (*get_id)(pid_t pid), const char *err_str)
 247 {
 248   pid_t         pid = atoi(pid_str);
 249   xid_t         xid = get_id(pid);
 250
 251   if (xid==VC_NOCTX) perror(err_str);
 252   else {
 253     utilvserver_fmt_long(buf, xid);
 254     return buf;
 255   }
 256
 257   return 0;
 258 }
 259
 260 static char *
 261 getXid(char *buf, char const *pid_str)
 262 {
 263   return getCtxId(buf, pid_str, vc_get_task_xid, "vc_get_task_xid()");
 264 }
 265
 266 static char *
 267 getNid(char *buf, const char *pid_str)
 268 {
 269   return getCtxId(buf, pid_str, vc_get_task_nid, "vc_get_task_nid()");
 270 }
 271
 272 static char *
 273 getTag(char *buf, const char *pid_str)
 274 {
 275   return getCtxId(buf, pid_str, vc_get_task_tag, "vc_get_task_tag()");
 276 }
 277
 278 static char *
 279 getPXid(char UNUSED *buf, char const UNUSED *vserver)
 280 {
 281   // TODO: implement me when available
 282   return 0;
 283 }
 284
 285 static char *
 286 getInitPid_native(char *buf, xid_t xid)
 287 {
 288   struct vc_vx_info             info;
 289
 290   if (vc_get_vx_info(xid, &info)==-1) perror("vc_get_vx_info()");
 291   else {
 292     utilvserver_fmt_long(buf, info.initpid);
 293     return buf;
 294   }
 295
 296   return 0;
 297 }
 298
 299 #if defined(VC_ENABLE_API_COMPAT) || defined(VC_ENABLE_API_V11)
 300 static int
 301 selectPid(struct dirent const *ent)
 302 {
 303   return atoi(ent->d_name)!=0;
 304 }
 305
 306 static bool
 307 getInitPid_internal(pid_t pid, xid_t xid, pid_t *res)
 308 {
 309   *res = -1;
 310
 311   for (;*res==-1;) {
 312     size_t                      bufsize = utilvserver_getProcEntryBufsize();
 313     char                        buf[bufsize+1];
 314     char                        *pos = 0;
 315
 316     pos = utilvserver_getProcEntry(pid, "\ns_context: ", buf, bufsize);
 317     if (pos==0 && errno==EAGAIN) continue;
 318
 319     if (pos==0 || (xid_t)atoi(pos)!=xid) return false;
 320
 321     buf[bufsize] = '\0';
 322     pos          = strstr(buf, "\ninitpid: ");
 323
 324     if (pos!=0) {
 325       pos       += sizeof("\ninitpid: ")-1;
 326       if (strncmp(pos, "none", 4)==0) *res = -1;
 327       else                            *res = atoi(pos);
 328     }
 329   }
 330
 331   return true;
 332 }
 333
 334 static char *
 335 getInitPid_emulated(char *buf, xid_t xid)
 336 {
 337   struct dirent **namelist;
 338   int           n;
 339
 340   switchToWatchXid(0);  // ignore errors silently...
 341   n = scandir("/proc", &namelist, selectPid, alphasort);
 342   if (n<0) perror("scandir()");
 343   else while (n--) {
 344     pid_t       pid;
 345     if (!getInitPid_internal(atoi(namelist[n]->d_name), xid, &pid)) continue;
 346
 347     utilvserver_fmt_long(buf, pid);
 348     return buf;
 349   }
 350
 351   return 0;
 352 }
 353 #else // VC_ENABLE_API_COMPAT
 354 static char *
 355 getInitPid_emulated(char UNUSED *buf, xid_t UNUSED xid)
 356 {
 357   WRITE_MSG(2, "tools were built without compat API, getInitPid() not available\n");
 358   return 0;
 359 }
 360 #endif // VC_ENABLE_API_COMPAT
 361
 362 static char *
 363 getInitPid(char *buf, xid_t xid)
 364 {
 365   if (vc_isSupported(vcFEATURE_VINFO))
 366     return getInitPid_native(buf, xid);
 367   else
 368     return getInitPid_emulated(buf, xid);
 369 }
 370
 371 static char *
 372 getInitPidPid(char *buf, char const *vserver)
 373 {
 374   struct vc_vx_info     info;
 375   pid_t                 pid = atoi(vserver);
 376   xid_t                 xid = vc_get_task_xid(pid);
 377
 378   if (xid==VC_NOCTX) perror("vc_get_task_xid()");
 379   else if (vc_get_vx_info(xid, &info)==-1) perror("vc_get_vx_info()");
 380   else {
 381     utilvserver_fmt_long(buf, info.initpid);
 382     return buf;
 383   }
 384
 385   return 0;
 386 }
 387
 388 static char *
 389 getUTS(char *buf, xid_t xid, size_t argc, char * argv[])
 390 {
 391   if (argc>0) {
 392     vc_uts_type type = utsText2Tag(argv[0]);
 393     if (vc_get_vhi_name(xid, type, buf, sizeof(buf)-1)==-1)
 394       perror("vc_get_vhi_name()");
 395     else
 396       return buf;
 397   }
 398   else {
 399     bool                is_passed = false;
 400     char                tmp[128];
 401 #define APPEND_UTS(TYPE)                                                \
 402     (((vc_get_vhi_name(xid, TYPE, tmp, sizeof(tmp)-1)!=-1) && (strcat(buf, tmp), strcat(buf, " "), is_passed=true)) || \
 403      (strcat(buf, "??? ")))
 404
 405     if (APPEND_UTS(vcVHI_CONTEXT) &&
 406         APPEND_UTS(vcVHI_SYSNAME) &&
 407         APPEND_UTS(vcVHI_NODENAME) &&
 408         APPEND_UTS(vcVHI_RELEASE) &&
 409         APPEND_UTS(vcVHI_VERSION) &&
 410         APPEND_UTS(vcVHI_MACHINE) &&
 411         APPEND_UTS(vcVHI_DOMAINNAME) &&
 412         is_passed)
 413       return buf;
 414
 415     perror("vc_get_vhi_name()");
 416 #undef APPEND_UTS
 417   }
 418
 419   return 0;
 420 }
 421
 422 static int
 423 printSysInfo(char *buf)
 424 {
 425   int                   fd = open(PKGLIBDIR "/FEATURES.txt", O_RDONLY);
 426   struct utsname        uts;
 427
 428   if (uname(&uts)==-1)
 429     perror("uname()");
 430   else {
 431     WRITE_MSG(1,
 432               "Versions:\n"
 433               "                   Kernel: ");
 434     WRITE_STR(1, uts.release);
 435     WRITE_MSG(1, "\n"
 436               "                   VS-API: ");
 437
 438     memset(buf, 0, 128);
 439     if (getAPIVer(buf)) WRITE_STR(1, buf);
 440     else                WRITE_MSG(1, "???");
 441
 442     WRITE_MSG(1, "\n"
 443               "             util-vserver: " PACKAGE_VERSION "; " __DATE__ ", " __TIME__"\n"
 444               "\n");
 445   }
 446
 447   if (fd==-1)
 448     WRITE_MSG(1, "FEATURES.txt not found\n");
 449   else {
 450     off_t               l  = Elseek(fd, 0, SEEK_END);
 451     Elseek(fd, 0, SEEK_SET);
 452     {
 453       char              buf[l];
 454       EreadAll(fd, buf, l);
 455       EwriteAll(1, buf, l);
 456     }
 457     Eclose(fd);
 458   }
 459
 460   return EXIT_SUCCESS;
 461 }
 462
 463 static char *
 464 getContext(char *buf, char const *vserver, bool allow_only_static)
 465 {
 466   xid_t         xid = vc_getVserverCtx(vserver, vcCFG_AUTO,
 467                                        allow_only_static, 0, vcCTX_XID);
 468   if (xid==VC_NOCTX) return 0;
 469
 470   utilvserver_fmt_long(buf, xid);
 471   return buf;
 472 }
 473
 474 static char const *
 475 getXIDType(xid_t xid, int argc, char *argv[])
 476 {
 477   char const *          tp;
 478
 479   switch (vc_getXIDType(xid)) {
 480     case vcTYPE_INVALID         :  tp = "invalid"; break;
 481     case vcTYPE_MAIN            :  tp = "main";    break;
 482     case vcTYPE_WATCH           :  tp = "watch";   break;
 483     case vcTYPE_STATIC          :  tp = "static";  break;
 484     case vcTYPE_DYNAMIC         :  tp = "dynamic"; break;
 485     default                     :  tp = 0;         break;
 486   }
 487
 488   if (argc==0 || tp==0)
 489     return tp;
 490
 491   while (argc>0) {
 492     --argc;
 493     if (strcasecmp(argv[argc], tp)==0) return tp;
 494   }
 495
 496   return 0;
 497 }
 498
 499 static int
 500 testFeature(int argc, char *argv[])
 501 {
 502   return (argc>0 && vc_isSupportedString(argv[0])) ? EXIT_SUCCESS : EXIT_FAILURE;
 503 }
 504
 505 static bool
 506 str2bool(char const *str)
 507 {
 508   return atoi(str)!=0 || strchr("yYtT", str[0])!=0 || strcasecmp("true", str)==0;
 509 }
 510
 511 static int
 512 execQuery(char const *vserver, VserverTag tag, int argc, char *argv[])
 513 {
 514   char const *          res = 0;
 515   char                  buf[sizeof(xid_t)*4 + 1024 + strlen(vserver)];
 516
 517   memset(buf, 0, sizeof buf);
 518   switch (tag) {
 519     case tgNAME         :  res = vc_getVserverName(vserver, vcCFG_AUTO); break;
 520     case tgVDIR         :
 521       res = vc_getVserverVdir(vserver, vcCFG_AUTO, argc>0 && atoi(argv[0]));
 522       break;
 523     case tgCFGDIR       :  res = vc_getVserverCfgDir(vserver, vcCFG_AUTO);     break;
 524     case tgAPPDIR       :
 525       res = vc_getVserverAppDir(vserver, vcCFG_AUTO, argc==0 ? "" : argv[0]);
 526       break;
 527
 528     case tgRUNNING      : {
 529       signed long               xid;    // type is a small hack, but should be ok...
 530       struct vc_vx_info         info;
 531
 532       if (isNumber(vserver, &xid, true) && xid>=0)
 533         res = (vc_get_vx_info(xid, &info)==-1) ? 0 : "1";
 534       else
 535         res = (vc_getVserverCtx(vserver, vcCFG_AUTO, false, 0, vcCTX_XID)==VC_NOCTX) ? 0 : "1";
 536
 537       break;
 538     }
 539
 540     case tgCANONIFY     :
 541       strcpy(buf, vserver);
 542       if (canonifyVserverName(buf)>0) res = buf;
 543       break;
 544
 545     case tgCONTEXT      :  res = getContext(buf, vserver,
 546                                             argc==0 || str2bool(argv[0])); break;
 547     case tgINITPID_PID  :  res = getInitPidPid(buf, vserver);  break;
 548     case tgAPIVER       :  res = getAPIVer(buf);               break;
 549     case tgXID          :  res = getXid(buf, vserver);         break;
 550     case tgPXID         :  res = getPXid(buf, vserver);        break;
 551     case tgSYSINFO      :  return printSysInfo(buf);           break;
 552     case tgFEATURE      :  return testFeature(argc,argv);      break;
 553     case tgVERIFYCAP    :  return verifyCap() ? 0 : 1;         break;
 554     case tgVERIFYPROC   :  return verifyProc() ? 0 : 1;        break;
 555     case tgNID          :  res = getNid(buf, vserver);         break;
 556     case tgTAG          :  res = getTag(buf, vserver);         break;
 557
 558
 559     default             : {
 560       xid_t             xid = *vserver!='\0' ? vc_xidopt2xid(vserver,true,0) : VC_SAMECTX;
 561
 562       switch (tag) {
 563         case tgID       :  res = vc_getVserverByCtx(xid,0,0);  break;
 564         case tgINITPID  :  res = getInitPid(buf, xid);         break;
 565         case tgUTS      :  res = getUTS(buf, xid, argc, argv); break;
 566         case tgXIDTYPE  :  res = getXIDType(xid, argc, argv);  break;
 567
 568         default         :  assert(false); abort();  // TODO
 569       }
 570     }
 571   }
 572
 573   if (res==0) return EXIT_FAILURE;
 574   WRITE_STR(1, res);
 575   WRITE_MSG(1, "\n");
 576   return EXIT_SUCCESS;
 577 }
 578
 579 int main(int argc, char *argv[])
 580 {
 581   bool          quiet = false;
 582   char const *  vserver;
 583   VserverTag    tag;
 584
 585   while (1) {
 586     int         c = getopt_long(argc, argv, "ql", CMDLINE_OPTIONS, 0);
 587     if (c==-1) break;
 588
 589     switch (c) {
 590       case 'h'          :  showHelp(1, argv[0], 0);
 591       case 'v'          :  showVersion();
 592       case 'l'          :  showTags();
 593       case 'q'          :  quiet = true; break;
 594       default           :
 595         WRITE_MSG(2, "Try '");
 596         WRITE_STR(2, argv[0]);
 597         WRITE_MSG(2, " --help' for more information.\n");
 598         exit(1);
 599         break;
 600     }
 601   }
 602
 603   if (optind+2>argc) {
 604     execQuery("-", tgSYSINFO, 0, 0);
 605     WRITE_MSG(2, "\nAssumed 'SYSINFO' as no other option given; try '--help' for more information.\n");
 606     exit(0);
 607   }
 608
 609   vserver = argv[optind];
 610   tag     = stringToTag(argv[optind+1]);
 611
 612   if (tag==tgNONE) {
 613     WRITE_MSG(2, "Unknown tag; use '-l' to get list of valid tags\n");
 614     exit(1);
 615   }
 616
 617   if (quiet) {
 618     int         fd = Eopen("/dev/null", O_WRONLY, 0644);
 619     Edup2(fd, 1);
 620     Eclose(fd);
 621   }
 622
 623   return execQuery(vserver, tag, argc-(optind+2), argv+optind+2);
 624 }