virsh.c 45.1 KB
Newer Older
1
/*
2
 * virsh.c: a Xen shell used to exercise the libvir API
3 4 5 6 7 8
 *
 * Copyright (C) 2005 Red Hat, Inc.
 *
 * See COPYING.LIB for the License of this software
 *
 * Daniel Veillard <veillard@redhat.com>
K
Karel Zak 已提交
9 10 11
 * Karel Zak <kzak@redhat.com>
 *
 * $Id$
12 13
 */

K
Karel Zak 已提交
14 15
#define _GNU_SOURCE    /* isblank() */

16
#include "libvir.h"
17
#include <stdio.h>
K
Karel Zak 已提交
18 19 20
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
21
#include <unistd.h>
K
Karel Zak 已提交
22
#include <getopt.h>
23
#include <sys/types.h>
K
Karel Zak 已提交
24
#include <sys/time.h>
K
Karel Zak 已提交
25 26 27 28 29 30
#include <ctype.h>

#include <readline/readline.h>
#include <readline/history.h>

#include "config.h"
31
#include "internal.h"
K
Karel Zak 已提交
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

static char *progname;

#ifndef TRUE
#define TRUE 1
#define FALSE 0
#endif

#define VSH_PROMPT_RW    "virsh # "
#define VSH_PROMPT_RO    "virsh > "

#define GETTIMEOFDAY(T) gettimeofday(T, NULL)
#define DIFF_MSEC(T, U) \
        ((((int) ((T)->tv_sec - (U)->tv_sec)) * 1000000.0 + \
          ((int) ((T)->tv_usec - (U)->tv_usec))) / 1000.0)

typedef enum {
    VSH_MESG,        /* standard output */
    VSH_HEADER,      /* header for standard output */
    VSH_FOOTER,      /* timing, last command state, or whatever */
    VSH_DEBUG1,      /* debugN where 'N' = level */
    VSH_DEBUG2,
    VSH_DEBUG3,
    VSH_DEBUG4,
    VSH_DEBUG5
} vshOutType;

/*
 * virsh command line grammar:
 *
 *    command_line    =     <command>\n | <command>; <command>; ...
 *
 *    command         =    <keyword> <option> <data>
 *
 *    option          =     <bool_option> | <int_option> | <string_option>
 *    data            =     <string>
 *
 *    bool_option     =     --optionname
 *    int_option      =     --optionname <number>
 *    string_option   =     --optionname <string>
 *        
 *     keyword        =     [a-zA-Z]
 *     number         =     [0-9]+
 *     string         =     [^[:blank:]] | "[[:alnum:]]"$
 *
 *  Note: only one <data> token per command is supported. It means:
 *        "command aaa bbb" is unsupported and you have to use any option, like:
 *        "command --aaa <data> bbb" or whatever.
 */

/*
 * vshCmdOptType - command option type 
 */   
typedef enum {
    VSH_OT_NONE = 0,   /* none */
    VSH_OT_BOOL,       /* boolean option */
    VSH_OT_STRING,     /* string option */
    VSH_OT_INT,        /* int option */
    VSH_OT_DATA        /* string data (as non-option) */
} vshCmdOptType;

/*
 * Command Option Flags
 */
#define VSH_OFLAG_NONE    0        /* without flags */
#define VSH_OFLAG_REQ    (1 << 1)    /* option required */

/* dummy */
typedef struct __vshControl vshControl;
typedef struct __vshCmd vshCmd;

/*
 * vshCmdInfo -- information about command
 */
typedef struct  {
K
Karel Zak 已提交
107 108
    const char    *name;     /* name of information */
    const char    *data;     /* information */
K
Karel Zak 已提交
109 110 111 112 113 114
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
typedef struct  {
K
Karel Zak 已提交
115
    const char       *name;     /* the name of option */
K
Karel Zak 已提交
116 117
    vshCmdOptType    type;      /* option type */
    int              flag;      /* flags */
K
Karel Zak 已提交
118
    const char       *help;     /* help string */
K
Karel Zak 已提交
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
} vshCmdOptDef;

/*
 * vshCmdOpt - command options
 */
typedef struct vshCmdOpt {
    vshCmdOptDef     *def;      /* pointer to relevant option */
    char             *data;     /* allocated data */
    struct vshCmdOpt *next;    
} vshCmdOpt;

/*
 * vshCmdDef - command definition
 */
typedef struct  {
K
Karel Zak 已提交
134
    const char       *name;
K
Karel Zak 已提交
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
    int              (*handler)(vshControl *, vshCmd *);    /* command handler */
    vshCmdOptDef     *opts;     /* definition of command options */
    vshCmdInfo       *info;     /* details about command */
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
    vshCmdDef        *def;      /* command definition */
    vshCmdOpt        *opts;     /* list of command arguments */
    struct __vshCmd  *next;     /* next command */
} __vshCmd;

/*
 * vshControl
 */
typedef struct __vshControl {
    virConnectPtr   conn;       /* connection to hypervisor */
    vshCmd          *cmd;       /* the current command */
    char            *cmdstr;    /* string with command */
    uid_t           uid;        /* process owner */
    int             imode;      /* interactive mode? */
    int             quiet;      /* quiet mode */
    int             debug;      /* print debug messages? */
    int             timing;     /* print timing info? */
} __vshControl;
162

163

K
Karel Zak 已提交
164 165
static vshCmdDef commands[];

K
Karel Zak 已提交
166
static void vshError(vshControl *ctl, int doexit, const char *format, ...);
K
Karel Zak 已提交
167 168
static int vshInit(vshControl *ctl);
static int vshDeinit(vshControl *ctl);
K
Karel Zak 已提交
169
static void vshUsage(vshControl *ctl, const char *cmdname);
K
Karel Zak 已提交
170 171 172

static int vshParseArgv(vshControl *ctl, int argc, char **argv);

K
Karel Zak 已提交
173 174 175
static const char *vshCmddefGetInfo(vshCmdDef *cmd, const char *info);
static vshCmdDef *vshCmddefSearch(const char *cmdname);
static int vshCmddefHelp(vshControl *ctl, const char *name, int withprog);
K
Karel Zak 已提交
176

K
Karel Zak 已提交
177 178 179 180
static vshCmdOpt *vshCommandOpt(vshCmd *cmd, const char *name);
static int vshCommandOptInt(vshCmd *cmd, const char *name, int *found);
static char *vshCommandOptString(vshCmd *cmd, const char *name, int *found);
static int vshCommandOptBool(vshCmd *cmd, const char *name);
K
Karel Zak 已提交
181 182
static virDomainPtr vshCommandOptDomain(vshControl *ctl, vshCmd *cmd, const char *optname, char **name);

K
Karel Zak 已提交
183

K
Karel Zak 已提交
184
static void vshPrint(vshControl *ctl, vshOutType out, const char *format, ...);
K
Karel Zak 已提交
185

K
Karel Zak 已提交
186

K
Karel Zak 已提交
187
static const char *vshDomainStateToString(int state);
K
Karel Zak 已提交
188 189 190 191 192 193 194 195 196 197 198 199 200 201
static int vshConnectionUsability(vshControl *ctl, virConnectPtr conn, int showerror);

/* ---------------
 * Commands
 * ---------------
 */

/*
 * "help" command 
 */
static vshCmdInfo info_help[] = {
    { "syntax",   "help [<command>]" },
    { "help",     "print help" },
    { "desc",     "Prints global help or command specific help." },
202
    { "version",  "Prints versionning informations." },
K
Karel Zak 已提交
203 204 205 206 207 208 209 210 211 212
    { NULL, NULL }
};

static vshCmdOptDef opts_help[] = {
    { "command", VSH_OT_DATA, 0, "name of command" },
        { NULL, 0, 0, NULL }
};

static int
cmdHelp(vshControl *ctl, vshCmd *cmd) {
K
Karel Zak 已提交
213
    const char *cmdname = vshCommandOptString(cmd, "command", NULL);
K
Karel Zak 已提交
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276

    if (!cmdname) {
        vshCmdDef *def;
        
        vshPrint(ctl, VSH_HEADER, "Commands:\n\n");
        for(def = commands; def->name; def++)
            vshPrint(ctl, VSH_MESG, "    %-15s %s\n", def->name, 
                    vshCmddefGetInfo(def, "help"));
        return TRUE;
    }
    return vshCmddefHelp(ctl, cmdname, FALSE);
}

/*
 * "connect" command 
 */
static vshCmdInfo info_connect[] = {
    { "syntax",   "connect [--readonly]" },
    { "help",     "(re)connect to hypervisor" },
    { "desc",     "Connect to local hypervisor. This is build-in command after shell start up." },
    { NULL, NULL }
};

static vshCmdOptDef opts_connect[] = {
    { "readonly", VSH_OT_BOOL, 0, "read-only connection" },
        { NULL, 0, 0, NULL }
};

static int
cmdConnect(vshControl *ctl, vshCmd *cmd) {
    int ro = vshCommandOptBool(cmd, "readonly");
    
    if (ctl->conn) {
        if (virConnectClose(ctl->conn)!=0) {
            vshError(ctl, FALSE, "failed to disconnect from the hypervisor");
            return FALSE;
        }
        ctl->conn = NULL;
    }
    if (!ro)
        ctl->conn = virConnectOpen(NULL);
    else
        ctl->conn = virConnectOpenReadOnly(NULL);

    if (!ctl->conn)
        vshError(ctl, FALSE, "failed to connect to the hypervisor");
    
    return ctl->conn ? TRUE : FALSE;
}

/*
 * "list" command
 */
static vshCmdInfo info_list[] = {
    { "syntax",   "list" },
    { "help",     "list domains" },
    { "desc",     "Returns list of domains." },
    { NULL, NULL }
};



static int
277
cmdList(vshControl *ctl, vshCmd *cmd ATTRIBUTE_UNUSED) {
K
Karel Zak 已提交
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
    int *ids, maxid, i;

    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;
    
    maxid = virConnectNumOfDomains(ctl->conn);
    if (maxid <= 0) {
        /* strange, there should be at least dom0... */
        vshError(ctl, FALSE, "failed to list active domains.");
        return FALSE;
    }
    ids = malloc(sizeof(int) * maxid);
    virConnectListDomains(ctl->conn, &ids[0], maxid);
    
    vshPrint(ctl, VSH_HEADER, "%3s %-20s %s\n", "Id", "Name", "State");
    vshPrint(ctl, VSH_HEADER, "----------------------------------\n");
    
    for(i=0; i < maxid; i++) {
        int ret;
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByID(ctl->conn, ids[i]);
        
         /* this kind of work with domains is not atomic operation */
        if (!dom)
            continue;
        ret = virDomainGetInfo(dom, &info);
        
        vshPrint(ctl, VSH_MESG, "%3d %-20s %s\n", 
                virDomainGetID(dom), 
                virDomainGetName(dom),
                ret < 0 ? "no state" : vshDomainStateToString(info.state));
309
        virDomainFree(dom);
K
Karel Zak 已提交
310 311 312 313 314 315 316 317 318
    }
    free(ids);
    return TRUE;
}

/*
 * "dstate" command
 */
static vshCmdInfo info_dstate[] = {
K
Karel Zak 已提交
319
    { "syntax",  "dstate <domain>" },
K
Karel Zak 已提交
320
    { "help",    "domain state" },
K
Karel Zak 已提交
321
    { "desc",    "Returns state about a running domain." },
K
Karel Zak 已提交
322 323 324 325
    { NULL, NULL }
};

static vshCmdOptDef opts_dstate[] = {
K
Karel Zak 已提交
326 327
    { "domain",  VSH_OT_DATA, 0, "domain name or id" },
    { NULL, 0, 0, NULL }
K
Karel Zak 已提交
328 329 330 331
};

static int
cmdDstate(vshControl *ctl, vshCmd *cmd) {
332
    virDomainInfo info;
K
Karel Zak 已提交
333
    virDomainPtr dom;
K
Karel Zak 已提交
334 335
    int ret = TRUE;
   
K
Karel Zak 已提交
336 337
    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;
338

K
Karel Zak 已提交
339
    if (!(dom = vshCommandOptDomain(ctl, cmd, "domain", NULL)))
K
Karel Zak 已提交
340 341 342 343 344 345 346
        return FALSE;
    
    if (virDomainGetInfo(dom, &info)==0)
        vshPrint(ctl, VSH_MESG, "%s\n", vshDomainStateToString(info.state));
    else
        ret = FALSE;
        
347 348 349 350 351 352 353 354
    virDomainFree(dom);
    return ret;
}

/*
 * "suspend" command
 */
static vshCmdInfo info_suspend[] = {
K
Karel Zak 已提交
355 356
    { "syntax",  "suspend <domain>" },
    { "help",    "suspend a domain" },
357 358 359 360 361
    { "desc",    "Suspend a running domain." },
    { NULL, NULL }
};

static vshCmdOptDef opts_suspend[] = {
K
Karel Zak 已提交
362 363
    { "domain",  VSH_OT_DATA, 0, "domain name or id" },
    { NULL, 0, 0, NULL }
364 365 366 367 368
};

static int
cmdSuspend(vshControl *ctl, vshCmd *cmd) {
    virDomainPtr dom;
K
Karel Zak 已提交
369 370
    char *name;
    int ret = TRUE;
371 372 373 374
    
    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;

K
Karel Zak 已提交
375
    if (!(dom = vshCommandOptDomain(ctl, cmd, "domain", &name)))
376 377 378
        return FALSE;
    
    if (virDomainSuspend(dom)==0) {
K
Karel Zak 已提交
379
        vshPrint(ctl, VSH_MESG, "Domain %s suspended\n", name);
380 381 382 383 384 385 386 387 388
    } else {
        vshError(ctl, FALSE, "Failed to suspend domain\n");
        ret = FALSE;
    }
        
    virDomainFree(dom);
    return ret;
}

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
/*
 * "save" command
 */
static vshCmdInfo info_save[] = {
    { "syntax",  "save <domain> to <file>" },
    { "help",    "save a domain state to a file" },
    { "desc",    "Save a running domain." },
    { NULL, NULL }
};

static vshCmdOptDef opts_save[] = {
    { "file",  VSH_OT_STRING, VSH_OFLAG_REQ, "where to save the data" },
    { "domain",  VSH_OT_DATA, 0, "domain name or id" },
    { NULL, 0, 0, NULL }
};

static int
cmdSave(vshControl *ctl, vshCmd *cmd) {
    virDomainPtr dom;
    char *name;
    char *to;
    int found;
    int ret = TRUE;
    
    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;

    to = vshCommandOptString(cmd, "file", &found);
    if (!found)
        return FALSE;
    
    if (!(dom = vshCommandOptDomain(ctl, cmd, "domain", &name)))
        return FALSE;
    
    if (virDomainSave(dom, to)==0) {
        vshPrint(ctl, VSH_MESG, "Domain %s saved\n", name);
    } else {
        vshError(ctl, FALSE, "Failed to save domain\n");
        ret = FALSE;
    }
        
    virDomainFree(dom);
    return ret;
}

/*
 * "restore" command
 */
static vshCmdInfo info_restore[] = {
    { "syntax",  "restore a domain from <file>" },
    { "help",    "restore a domain from a saved state in a file" },
    { "desc",    "Restore a domain." },
    { NULL, NULL }
};

static vshCmdOptDef opts_restore[] = {
    { "file",  VSH_OT_DATA, 0, "the state to restore" },
    { NULL, 0, 0, NULL }
};

static int
cmdRestore(vshControl *ctl, vshCmd *cmd) {
    char *from;
    int found;
    int ret = TRUE;
    
    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        return FALSE;
    
    if (virDomainRestore(ctl->conn, from)==0) {
        vshPrint(ctl, VSH_MESG, "Domain restored from %s\n", from);
    } else {
        vshError(ctl, FALSE, "Failed to restore domain\n");
        ret = FALSE;
    }
    return ret;
}

471 472 473 474
/*
 * "resume" command
 */
static vshCmdInfo info_resume[] = {
K
Karel Zak 已提交
475 476
    { "syntax",  "resume <domain>" },
    { "help",    "resume a domain" },
477 478 479 480 481
    { "desc",    "Resume a previously suspended domain." },
    { NULL, NULL }
};

static vshCmdOptDef opts_resume[] = {
K
Karel Zak 已提交
482 483
    { "domain",  VSH_OT_DATA, 0, "domain name or id" },
    { NULL, 0, 0, NULL }
484 485 486 487 488
};

static int
cmdResume(vshControl *ctl, vshCmd *cmd) {
    virDomainPtr dom;
K
Karel Zak 已提交
489 490
    int ret = TRUE;
    char *name;
491 492 493 494
    
    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;

K
Karel Zak 已提交
495
    if (!(dom = vshCommandOptDomain(ctl, cmd, "domain", &name)))
496 497 498
        return FALSE;
    
    if (virDomainResume(dom)==0) {
K
Karel Zak 已提交
499
        vshPrint(ctl, VSH_MESG, "Domain %s resumed\n", name);
500 501 502 503 504 505 506 507 508
    } else {
        vshError(ctl, FALSE, "Failed to resume domain\n");
        ret = FALSE;
    }
        
    virDomainFree(dom);
    return ret;
}

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
/*
 * "shutdown" command
 */
static vshCmdInfo info_shutdown[] = {
    { "syntax",  "shutdown <domain>" },
    { "help",    "gracefully shutdown a domain" },
    { "desc",    "Run shutdown in the targetted domain" },
    { NULL, NULL }
};

static vshCmdOptDef opts_shutdown[] = {
    { "domain",  VSH_OT_DATA, 0, "domain name or id" },
    { NULL, 0, 0, NULL }
};

static int
cmdShutdown(vshControl *ctl, vshCmd *cmd) {
    virDomainPtr dom;
    int ret = TRUE;
    char *name;
    
    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, "domain", &name)))
        return FALSE;
    
    if (virDomainShutdown(dom)==0) {
        vshPrint(ctl, VSH_MESG, "Domain %s is being shutdown\n", name);
    } else {
        vshError(ctl, FALSE, "Failed to shutdown domain\n");
        ret = FALSE;
    }
        
    virDomainFree(dom);
    return ret;
}

547 548 549 550
/*
 * "destroy" command
 */
static vshCmdInfo info_destroy[] = {
K
Karel Zak 已提交
551 552
    { "syntax",  "destroy <domain>" },
    { "help",    "destroy a domain" },
553 554 555 556 557
    { "desc",    "Destroy a given domain." },
    { NULL, NULL }
};

static vshCmdOptDef opts_destroy[] = {
K
Karel Zak 已提交
558 559
    { "domain",  VSH_OT_DATA, 0, "domain name or id" },
    { NULL, 0, 0, NULL }
560 561 562 563 564
};

static int
cmdDestroy(vshControl *ctl, vshCmd *cmd) {
    virDomainPtr dom;
K
Karel Zak 已提交
565 566 567
    int ret = TRUE;
    char *name;
   
568 569 570
    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;

K
Karel Zak 已提交
571
    if (!(dom = vshCommandOptDomain(ctl, cmd, "domain", &name)))
572 573 574
        return FALSE;
    
    if (virDomainDestroy(dom)==0) {
K
Karel Zak 已提交
575
        vshPrint(ctl, VSH_MESG, "Domain %s destroyed\n", name);
576 577 578 579 580 581
    } else {
        vshError(ctl, FALSE, "Failed to destroy domain\n");
        ret = FALSE;
        virDomainFree(dom);
    }
        
K
Karel Zak 已提交
582 583 584 585 586 587 588
    return ret;
}

/*
 * "dinfo" command
 */
static vshCmdInfo info_dinfo[] = {
K
Karel Zak 已提交
589
    { "syntax",   "dinfo <domain>" },
K
Karel Zak 已提交
590 591 592 593 594 595
    { "help",     "domain information" },
    { "desc",     "Returns basic information about the domain." },
    { NULL, NULL }
};

static vshCmdOptDef opts_dinfo[] = {
K
Karel Zak 已提交
596
    { "domain",  VSH_OT_DATA, 0, "domain name or id" },
597
    { NULL, 0, 0, NULL }
K
Karel Zak 已提交
598 599 600 601 602 603
};

static int
cmdDinfo(vshControl *ctl, vshCmd *cmd) {
    virDomainInfo info;
    virDomainPtr dom;
K
Karel Zak 已提交
604
    int ret = TRUE;
605
    char *str;
K
Karel Zak 已提交
606
   
K
Karel Zak 已提交
607 608 609
    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;

K
Karel Zak 已提交
610
    if (!(dom = vshCommandOptDomain(ctl, cmd, "domain", NULL)))
K
Karel Zak 已提交
611 612
        return FALSE;
    
613 614 615 616 617 618 619 620 621 622
     vshPrint(ctl, VSH_MESG, "%-15s %d\n", "Id:", 
            virDomainGetID(dom));
     vshPrint(ctl, VSH_MESG, "%-15s %s\n", "Name:", 
            virDomainGetName(dom));
     
     if ((str=virDomainGetOSType(dom))) {
         vshPrint(ctl, VSH_MESG, "%-15s %s\n", "OS Type:", str);
         free(str);
     }

K
Karel Zak 已提交
623 624 625
    if (virDomainGetInfo(dom, &info)==0) {
        vshPrint(ctl, VSH_MESG, "%-15s %s\n", "State:",    
                vshDomainStateToString(info.state));
626
        
K
Karel Zak 已提交
627 628 629
        vshPrint(ctl, VSH_MESG, "%-15s %d\n", "CPU(s):",
                info.nrVirtCpu);
        
K
Karel Zak 已提交
630 631 632 633
        if (info.cpuTime != 0) 
        {
            float cpuUsed = info.cpuTime;
            cpuUsed /= 1000000000;
K
Karel Zak 已提交
634
            
K
Karel Zak 已提交
635
            vshPrint(ctl, VSH_MESG, "%-15s %.1fs\n", "CPU time:", cpuUsed);
K
Karel Zak 已提交
636 637 638 639 640 641 642 643 644 645 646
        }
           
        vshPrint(ctl, VSH_MESG, "%-15s %lu kB\n", "Max memory:",
                info.maxMem);
        vshPrint(ctl, VSH_MESG, "%-15s %lu kB\n", "Used memory:",
                info.memory);
        
    } else {
        ret = FALSE;
    }
        
647
    virDomainFree(dom);
K
Karel Zak 已提交
648 649 650
    return ret;
}

651 652 653 654
/*
 * "dumpxml" command
 */
static vshCmdInfo info_dumpxml[] = {
K
Karel Zak 已提交
655
    { "syntax",   "dumpxml <name>" },
656 657 658 659 660 661
    { "help",     "domain information in XML" },
    { "desc",     "Ouput the domain informations as an XML dump to stdout" },
    { NULL, NULL }
};

static vshCmdOptDef opts_dumpxml[] = {
K
Karel Zak 已提交
662
    { "domain",  VSH_OT_DATA, 0, "domain name or id" },
663 664 665 666 667 668
    { NULL, 0, 0, NULL }
};

static int
cmdDumpXML(vshControl *ctl, vshCmd *cmd) {
    virDomainPtr dom;
K
Karel Zak 已提交
669
    int ret = TRUE;
670 671 672 673 674
    char *dump;
    
    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;

K
Karel Zak 已提交
675
    if (!(dom = vshCommandOptDomain(ctl, cmd, "domain", NULL)))
676 677 678 679 680 681 682 683 684 685 686 687 688 689
        return FALSE;
    
    dump = virDomainGetXMLDesc(dom, 0);
    if (dump != NULL) {
        printf("%s", dump);
        free(dump);
    } else {
        ret = FALSE;
    }
        
    virDomainFree(dom);
    return ret;
}

K
Karel Zak 已提交
690 691 692 693 694
/*
 * "nameof" command
 */
static vshCmdInfo info_nameof[] = {
    { "syntax",   "nameof <id>" },
K
Karel Zak 已提交
695
    { "help",     "convert a domain Id to domain name" },
K
Karel Zak 已提交
696 697 698 699 700
    { NULL, NULL }
};

static vshCmdOptDef opts_nameof[] = {
    { "id",        VSH_OT_DATA,  0, "domain Id" },
701
    { NULL, 0, 0, NULL }
K
Karel Zak 已提交
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
};

static int
cmdNameof(vshControl *ctl, vshCmd *cmd) {
    int found;
    int id = vshCommandOptInt(cmd, "id", &found);
    virDomainPtr dom;

    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;
    if (!found)
        return FALSE;
    
    dom = virDomainLookupByID(ctl->conn, id);
    if (dom) {
        vshPrint(ctl, VSH_MESG, "%s\n", virDomainGetName(dom));
718
        virDomainFree(dom);
K
Karel Zak 已提交
719 720 721 722 723 724 725 726 727 728 729 730
    } else {
        vshError(ctl, FALSE, "failed to get domain '%d'", id);
        return FALSE;
    }
    return TRUE;
}

/*
 * "idof" command
 */
static vshCmdInfo info_idof[] = {
    { "syntax",   "idof <name>" },
K
Karel Zak 已提交
731
    { "help",     "convert a domain name to domain Id" },
K
Karel Zak 已提交
732 733 734 735 736 737 738 739 740 741 742
    { NULL, NULL }
};

static vshCmdOptDef opts_idof[] = {
    { "name",     VSH_OT_DATA,   0, "domain name" },
        { NULL, 0, 0, NULL }
};

static int
cmdIdof(vshControl *ctl, vshCmd *cmd) {
    char *name = vshCommandOptString(cmd, "name", NULL);
743
    virDomainPtr dom;
K
Karel Zak 已提交
744 745 746 747 748 749 750 751

    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;
    if (!name)
        return FALSE;
    
    dom = virDomainLookupByName(ctl->conn, name);
    if (dom) {
752
        vshPrint(ctl, VSH_MESG, "%d\n", virDomainGetID(dom));
753
        virDomainFree(dom);
K
Karel Zak 已提交
754 755 756 757 758 759 760
    } else {
        vshError(ctl, FALSE, "failed to get domain '%s'", name);
        return FALSE;
    }
    return TRUE;
}

761 762 763 764 765 766 767 768 769 770 771 772
/*
 * "version" command
 */
static vshCmdInfo info_version[] = {
    { "syntax",   "version" },
    { "help",     "show versions" },
    { "desc",     "Display the version informations available" },
    { NULL, NULL }
};


static int
773
cmdVersion(vshControl *ctl, vshCmd *cmd ATTRIBUTE_UNUSED) {
774 775
    unsigned long hvVersion;
    const char *hvType;
776 777 778 779 780 781 782
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;
783 784 785 786 787 788

    if (!vshConnectionUsability(ctl, ctl->conn, TRUE))
        return FALSE;
    
    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
K
Karel Zak 已提交
789
        vshError(ctl, FALSE, "failed to get hypervisor type\n");
790 791 792
        return FALSE;
    }

793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
    includeVersion = LIBVIR_VERSION_NUMBER;
    major = includeVersion / 1000000;
    includeVersion %= 1000000;
    minor = includeVersion / 1000;
    rel = includeVersion % 1000;
    vshPrint(ctl, VSH_MESG, "Compiled against library: libvir %d.%d.%d\n",
             major, minor, rel);

    ret = virGetVersion(&libVersion, hvType, &apiVersion);
    if (ret < 0) {
        vshError(ctl, FALSE, "failed to get the library version");
        return FALSE;
    }
    major = libVersion / 1000000;
    libVersion %= 1000000;
    minor = libVersion / 1000;
    rel = libVersion % 1000;
    vshPrint(ctl, VSH_MESG, "Using library: libvir %d.%d.%d\n",
             major, minor, rel);
    
    major = apiVersion / 1000000;
    apiVersion %= 1000000;
    minor = apiVersion / 1000;
    rel = apiVersion % 1000;
    vshPrint(ctl, VSH_MESG, "Using API: %s %d.%d.%d\n", hvType,
             major, minor, rel);

    ret =  virConnectGetVersion(ctl->conn, &hvVersion);
    if (ret < 0) {
        vshError(ctl, FALSE, "failed to get the hypervisor version");
823 824 825 826
        return FALSE;
    }
    if (hvVersion == 0) {
        vshPrint(ctl, VSH_MESG,
K
Karel Zak 已提交
827
                 "cannot extract running %s hypervisor version\n",
828 829
                 hvType);
    } else {
830
        major = hvVersion / 1000000;
831
        hvVersion %= 1000000;
832 833
        minor = hvVersion / 1000;
        rel = hvVersion % 1000;
834 835 836 837 838 839 840

        vshPrint(ctl, VSH_MESG, "Running hypervisor: %s %d.%d.%d\n", hvType,
                 major, minor, rel);
    }
    return TRUE;
}

K
Karel Zak 已提交
841 842 843 844 845 846 847 848 849 850
/*
 * "quit" command
 */
static vshCmdInfo info_quit[] = {
    { "syntax",   "quit" },
    { "help",     "quit this interactive terminal" },
    { NULL, NULL }
};

static int
851
cmdQuit(vshControl *ctl, vshCmd *cmd ATTRIBUTE_UNUSED) {
K
Karel Zak 已提交
852 853 854 855 856 857 858 859 860 861
    ctl->imode = FALSE;
    return TRUE;
}

/*
 * Commands
 */
static vshCmdDef commands[] = {
    { "connect",    cmdConnect,    opts_connect,   info_connect },
    { "dinfo",      cmdDinfo,      opts_dinfo,     info_dinfo },
862
    { "dumpxml",    cmdDumpXML,    opts_dumpxml,   info_dumpxml },
K
Karel Zak 已提交
863
    { "dstate",     cmdDstate,     opts_dstate,    info_dstate },
864 865
    { "suspend",    cmdSuspend,    opts_suspend,   info_suspend },
    { "resume",     cmdResume,     opts_resume,    info_resume },
866 867
    { "save",       cmdSave,       opts_save,      info_save },
    { "restore",    cmdRestore,    opts_restore,   info_restore },
868
    { "shutdown",   cmdShutdown,   opts_shutdown,  info_shutdown },
869
    { "destroy",    cmdDestroy,    opts_destroy,   info_destroy },
K
Karel Zak 已提交
870 871 872 873
    { "help",       cmdHelp,       opts_help,      info_help },
    { "idof",       cmdIdof,       opts_idof,      info_idof },
    { "list",       cmdList,       NULL,           info_list },
    { "nameof",     cmdNameof,     opts_nameof,    info_nameof },
874
    { "version",    cmdVersion,    NULL,           info_version },
K
Karel Zak 已提交
875 876 877 878 879 880 881 882
    { "quit",       cmdQuit,       NULL,           info_quit },
    { NULL, NULL, NULL, NULL }
};

/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
883 884
static const char *
vshCmddefGetInfo(vshCmdDef *cmd, const char *name) {
K
Karel Zak 已提交
885 886 887 888 889 890 891 892 893 894
    vshCmdInfo *info;
    
    for (info = cmd->info; info && info->name; info++) {
        if (strcmp(info->name, name)==0)
            return info->data;
    }
    return NULL;
}

static vshCmdOptDef *
K
Karel Zak 已提交
895
vshCmddefGetOption(vshCmdDef *cmd, const char *name) {
K
Karel Zak 已提交
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
    vshCmdOptDef *opt;
    
    for (opt = cmd->opts; opt && opt->name; opt++)
        if (strcmp(opt->name, name)==0)
            return opt;
    return NULL;
}

static vshCmdOptDef *
vshCmddefGetData(vshCmdDef *cmd) {
    vshCmdOptDef *opt;

    for (opt = cmd->opts; opt && opt->name; opt++)
        if (opt->type==VSH_OT_DATA)
            return opt;
    return NULL;
}

static vshCmdDef *
K
Karel Zak 已提交
915
vshCmddefSearch(const char *cmdname) {
K
Karel Zak 已提交
916 917 918 919 920 921 922 923 924
    vshCmdDef *c;
    
    for (c = commands; c->name; c++)
        if (strcmp(c->name, cmdname)==0)
            return c;
    return NULL;
}

static int
K
Karel Zak 已提交
925
vshCmddefHelp(vshControl *ctl, const char *cmdname, int withprog) {
K
Karel Zak 已提交
926 927 928 929 930 931 932
    vshCmdDef *def = vshCmddefSearch(cmdname);
    
    if (!def) {
         vshError(ctl, FALSE, "command '%s' doesn't exist", cmdname);
         return FALSE;
    } else {    
        vshCmdOptDef *opt;
K
Karel Zak 已提交
933 934 935
        const char *desc = vshCmddefGetInfo(def, "desc");
        const char *help = vshCmddefGetInfo(def, "help");
        const char *syntax = vshCmddefGetInfo(def, "syntax");
K
Karel Zak 已提交
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008

        fputs("  NAME\n", stdout);
        fprintf(stdout, "    %s - %s\n", def->name,  help);
        
        if (syntax) {
            fputs("\n  SYNOPSIS\n", stdout);
            if (!withprog)
                fprintf(stdout, "    %s\n", syntax);
            else
                fprintf(stdout, "    %s %s\n", progname, syntax);
        }
        if (desc) {
            fputs("\n  DESCRIPTION\n", stdout);
            fprintf(stdout, "    %s\n", desc);
        }
        if (def->opts) {
            fputs("\n  OPTIONS\n", stdout);
            for (opt=def->opts; opt->name; opt++) {
                char buf[256];
                
                if (opt->type==VSH_OT_BOOL)
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
                else if (opt->type==VSH_OT_INT)
                    snprintf(buf, sizeof(buf), "--%s <number>", opt->name);
                else if (opt->type==VSH_OT_STRING)
                    snprintf(buf, sizeof(buf), "--%s <string>", opt->name);
                else if (opt->type==VSH_OT_DATA)
                    snprintf(buf, sizeof(buf), "<%s>", opt->name);
                
                fprintf(stdout, "    %-15s  %s\n", buf, opt->help);
            }    
        }
        fputc('\n', stdout);
    }
    return TRUE;
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
static void     
vshCommandOptFree(vshCmdOpt *arg) {
    vshCmdOpt *a = arg;

    while(a) {
        vshCmdOpt *tmp = a;
        a = a->next;

        if (tmp->data)
            free(tmp->data);
        free(tmp);
    }
}

static void
vshCommandFree(vshCmd *cmd) {
    vshCmd *c = cmd;

    while(c) {
        vshCmd *tmp = c;
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
        free(tmp);
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
K
Karel Zak 已提交
1009
vshCommandOpt(vshCmd *cmd, const char *name) {
K
Karel Zak 已提交
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
    vshCmdOpt *opt = cmd->opts;
    
    while(opt) {
        if (opt->def && strcmp(opt->def->name, name)==0)
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
 * Returns option as INT
 */
static int
K
Karel Zak 已提交
1024
vshCommandOptInt(vshCmd *cmd, const char *name, int *found) {
K
Karel Zak 已提交
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
    int res = 0;
    
    if (arg)
        res = atoi(arg->data);
    if (found)
        *found = arg ? TRUE : FALSE;
    return res;
}

/*
 * Returns option as STRING
 */
static char *
K
Karel Zak 已提交
1039
vshCommandOptString(vshCmd *cmd, const char *name, int *found) {
K
Karel Zak 已提交
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
    if (found)
        *found = arg ? TRUE : FALSE;
    return arg ? arg->data : NULL;
}

/*
 * Returns TRUE/FALSE if the option exists
 */
static int
K
Karel Zak 已提交
1050
vshCommandOptBool(vshCmd *cmd, const char *name) {
K
Karel Zak 已提交
1051 1052 1053
    return vshCommandOpt(cmd, name) ? TRUE : FALSE;
}

K
Karel Zak 已提交
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
static virDomainPtr
vshCommandOptDomain(vshControl *ctl, vshCmd *cmd, const char *optname, char **name) {
    virDomainPtr dom = NULL;
    char *n, *end = NULL;
    int id;
    
    if (!(n = vshCommandOptString(cmd, optname, NULL))) {
        vshError(ctl, FALSE, "undefined domain name or id");
        return NULL; 
    }
    
    if (name)
        *name = n;
    
    /* try it by ID */
    id = (int) strtol(n, &end, 10);
    if (id >= 0 && end && *end=='\0')
        dom = virDomainLookupByID(ctl->conn, id);
    
    /* try it by NAME */
    if (!dom)
        dom = virDomainLookupByName(ctl->conn, n);

    if (!dom) 
        vshError(ctl, FALSE, "failed to get domain '%s'", n);
        
    return dom;
}

K
Karel Zak 已提交
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
/*
 * Executes command(s) and returns return code from last command
 */
static int
vshCommandRun(vshControl *ctl, vshCmd *cmd) {
    int ret = TRUE;
    
    while(cmd) {
        struct timeval before, after;
        
        if (ctl->timing)
            GETTIMEOFDAY(&before);
        
        ret = cmd->def->handler(ctl, cmd);

        if (ctl->timing)
            GETTIMEOFDAY(&after);
        
        if (strcmp(cmd->def->name, "quit")==0) /* hack ... */
            return ret;

        if (ctl->timing)
            vshPrint(ctl, VSH_MESG, "\n(Time: %.3f ms)\n\n", DIFF_MSEC(&after, &before));
        else     
            vshPrint(ctl, VSH_FOOTER, "\n");
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
 * Command string parsing
 * ---------------
 */
#define VSH_TK_ERROR    -1
#define VSH_TK_NONE    0
#define VSH_TK_OPTION    1
#define VSH_TK_DATA    2
#define VSH_TK_END    3

static int 
vshCommandGetToken(vshControl *ctl, char *str, char **end, char **res) {
    int tk = VSH_TK_NONE;
    int quote = FALSE;
    int sz = 0;
    char *p = str;
    char *tkstr = NULL;
    
    *end = NULL;
    
    while(p && *p && isblank((unsigned char) *p)) 
        p++;
1135
    
K
Karel Zak 已提交
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
    if (p==NULL || *p=='\0')
        return VSH_TK_END;
     if (*p==';') {
        *end = ++p;        /* = \0 or begi of next command */
        return VSH_TK_END;
    }
    while(*p) {
        /* end of token is blank space or ';' */
        if ((quote==FALSE && isblank((unsigned char) *p)) || *p==';')
            break;

        if (tk==VSH_TK_NONE) {
            if (*p=='-' && *(p+1)=='-' && *(p+2) && isalnum((unsigned char) *(p+2))) {
                tk = VSH_TK_OPTION;
                p+=2;
            } else {
                tk = VSH_TK_DATA;
                if (*p=='"') {
                           quote = TRUE;
                    p++;
                } else {
                    quote = FALSE;
                }
            }
            tkstr = p;    /* begin of token */
        } else if (quote && *p=='"') {
            quote = FALSE;
            p++;
            break;        /* end of "..." token */
        }
        p++;
        sz++;
    }
    if (quote) {
        vshError(ctl, FALSE, "missing \"");
        return VSH_TK_ERROR;
    }
    if (tkstr==NULL || *tkstr=='\0' || p==NULL)
        return VSH_TK_END;
    if (sz==0)
        return VSH_TK_END;
    
    *res = malloc(sz+1);
    memcpy(*res, tkstr, sz);
    *(*res+sz) = '\0';

    *end = p;
    return tk;
}

static int
vshCommandParse(vshControl *ctl, char *cmdstr) {
    char *str;
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
    
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
    
    if (cmdstr==NULL || *cmdstr=='\0')
        return FALSE;
    
    str = cmdstr;
    while(str && *str) 
    {
        vshCmdOpt *last = NULL;
        vshCmdDef *cmd = NULL;
        int tk = VSH_TK_NONE;
        
        first = NULL;
        
        while (tk!=VSH_TK_END) {
            char *end = NULL;
            vshCmdOptDef *opt = NULL;
    
            tkdata = NULL;
            
            /* get token */
            tk = vshCommandGetToken(ctl, str, &end, &tkdata);
            
            str = end;
            
            if (tk==VSH_TK_END)
                break;
            if (tk==VSH_TK_ERROR)
                goto syntaxError;
            
            if (cmd==NULL) {
                /* first token must be command name */
                if (tk!=VSH_TK_DATA) {
                    vshError(ctl, FALSE, 
                        "unexpected token (command name): '%s'", 
                        tkdata);
                    goto syntaxError;
                }
                if (!(cmd = vshCmddefSearch(tkdata))) {
                    vshError(ctl, FALSE,
                        "unknown command: '%s'", tkdata);
                    goto syntaxError;  /* ... or ignore this command only? */
                }
                free(tkdata);
            } else if (tk==VSH_TK_OPTION) {
                if (!(opt = vshCmddefGetOption(cmd, tkdata))) {
                    vshError(ctl, FALSE,
                        "command '%s' doesn't support option --%s",
                        cmd->name, tkdata);
                    goto syntaxError;
                }
                free(tkdata);        /* option name */
                tkdata = NULL;

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
                    tk = vshCommandGetToken(ctl, str, &end, &tkdata);
                    str = end;    
                    if (tk==VSH_TK_ERROR)
                        goto syntaxError;
                    if (tk!=VSH_TK_DATA) {
                        vshError(ctl, FALSE,
                            "expected syntax: --%s <%s>", 
                            opt->name, 
                            opt->type==VSH_OT_INT ? "number" : "string");
                        goto syntaxError;
                    }
                }
            } else if (tk==VSH_TK_DATA) {
                if (!(opt = vshCmddefGetData(cmd))) {
                    vshError(ctl, FALSE,
                        "unexpected data '%s'",
                               tkdata);
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
                vshCmdOpt *arg = malloc(sizeof(vshCmdOpt));
                
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
                
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
                
                vshPrint(ctl, VSH_DEBUG4, "%s: %s(%s): %s\n",
                    cmd->name,
                    opt->name,
                    tk==VSH_TK_OPTION ? "OPTION" : "DATA",
                    arg->data);
            }
            if (!str)
                break;
        }
        
        /* commad parsed -- allocate new struct for the command */
        if (cmd) {
            vshCmd *c = malloc(sizeof(vshCmd));    
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
    }
    
    return TRUE;

syntaxError:
    if (ctl->cmd)
        vshCommandFree(ctl->cmd);
    if (first)
        vshCommandOptFree(first);
    if (tkdata)
        free(tkdata);
    return FALSE;    
}


/* ---------------
 * Misc utils  
 * ---------------
 */
K
Karel Zak 已提交
1329
static const char *
K
Karel Zak 已提交
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
vshDomainStateToString(int state) {
    switch (state) {
        case VIR_DOMAIN_RUNNING:
                return "running ";
        case VIR_DOMAIN_BLOCKED:
            return "blocked ";
        case VIR_DOMAIN_PAUSED:
            return "paused ";
        case VIR_DOMAIN_SHUTDOWN:
            return "in shutdown";
        case VIR_DOMAIN_SHUTOFF:
            return "shut off";
        default:
            return "no state";    /* = dom0 state */
    }
    return NULL;
}

static int
vshConnectionUsability(vshControl *ctl, virConnectPtr conn, int showerror) {
    /* TODO: use something like virConnectionState() to 
     *       check usability of the connection 
     */
    if (!conn) {
        if (showerror)
            vshError(ctl, FALSE, "no valid connection.");
        return FALSE;
    }
    return TRUE;
}

static int
vshWantedDebug(vshOutType type, int mode) {
    switch(type) {
        case VSH_DEBUG5:
            if (mode < 5)
                return FALSE;
            return TRUE;
        case VSH_DEBUG4:
            if (mode < 4)
                return FALSE;
            return TRUE;
        case VSH_DEBUG3:
            if (mode < 3)
                return FALSE;
            return TRUE;
        case VSH_DEBUG2:
            if (mode < 2)
                return FALSE;
            return TRUE;
        case VSH_DEBUG1:
            if (mode < 1)
                return FALSE;
            return TRUE;
        default:
            /* it's right, all others types have to pass */
            return TRUE;
    }
    return FALSE;
}

static void
K
Karel Zak 已提交
1392
vshPrint(vshControl *ctl, vshOutType type, const char *format, ...) {
K
Karel Zak 已提交
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406
    va_list ap;
    
    if (ctl->quiet==TRUE && (type==VSH_HEADER || type==VSH_FOOTER))
        return;

    if (!vshWantedDebug(type, ctl->debug))
        return;
    
    va_start(ap, format);
    vfprintf(stderr, format, ap);
    va_end(ap);
}

static void
K
Karel Zak 已提交
1407
vshError(vshControl *ctl, int doexit, const char *format, ...) {
K
Karel Zak 已提交
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
    va_list ap;
    
    if (doexit)
        fprintf(stderr, "%s: error: ", progname);
    else
        fputs("error: ", stderr);
    
    va_start(ap, format);
    vfprintf(stderr, format, ap);
    va_end(ap);

    fputc('\n', stderr);
    
    if (doexit) {
        vshDeinit(ctl);
        exit(EXIT_FAILURE);
    }
}

/*
 * Initialize vistsh
 */
static int
vshInit(vshControl *ctl) {
    if (ctl->conn)
        return FALSE;

    ctl->uid = getuid();
    
    /* basic connection to hypervisor */
    if (ctl->uid == 0)
        ctl->conn = virConnectOpen(NULL);
    else
        ctl->conn = virConnectOpenReadOnly(NULL);
    
    if (!ctl->conn)
        vshError(ctl, TRUE, "failed to connect to the hypervisor");

    return TRUE;
}

/* -----------------
 * Readline stuff
 * -----------------
 */

/* 
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
 * (i.e. STATE == 0), then we start at the top of the list. 
 */
static char *
vshReadlineCommandGenerator(const char *text, int state) {
    static int list_index, len;
K
Karel Zak 已提交
1462
    const char *name;
K
Karel Zak 已提交
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475

    /* If this is a new word to complete, initialize now.  This
     * includes saving the length of TEXT for efficiency, and
     * initializing the index variable to 0. 
     */
    if (!state) {
        list_index = 0;
        len = strlen (text);
    }

    /* Return the next name which partially matches from the
     * command list. 
     */
K
Karel Zak 已提交
1476
    while ((name = commands[list_index].name)) {
K
Karel Zak 已提交
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
        list_index++;
        if (strncmp (name, text, len) == 0)
            return strdup(name);
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
vshReadlineOptionsGenerator(const char *text, int state) {
    static int list_index, len;
    static vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
1490
    const char *name;
K
Karel Zak 已提交
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

        cmdname = calloc((p - rl_line_buffer)+ 1, 1);
        memcpy(cmdname, rl_line_buffer, p-rl_line_buffer);

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
        len = strlen (text);
        free(cmdname);
    }

    if (!cmd)
        return NULL;
    
K
Karel Zak 已提交
1512
    while ((name = cmd->opts[list_index].name)) {
K
Karel Zak 已提交
1513 1514 1515 1516
        vshCmdOptDef *opt = &cmd->opts[list_index];
        char *res;
        list_index++;
       
K
Karel Zak 已提交
1517
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
            /* ignore non --option */
            continue;
        
        if (len > 2) {
            if (strncmp (name, text+2, len-2))
                continue;
        }
        res = malloc(strlen(name)+3);
        sprintf(res, "--%s", name);
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
1535
vshReadlineCompletion(const char *text, int start, int end ATTRIBUTE_UNUSED) {
K
Karel Zak 已提交
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548
    char **matches = (char **) NULL;

    if (start==0)
        /* command name generator */
        matches = rl_completion_matches (text, vshReadlineCommandGenerator);
    else
        /* commands options */
        matches = rl_completion_matches (text, vshReadlineOptionsGenerator);
    return matches;
}


static void
K
Karel Zak 已提交
1549
vshReadlineInit(void) {
K
Karel Zak 已提交
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
    /* Allow conditional parsing of the ~/.inputrc file. */
    rl_readline_name = "virsh";

    /* Tell the completer that we want a crack first. */
    rl_attempted_completion_function = vshReadlineCompletion;
}

/*
 * Deinitliaze virsh
 */
static int
vshDeinit(vshControl *ctl) {
    if (ctl->conn) {
        if (virConnectClose(ctl->conn)!=0) {
            ctl->conn = NULL; /* prevent recursive call from vshError() */
            vshError(ctl, TRUE, "failed to disconnect from the hypervisor");
        }
    }
    return TRUE;
}
    
/*
 * Print usage
 */
static void
K
Karel Zak 已提交
1575
vshUsage(vshControl *ctl, const char *cmdname) {
K
Karel Zak 已提交
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619
    vshCmdDef *cmd;
    
    /* global help */
    if (!cmdname) {
        fprintf(stdout, "\n%s [options] [commands]\n\n"
                "  options:\n"
                "    -d | --debug <num>      debug level [0-5]\n"
                "    -h | --help             this help\n"
                "    -q | --quiet            quiet mode\n"
                "    -t | --timing           print timing information\n"
                "    -v | --version          program version\n\n"
                "  commands (non interactive mode):\n", progname);
    
        for(cmd = commands; cmd->name; cmd++)
            fprintf(stdout, 
                "    %-15s %s\n", cmd->name, vshCmddefGetInfo(cmd, "help"));
        
        fprintf(stdout, "\n  (specify --help <command> for details about the command)\n\n");
        return;
    }
    if (!vshCmddefHelp(ctl, cmdname, TRUE))
        exit(EXIT_FAILURE);
}

/*
 * argv[]:  virsh [options] [command]
 *
 */
static int
vshParseArgv(vshControl *ctl, int argc, char **argv) {
    char *last = NULL;
    int i, end = 0, help = 0;
    int arg, idx=0;
    struct option opt[] = {
        { "debug",    1, 0, 'd' },
        { "help",     0, 0, 'h' },
        { "quiet",    0, 0, 'q' },
        { "timing",   0, 0, 't' },
        { "version",  0, 0, 'v' },
        {0, 0, 0, 0}
    };         

    
    if (argc < 2)
K
Karel Zak 已提交
1620
        return TRUE;
K
Karel Zak 已提交
1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
    
    /* look for begin of command, for example:
     *   ./virsh --debug 5 -q command --cmdoption
     *                  <--- ^ --->
     *        getopt() stuff | command suff
     */
    for(i=1; i < argc; i++) {
        if (*argv[i] != '-') {
            int valid = FALSE;
            
            /* non "--option" argv, is it command? */
            if (last) {
                struct option *o;
                int sz = strlen(last);
                
                for(o=opt; o->name; o++) {
                    if (sz==2 && *(last+1)==o->val)
                        /* valid virsh short option */
                        valid = TRUE;
                    else if (sz > 2 && strcmp(o->name, last+2)==0)
                        /* valid virsh long option */
                        valid = TRUE;
                }
            }
            if (!valid) {
                end = i;
                break;
            }
        }
        last = argv[i];
    }
    end = end ? : argc;
    
    /* standard (non-command) options */
    while((arg = getopt_long(end, argv, "d:hqtv", opt, &idx)) != -1) {
        switch(arg) {
            case 'd':
                ctl->debug = atoi(optarg);
                break;
            case 'h':
                help = 1;
                break;
            case 'q':
                ctl->quiet = TRUE;
                break;
            case 't':
                ctl->timing = TRUE;
                break;
            case 'v':
                fprintf(stdout, "%s\n", VERSION);
                exit(EXIT_SUCCESS);
            default:
                vshError(ctl, TRUE, "unsupported option '-%c'. See --help.", arg);
                break;
        }
    }

    if (help) {
        /* global or command specific help */
        vshUsage(ctl, argc > end ? argv[end] : NULL);
        exit(EXIT_SUCCESS);
    }    
    
    if (argc > end) {
        /* parse command */
        char *cmdstr;
K
Karel Zak 已提交
1687
        int sz=0, ret;
K
Karel Zak 已提交
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
        
        ctl->imode = FALSE;
        
        for (i=end; i < argc; i++)
            sz += strlen(argv[i]) + 1;     /* +1 is for blank space between items */

        cmdstr = calloc(sz+1, 1);
        
        for (i=end; i < argc; i++) {
            strncat(cmdstr, argv[i], sz);
            sz -= strlen(argv[i]);
            strncat(cmdstr, " ", sz--);
        }
        vshPrint(ctl, VSH_DEBUG2, "command: \"%s\"\n", cmdstr);
        ret = vshCommandParse(ctl, cmdstr);
        
        free(cmdstr);
        return ret;
    }
    return TRUE;
}

int 
main(int argc, char **argv) {
    vshControl _ctl, *ctl=&_ctl;
    int ret = TRUE;

    if (!(progname=strrchr(argv[0], '/')))
        progname = argv[0];
    else
        progname++;
    
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = TRUE;    /* default is interactive mode */

    if (!vshParseArgv(ctl, argc, argv))
        exit(EXIT_FAILURE);
        
    if (!vshInit(ctl))
        exit(EXIT_FAILURE);
    
    if (!ctl->imode) {
        ret = vshCommandRun(ctl, ctl->cmd);    
1731
    } else {
K
Karel Zak 已提交
1732 1733 1734 1735 1736 1737 1738
        /* interactive mode */
        if (!ctl->quiet) {
            vshPrint(ctl, VSH_MESG, "Welcome to %s, the virtualization interactive terminal.\n\n", 
                        progname);
            vshPrint(ctl, VSH_MESG, "Type:  'help' for help with commands\n"
                                    "       'quit' to quit\n\n");
        }
K
Karel Zak 已提交
1739
        vshReadlineInit();
K
Karel Zak 已提交
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758
        do {
            ctl->cmdstr = readline(ctl->uid==0 ? VSH_PROMPT_RW : VSH_PROMPT_RO);
            if (ctl->cmdstr==NULL)
                break;                /* EOF */
            if (*ctl->cmdstr) {
                add_history(ctl->cmdstr);
                if (vshCommandParse(ctl, ctl->cmdstr))
                    vshCommandRun(ctl, ctl->cmd);
            }
            free(ctl->cmdstr);
            ctl->cmdstr = NULL;
        } while(ctl->imode);    

        if (ctl->cmdstr==NULL)
            fputc('\n', stdout);    /* line break after alone prompt */
    }
    
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
1759
}
K
Karel Zak 已提交
1760 1761 1762 1763 1764 1765 1766

/*
 * vim: set tabstop=4:
 * vim: set shiftwidth=4:
 * vim: set expandtab:
 */