# (C) Copyright IBM Corp. 2005
# Copyright (C) 2004 Mike Wray
# Copyright (c) 2005-2006 XenSource Ltd.
#
# Authors:
#     Sean Dague <sean at dague dot net>
#     Mike Wray <mike dot wray at hp dot com>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of version 2.1 of the GNU Lesser General Public
# License as published by the Free Software Foundation.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

"""Grand unified management application for Xen.
"""
import atexit
import cmd
import os
import pprint
import shlex
import sys
import re
import getopt
import socket
import traceback
import xmlrpclib
import time
import datetime
from select import select
import xml.dom.minidom
from xen.util.blkif import blkdev_name_to_number
from xen.util import vscsi_util
from xen.util.pci import *
from xen.util import vusb_util

import warnings
warnings.filterwarnings('ignore', category=FutureWarning)

from xen.xend import PrettyPrint
from xen.xend import sxp
from xen.xend import XendClient
from xen.xend.XendConstants import *
from xen.xend.server.DevConstants import xenbusState

from xen.xm.opts import OptionError, Opts, wrap, set_true
from xen.xm import console
from xen.util.xmlrpcclient import ServerProxy
import xen.util.xsm.xsm as security
from xen.util.xsm.xsm import XSMError
from xen.util.acmpolicy import ACM_LABEL_UNLABELED_DISPLAY
from xen.util.sxputils import sxp2map, map2sxp as map_to_sxp
from xen.util import auxbin

import XenAPI

import inspect
from xen.xend import XendOptions
xoptions = XendOptions.instance()

import signal
signal.signal(signal.SIGINT, signal.SIG_DFL)

# getopt.gnu_getopt is better, but only exists in Python 2.3+.  Use
# getopt.getopt if gnu_getopt is not available.  This will mean that options
# may only be specified before positional arguments.
if not hasattr(getopt, 'gnu_getopt'):
    getopt.gnu_getopt = getopt.getopt

XM_CONFIG_FILE_ENVVAR = 'XM_CONFIG_FILE'
XM_CONFIG_FILE_DEFAULT = auxbin.xen_configdir() + '/xm-config.xml'

# Supported types of server
SERVER_LEGACY_XMLRPC = 'LegacyXMLRPC'
SERVER_XEN_API = 'Xen-API'

# General help message

USAGE_HELP = "Usage: xm <subcommand> [args]\n\n" \
             "Control, list, and manipulate Xen guest instances.\n"

USAGE_FOOTER = '<Domain> can either be the Domain Name or Id.\n' \
               'For more help on \'xm\' see the xm(1) man page.\n' \
               'For more help on \'xm create\' see the xmdomain.cfg(5) '\
               ' man page.\n'

# Help strings are indexed by subcommand name in this way:
# 'subcommand': (argstring, description)

SUBCOMMAND_HELP = {
    # common commands

    'shell'       : ('', 'Launch an interactive shell.'),
    
    'console'     : ('[-q|--quiet] <Domain>',
                     'Attach to <Domain>\'s console.'),
    'vncviewer'   : ('[--[vncviewer-]autopass] <Domain>',
                     'Attach to <Domain>\'s VNC server.'),
    'create'      : ('<ConfigFile> [options] [vars]',
                     'Create a domain based on <ConfigFile>.'),
    'destroy'     : ('<Domain>',
                     'Terminate a domain immediately.'),
    'help'        : ('', 'Display this message.'),
    'list'        : ('[options] [Domain, ...]',
                     'List information about all/some domains.'),
    'mem-max'     : ('<Domain> <Mem>',
                     'Set the maximum amount reservation for a domain.'),
    'mem-set'     : ('<Domain> <Mem>',
                     'Set the current memory usage for a domain.'),
    'migrate'     : ('<Domain> <Host>',
                     'Migrate a domain to another machine.'),
    'pause'       : ('<Domain>', 'Pause execution of a domain.'),
    'reboot'      : ('<Domain> [-wa]', 'Reboot a domain.'),
    'reset'       : ('<Domain>', 'Reset a domain.'),
    'restore'     : ('<CheckpointFile> [-p]',
                     'Restore a domain from a saved state.'),
    'save'        : ('[-c] <Domain> <CheckpointFile>',
                     'Save a domain state to restore later.'),
    'shutdown'    : ('<Domain> [-waRH]', 'Shutdown a domain.'),
    'top'         : ('', 'Monitor a host and the domains in real time.'),
    'unpause'     : ('<Domain>', 'Unpause a paused domain.'),
    'uptime'      : ('[-s] [Domain, ...]',
                     'Print uptime for all/some domains.'),

    # Life cycle xm commands
    'new'         : ('<ConfigFile> [options] [vars]',
                     'Adds a domain to Xend domain management'),
    'delete'      : ('<DomainName>',
                     'Remove a domain from Xend domain management.'),
    'start'       : ('<DomainName>', 'Start a Xend managed domain'),
    'resume'      : ('<DomainName>', 'Resume a Xend managed domain'),
    'suspend'     : ('<DomainName>', 'Suspend a Xend managed domain'),

    # less used commands

    'dmesg'       : ('[-c|--clear]',
                     'Read and/or clear Xend\'s message buffer.'),
    'domid'       : ('<DomainName>', 'Convert a domain name to domain id.'),
    'domname'     : ('<DomId>', 'Convert a domain id to domain name.'),
    'dump-core'   : ('[-L|--live] [-C|--crash] [-R|--reset] <Domain> [Filename]',
                     'Dump core for a specific domain.'),
    'info'        : ('[-c|--config] [-n|--numa]',
                     'Get information about Xen host.'),
    'log'         : ('', 'Print Xend log'),
    'rename'      : ('<Domain> <NewDomainName>', 'Rename a domain.'),
    'sched-sedf'  : ('<Domain> [options]', 'Get/set EDF parameters.'),
    'sched-credit': ('[-d <Domain> [-w[=WEIGHT]|-c[=CAP]]]',
                     'Get/set credit scheduler parameters.'),
    'sched-credit2': ('[-d <Domain> [-w[=WEIGHT]]',
                     'Get/set credit2 scheduler parameters.'),
    'sysrq'       : ('<Domain> <letter>', 'Send a sysrq to a domain.'),
    'debug-keys'  : ('<Keys>', 'Send debug keys to Xen.'),
    'trigger'     : ('<Domain> <nmi|reset|init|s3resume|power> [<VCPU>]',
                     'Send a trigger to a domain.'),
    'vcpu-list'   : ('[Domain, ...]',
                     'List the VCPUs for all/some domains.'),
    'vcpu-pin'    : ('<Domain> <VCPU|all> <CPUs|all>',
                     'Set which CPUs a VCPU can use.'),
    'vcpu-set'    : ('<Domain> <vCPUs>',
                     'Set the number of active VCPUs for allowed for the'
                     ' domain.'),
    #usb
    'usb-add'     : ('<domain> <[host:bus.addr] [host:vendor_id:product_id]>','Add the usb device to FV VM.'),
    'usb-del'     : ('<domain> <[host:bus.addr] [host:vendor_id:product_id]>','Delete the usb device to FV VM.'),
    #domstate
    'domstate'  : ('<domain> ', 'get the state of a domain'),

    # device commands

    'block-attach'  :  ('<Domain> <BackDev> <FrontDev> <Mode> [BackDomain]',
                        'Create a new virtual block device.'),
    'block-configure': ('<Domain> <BackDev> <FrontDev> <Mode> [BackDomain]',
                        'Change block device configuration'),
    'block-detach'  :  ('<Domain> <DevId> [-f|--force]',
                        'Destroy a domain\'s virtual block device.'),
    'block-list'    :  ('<Domain> [--long]',
                        'List virtual block devices for a domain.'),
    'network-attach':  ('<Domain> [type=<type>] [mac=<mac>] [bridge=<bridge>] '
                        '[ip=<ip>] [script=<script>] [backend=<BackDomain>] '
                        '[vifname=<name>] [rate=<rate>] [model=<model>]'
                        '[accel=<accel>]',
                        'Create a new virtual network device.'),
    'network-detach':  ('<Domain> <DevId|mac> [-f|--force]',
                        'Destroy a domain\'s virtual network device.'),
    'network-list'  :  ('<Domain> [--long]',
                        'List virtual network interfaces for a domain.'),
    'network2-attach': ('<Domain> [front_mac=<mac>] [back_mac=<mac>] '
                        '[backend=<BackDomain>] [trusted=<0|1>] '
                        '[back_trusted=<0|1>] [bridge=<bridge>] '
                        '[filter_mac=<0|1>] [front_filter_mac=<0|1>] '
                        '[pdev=<PDEV>] [max_bypasses=n]',
                        'Create a new version 2 virtual network device.'),
    'network2-detach': ('<Domain> <DevId> [-f|--force]',
                         'Destroy a domain\'s version 2 virtual network device.'),
    'network2-list'  : ('<Domain> [--long]',
                        'List version 2 virtual network interfaces for a domain.'),
    'vnet-create'   :  ('<ConfigFile>','Create a vnet from ConfigFile.'),
    'vnet-delete'   :  ('<VnetId>', 'Delete a Vnet.'),
    'vnet-list'     :  ('[-l|--long]', 'List Vnets.'),
    'vtpm-list'     :  ('<Domain> [--long]', 'List virtual TPM devices.'),
    'pci-attach'    :  ('[-o|--options=<opt>] <Domain> <domain:bus:slot.func> [virtual slot]',
                        'Insert a new pass-through pci device.'),
    'pci-detach'    :  ('<Domain> <domain:bus:slot.func>',
                        'Remove a domain\'s pass-through pci device.'),
    'pci-list'      :  ('<Domain>',
                        'List pass-through pci devices for a domain.'),
    'pci-list-assignable-devices' : ('', 'List all the assignable pci devices'),
    'scsi-attach'  :  ('<Domain> <PhysDevice> <VirtDevice> [BackDomain]',
                        'Attach a new SCSI device.'),
    'scsi-detach'  :  ('<Domain> <VirtDevice>',
                        'Detach a specified SCSI device.'),
    'scsi-list'    :  ('<Domain> [--long]',
                        'List all SCSI devices currently attached.'),
    'usb-attach'  :  ('<Domain> <DevId> <PortNumber> <BusId>',
                        'Attach a new USB physical bus to domain\'s virtual port.'),
    'usb-detach'  :  ('<Domain> <DevId> <PortNumber>',
                        'Detach a USB physical bus from domain\'s virtual port.'),
    'usb-list'    :  ('<Domain>',
                        'List domain\'s attachment state of all virtual port .'),
    'usb-list-assignable-devices' : ('', 'List all the assignable usb devices'),
    'usb-hc-create'  :  ('<Domain> <USBSpecVer> <NumberOfPorts>',
                        'Create a domain\'s new virtual USB host controller.'),
    'usb-hc-destroy'  :  ('<Domain> <DevId>',
                        'Destroy a domain\'s virtual USB host controller.'),

    # tmem
    'tmem-list'     :  ('[-l|--long] [<Domain>|-a|--all]', 'List tmem pools.'),
    'tmem-thaw'     :  ('[<Domain>|-a|--all]', 'Thaw tmem pools.'),
    'tmem-freeze'   :  ('[<Domain>|-a|--all]', 'Freeze tmem pools.'),
    'tmem-destroy'  :  ('[<Domain>|-a|--all]', 'Destroy tmem pools.'),
    'tmem-set'      :  ('[<Domain>|-a|--all] [weight=<weight>] [cap=<cap>] '
                        '[compress=<compress>]',
                        'Change tmem settings.'),
    'tmem-freeable'  :  ('', 'Print freeable tmem (in MiB).'),
    'tmem-shared-auth' :  ('[<Domain>|-a|--all] [--uuid=<uuid>] [--auth=<0|1>]', 'De/authenticate shared tmem pool.'),

    #
    # cpupool commands
    #
    'cpupool-create'   :  ('<ConfigFile> [vars]',
                        'Create a CPU pool based an ConfigFile.'),
    'cpupool-new'      :  ('<ConfigFile> [vars]',
                        'Adds a CPU pool to Xend CPU pool management'),
    'cpupool-start'    :  ('<CPU Pool>', 'Starts a Xend CPU pool'),
    'cpupool-list'     :  ('[<CPU Pool>] [-l|--long] [-c|--cpus]', 'List CPU pools on host'),
    'cpupool-destroy'  :  ('<CPU Pool>', 'Deactivates a CPU pool'),
    'cpupool-delete'   :  ('<CPU Pool>',
                        'Removes a CPU pool from Xend management'),
    'cpupool-cpu-add'  :  ('<CPU Pool> <CPU nr>', 'Adds a CPU to a CPU pool'),
    'cpupool-cpu-remove': ('<CPU Pool> <CPU nr>', 'Removes a CPU from a CPU pool'),
    'cpupool-migrate'  :  ('<Domain> <CPU Pool>',
                        'Moves a domain into a CPU pool'),

    # security

    'addlabel'      :  ('<label> {dom <ConfigFile>|res <resource>|mgt <managed domain>} [<policy>]',
                        'Add security label to domain.'),
    'rmlabel'       :  ('{dom <ConfigFile>|res <Resource>|mgt<managed domain>}',
                        'Remove a security label from domain.'),
    'getlabel'      :  ('{dom <ConfigFile>|res <Resource>|mgt <managed domain>}',
                        'Show security label for domain or resource.'),
    'dry-run'       :  ('<ConfigFile>',
                        'Test if a domain can access its resources.'),
    'resources'     :  ('', 'Show info for each labeled resource.'),
    'dumppolicy'    :  ('', 'Print hypervisor ACM state information.'),
    'setpolicy'     :  ('<policytype> <policyfile> [options]',
                        'Set the policy of the system.'),
    'resetpolicy'   :  ('',
                        'Set the policy of the system to the default policy.'),
    'getpolicy'     :  ('[options]', 'Get the policy of the system.'),
    'labels'        :  ('[policy] [type=dom|res|any]',
                        'List <type> labels for (active) policy.'),
    'serve'         :  ('', 'Proxy Xend XMLRPC over stdio.'),
    'getenforce'    :  ('', 'Returns the current enforcing mode for the Flask XSM module (Enforcing,Permissive)'),
    'setenforce'    :  ('[ (Enforcing|1) | (Permissive|0) ]',
                        'Modifies the current enforcing mode for the Flask XSM module'),
}

SUBCOMMAND_OPTIONS = {
    'sched-sedf': (
       ('-p [MS]', '--period[=MS]', 'Relative deadline(ms)'),
       ('-s [MS]', '--slice[=MS]' ,
        'Worst-case execution time(ms). (slice < period)'),
       ('-l [MS]', '--latency[=MS]',
        'Scaled period (ms) when domain performs heavy I/O'),
       ('-e [FLAG]', '--extra[=FLAG]',
        'Flag (0 or 1) controls if domain can run in extra time.'),
       ('-w [FLOAT]', '--weight[=FLOAT]',
        'CPU Period/slice (do not set with --period/--slice)'),
    ),
    'sched-credit': (
       ('-d DOMAIN', '--domain=DOMAIN', 'Domain to modify'),
       ('-w WEIGHT', '--weight=WEIGHT', 'Weight (int)'),
       ('-c CAP',    '--cap=CAP',       'Cap (int)'),
    ),
    'sched-credit2': (
       ('-d DOMAIN', '--domain=DOMAIN', 'Domain to modify'),
       ('-w WEIGHT', '--weight=WEIGHT', 'Weight (int)'),
    ),
    'list': (
       ('-l', '--long',         'Output all VM details in SXP'),
       ('', '--label',          'Include security labels'),
       ('', '--state=<state>',  'Select only VMs with the specified state'),
       ('', '--pool=<pool>',    'Select only VMs in specified cpu pool'),
    ),
    'console': (
       ('-q', '--quiet', 'Do not print an error message if the domain does not exist'),
    ),
    'vncviewer': (
       ('', '--autopass', 'Pass VNC password to viewer via stdin and -autopass'),
       ('', '--vncviewer-autopass', '(consistency alias for --autopass)'),
    ),
    'dmesg': (
       ('-c', '--clear', 'Clear dmesg buffer as well as printing it'),
    ),
    'vnet-list': (
       ('-l', '--long', 'List Vnets as SXP'),
    ),
    'network-list': (
       ('-l', '--long', 'List resources as SXP'),
    ),
    'dump-core': (
       ('-L', '--live', 'Dump core without pausing the domain'),
       ('-C', '--crash', 'Crash domain after dumping core'),
       ('-R', '--reset', 'Reset domain after dumping core'),
    ),
    'start': (
       ('-p', '--paused', 'Do not unpause domain after starting it'),
       ('-c', '--console_autoconnect', 'Connect to the console after the domain is created'),
       ('', '--vncviewer', 'Connect to display via VNC after the domain is created'),
       ('', '--vncviewer-autopass', 'Pass VNC password to viewer via stdin and -autopass'),
    ),
    'resume': (
       ('-p', '--paused', 'Do not unpause domain after resuming it'),
    ),
    'save': (
       ('-c', '--checkpoint', 'Leave domain running after creating snapshot'),
    ),
    'restore': (
       ('-p', '--paused', 'Do not unpause domain after restoring it'),
    ),
    'info': (
       ('-c', '--config', 'List Xend configuration parameters'),
       ('-n', '--numa', 'List host NUMA topology information'),
    ),
    'tmem-list': (
       ('-l', '--long', 'List tmem stats.'),
    ),
    'tmem-thaw': (
       ('-a', '--all', 'Thaw all tmem.'),
    ),
    'tmem-freeze':  (
       ('-a', '--all', 'Freeze all tmem.'),
    ),
    'tmem-destroy':  (
       ('-a', '--all', 'Destroy all tmem.'),
    ),
    'tmem-set':  (
       ('-a', '--all', 'Operate on all tmem.'),
    ),
    'tmem-shared-auth':  (
       ('-a', '--all', 'Authenticate for all tmem pools.'),
       ('-u', '--uuid', 'Specify uuid (abcdef01-2345-6789-01234567890abcdef).'),
       ('-A', '--auth', '0=auth,1=deauth'),
    ),
    'cpupool-list': (
       ('-l', '--long', 'Output all CPU pool details in SXP format'),
       ('-c', '--cpus', 'Output list of CPUs used by a pool'),
    ),
}

common_commands = [
    "console",
    "vncviewer",
    "create",
    "new",
    "delete",
    "destroy",
    "dump-core",
    "help",
    "list",
    "mem-set",
    "migrate",
    "pause",
    "reboot",
    "reset",
    "restore",
    "resume",
    "save",
    "shell",
    "shutdown",
    "start",
    "suspend",
    "top",
    "unpause",
    "uptime",
    "usb-add",
    "usb-del",
    "domstate",
    "vcpu-set",
    ]

domain_commands = [
    "console",
    "vncviewer",
    "create",
    "new",
    "delete",
    "destroy",
    "domid",
    "domname",
    "dump-core",
    "list",
    "mem-max",
    "mem-set",
    "migrate",
    "pause",
    "reboot",
    "rename",
    "reset",
    "restore",
    "resume",
    "save",
    "shutdown",
    "start",
    "suspend",
    "sysrq",
    "trigger",
    "top",
    "unpause",
    "uptime",
    "usb-add",
    "usb-del",
    "domstate",
    "vcpu-list",
    "vcpu-pin",
    "vcpu-set",
    ]

host_commands = [
    "debug-keys",
    "dmesg",
    "info",
    "log",
    "serve",
    ]

scheduler_commands = [
    "sched-credit2",
    "sched-credit",
    "sched-sedf",
    ]

device_commands = [
    "block-attach",
    "block-detach",
    "block-list",
    "block-configure",
    "network-attach",
    "network-detach",
    "network-list",
    "network2-attach",
    "network2-detach",
    "network2-list",
    "vtpm-list",
    "pci-attach",
    "pci-detach",
    "pci-list",
    "pci-list-assignable-devices",
    "scsi-attach",
    "scsi-detach",
    "scsi-list",
    "usb-attach",
    "usb-detach",
    "usb-list",
    "usb-list-assignable-devices",
    "usb-hc-create",
    "usb-hc-destroy",
    ]

vnet_commands = [
    "vnet-list",
    "vnet-create",
    "vnet-delete",
    ]

security_commands = [
    "setpolicy",
    ]

acm_commands = [
    "labels",
    "addlabel",
    "rmlabel",
    "getlabel",
    "dry-run",
    "resources",
    "dumppolicy",
    "resetpolicy",
    "getpolicy",
    ]

flask_commands = [
    "getenforce",
    "setenforce",
    ]

tmem_commands = [
    "tmem-list",
    "tmem-thaw",
    "tmem-freeze",
    "tmem-destroy",
    "tmem-set",
    "tmem-shared-auth",
    ]

cpupool_commands = [
    "cpupool-create",
    "cpupool-new",
    "cpupool-start",
    "cpupool-list",
    "cpupool-destroy",
    "cpupool-delete",
    "cpupool-cpu-add",
    "cpupool-cpu-remove",
    "cpupool-migrate",
    ]

all_commands = (domain_commands + host_commands + scheduler_commands +
                device_commands + vnet_commands + security_commands +
                acm_commands + flask_commands + tmem_commands + cpupool_commands +
                ['shell', 'event-monitor'])


##
# Configuration File Parsing
##

xmConfigFile = os.getenv(XM_CONFIG_FILE_ENVVAR, XM_CONFIG_FILE_DEFAULT)
config = None
if os.path.isfile(xmConfigFile):
    try:
        config = xml.dom.minidom.parse(xmConfigFile)
    except:
        print >>sys.stderr, ('Ignoring invalid configuration file %s.' %
                             xmConfigFile)

def parseServer():
    if config:
        server = config.getElementsByTagName('server')
        if server:
            st = server[0].getAttribute('type')
            if st != SERVER_XEN_API and st != SERVER_LEGACY_XMLRPC:
                print >>sys.stderr, ('Invalid server type %s; using %s.' %
                                     (st, SERVER_LEGACY_XMLRPC))
                st = SERVER_LEGACY_XMLRPC
            return (st, server[0].getAttribute('uri'))

    return SERVER_LEGACY_XMLRPC, XendClient.uri

def parseAuthentication():
    server = config.getElementsByTagName('server')[0]
    return (server.getAttribute('username'),
            server.getAttribute('password'))

serverType, serverURI = parseServer()
server = None


####################################################################
#
#  Help/usage printing functions
#
####################################################################

def cmdHelp(cmd):
    """Print help for a specific subcommand."""
    
    if not SUBCOMMAND_HELP.has_key(cmd):
        for fc in SUBCOMMAND_HELP.keys():
            if fc[:len(cmd)] == cmd:
                cmd = fc
                break
    
    try:
        args, desc = SUBCOMMAND_HELP[cmd]
    except KeyError:
        shortHelp()
        return
    
    print 'Usage: xm %s %s' % (cmd, args)
    print
    print desc
    
    try:
        # If options help message is defined, print this.
        for shortopt, longopt, desc in SUBCOMMAND_OPTIONS[cmd]:
            if shortopt and longopt:
                optdesc = '%s, %s' % (shortopt, longopt)
            elif shortopt:
                optdesc = shortopt
            elif longopt:
                optdesc = longopt

            wrapped_desc = wrap(desc, 43)   
            print '  %-30s %-43s' % (optdesc, wrapped_desc[0])
            for line in wrapped_desc[1:]:
                print ' ' * 33 + line
        print
    except KeyError:
        # if the command is an external module, we grab usage help
        # from the module itself.
        if cmd in IMPORTED_COMMANDS:
            try:
                cmd_module =  __import__(cmd, globals(), locals(), 'xen.xm')
                cmd_usage = getattr(cmd_module, "help", None)
                if cmd_usage:
                    print cmd_usage()
            except ImportError:
                pass
        
def shortHelp():
    """Print out generic help when xm is called without subcommand."""
    
    print USAGE_HELP
    print 'Common \'xm\' commands:\n'
    
    for command in common_commands:
        try:
            args, desc = SUBCOMMAND_HELP[command]
        except KeyError:
            continue
        wrapped_desc = wrap(desc, 50)
        print ' %-20s %-50s' % (command, wrapped_desc[0])
        for line in wrapped_desc[1:]:
            print ' ' * 22 + line

    print
    print USAGE_FOOTER
    print 'For a complete list of subcommands run \'xm help\'.'
    
def longHelp():
    """Print out full help when xm is called with xm --help or xm help"""
    
    print USAGE_HELP
    print 'xm full list of subcommands:\n'
    
    for command in all_commands:
        try:
            args, desc = SUBCOMMAND_HELP[command]
        except KeyError:
            continue

        wrapped_desc = wrap(desc, 50)
        print ' %-20s %-50s' % (command, wrapped_desc[0])
        for line in wrapped_desc[1:]:
            print ' ' * 22 + line        

    print
    print USAGE_FOOTER        

def _usage(cmd):
    """ Print help usage information """
    if cmd:
        cmdHelp(cmd)
    else:
        shortHelp()

def usage(cmd = None):
    """ Print help usage information and exits """
    _usage(cmd)
    sys.exit(1)


####################################################################
#
#  Utility functions
#
####################################################################

def get_default_SR():
    return [sr_ref
            for sr_ref in server.xenapi.SR.get_all()
            if server.xenapi.SR.get_type(sr_ref) == "local"][0]

def get_default_Network():
    return [network_ref
            for network_ref in server.xenapi.network.get_all()][0]

class XenAPIUnsupportedException(Exception):
    pass

def xenapi_unsupported():
    if serverType == SERVER_XEN_API:
        raise XenAPIUnsupportedException, "This function is not supported by Xen-API"

def xenapi_only():
    if serverType != SERVER_XEN_API:
        raise XenAPIUnsupportedException, "This function is only supported by Xen-API"

def map2sxp(m):
    return [[k, m[k]] for k in m.keys()]

def arg_check(args, name, lo, hi = -1):
    n = len([i for i in args if i != '--'])
    
    if hi == -1:
        if n != lo:
            err("'xm %s' requires %d argument%s.\n" % (name, lo,
                                                       lo == 1 and '' or 's'))
            usage(name)
    else:
        if n < lo or n > hi:
            err("'xm %s' requires between %d and %d arguments.\n" %
                (name, lo, hi))
            usage(name)


def unit(c):
    if not c.isalpha():
        return 0
    base = 1
    if c == 'G' or c == 'g': base = 1024 * 1024 * 1024
    elif c == 'M' or c == 'm': base = 1024 * 1024
    elif c == 'K' or c == 'k': base = 1024
    else:
        print 'ignoring unknown unit'
    return base

def int_unit(str, dest):
    base = unit(str[-1])
    if not base:
        return int(str)

    value = int(str[:-1])
    dst_base = unit(dest)
    if dst_base == 0:
        dst_base = 1
    if dst_base > base:
        return value / (dst_base / base)
    else:
        return value * (base / dst_base)

def err(msg):
    print >>sys.stderr, "Error:", msg


def get_single_vm(dom):
    if serverType == SERVER_XEN_API:
        uuids = server.xenapi.VM.get_by_name_label(dom)
        if len(uuids) > 0:
            return uuids[0]

        refs = []

        try:
            domid = int(dom)
            refs = [vm_ref
                    for vm_ref in server.xenapi.VM.get_all()
                    if int(server.xenapi.VM.get_domid(vm_ref)) == domid]
        except:
            pass
            
        if len(refs) > 0:
            return refs[0]

        raise OptionError("Domain '%s' not found." % dom)
    else:
        dominfo = server.xend.domain(dom, False)
        return dominfo['uuid']

##
#
# Xen-API Shell
#
##

class Shell(cmd.Cmd):
    def __init__(self):
        cmd.Cmd.__init__(self)
        self.prompt = "xm> "
        if serverType == SERVER_XEN_API:
            try:
                res = server.xenapi.host.list_methods()
                for f in res:
                    setattr(Shell, 'do_' + f + ' ', self.default)
            except:
                pass

    def preloop(self):
        cmd.Cmd.preloop(self)
        try:
            import readline
            readline.set_completer_delims(' ')
        except ImportError:
            pass

    def default(self, line):
        words = shlex.split(line)
        if len(words) > 0 and words[0] == 'xm':
            words = words[1:]
        if len(words) > 0:
            cmd = xm_lookup_cmd(words[0])
            if cmd:
                _run_cmd(cmd, words[0], words[1:])
            elif serverType == SERVER_XEN_API:
                ok, res = _run_cmd(lambda x: server.xenapi_request(words[0],
                                                                   tuple(x)),
                                   words[0], words[1:])
                if ok and res is not None and res != '':
                    pprint.pprint(res)
            else:
                print '*** Unknown command: %s' % words[0]
        return False

    def completedefault(self, text, line, begidx, endidx):
        words = shlex.split(line[:begidx])
        clas, func = words[0].split('.')
        if len(words) > 1 or \
           func.startswith('get_by_') or \
           func == 'get_all':
            return []
        uuids = server.xenapi_request('%s.get_all' % clas, ())
        return [u + " " for u in uuids if u.startswith(text)]

    def emptyline(self):
        pass

    def do_EOF(self, line):
        print
        sys.exit(0)

    def do_help(self, line):
        _usage(line)


def xm_shell(args):
    Shell().cmdloop('The Xen Master. Type "help" for a list of functions.')


def xm_event_monitor(args):
    if serverType == SERVER_XEN_API:
        while True:
            server.xenapi.event.register(args)
            events = server.xenapi.event.next()
            for e in events:
                print e
    else:
        err("Event monitoring not supported unless using Xen-API.")


#########################################################################
#
#  Main xm functions
#
#########################################################################

def xm_save(args):

    arg_check(args, "save", 2, 3)
    
    try:
        (options, params) = getopt.gnu_getopt(args, 'c', ['checkpoint'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('save')

    checkpoint = False
    for (k, v) in options:
        if k in ['-c', '--checkpoint']:
            checkpoint = True

    if len(params) != 2:
        err("Wrong number of parameters")
        usage('save')

    dom = params[0]
    savefile = os.path.abspath(params[1])

    if not os.access(os.path.dirname(savefile), os.W_OK):
        err("xm save: Unable to create file %s" % savefile)
        sys.exit(1)
        
    if serverType == SERVER_XEN_API:       
        server.xenapi.VM.save(get_single_vm(dom), savefile, checkpoint)
    else:
        server.xend.domain.save(dom, savefile, checkpoint)
    
def xm_restore(args):
    arg_check(args, "restore", 1, 2)

    try:
        (options, params) = getopt.gnu_getopt(args, 'p', ['paused'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('restore')

    paused = False
    for (k, v) in options:
        if k in ['-p', '--paused']:
            paused = True

    if len(params) != 1:
        err("Wrong number of parameters")
        usage('restore')

    savefile = os.path.abspath(params[0])

    if not os.access(savefile, os.R_OK):
        err("xm restore: Unable to read file %s" % savefile)
        sys.exit(1)

    if serverType == SERVER_XEN_API:
        server.xenapi.VM.restore(savefile, paused)
    else:
        server.xend.domain.restore(savefile, paused)


def datetime_to_secs(v):
    unwanted = ":-."
    for c in unwanted:
        v = str(v).replace(c, "")
    return time.mktime(time.strptime(v[0:14], '%Y%m%dT%H%M%S'))

def getDomains(domain_names, state, full = 0, pool = None):
    if serverType == SERVER_XEN_API:
        doms_sxp = []
        doms_dict = []

        dom_recs = server.xenapi.VM.get_all_records()
        dom_metrics_recs = server.xenapi.VM_metrics.get_all_records()

        for dom_ref, dom_rec in dom_recs.items():
            if pool and pool != dom_rec['pool_name']:
                continue

            dom_metrics_rec = dom_metrics_recs[dom_rec['metrics']]

            states = ('running', 'blocked', 'paused', 'shutdown',
                      'crashed', 'dying')
            def state_on_off(state):
                if state in dom_metrics_rec['state']:
                    return state[0]
                else:
                    return "-"
            state_str = "".join([state_on_off(state)
                                 for state in states])
            dom_rec.update({'name':     dom_rec['name_label'],
                            'memory_actual': int(dom_metrics_rec['memory_actual'])/1024,
                            'vcpus':    dom_metrics_rec['VCPUs_number'],
                            'state':    state_str,
                            'cpu_time': dom_metrics_rec['VCPUs_utilisation'],
                            'start_time': datetime_to_secs(
                                              dom_metrics_rec['start_time'])})

            doms_sxp.append(['domain'] + map2sxp(dom_rec))
            doms_dict.append(dom_rec)
            
        if domain_names:
            doms = [['domain'] + map2sxp(dom) for dom in doms_dict
                    if dom["name"] in domain_names]
            
            if len(doms) > 0:
                return doms
            else:
                print "Error: no domain%s named %s" % \
                      (len(domain_names) > 1 and 's' or '',
                       ', '.join(domain_names))
                sys.exit(-1)
        else:
            return doms_sxp
    else:
        if domain_names:
            return [server.xend.domain(dom, full) for dom in domain_names]
        else:
            doms = server.xend.domains_with_state(True, state, full)
            if not pool:
                return doms
            else:
                doms_in_pool = []
                for dom in doms:
                    if sxp.child_value(dom, 'pool_name', '') == pool:
                        doms_in_pool.append(dom)
                return doms_in_pool


def xm_list(args):
    use_long = 0
    show_vcpus = 0
    show_labels = 0
    state = 'all'
    pool = None
    try:
        (options, params) = getopt.gnu_getopt(args, 'lv',
                                              ['long','vcpus','label',
                                               'state=','pool='])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('list')
    
    for (k, v) in options:
        if k in ['-l', '--long']:
            use_long = 1
        if k in ['-v', '--vcpus']:
            show_vcpus = 1
        if k in ['--label']:
            show_labels = 1
        if k in ['--state']:
            state = v
        if k in ['--pool']:
            pool = v

    if state != 'all' and len(params) > 0:
        raise OptionError(
            "You may specify either a state or a particular VM, but not both")

    if pool and len(params) > 0:
        raise OptionError(
            "You may specify either a pool or a particular VM, but not both")

    if show_vcpus:
        print >>sys.stderr, (
            "xm list -v is deprecated.  Please use xm vcpu-list.")
        xm_vcpu_list(params)
        return

    doms = getDomains(params, state, use_long, pool)

    if use_long:
        map(PrettyPrint.prettyprint, doms)
    elif show_labels:
        xm_label_list(doms)
    else:
        xm_brief_list(doms)


def parse_doms_info(info):
    def get_info(n, t, d):
        return t(sxp.child_value(info, n, d))

    def get_status(n, t, d):
        return DOM_STATES[t(sxp.child_value(info, n, d))]

    start_time = get_info('start_time', float, -1)
    if start_time == -1:
        up_time = float(-1)
    else:
        up_time = time.time() - start_time

    parsed_info = {
        'domid'    : get_info('domid',              str,   ''),
        'name'     : get_info('name',               str,   '??'),
        'state'    : get_info('state',              str,   ''),

        # VCPUs is the number online when the VM is up, or the number
        # configured otherwise.
        'vcpus'    : get_info('online_vcpus', int,
                              get_info('vcpus', int, 0)),
        'up_time'  : up_time
        }

    security_label = get_info('security_label', str, '')
    parsed_info['seclabel'] = security.parse_security_label(security_label)

    if serverType == SERVER_XEN_API:
        parsed_info['mem'] = get_info('memory_actual', int, 0) / 1024
        cpu_times = get_info('cpu_time', lambda x : (x), 0.0)
        if sum(cpu_times.values()) > 0:
            parsed_info['cpu_time'] = sum(cpu_times.values()) / float(len(cpu_times.values()))
        else:
            parsed_info['cpu_time'] = 0
    else:
        parsed_info['mem'] = get_info('memory', int,0)
        parsed_info['cpu_time'] = get_info('cpu_time', float, 0.0)

    return parsed_info

def check_sched_type(sched):
    if serverType == SERVER_XEN_API:
        current = server.xenapi.host.get_sched_policy(
            server.xenapi.session.get_this_host(server.getSession()))
    else:
        current = 'unknown'
        for x in server.xend.node.info()[1:]:
            if len(x) > 1 and x[0] == 'xen_scheduler':
                current = x[1]
                break
    if sched != current:
        err("Xen is running with the %s scheduler" % current)
        sys.exit(1)

def parse_sedf_info(info):
    def get_info(n, t, d):
        return t(sxp.child_value(info, n, d))

    return {
        'domid'    : get_info('domid',         int,   -1),
        'period'   : get_info('period',        int,   -1),
        'slice'    : get_info('slice',         int,   -1),
        'latency'  : get_info('latency',       int,   -1),
        'extratime': get_info('extratime',     int,   -1),
        'weight'   : get_info('weight',        int,   -1),
        }

def domid_match(domid, info):
    return domid is None or domid == info['name'] or \
           domid == str(info['domid'])

def xm_brief_list(doms):
    print '%-40s %5s %5s %5s %10s %9s' % \
          ('Name', 'ID', 'Mem', 'VCPUs', 'State', 'Time(s)')
    
    format = "%(name)-40s %(domid)5s %(mem)5d %(vcpus)5d %(state)10s " \
             "%(cpu_time)8.1f"
    
    for dom in doms:
        d = parse_doms_info(dom)
        print format % d

def xm_label_list(doms):
    print '%-40s %5s %5s %5s %10s %9s %-10s' % \
          ('Name', 'ID', 'Mem', 'VCPUs', 'State', 'Time(s)', 'Label')

    output = []
    format = '%(name)-40s %(domid)5s %(mem)5d %(vcpus)5d %(state)10s ' \
             '%(cpu_time)8.1f %(seclabel)10s'

    for dom in doms:
        d = parse_doms_info(dom)
        if d['seclabel'] == "" and serverType != SERVER_XEN_API:
            seclab = server.xend.security.get_domain_label(d['name'])
            if len(seclab) > 0 and seclab[0] == '\'':
                seclab = seclab[1:]
            d['seclabel'] = seclab
        output.append((format % d, d['seclabel']))
        
    #sort by labels
    output.sort(lambda x,y: cmp( x[1].lower(), y[1].lower()))
    for line, label in output:
        print line


def xm_vcpu_list(args):
    if serverType == SERVER_XEN_API:
        if args:
            vm_refs = map(get_single_vm, args)
        else:
            vm_refs = server.xenapi.VM.get_all()
            
        vm_records = dict(map(lambda vm_ref:
                                  (vm_ref, server.xenapi.VM.get_record(
                                      vm_ref)),
                              vm_refs))

        vm_metrics = dict(map(lambda (ref, record):
                                  (ref,
                                   server.xenapi.VM_metrics.get_record(
                                       record['metrics'])),
                              vm_records.items()))

        dominfo = []

        # vcpu_list doesn't list 'managed' domains
        # when they are not running, so filter them out

        vm_refs = [vm_ref
                  for vm_ref in vm_refs
                  if vm_records[vm_ref]["power_state"] != "Halted"]

        for vm_ref in vm_refs:
            info = ['domain',
                    ['domid',      vm_records[vm_ref]['domid']],
                    ['name',       vm_records[vm_ref]['name_label']],
                    ['vcpu_count', vm_records[vm_ref]['VCPUs_max']]]

            for i in range(int(vm_records[vm_ref]['VCPUs_max'])):
                def chk_flag(flag):
                    return flag in vm_metrics[vm_ref]['VCPUs_flags'][str(i)] \
                           and 1 or 0
                
                vcpu_info = ['vcpu',
                             ['number',
                                  i],
                             ['online',
                                  chk_flag("online")],
                             ['blocked',
                                  chk_flag("blocked")],
                             ['running',
                                  chk_flag("running")],
                             ['cpu_time',
                                  vm_metrics[vm_ref]['VCPUs_utilisation'][str(i)]],
                             ['cpu',
                                  vm_metrics[vm_ref]['VCPUs_CPU'][str(i)]],
                             ['cpumap',
                                  vm_metrics[vm_ref]['VCPUs_params']\
                                  ['cpumap%i' % i].split(",")]]
                
                info.append(vcpu_info)

            dominfo.append(info)
    else:    
        if args:
            dominfo = map(server.xend.domain.getVCPUInfo, args)
        else:
            doms = server.xend.domains_with_state(False, 'all', False)
            dominfo = map(server.xend.domain.getVCPUInfo, doms)

    print '%-32s %5s %5s %5s %5s %9s %s' % \
          ('Name', 'ID', 'VCPU', 'CPU', 'State', 'Time(s)', 'CPU Affinity')

    format = '%(name)-32s %(domid)5s %(number)5d %(c)5s %(s)5s ' \
             ' %(cpu_time)8.1f %(cpumap)s'

    for dom in dominfo:
        def get_info(n):
            return sxp.child_value(dom, n)

        #
        # convert a list of integers into a list of pairs indicating
        # continuous sequences in the list:
        #
        # [0,1,2,3]   -> [(0,3)]
        # [1,2,4,5]   -> [(1,2),(4,5)]
        # [0]         -> [(0,0)]
        # [0,1,4,6,7] -> [(0,1),(4,4),(6,7)]
        #
        def list_to_rangepairs(cmap):
            cmap.sort()
            pairs = []
            x = y = 0
            for i in range(0,len(cmap)):
                try:
                    if ((cmap[y+1] - cmap[i]) > 1):
                        pairs.append((cmap[x],cmap[y]))
                        x = y = i+1
                    else:
                        y = y + 1
                # if we go off the end, then just add x to y
                except IndexError:
                    pairs.append((cmap[x],cmap[y]))

            return pairs

        #
        # Convert pairs to range string, e.g: [(1,2),(3,3),(5,7)] -> 1-2,3,5-7
        #
        def format_pairs(pairs):
            if not pairs:
                return "no cpus"
            out = ""
            for f,s in pairs:
                if (f==s):
                    out += '%d'%f
                else:
                    out += '%d-%d'%(f,s)
                out += ','
            # trim trailing ','
            return out[:-1]

        def format_cpumap(cpumap):
            cpumap = map(lambda x: int(x), cpumap)
            cpumap.sort()

            if serverType == SERVER_XEN_API:
                nr_cpus = len(server.xenapi.host.get_host_CPUs(
                    server.xenapi.session.get_this_host(server.getSession())))
            else:
                for x in server.xend.node.info()[1:]:
                    if len(x) > 1 and x[0] == 'nr_cpus':
                        nr_cpus = int(x[1])

            # normalize cpumap by modulus nr_cpus, and drop duplicates
            cpumap = dict.fromkeys(
                       filter(lambda x: x < nr_cpus, cpumap)).keys()
            if len(cpumap) == nr_cpus:
                return "any cpu"

            return format_pairs(list_to_rangepairs(cpumap))

        name  = get_info('name')
        domid = get_info('domid')
        if domid is not None:
            domid = str(domid)
        else:
            domid = ''

        for vcpu in sxp.children(dom, 'vcpu'):
            def vinfo(n, t):
                return t(sxp.child_value(vcpu, n))

            number   = vinfo('number',   int)
            cpu      = vinfo('cpu',      int)
            cpumap   = format_cpumap(vinfo('cpumap', list))
            online   = vinfo('online',   int)
            cpu_time = vinfo('cpu_time', float)
            running  = vinfo('running',  int)
            blocked  = vinfo('blocked',  int)

            if cpu < 0:
                c = ''
                s = ''
            elif online:
                c = str(cpu)
                if running:
                    s = 'r'
                else:
                    s = '-'
                if blocked:
                    s += 'b'
                else:
                    s += '-'
                s += '-'
            else:
                c = '-'
                s = '--p'

            print format % locals()

def start_do_console(domain_name):
    cpid = os.fork() 
    if cpid != 0:
        for i in range(10):
            # Catch failure of the create process 
            time.sleep(1)
            (p, rv) = os.waitpid(cpid, os.WNOHANG)
            if os.WIFEXITED(rv):
                if os.WEXITSTATUS(rv) != 0:
                    sys.exit(os.WEXITSTATUS(rv))
            try:
                # Acquire the console of the created dom
                if serverType == SERVER_XEN_API:
                    domid = server.xenapi.VM.get_domid(
                               get_single_vm(domain_name))
                else:
                    dom = server.xend.domain(domain_name)
                    domid = int(sxp.child_value(dom, 'domid', '-1'))
                console.execConsole(domid)
            except:
                pass
        print("Could not start console\n");
        sys.exit(0)

def xm_start(args):

    paused = False
    console_autoconnect = False
    vncviewer = False
    vncviewer_autopass = False

    try:
        (options, params) = getopt.gnu_getopt(args, 'cp', ['console_autoconnect','paused','vncviewer','vncviewer-autopass'])
        for (k, v) in options:
            if k in ('-p', '--paused'):
                paused = True
            if k in ('-c', '--console_autoconnect'):
                console_autoconnect = True
            if k in ('--vncviewer'):
                vncviewer = True
            if k in ('--vncviewer-autopass'):
                vncviewer_autopass = True

        if len(params) != 1:
            raise OptionError("Expects 1 argument")
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('start')

    dom = params[0]

    if console_autoconnect:
        start_do_console(dom)

    try:
        if serverType == SERVER_XEN_API:
            server.xenapi.VM.start(get_single_vm(dom), paused)
            domid = int(server.xenapi.VM.get_domid(get_single_vm(dom)))
        else:
            server.xend.domain.start(dom, paused)
            info = server.xend.domain(dom)
            domid = int(sxp.child_value(info, 'domid', '-1'))
    except:
        raise
        
    if domid == -1:
        raise xmlrpclib.Fault(0, "Domain '%s' is not started" % dom)

    if vncviewer:
        console.runVncViewer(domid, vncviewer_autopass, True)


def xm_delete(args):
    arg_check(args, "delete", 1)
    dom = args[0]
    if serverType == SERVER_XEN_API:
        server.xenapi.VM.destroy(get_single_vm(dom))
    else:
        server.xend.domain.delete(dom)

def xm_suspend(args):
    arg_check(args, "suspend", 1)
    dom = args[0]
    if serverType == SERVER_XEN_API:
        server.xenapi.VM.suspend(get_single_vm(dom))
    else:
        server.xend.domain.suspend(dom)

def xm_resume(args):
    arg_check(args, "resume", 1, 2)

    try:
        (options, params) = getopt.gnu_getopt(args, 'p', ['paused'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('resume')

    paused = False
    for (k, v) in options:
        if k in ['-p', '--paused']:
            paused = True

    if len(params) != 1:
        err("Wrong number of parameters")
        usage('resume')

    dom = params[0]
    if serverType == SERVER_XEN_API:
        server.xenapi.VM.resume(get_single_vm(dom), paused)
    else:
        server.xend.domain.resume(dom, paused)
    
def xm_reboot(args):
    arg_check(args, "reboot", 1, 3)
    from xen.xm import shutdown
    shutdown.main(["shutdown", "-R"] + args)

def xm_shutdown(args):
    arg_check(args, "shutdown", 1, 4)
    from xen.xm import shutdown
    shutdown.main(["shutdown"] + args)

def xm_reset(args):
    arg_check(args, "reset", 1)
    dom = args[0]

    if serverType == SERVER_XEN_API:
        server.xenapi.VM.hard_reboot(get_single_vm(dom))
    else:
        server.xend.domain.reset(dom)

def xm_pause(args):
    arg_check(args, "pause", 1)
    dom = args[0]

    if serverType == SERVER_XEN_API:
        server.xenapi.VM.pause(get_single_vm(dom))
        server.xenapi.VM.set_pauseflag(get_single_vm(dom), True)
    else:
        server.xend.domain.pause(dom)
        server.xend.domain.setpauseflag(dom, True)

def xm_unpause(args):
    arg_check(args, "unpause", 1)
    dom = args[0]

    if serverType == SERVER_XEN_API:
        server.xenapi.VM.unpause(get_single_vm(dom))
        server.xenapi.VM.set_pauseflag(get_single_vm(dom), False)
    else:
        server.xend.domain.unpause(dom)
        server.xend.domain.setpauseflag(dom, False)

def xm_dump_core(args):
    live = False
    crash = False
    reset = False
    try:
        (options, params) = getopt.gnu_getopt(args, 'LCR', ['live', 'crash', 'reset'])
        for (k, v) in options:
            if k in ('-L', '--live'):
                live = True
            elif k in ('-C', '--crash'):
                crash = True
            elif k in ('-R', '--reset'):
                reset = True

        if crash and reset:
            raise OptionError("You may not specify more than one '-CR' option")
        if len(params) not in (1, 2):
            raise OptionError("Expects 1 or 2 argument(s)")
    except getopt.GetoptError, e:
        raise OptionError(str(e))
    
    dom = params[0]
    if len(params) == 2:
        filename = os.path.abspath(params[1])
    else:
        filename = None

    print "Dumping core of domain: %s ..." % str(dom)
    server.xend.domain.dump(dom, filename, live, crash, reset)

def xm_rename(args):
    arg_check(args, "rename", 2)
        
    if serverType == SERVER_XEN_API:
        server.xenapi.VM.set_name_label(get_single_vm(args[0]), args[1])
    else:
        server.xend.domain.setName(args[0], args[1])

def xm_importcommand(command, args):
    cmd = __import__(command, globals(), locals(), 'xen.xm')
    cmd.main([command] + args)


#############################################################

def xm_vcpu_pin(args):
    arg_check(args, "vcpu-pin", 3)

    def cpu_make_map(cpulist):
        cpus = []
        for c in cpulist.split(','):
            if c == '':
                continue
            if c.find('-') != -1:
                (x,y) = c.split('-')
                for i in range(int(x),int(y)+1):
                    cpus.append(int(i))
            else:
                # remove this element from the list
                if c[0] == '^':
                    cpus = [x for x in cpus if x != int(c[1:])]
                else:
                    cpus.append(int(c))
        cpus.sort()
        return ",".join(map(str, cpus))

    dom  = args[0]
    vcpu = args[1]
    if args[2] == 'all':
        cpumap = cpu_make_map('0-63')
    else:
        cpumap = cpu_make_map(args[2])

    if serverType == SERVER_XEN_API:
        server.xenapi.VM.add_to_VCPUs_params_live(
            get_single_vm(dom), "cpumap%i" % int(vcpu), cpumap)
    else:
        server.xend.domain.pincpu(dom, vcpu, cpumap)

def xm_mem_max(args):
    arg_check(args, "mem-max", 2)

    dom = args[0]

    if serverType == SERVER_XEN_API:
        mem = int_unit(args[1], 'k') * 1024
        server.xenapi.VM.set_memory_static_max(get_single_vm(dom), mem)
    else:
        mem = int_unit(args[1], 'm')
        server.xend.domain.maxmem_set(dom, mem)
    
def xm_mem_set(args):
    arg_check(args, "mem-set", 2)

    dom = args[0]

    if serverType == SERVER_XEN_API:
        mem_target = int_unit(args[1], 'm') * 1024 * 1024
        server.xenapi.VM.set_memory_dynamic_max_live(get_single_vm(dom),
                                                     mem_target)
        server.xenapi.VM.set_memory_dynamic_min_live(get_single_vm(dom),
                                                     mem_target)
    else:
        mem_target = int_unit(args[1], 'm')
        server.xend.domain.setMemoryTarget(dom, mem_target)

def xm_usb_add(args):
    arg_check(args, "usb-add", 2)
    server.xend.domain.usb_add(args[0],args[1])

def xm_domstate(args):
    arg_check(args, "domstate", 1)
    (opitons, params) = getopt.gnu_getopt(args, 's',  ['domname='])
    doms = getDomains(params, 'all')
    d = parse_doms_info(doms[0])
    state =  d['state']
    if state:
        if   state.find('s') > 0:
            print 'shutoff'  
        elif state.find('b') > 0: 
            print 'idle'  
        elif state.find('d') > 0: 
            print 'shutdown'  
        elif state.find('r') > 0: 
            print 'running'  
        elif state.find('c') > 0:
            print 'crashed' 
        elif state.find('p') > 0:
            if server.xend.domain.getpauseflag(args[0]):
                print 'paused by admin'
            else:
                print 'paused'
    else:
        print 'shutoff'
    return 

def xm_usb_del(args):
    arg_check(args, "usb-del", 2)
    server.xend.domain.usb_del(args[0],args[1])
    
def xm_vcpu_set(args):
    arg_check(args, "vcpu-set", 2)

    dom = args[0]
    vcpus = int(args[1])

    if serverType == SERVER_XEN_API:
        server.xenapi.VM.set_VCPUs_number_live(get_single_vm(dom), vcpus)
    else:
        server.xend.domain.setVCpuCount(dom, vcpus)

def xm_destroy(args):
    arg_check(args, "destroy", 1)

    dom = args[0]
    
    if serverType == SERVER_XEN_API:
        server.xenapi.VM.hard_shutdown(get_single_vm(dom))
    else:
        server.xend.domain.destroy(dom)

def xm_domid(args):
    arg_check(args, "domid", 1)

    name = args[0]

    if serverType == SERVER_XEN_API:
        print server.xenapi.VM.get_domid(get_single_vm(name))
    else:
        dom = server.xend.domain(name)
        print sxp.child_value(dom, 'domid')
    
def xm_domname(args):
    arg_check(args, "domname", 1)

    name = args[0]
    
    if serverType == SERVER_XEN_API:
        print server.xenapi.VM.get_name_label(get_single_vm(name))
    else:
        dom = server.xend.domain(name)
        print sxp.child_value(dom, 'name')

def xm_sched_sedf(args):
    xenapi_unsupported()
    
    def ns_to_ms(val):
        return float(val) * 0.000001
    
    def ms_to_ns(val):
        return (float(val) / 0.000001)

    def print_sedf(info):
        info['period']  = ns_to_ms(info['period'])
        info['slice']   = ns_to_ms(info['slice'])
        info['latency'] = ns_to_ms(info['latency'])
        print( ("%(name)-32s %(domid)5d %(period)9.1f %(slice)9.1f" +
                " %(latency)7.1f %(extratime)6d %(weight)6d") % info)

    check_sched_type('sedf')

    # we want to just display current info if no parameters are passed
    if len(args) == 0:
        domid = None
    else:
        # we expect at least a domain id (name or number)
        # and at most a domid up to 5 options with values
        arg_check(args, "sched-sedf", 1, 11)
        domid = args[0]
        # drop domid from args since get_opt doesn't recognize it
        args = args[1:] 

    opts = {}
    try:
        (options, params) = getopt.gnu_getopt(args, 'p:s:l:e:w:',
            ['period=', 'slice=', 'latency=', 'extratime=', 'weight='])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('sched-sedf')
    
    # convert to nanoseconds if needed 
    for (k, v) in options:
        if k in ['-p', '--period']:
            opts['period'] = ms_to_ns(v)
        elif k in ['-s', '--slice']:
            opts['slice'] = ms_to_ns(v)
        elif k in ['-l', '--latency']:
            opts['latency'] = ms_to_ns(v)
        elif k in ['-e', '--extratime']:
            opts['extratime'] = v
        elif k in ['-w', '--weight']:
            opts['weight'] = v

    doms = filter(lambda x : domid_match(domid, x),
                        [parse_doms_info(dom)
                         for dom in getDomains(None, 'running')])
    if domid is not None and doms == []: 
        err("Domain '%s' does not exist." % domid)
        usage('sched-sedf')

    # print header if we aren't setting any parameters
    if len(opts.keys()) == 0:
        print '%-33s %4s %-4s %-4s %-7s %-5s %-6s' % \
              ('Name','ID','Period(ms)', 'Slice(ms)', 'Lat(ms)',
               'Extra','Weight')
    
    for d in doms:
        # fetch current values so as not to clobber them
        try:
            sedf_raw = server.xend.domain.cpu_sedf_get(d['domid'])
        except xmlrpclib.Fault:
            # domain does not support sched-sedf?
            sedf_raw = {}

        sedf_info = parse_sedf_info(sedf_raw)
        sedf_info['name'] = d['name']
        # update values in case of call to set
        if len(opts.keys()) > 0:
            for k in opts.keys():
                sedf_info[k]=opts[k]
         
            # send the update, converting user input
            v = map(int, [sedf_info['period'], sedf_info['slice'],
                          sedf_info['latency'],sedf_info['extratime'], 
                          sedf_info['weight']])
            rv = server.xend.domain.cpu_sedf_set(d['domid'], *v)
            if int(rv) != 0:
                err("Failed to set sedf parameters (rv=%d)."%(rv))

        # not setting values, display info
        else:
            print_sedf(sedf_info)

def xm_sched_credit(args):
    """Get/Set options for Credit Scheduler."""
    
    check_sched_type('credit')

    try:
        opts, params = getopt.getopt(args, "d:w:c:",
            ["domain=", "weight=", "cap="])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('sched-credit')

    domid = None
    weight = None
    cap = None

    for o, a in opts:
        if o in ["-d", "--domain"]:
            domid = a
        elif o in ["-w", "--weight"]:
            weight = int(a)
        elif o in ["-c", "--cap"]:
            cap = int(a);

    doms = filter(lambda x : domid_match(domid, x),
                  [parse_doms_info(dom)
                  for dom in getDomains(None, 'all')])

    if weight is None and cap is None:
        if domid is not None and doms == []: 
            err("Domain '%s' does not exist." % domid)
            usage('sched-credit')
        # print header if we aren't setting any parameters
        print '%-33s %4s %6s %4s' % ('Name','ID','Weight','Cap')
        
        for d in doms:
            try:
                if serverType == SERVER_XEN_API:
                    info = server.xenapi.VM_metrics.get_VCPUs_params(
                        server.xenapi.VM.get_metrics(
                            get_single_vm(d['name'])))
                else:
                    info = server.xend.domain.sched_credit_get(d['name'])
            except xmlrpclib.Fault:
                pass

            if 'weight' not in info or 'cap' not in info:
                # domain does not support sched-credit?
                info = {'weight': -1, 'cap': -1}

            info['weight'] = int(info['weight'])
            info['cap']    = int(info['cap'])
            
            info['name']  = d['name']
            info['domid'] = str(d['domid'])
            print( ("%(name)-32s %(domid)5s %(weight)6d %(cap)4d") % info)
    else:
        if domid is None:
            # place holder for system-wide scheduler parameters
            err("No domain given.")
            usage('sched-credit')

        if serverType == SERVER_XEN_API:
            if doms[0]['domid']:
                server.xenapi.VM.add_to_VCPUs_params_live(
                    get_single_vm(domid),
                    "weight",
                    weight)
                server.xenapi.VM.add_to_VCPUs_params_live(
                    get_single_vm(domid),
                    "cap",
                    cap)
            else:
                server.xenapi.VM.add_to_VCPUs_params(
                    get_single_vm(domid),
                    "weight",
                    weight)
                server.xenapi.VM.add_to_VCPUs_params(
                    get_single_vm(domid),
                    "cap",
                    cap)
        else:
            result = server.xend.domain.sched_credit_set(domid, weight, cap)
            if result != 0:
                err(str(result))

def xm_sched_credit2(args):
    """Get/Set options for Credit2 Scheduler."""

    check_sched_type('credit2')

    try:
        opts, params = getopt.getopt(args, "d:w:",
            ["domain=", "weight="])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('sched-credit2')

    domid = None
    weight = None

    for o, a in opts:
        if o in ["-d", "--domain"]:
            domid = a
        elif o in ["-w", "--weight"]:
            weight = int(a)

    doms = filter(lambda x : domid_match(domid, x),
                  [parse_doms_info(dom)
                  for dom in getDomains(None, 'all')])

    if weight is None:
        if domid is not None and doms == []:
            err("Domain '%s' does not exist." % domid)
            usage('sched-credit2')
        # print header if we aren't setting any parameters
        print '%-33s %4s %6s' % ('Name','ID','Weight')

        for d in doms:
            try:
                if serverType == SERVER_XEN_API:
                    info = server.xenapi.VM_metrics.get_VCPUs_params(
                        server.xenapi.VM.get_metrics(
                            get_single_vm(d['name'])))
                else:
                    info = server.xend.domain.sched_credit2_get(d['name'])
            except xmlrpclib.Fault:
                pass

            if 'weight' not in info:
                # domain does not support sched-credit2?
                info = {'weight': -1}

            info['weight'] = int(info['weight'])

            info['name']  = d['name']
            info['domid'] = str(d['domid'])
            print( ("%(name)-32s %(domid)5s %(weight)6d") % info)
    else:
        if domid is None:
            # place holder for system-wide scheduler parameters
            err("No domain given.")
            usage('sched-credit2')

        if serverType == SERVER_XEN_API:
            if doms[0]['domid']:
                server.xenapi.VM.add_to_VCPUs_params_live(
                    get_single_vm(domid),
                    "weight",
                    weight)
            else:
                server.xenapi.VM.add_to_VCPUs_params(
                    get_single_vm(domid),
                    "weight",
                    weight)
        else:
            result = server.xend.domain.sched_credit2_set(domid, weight)
            if result != 0:
                err(str(result))

def xm_info(args):
    arg_check(args, "info", 0, 1)
    
    try:
        (options, params) = getopt.gnu_getopt(args, 'cn', ['config','numa'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('info')
    
    show_xend_config = 0
    show_numa_topology = 0
    for (k, v) in options:
        if k in ['-c', '--config']:
            show_xend_config = 1
        if k in ['-n', '--numa']:
            show_numa_topology = 1

    if show_xend_config:
        for name, obj in inspect.getmembers(xoptions):
            if not inspect.ismethod(obj):
                if name == "config":
                    for x in obj[1:]:
                        if len(x) < 2: 
                            print "%-38s: (none)" % x[0]
                        else: 
                            print "%-38s:" % x[0], x[1]
                else:
                    print "%-38s:" % name, obj
        return

    if serverType == SERVER_XEN_API:

        # Need to fake out old style xm info as people rely on parsing it
        
        host_record = server.xenapi.host.get_record(
            server.xenapi.session.get_this_host(server.getSession()))

        host_cpu_records = map(server.xenapi.host_cpu.get_record, host_record["host_CPUs"])

        host_metrics_record = server.xenapi.host_metrics.get_record(host_record["metrics"])

        def getVal(keys, default=""):
            data = host_record
            for key in keys:
                if key in data:
                    data = data[key]
                else:
                    return default
            return data

        def getCpuMhz():
            cpu_speeds = [int(host_cpu_record["speed"])
                          for host_cpu_record in host_cpu_records
                          if "speed" in host_cpu_record]
            if len(cpu_speeds) > 0:
                return sum(cpu_speeds) / len(cpu_speeds)
            else:
                return 0

        getCpuMhz()

        def getCpuFeatures():
            if len(host_cpu_records) > 0:
                return host_cpu_records[0].get("features", "")
            else:
                return ""
                
        def getFreeCpuCount():
            cnt = 0
            for host_cpu_record in host_cpu_records:
                if len(host_cpu_record.get("cpu_pool", [])) == 0:
                    cnt += 1
            return cnt

        info = {
            "host":              getVal(["name_label"]),
            "release":           getVal(["software_version", "release"]),
            "version":           getVal(["software_version", "version"]),
            "machine":           getVal(["software_version", "machine"]),
            "nr_cpus":           getVal(["cpu_configuration", "nr_cpus"]),
            "nr_nodes":          getVal(["cpu_configuration", "nr_nodes"]),
            "cores_per_socket":  getVal(["cpu_configuration", "cores_per_socket"]),
            "threads_per_core":  getVal(["cpu_configuration", "threads_per_core"]),
            "cpu_mhz":           getCpuMhz(),
            "hw_caps":           getCpuFeatures(),
            "free_cpus":         getFreeCpuCount(),
            "total_memory":      int(host_metrics_record["memory_total"])/1024/1024,
            "free_memory":       int(host_metrics_record["memory_free"])/1024/1024,
            "xen_major":         getVal(["software_version", "xen_major"]),
            "xen_minor":         getVal(["software_version", "xen_minor"]),
            "xen_extra":         getVal(["software_version", "xen_extra"]),
            "xen_caps":          " ".join(getVal(["capabilities"], [])),
            "xen_scheduler":     getVal(["sched_policy"]),
            "xen_pagesize":      getVal(["other_config", "xen_pagesize"]),
            "platform_params":   getVal(["other_config", "platform_params"]),
            "xen_commandline":   getVal(["other_config", "xen_commandline"]),
            "xen_changeset":     getVal(["software_version", "xen_changeset"]),
            "cc_compiler":       getVal(["software_version", "cc_compiler"]),
            "cc_compile_by":     getVal(["software_version", "cc_compile_by"]),
            "cc_compile_domain": getVal(["software_version", "cc_compile_domain"]),
            "cc_compile_date":   getVal(["software_version", "cc_compile_date"]),
            "xend_config_format":getVal(["software_version", "xend_config_format"])                                
        }

        sorted = info.items()
        sorted.sort(lambda (x1,y1), (x2,y2): -cmp(x1,x2))
        
        for (k, v) in sorted:
           print "%-23s:" % k, v 
    else:
        info = server.xend.node.info(show_numa_topology)
        for x in info[1:]:
            if len(x) < 2: 
                print "%-23s: (none)" % x[0]
            else: 
                print "%-23s:" % x[0], x[1]

def xm_console(args):
    arg_check(args, "console", 1, 3)

    num = 0
    quiet = False;

    try:
        (options, params) = getopt.gnu_getopt(args, 'qn:', ['quiet', 'num'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('console')

    for (k, v) in options:
        if k in ['-q', '--quiet']:
            quiet = True
        elif k in ['-n', '--num']:
            num = int(v[0])
        else:
            assert False

    if len(params) != 1:
        err('No domain given')
        usage('console')

    dom = params[0]

    try:
        if serverType == SERVER_XEN_API:
            domid = int(server.xenapi.VM.get_domid(get_single_vm(dom)))
        else:
            info = server.xend.domain(dom)
            domid = int(sxp.child_value(info, 'domid', '-1'))
    except:
        if quiet:
            sys.exit(1)
        else:
            raise
        
    if domid == -1:
        if quiet:
            sys.exit(1)
        else:
            raise xmlrpclib.Fault(0, "Domain '%s' is not started" % dom)

    console.execConsole(domid, num)


def domain_name_to_domid(domain_name):
    if serverType == SERVER_XEN_API:
        domid = server.xenapi.VM.get_domid(
                   get_single_vm(domain_name))
    else:
        dom = server.xend.domain(domain_name)
        domid = int(sxp.child_value(dom, 'domid', '-1'))
    return int(domid)

def xm_vncviewer(args):
    autopass = False;

    try:
        (options, params) = getopt.gnu_getopt(args, '', ['autopass','vncviewer-autopass'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('vncviewer')

    for (k, v) in options:
        if k in ['--autopass','--vncviewer-autopass']:
            autopass = True
        else:
            assert False

    if len(params) != 1:
        err('No domain given (or several parameters specified)')
        usage('vncviewer')

    dom = params[0]
    domid = domain_name_to_domid(dom)

    console.runVncViewer(domid, autopass)


def xm_uptime(args):
    short_mode = 0

    try:
        (options, params) = getopt.gnu_getopt(args, 's', ['short'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('uptime')

    for (k, v) in options:
        if k in ['-s', '--short']:
            short_mode = 1

    doms = getDomains(params, 'all')

    if short_mode == 0:
        print '%-33s %4s %s ' % ('Name','ID','Uptime')

    for dom in doms:
        d = parse_doms_info(dom)
        if d['domid'] == '':
            uptime = 0
        elif int(d['domid']) > 0:
            uptime = int(round(d['up_time']))
        else:
            f=open('/proc/uptime', 'r')
            upfile = f.read()
            uptime = int(round(float(upfile.split(' ')[0])))
            f.close()

        days = int(uptime / 86400)
        uptime -= (days * 86400)
        hours = int(uptime / 3600)
        uptime -= (hours * 3600)
        minutes = int(uptime / 60)
        uptime -= (minutes * 60)
        seconds = uptime
            
        upstring = ""
        if days > 0:
            upstring += str(days) + " day"
            if days > 1:
                upstring += "s"
            upstring += ", "
        upstring += '%(hours)2d:%(minutes)02d' % vars()

        if short_mode:
            now = datetime.datetime.now()
            upstring = now.strftime(" %H:%M:%S") + " up " + upstring
            upstring += ", " + d['name'] + " (" + d['domid'] + ")"
        else:
            upstring += ':%(seconds)02d' % vars()
            upstring = ("%(name)-32s %(domid)5s " % d) + upstring

        print upstring

def xm_sysrq(args):
    arg_check(args, "sysrq", 2)
    dom = args[0]
    req = args[1]
    if serverType == SERVER_XEN_API:
        server.xenapi.VM.send_sysrq(get_single_vm(dom), req)
    else:
        server.xend.domain.send_sysrq(dom, req)

def xm_trigger(args):
    vcpu = 0
    
    arg_check(args, "trigger", 2, 3)
    dom = args[0]
    trigger = args[1]
    if len(args) == 3:
        vcpu = int(args[2])
        
    if serverType == SERVER_XEN_API:
        server.xenapi.VM.send_trigger(get_single_vm(dom), trigger, vcpu)
    else:
        server.xend.domain.send_trigger(dom, trigger, vcpu)

def xm_debug_keys(args):
    arg_check(args, "debug-keys", 1)

    keys = str(args[0])
    
    if serverType == SERVER_XEN_API:
        server.xenapi.host.send_debug_keys(
            server.xenapi.session.get_this_host(server.getSession()),
            keys)
    else:
        server.xend.node.send_debug_keys(keys)

def xm_top(args):
    arg_check(args, "top", 0)

    os.system('xentop')

def xm_dmesg(args):
    arg_check(args, "dmesg", 0, 1)
    
    try:
        (options, params) = getopt.gnu_getopt(args, 'c', ['clear'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('dmesg')
    
    use_clear = 0
    for (k, v) in options:
        if k in ['-c', '--clear']:
            use_clear = 1
    
    if len(params) :
        err("No parameter required")
        usage('dmesg')

    if serverType == SERVER_XEN_API:
        host = server.xenapi.session.get_this_host(server.getSession())
        if use_clear:
            print server.xenapi.host.dmesg_clear(host),
        else:
            print server.xenapi.host.dmesg(host),
    else:
        if not use_clear:
            print server.xend.node.dmesg.info(),
        else:
            print server.xend.node.dmesg.clear(),

def xm_log(args):
    arg_check(args, "log", 0)

    if serverType == SERVER_XEN_API:
        print server.xenapi.host.get_log(
            server.xenapi.session.get_this_host(server.getSession()))
    else:
        print server.xend.node.log()

def xm_serve(args):
    if serverType == SERVER_XEN_API:
        print "Not supported with XenAPI"
        sys.exit(-1)

    arg_check(args, "serve", 0)

    from fcntl import fcntl, F_SETFL
    
    s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
    s.connect(XendClient.XML_RPC_SOCKET)
    fcntl(sys.stdin, F_SETFL, os.O_NONBLOCK)

    while True:
        iwtd, owtd, ewtd = select([sys.stdin, s], [], [])
        if s in iwtd:
            data = s.recv(4096)
            if len(data) > 0:
                sys.stdout.write(data)
                sys.stdout.flush()
            else:
                break
        if sys.stdin in iwtd:
            data = sys.stdin.read(4096)
            if len(data) > 0:
                s.sendall(data)
            else:
                break
    s.close()

def parse_dev_info(info):
    def get_info(n, t, d):
        i = 0
        while i < len(info):
            if (info[i][0] == n):
                return t(info[i][1])
            i = i + 1
        return t(d)
    return {
        #common
        'backend-id' : get_info('backend-id',   int,   -1),
        'handle'     : get_info('handle',       int,    0),
        'state'      : get_info('state',        int,   -1),
        'be-path'    : get_info('backend',      str,   '??'),
        'event-ch'   : get_info('event-channel',int,   -1),
        #network specific
        'virtual-device' : get_info('virtual-device', str, '??'),
        'tx-ring-ref': get_info('tx-ring-ref',  int,   -1),
        'rx-ring-ref': get_info('rx-ring-ref',  int,   -1),
        'mac'        : get_info('mac',          str,   '??'),
        #block-device specific
        'ring-ref'   : get_info('ring-ref',     int,   -1),
        #vscsi specific
        'feature-host'   : get_info('feature-host',     int,   -1),
        }

def arg_check_for_resource_list(args, name):
    use_long = 0
    try:
        (options, params) = getopt.gnu_getopt(args, 'l', ['long'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage(name)

    for (k, v) in options:
        if k in ['-l', '--long']:
            use_long = 1

    if len(params) == 0:
        print 'No domain parameter given'
        usage(name)
    if len(params) > 1:
        print 'No multiple domain parameters allowed'
        usage(name)
    
    return (use_long, params)

def xm_network_list(args):
    (use_long, params) = arg_check_for_resource_list(args, "network-list")

    dom = params[0]

    if serverType == SERVER_XEN_API:
        vif_refs = server.xenapi.VM.get_VIFs(get_single_vm(dom))
        vif_properties = []
        for vif_ref in vif_refs:
            vif_property = server.xenapi.VIF.get_runtime_properties(vif_ref)
            vif_property['mac'] = server.xenapi.VIF.get_MAC(vif_ref)
            vif_properties.append(vif_property)
        devs = map(lambda (handle, properties): [handle, map2sxp(properties)],
                   zip(range(len(vif_properties)), vif_properties))
    else:
        devs = server.xend.domain.getDeviceSxprs(dom, 'vif')
        
    if use_long:
        map(PrettyPrint.prettyprint, devs)
    else:
        hdr = 0
        for x in devs:
            if hdr == 0:
                print 'Idx BE     MAC Addr.     handle state evt-ch tx-/rx-ring-ref BE-path'
                hdr = 1
            ni = parse_dev_info(x[1])
            ni['idx'] = int(x[0])
            print ("%(idx)-3d "
                   "%(backend-id)-3d"
                   "%(mac)-17s    "
                   "%(handle)-3d   "
                   "%(state)-3d    "
                   "%(event-ch)-3d   "
                   "%(tx-ring-ref)-5d/%(rx-ring-ref)-5d   "
                   "%(be-path)-30s  "
                   % ni)

def xm_block_list(args):
    (use_long, params) = arg_check_for_resource_list(args, "block-list")

    dom = params[0]

    if serverType == SERVER_XEN_API:
        vbd_refs = server.xenapi.VM.get_VBDs(get_single_vm(dom))
        vbd_properties = \
            map(server.xenapi.VBD.get_runtime_properties, vbd_refs)
        vbd_devs = \
            map(server.xenapi.VBD.get_device, vbd_refs)
        vbd_devids = [blkdev_name_to_number(x)[1] for x in vbd_devs]
        devs = map(lambda (devid, prop): [devid, map2sxp(prop)],
                   zip(vbd_devids, vbd_properties))
    else:
        devs = server.xend.domain.getDeviceSxprs(dom, 'vbd')

    if use_long:
        map(PrettyPrint.prettyprint, devs)
    else:
        hdr = 0
        for x in devs:
            if hdr == 0:
                print 'Vdev  BE handle state evt-ch ring-ref BE-path'
                hdr = 1
            ni = parse_dev_info(x[1])
            ni['idx'] = int(x[0])
            print ("%(idx)-5d  "
                   "%(backend-id)-3d  "
                   "%(handle)-3d   "
                   "%(state)-3d    "
                   "%(event-ch)-3d    "
                   "%(ring-ref)-5d "
                   "%(be-path)-30s  "
                   % ni)

def xm_vtpm_list(args):
    (use_long, params) = arg_check_for_resource_list(args, "vtpm-list")

    dom = params[0]

    if serverType == SERVER_XEN_API:
        vtpm_refs = server.xenapi.VM.get_VTPMs(get_single_vm(dom))
        vtpm_properties = \
            map(server.xenapi.VTPM.get_runtime_properties, vtpm_refs)
        devs = map(lambda (handle, properties): [handle, map2sxp(properties)],
                   zip(range(len(vtpm_properties)), vtpm_properties))
    else:
        devs = server.xend.domain.getDeviceSxprs(dom, 'vtpm')

    if use_long:
        map(PrettyPrint.prettyprint, devs)
    else:
        hdr = 0
        for x in devs:
            if hdr == 0:
                print 'Idx  BE handle state evt-ch ring-ref BE-path'
                hdr = 1
            ni = parse_dev_info(x[1])
            ni['idx'] = int(x[0])
            print ("%(idx)-3d   "
                   "%(backend-id)-3d  "
                   "%(handle)-3d   "
                   "%(state)-3d    "
                   "%(event-ch)-3d    "
                   "%(ring-ref)-5d "
                   "%(be-path)-30s  "
                   % ni)

def attached_pci_dict_bin(dom):
    devs = []
    if serverType == SERVER_XEN_API:
        for dpci_ref in server.xenapi.VM.get_DPCIs(get_single_vm(dom)):
            ppci_ref = server.xenapi.DPCI.get_PPCI(dpci_ref)
            ppci_record = server.xenapi.PPCI.get_record(ppci_ref)
            dev = {
                'domain': int(ppci_record['domain']),
                'bus':    int(ppci_record['bus']),
                'slot':   int(ppci_record['slot']),
                'func':   int(ppci_record['func']),
                'vdevfn': int(server.xenapi.DPCI.get_hotplug_slot(dpci_ref)),
                'key':    server.xenapi.DPCI.get_key(dpci_ref)
            }
            devs.append(dev)

    else:
        for x in server.xend.domain.getDeviceSxprs(dom, 'pci'):
            dev = {
                'domain': int(x['domain'], 16),
                'bus':    int(x['bus'], 16),
                'slot':   int(x['slot'], 16),
                'func':   int(x['func'], 16),
                'vdevfn': int(x['vdevfn'], 16),
                'key':    x['key']
            }
            devs.append(dev)

    return devs

def pci_dict_bin_to_str(pci_dev):
    new_dev = pci_dev.copy()

    new_dev['domain'] = '0x%04x' % pci_dev['domain']
    new_dev['bus']    = '0x%02x' % pci_dev['bus']
    new_dev['slot']   = '0x%02x' % pci_dev['slot']
    new_dev['func']   = '0x%x'   % pci_dev['func']
    new_dev['vdevfn'] = '0x%02x' % pci_dev['vdevfn']

    return new_dev

def attached_pci_dict(dom):
    return map(pci_dict_bin_to_str, attached_pci_dict_bin(dom))

def xm_pci_list(args):
    (use_long, params) = arg_check_for_resource_list(args, "pci-list")

    devs = attached_pci_dict_bin(params[0])
    if len(devs) == 0:
        return

    devs.sort(None,
              lambda x: (x['vdevfn'] - PCI_FUNC(x['vdevfn'])) << 32 |
                         PCI_BDF(x['domain'], x['bus'], x['slot'], x['func']))

    has_vdevfn = False
    for x in devs:
        if x['vdevfn'] & AUTO_PHP_SLOT:
            x['show_vdevfn'] = '-'
        else:
            x['show_vdevfn'] = "%02x.%01x" % (PCI_SLOT(x['vdevfn']), PCI_FUNC(x['vdevfn']))
            has_vdevfn = True

    hdr_str = 'Device'
    fmt_str = '%(domain)04x:%(bus)02x:%(slot)02x.%(func)x'
    if has_vdevfn:
        hdr_str = 'Vdev ' + hdr_str
        fmt_str = '%(show_vdevfn)-4s ' + fmt_str

    print hdr_str
    for x in devs:
        print fmt_str % x


def parse_pci_info(info):
    def get_info(n, t, d):
        return t(sxp.child_value(info, n, d))
    return {
        'domain' : get_info('domain', parse_hex, 0),
        'bus'    : get_info('bus', parse_hex, -1),
        'slot'   : get_info('slot', parse_hex, -1),
        'func'   : get_info('func', parse_hex, -1)
        }

def xm_pci_list_assignable_devices(args):
    xenapi_unsupported()
    arg_check(args, "pci-list-assignable-devices", 0)

    devs =  server.xend.node.pciinfo()
    if devs is None:
        print "Error: pciback/pci-stub not loaded?"
        return
 
    fmt_str = "%(domain)04x:%(bus)02x:%(slot)02x.%(func)01x"
    for x in devs:
        pci = parse_pci_info(x)
        print fmt_str % pci


def vscsi_sort(devs):
    def sort_hctl(ds, l):
        s = []
        for d1 in ds:
            for d2 in d1:
                v_dev = sxp.child_value(d2, 'v-dev')
                n = int(v_dev.split(':')[l])
                try:
                    j = s[n]
                except IndexError:
                    j = []
                    s.extend([ [] for _ in range(len(s), n+1) ])
                j.append(d2)
                s[n] = j
        return s

    for i in range(len(devs)):
        ds1 = [ devs[i][1][0][1] ]
        ds1 = sort_hctl(ds1, 3)
        ds1 = sort_hctl(ds1, 2)
        ds1 = sort_hctl(ds1, 1)
        ds2 = []
        for d in ds1:
            ds2.extend(d)
        devs[i][1][0][1] = ds2
    return devs

def vscsi_convert_sxp_to_dict(dev_sxp):
    dev_dict = {}
    for opt_val in dev_sxp[1:]:
        try:
            opt, val = opt_val
            dev_dict[opt] = val
        except TypeError:
            pass
    return dev_dict

def xm_scsi_list(args):
    (use_long, params) = arg_check_for_resource_list(args, "scsi-list")

    dom = params[0]

    devs = []
    if serverType == SERVER_XEN_API:

        dscsi_refs = server.xenapi.VM.get_DSCSIs(get_single_vm(dom))
        dscsi_properties = \
            map(server.xenapi.DSCSI.get_runtime_properties, dscsi_refs)
        dscsi_dict = {}
        for dscsi_property in dscsi_properties:
            devid = int(dscsi_property['dev']['devid'])
            try:
                dscsi_sxp = dscsi_dict[devid]
            except:
                dscsi_sxp = [['devs', []]]
                for key, value in dscsi_property.items():
                    if key != 'dev':
                        dscsi_sxp.append([key, value])
            dev_sxp = ['dev']
            dev_sxp.extend(map2sxp(dscsi_property['dev']))
            dscsi_sxp[0][1].append(dev_sxp)
            dscsi_dict[devid] = dscsi_sxp
        devs = map2sxp(dscsi_dict)

    else:
        devs = server.xend.domain.getDeviceSxprs(dom, 'vscsi')

    # Sort devs by virtual HCTL.
    devs = vscsi_sort(devs)

    if use_long:
        map(PrettyPrint.prettyprint, devs)
    else:
        hdr = 0
        for x in devs:
            if hdr == 0:
                print "%-3s %-3s %-5s %-4s  %-10s %-5s %-10s %-4s" \
                        % ('Idx', 'BE', 'state', 'host', 'phy-hctl', 'phy', 'vir-hctl', 'devstate')
                hdr = 1
            ni = parse_dev_info(x[1])
            ni['idx'] = int(x[0])
            for dev in x[1][0][1]:
                mi = vscsi_convert_sxp_to_dict(dev)
                print "%(idx)-3d %(backend-id)-3d %(state)-5d %(feature-host)-4d " % ni,
                print "%(p-dev)-10s %(p-devname)-5s %(v-dev)-10s %(frontstate)-4s" % mi

def xm_usb_list(args):
    xenapi_unsupported()
    arg_check(args, 'usb-list', 1)
    dom = args[0]
    devs = server.xend.domain.getDeviceSxprs(dom, 'vusb')
    for x in devs:
        print "%-3s %-3s %-5s %-7s  %-30s" \
            % ('Idx', 'BE', 'state', 'usb-ver', 'BE-path')
        ni = parse_dev_info(x[1])
        ni['idx'] = int(x[0])
        usbver = sxp.child_value(x[1], 'usb-ver')
        if int(usbver) == 1:
            ni['usb-ver'] = 'USB1.1'
        else:
            ni['usb-ver'] = 'USB2.0'
        print "%(idx)-3d %(backend-id)-3d %(state)-5d %(usb-ver)-7s %(be-path)-30s  " % ni

        ports = sxp.child(x[1], 'port')
        for port in ports[1:]:
            try:
                num, bus = port
                if bus != "" and vusb_util.usb_device_is_connected(bus):
                        idvendor = vusb_util.get_usb_idvendor(bus)
                        idproduct = vusb_util.get_usb_idproduct(bus)
                        prodinfo = vusb_util.get_usbdevice_info(bus)
                        print "port %i: %s [ID %-4s:%-4s %s]" \
                            % (int(num), str(bus), idvendor, idproduct, prodinfo)
                else:
                    print "port %i: " % int(num) + str(bus)
            except TypeError:
                pass

def xm_usb_list_assignable_devices(args):
    xenapi_unsupported()
    arg_check(args, 'usb-list-assignable-devices', 0)

    usb_devs = vusb_util.get_usb_devices()
    buses = vusb_util.get_assigned_buses()

    for x in buses:
        try:
            usb_devs.remove(x)
        except ValueError:
            pass

    for dev in usb_devs:
        idvendor = vusb_util.get_usb_idvendor(dev)
        idproduct = vusb_util.get_usb_idproduct(dev)
        prodinfo = vusb_util.get_usbdevice_info(dev)
        print "%-13s: ID %-4s:%-4s %s" \
                % (dev, idvendor, idproduct, prodinfo)

def parse_block_configuration(args):
    dom = args[0]

    if args[1].startswith('tap2:'):
        cls = 'tap2'
    elif args[1].startswith('tap:'):
        cls = 'tap'
    else:
        cls = 'vbd'

    vbd = [cls,
           ['uname', args[1]],
           ['dev',   args[2]],
           ['mode',  args[3]]]
    if len(args) == 5:
        vbd.append(['backend', args[4]])

    return (dom, vbd)


def xm_block_attach(args):
    arg_check(args, 'block-attach', 4, 5)

    if serverType == SERVER_XEN_API:
        dom   = args[0]
        uname = args[1]
        dev   = args[2]
        mode  = args[3]

        # First create new VDI
        vdi_record = {
            "name_label":       "vdi" + str(uname.__hash__()),   
            "name_description": "",
            "SR":               get_default_SR(),
            "virtual_size":     0,
            "sector_size":      512,
            "type":             "system",
            "sharable":         False,
            "read_only":        mode!="w",
            "other_config":     {"location": uname}
        }

        vdi_ref = server.xenapi.VDI.create(vdi_record)

        # Now create new VBD

        vbd_record = {
            "VM":               get_single_vm(dom),
            "VDI":              vdi_ref,
            "device":           dev,
            "bootable":         True,
            "mode":             mode=="w" and "RW" or "RO",
            "type":             "Disk",
            "qos_algorithm_type": "",
            "qos_algorithm_params": {}
        }

        server.xenapi.VBD.create(vbd_record)
        
    else:
        (dom, vbd) = parse_block_configuration(args)
        server.xend.domain.device_create(dom, vbd)


def xm_block_configure(args):
    arg_check(args, 'block-configure', 4, 5)

    (dom, vbd) = parse_block_configuration(args)
    server.xend.domain.device_configure(dom, vbd)


def xm_network2_attach(args):
    xenapi_unsupported()
    arg_check(args, 'network2-attach', 1, 11)
    dom = args[0]
    vif = ['vif2']
    vif_params = ['front_mac', 'back_mac', 'backend', 'trusted',
                  'back_trusted', "front_filter_mac", "filter_mac",
                  'bridge', 'pdev', "max_bypasses" ]
    for a in args[1:]:
        vif_param = a.split("=")
        if len(vif_param) != 2 or vif_param[1] == "" or \
           vif_param[0] not in vif_params:
            err("Invalid argument: %s" % a)
            usage("network2-attach")
        vif.append(vif_param)
    server.xend.domain.device_create(dom, vif)

def xm_network2_detach(args):
    xenapi_unsupported()
    arg_check(args, "network2-detach", 2, 3)
    detach(args, "vif2")

def xm_network2_list(args):
    xenapi_unsupported()
    (use_long, params) = arg_check_for_resource_list(args, "network2-list")
    dom = params[0]
    devs = server.xend.domain.getDeviceSxprs(dom, 'vif2')
    map(PrettyPrint.prettyprint, devs)
                
def xm_network_attach(args):
    arg_check(args, 'network-attach', 1, 11)

    dom = args[0]
    vif = ['vif']
    vif_params = ['type', 'mac', 'bridge', 'ip', 'script', \
                  'backend', 'vifname', 'rate', 'model', 'accel']

    if serverType == SERVER_XEN_API:     
        vif_record = {
            "device":               "eth0",
            "network":              get_default_Network(),
            "VM":                   get_single_vm(dom),
            "MAC":                  "",
            "MTU":                  "",
            "qos_algorithm_type":   "",
            "qos_algorithm_params": {},
            "other_config":         {}
            }

        def set(keys, val):
            record = vif_record
            for key in keys[:-1]:
                record = record[key]
            record[keys[-1]] = val

        def get_net_from_bridge(bridge):
            # In OSS, we just assert network.name_label == bridge name
            networks = dict([(record['name_label'], ref)
                             for ref, record in server.xenapi.network
                             .get_all_records().items()])
            if bridge not in networks.keys():
                raise ValueError("Unknown bridge name!")
            return networks[bridge]

        vif_conv = {
            'type':
                lambda x: None,
            'mac':
                lambda x: set(['MAC'], x),
            'bridge':
                lambda x: set(['network'], get_net_from_bridge(x)),
            'ip':
                lambda x: set(['other_config', 'ip'], x),
            'script':
                lambda x: set(['other_config', 'script'], x),
            'backend':
                lambda x: set(['other_config', 'backend'], x),
            'vifname':
                lambda x: set(['device'], x),
            'rate':
                lambda x: set(['qos_algorithm_params', 'rate'], x),
            'model':
                lambda x: None,
            'accel':
                lambda x: set(['other_config', 'accel'], x)
            }
            
        for a in args[1:]:
            vif_param = a.split("=")
            if len(vif_param) != 2 or vif_param[1] == '' or \
                   vif_param[0] not in vif_params:
                err("Invalid argument: %s" % a)
                usage('network-attach')   
            else:
                vif_conv[vif_param[0]](vif_param[1])

        server.xenapi.VIF.create(vif_record)
    else:
        for a in args[1:]:
            vif_param = a.split("=")
            if len(vif_param) != 2 or vif_param[1] == '' or \
                   vif_param[0] not in vif_params:
                err("Invalid argument: %s" % a)
                usage('network-attach')
            vif.append(vif_param)
        server.xend.domain.device_create(dom, vif)

def parse_pci_configuration(args, opts = ''):
    dom = args[0]
    pci_dev_str = args[1]
    if len(args) == 3:
        pci_dev_str += '@' + args[2]
    if len(opts) > 0:
        pci_dev_str += ',' + serialise_pci_opts(opts)

    try:
        pci_dev = parse_pci_name_extended(pci_dev_str)
    except PciDeviceParseError, ex:
        raise OptionError(str(ex))

    return (dom, pci_dev)

def xm_pci_attach(args):
    config_pci_opts = []
    (options, params) = getopt.gnu_getopt(args, 'o:', ['options='])
    for (k, v) in options:
        if k in ('-o', '--options'):
            if len(v.split('=')) != 2:
                err("Invalid pci attach option: %s" % v)
                usage('pci-attach')
            config_pci_opts.append(v.split('='))

    n = len([i for i in params if i != '--'])
    if n < 2 or n > 3:
        err("Invalid argument for 'xm pci-attach'")
        usage('pci-attach')

    (dom, dev) = parse_pci_configuration(params, config_pci_opts)

    attached = attached_pci_dict(dom)

    attached_dev = map(lambda x: find_attached(attached, x, False), dev)

    head_dev = dev.pop(0)
    xm_pci_attach_one(dom, head_dev)

    # That is all for single-function virtual devices
    if len(dev) == 0:
        return

    # If the slot wasn't spefified in the args then use the slot
    # assigned to the head by qemu-xen for the rest of the functions
    if int(head_dev['vdevfn'], 16) & AUTO_PHP_SLOT:
        vdevfn = int(find_attached_devfn(attached_pci_dict(dom), head_dev), 16)
        if not vdevfn & AUTO_PHP_SLOT:
            vslot = PCI_SLOT(vdevfn)
            for i in dev:
                i['vdevfn'] = '0x%02x' % \
                              PCI_DEVFN(vslot, PCI_FUNC(int(i['vdevfn'], 16)))

    for i in dev:
        xm_pci_attach_one(dom, i)

def xm_pci_attach_one(dom, pci_dev):
    if serverType == SERVER_XEN_API:
        name = pci_dict_to_bdf_str(pci_dev)
        target_ref = None
        for ppci_ref in server.xenapi.PPCI.get_all():
            if name == server.xenapi.PPCI.get_name(ppci_ref):
                target_ref = ppci_ref
                break
        if target_ref is None:
            raise OptionError("Device %s not found" % name)

        dpci_record = {
            "VM":           get_single_vm(dom),
            "PPCI":         target_ref,
            "hotplug_slot": int(pci_dev['vdevfn'], 16),
            "options":      dict(pci_dev.get('opts', [])),
            "key":          pci_dev['key']
        }
        server.xenapi.DPCI.create(dpci_record)

    else:
        pci = pci_convert_dict_to_sxp(pci_dev, 'Initialising')
        server.xend.domain.device_configure(dom, pci)

def parse_scsi_configuration(p_scsi, v_hctl, state):
    def get_devid(hctl):
        return int(hctl.split(':')[0])

    host_mode = 0
    scsi_devices = None

    if p_scsi is not None:
        # xm scsi-attach
        if v_hctl == "host":
            host_mode = 1
            scsi_devices = vscsi_util.vscsi_get_scsidevices()
        elif len(v_hctl.split(':')) != 4:
            raise OptionError("Invalid argument: %s" % v_hctl)
        (p_hctl, devname) = \
            vscsi_util.vscsi_get_hctl_and_devname_by(p_scsi, scsi_devices)
        if p_hctl is None:
            raise OptionError("Cannot find device '%s'" % p_scsi)
        if host_mode:
            scsi_info = []
            devid = get_devid(p_hctl)
            for pHCTL, devname, _, _ in scsi_devices:
                if get_devid(pHCTL) == devid:
                    scsi_info.append([devid, pHCTL, devname, pHCTL])
        else:
            scsi_info = [[get_devid(v_hctl), p_hctl, devname, v_hctl]] 
    else:
        # xm scsi-detach
        if len(v_hctl.split(':')) != 4:
            raise OptionError("Invalid argument: %s" % v_hctl)
        scsi_info = [[get_devid(v_hctl), None, None, v_hctl]]

    scsi = ['vscsi', ['feature-host', host_mode]]
    for devid, pHCTL, devname, vHCTL in scsi_info:
        scsi.append(['dev', \
                     ['state', state], \
                     ['devid', devid], \
                     ['p-dev', pHCTL], \
                     ['p-devname', devname], \
                     ['v-dev', vHCTL] \
                   ])
    return scsi

def xm_scsi_attach(args):
    arg_check(args, 'scsi-attach', 3, 4)
    dom = args[0]
    p_scsi = args[1]
    v_hctl = args[2]
    scsi = parse_scsi_configuration(p_scsi, v_hctl, xenbusState['Initialising'])

    if serverType == SERVER_XEN_API:

        scsi_dev = sxp.children(scsi, 'dev')[0]

        if sxp.child_value(scsi, 'feature-host'):
            p_host = sxp.child_value(scsi_dev, 'devid')
            target_ref = None
            for pscsi_ref in server.xenapi.PSCSI_HBA.get_all():
                if p_host == int(server.xenapi.PSCSI_HBA.get_physical_host(pscsi_ref)):
                    target_ref = pscsi_ref
                    break
            if target_ref is None:
                raise OptionError("Cannot find device '%s'" % p_scsi)

            dscsi_record = {
                "VM":              get_single_vm(dom),
                "PSCSI_HBA":       target_ref,
                "assignment_mode": "HOST"
            }
            server.xenapi.DSCSI_HBA.create(dscsi_record)
        else:
            p_hctl = sxp.child_value(scsi_dev, 'p-dev')
            target_ref = None
            for pscsi_ref in server.xenapi.PSCSI.get_all():
                if p_hctl == server.xenapi.PSCSI.get_physical_HCTL(pscsi_ref):
                    target_ref = pscsi_ref
                    break
            if target_ref is None:
                raise OptionError("Cannot find device '%s'" % p_scsi)

            dscsi_record = {
                "VM":           get_single_vm(dom),
                "PSCSI":        target_ref,
                "virtual_HCTL": v_hctl
            }
            server.xenapi.DSCSI.create(dscsi_record)

    else:
        if len(args) == 4:
            scsi.append(['backend', args[3]])
        server.xend.domain.device_configure(dom, scsi)

def xm_usb_attach(args):
    xenapi_unsupported()
    arg_check(args, 'usb-attach', 4)
    dom = args[0]
    dev = args[1]
    port = args[2]
    bus = args[3]

    dev_exist = 0
    num_ports = 0
    devs = server.xend.domain.getDeviceSxprs(dom, 'vusb')
    for x in devs:
        if int(x[0]) == int(dev):
            dev_exist = 1
            num_ports = sxp.child_value(x[1], 'num-ports')

    if dev_exist == 0:
        print "Cannot find device '%s' in domain '%s'" % (dev,dom)
        return False

    if int(port) < 1 or int(port) > int(num_ports):
        print "Invalid Port Number '%s'" % port
        return False

    bus_match = re.match(r"(^(?P<bus>[0-9]{1,2})[-,])" + \
                         r"(?P<root_port>[0-9]{1,2})" + \
                         r"(?P<port>([\.,]{1}[0-9]{1,2}){0,5})$", bus)
    if bus_match is None:
        print "Invalid Busid '%s'" % bus
        return False

    if vusb_util.bus_is_assigned(bus):
        print "Cannot assign already attached bus '%s', detach first." % bus
        return False

    prev_bus = vusb_util.get_assigned_bus(domain_name_to_domid(dom), dev, port)
    if not prev_bus == "": 
        print "Cannot override already attached port '%s', detach first." % port
        return False

    usb = ['vusb', ['port', [port, str(bus)]]]
    server.xend.domain.device_configure(dom, usb, dev)

def xm_usb_hc_create(args):
    xenapi_unsupported()
    arg_check(args, 'usb-hc-create', 3)
    dom = args[0]
    ver = args[1]
    num = args[2]
    vusb_config = ['vusb']
    vusb_config.append(['usb-ver', str(ver)])
    vusb_config.append(['num-ports', str(num)])
    port_config = ['port']
    for i in range(1, int(num) + 1):
        port_config.append(['%i' % i, ""])
    vusb_config.append(port_config)
    server.xend.domain.device_create(dom, vusb_config)

def detach(args, deviceClass):
    rm_cfg = True
    dom = args[0]
    dev = args[1]
    try:
        force = args[2]
        if (force != "--force") and (force != "-f"):
            print "Ignoring option %s"%(force)
            force = None
    except IndexError:
        force = None

    server.xend.domain.destroyDevice(dom, deviceClass, dev, force, rm_cfg)


def xm_block_detach(args):
    if serverType == SERVER_XEN_API:
        arg_check(args, "block-detach", 2, 3)
        dom = args[0]
        dev = args[1]
        vbd_refs = server.xenapi.VM.get_VBDs(get_single_vm(dom))
        vbd_refs = [vbd_ref for vbd_ref in vbd_refs
                    if server.xenapi.VBD.get_device(vbd_ref) == dev]
        if len(vbd_refs) > 0:
            vbd_ref = vbd_refs[0]
            vdi_ref = server.xenapi.VBD.get_VDI(vbd_ref)

            server.xenapi.VBD.destroy(vbd_ref)

            if len(server.xenapi.VDI.get_VBDs(vdi_ref)) <= 0:
                server.xenapi.VDI.destroy(vdi_ref)
        else:
            raise OptionError("Cannot find device '%s' in domain '%s'"
                              % (dev,dom))
    else:
        arg_check(args, 'block-detach', 2, 3)
        dom = args[0]
        dev = args[1]
        dc = server.xend.domain.getBlockDeviceClass(dom, dev)
        if dc == "tap2":
            detach(args, 'tap2')
        elif dc == "tap":
            detach(args, 'tap')
        else:
            detach(args, 'vbd')

def xm_network_detach(args):
    arg_check(args, "network-detach", 2, 3)
    dom = args[0]
    devid = args[1]
    if serverType == SERVER_XEN_API:
        vif_refs = server.xenapi.VM.get_VIFs(get_single_vm(dom))
        if len(devid.split(":")) == 6:
            mac = devid.lower()
            vif_refs = [vif_ref for vif_ref in vif_refs
                        if server.xenapi.VIF.\
                        get_record(vif_ref)["MAC"].lower() == mac]
        else:
            vif_refs = [vif_ref for vif_ref in vif_refs
                        if server.xenapi.VIF.\
                        get_runtime_properties(vif_ref)["handle"] == devid]

        if len(vif_refs) > 0:
            vif_ref = vif_refs[0]
            
            server.xenapi.VIF.destroy(vif_ref)
        else:
            raise OptionError("Cannot find device '%s' in domain '%s'" % (devid, dom))
    else:
        if len(devid.split(":")) == 6:
            mac = devid.lower()
            vifs = server.xend.domain.getDeviceSxprs(dom, "vif")
            devids = [vif[0] for vif in vifs
                      if parse_dev_info(vif[1])["mac"].lower() == mac]
            if len(devids) > 0:
                devid = str(devids[0])
            else:
                raise OptionError("Cannot find device '%s' in domain '%s'" % (devid, dom))

        vif_args = [dom, devid]
        try:
            vif_args.append(args[2])
        except IndexError:
            pass
        detach(vif_args, 'vif')

def find_attached(attached, key, detaching):
    l = filter(lambda dev: pci_dict_cmp(dev, key), attached)

    if detaching:
        if  len(l) == 0:
             raise OptionError("pci: device %s is not attached!" %\
                               pci_dict_to_bdf_str(key))
        # There shouldn't ever be more than one match,
        # but perhaps an exception should be thrown if there is
        return l[0]
    else:
        if len(l) == 1:
            raise  OptionError("pci: device %s has been attached! " %\
                               pci_dict_to_bdf_str(key))
        return None

def find_attached_devfn(attached, key):
    pci_dev = find_attached(attached, key, True)
    return pci_dev['vdevfn']

def xm_pci_detach(args):
    arg_check(args, 'pci-detach', 2)

    (dom, dev) = parse_pci_configuration(args)
    attached = attached_pci_dict(dom)

    attached_dev = map(lambda x: find_attached(attached, x, True), dev)

    def f(pci_dev):
        vdevfn = int(pci_dev['vdevfn'], 16)
        return PCI_SLOT(vdevfn) | (vdevfn & AUTO_PHP_SLOT)
    vdevfns = map(f, attached_dev)
    if len(set(vdevfns)) > 1:
        err_str = map(lambda x: "\t%s is in slot 0x%02x\n" %
                                (pci_dict_to_bdf_str(x),
                                 PCI_SLOT(int(x['vdevfn'], 16))), dev)
        raise OptionError("More than one slot used by specified devices\n"
                          + ''.join(err_str))

    attached_to_slot = filter(lambda x:
                              f(x) == vdevfns[0] and
                              attached_dev[0]["key"] ==
                                      x["key"], attached_dev)

    if len(attached_to_slot) != len(dev):
        err_str_ = map(lambda x: '\t%s\n' % pci_dict_to_bdf_str(x), dev)
        err_str = "Requested:\n" + ''.join(err_str_)
        err_str_ = map(lambda x: '\t%s (%s)\n' %
                       (pci_dict_to_bdf_str(x), x['key']),
                       attached_to_slot)
        err_str += "Present:\n" + ''.join(err_str_)
        raise OptionError(("Not all functions in slot 0x%02x have had "
                           "detachment requested.\n" % vdevfns[0]) + err_str)

    for i in dev:
        xm_pci_detach_one(dom, i)

def xm_pci_detach_one(dom, pci_dev):
    if serverType == SERVER_XEN_API:
        name = pci_dict_to_bdf_str(pci_dev)
        target_ref = None
        for dpci_ref in server.xenapi.VM.get_DPCIs(get_single_vm(dom)):
            ppci_ref = server.xenapi.DPCI.get_PPCI(dpci_ref)
            if name == server.xenapi.PPCI.get_name(ppci_ref):
                target_ref = ppci_ref
                server.xenapi.DPCI.destroy(dpci_ref)
                break
        if target_ref is None:
            raise OptionError("Device %s not assigned" % name)

    else:
        pci = pci_convert_dict_to_sxp(pci_dev, 'Closing')
        server.xend.domain.device_configure(dom, pci)

def xm_scsi_detach(args):
    arg_check(args, 'scsi-detach', 2)
    dom = args[0]
    v_hctl = args[1]
    scsi = parse_scsi_configuration(None, v_hctl, xenbusState['Closing'])

    if serverType == SERVER_XEN_API:

        target_ref = None
        for dscsi_ref in server.xenapi.VM.get_DSCSIs(get_single_vm(dom)):
            if v_hctl == server.xenapi.DSCSI.get_virtual_HCTL(dscsi_ref):
                target_ref = dscsi_ref
                break
        if target_ref is None:
            raise OptionError("Device %s not assigned" % v_hctl)

        target_HBA_ref = server.xenapi.DSCSI.get_HBA(target_ref)
        if server.xenapi.DSCSI_HBA.get_assignment_mode(target_HBA_ref) == "HOST":
            server.xenapi.DSCSI_HBA.destroy(target_HBA_ref)
        else:
            server.xenapi.DSCSI.destroy(target_ref)

    else:
        server.xend.domain.device_configure(dom, scsi)

def xm_usb_detach(args):
    xenapi_unsupported()
    arg_check(args, 'usb-detach', 3)
    dom = args[0]
    dev = args[1]
    port = args[2]
    usb = ['vusb', ['port', [port, '']]]
    server.xend.domain.device_configure(dom, usb, dev)

def xm_usb_hc_destroy(args):
    xenapi_unsupported()
    arg_check(args, 'usb-hc-destroy', 2)
    dom = args[0]
    dev = args[1]
    server.xend.domain.destroyDevice(dom, 'vusb', dev)

def xm_vnet_list(args):
    xenapi_unsupported()
    try:
        (options, params) = getopt.gnu_getopt(args, 'l', ['long'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('vnet-list')
    
    use_long = 0
    for (k, v) in options:
        if k in ['-l', '--long']:
            use_long = 1
            
    if params:
        use_long = 1
        vnets = params
    else:
        vnets = server.xend_vnets()
    
    for vnet in vnets:
        try:
            if use_long:
                info = server.xend_vnet(vnet)
                PrettyPrint.prettyprint(info)
            else:
                print vnet
        except Exception, ex:
            print vnet, ex

def xm_vnet_create(args):
    xenapi_unsupported()
    arg_check(args, "vnet-create", 1)
    conf = args[0]
    if not os.access(conf, os.R_OK):
        print "File not found: %s" % conf
        sys.exit(1)

    server.xend_vnet_create(conf)

def xm_vnet_delete(args):
    xenapi_unsupported()
    arg_check(args, "vnet-delete", 1)
    vnet = args[0]
    server.xend_vnet_delete(vnet)

def xm_network_new(args):
    xenapi_only()
    arg_check(args, "network-new", 1)
    network = args[0]

    record = {
        "name_label":       network,
        "name_description": "",
        "other_config":     {},
        "default_gateway":  "",
        "default_netmask":  ""
        }
    
    server.xenapi.network.create(record)
    
def xm_network_del(args):
    xenapi_only()
    arg_check(args, "network-del", 1)
    network = args[0]

    networks = dict([(record['name_label'], ref)
                     for ref, record in
                     server.xenapi.network.get_all_records().items()])

    if network not in networks.keys():
        raise ValueError("'%s' is not a valid network name" % network)
    
    server.xenapi.network.destroy(networks[network])

def xm_network_show(args):
    xenapi_only()
    arg_check(args, "network-show", 0)

    networks = server.xenapi.network.get_all_records()
    pifs     = server.xenapi.PIF.get_all_records()
    vifs     = server.xenapi.VIF.get_all_records()

    print '%-20s %-40s %-10s' % \
          ('Name', 'VIFs', 'PIFs')
    
    format2 = "%(name_label)-20s %(vif)-40s %(pif)-10s"

    for network_ref, network in networks.items():
        for i in range(max(len(network['PIFs']),
                           len(network['VIFs']), 1)):
            if i < len(network['PIFs']):
                pif_uuid = network['PIFs'][i]
            else:
                pif_uuid = None
                
            if i < len(network['VIFs']):
                vif_uuid = network['VIFs'][i]
            else:
                vif_uuid = None
                
            pif = pifs.get(pif_uuid, None) 
            vif = vifs.get(vif_uuid, None)

            if vif:
                dom_name = server.xenapi.VM.get_name_label(vif['VM'])
                vif = "%s.%s" % (dom_name, vif['device'])
            else:
                vif = '' 

            if pif:
                if int(pif['VLAN']) > -1:
                    pif = '%s.%s' % (pif['device'], pif['VLAN'])
                else:
                    pif = pif['device']
            else:
                pif = ''

            if i == 0:
                r = {'name_label':network['name_label'],
                     'vif':vif, 'pif':pif}
            else:
                r = {'name_label':'', 'vif':vif, 'pif':pif}

            print format2 % r

def xm_tmem_list(args):
    try:
        (options, params) = getopt.gnu_getopt(args, 'la', ['long','all'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('tmem-list')

    use_long = False
    for (k, v) in options:
        if k in ['-l', '--long']:
            use_long = True

    all = False
    for (k, v) in options:
        if k in ['-a', '--all']:
            all = True

    if not all and len(params) == 0:
        err('You must specify -a or --all or a domain id.')
        usage('tmem-list')

    if all:
        domid = -1
    else:
        try: 
            domid = int(params[0])
            params = params[1:]
        except:
            err('Unrecognized domain id: %s' % params[0])
            usage('tmem-list')

    if serverType == SERVER_XEN_API:
        print server.xenapi.host.tmem_list(domid,use_long)
    else:
        print  server.xend.node.tmem_list(domid,use_long)

def parse_tmem_args(args, name):
    try:
        (options, params) = getopt.gnu_getopt(args, 'a', ['all'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage(name)

    all = False
    for (k, v) in options:
        if k in ['-a', '--all']:
            all = True

    if not all and len(params) == 0:
        err('You must specify -a or --all or a domain id.')
        usage(name)

    if all:
        domid = -1
    else:
        try: 
            domid = int(params[0])
            params = params[1:]
        except:
            err('Unrecognized domain id: %s' % params[0])
            usage(name)

    return domid, params

def xm_tmem_destroy(args):
    (domid, _) = parse_tmem_args(args, 'tmem-destroy')
    if serverType == SERVER_XEN_API:
        server.xenapi.host.tmem_destroy(domid)
    else:
        server.xend.node.tmem_destroy(domid)

def xm_tmem_thaw(args):
    (domid, _) = parse_tmem_args(args, 'tmem-thaw')
    if serverType == SERVER_XEN_API:
        server.xenapi.host.tmem_thaw(domid)
    else:
        server.xend.node.tmem_thaw(domid)

def xm_tmem_freeze(args):
    (domid, _) = parse_tmem_args(args, 'tmem-freeze')
    if serverType == SERVER_XEN_API:
        server.xenapi.host.tmem_freeze(domid)
    else:
        server.xend.node.tmem_freeze(domid)

def xm_tmem_flush(args):
    try:
        (options, params) = getopt.gnu_getopt(args, 'a', ['all'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage(name)

    all = False
    for (k, v) in options:
        if k in ['-a', '--all']:
            all = True

    if not all and len(params) == 0:
        err('You must specify -a or --all or a domain id.')
        usage('tmem-flush')

    if all:
        domid = -1
    else:
        try: 
            domid = int(params[0])
            params = params[1:]
        except:
            err('Unrecognized domain id: %s' % params[0])
            usage('tmem-flush')

    pages = -1
    for (k, v) in options:
        if k in ['-p', '--pages']:
            pages = v

    if serverType == SERVER_XEN_API:
        server.xenapi.host.tmem_flush(domid,pages)
    else:
        server.xend.node.tmem_flush(domid,pages)

def xm_tmem_set(args):
    try:
        (options, params) = getopt.gnu_getopt(args, 'a', ['all'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage(name)

    all = False
    for (k, v) in options:
        if k in ['-a', '--all']:
            all = True

    if not all and len(params) == 0:
        err('You must specify -a or --all or a domain id.')
        usage('tmem-set')

    if all:
        domid = -1
    else:
        try: 
            domid = int(params[0])
            params = params[1:]
        except:
            err('Unrecognized domain id: %s' % params[0])
            usage('tmem-set')

    weight = None
    cap = None
    compress = None
    for item in params:
        if item.startswith('weight='):
            try:
                weight = int(item[7:])
            except:
                err('weight should be a integer')
                usage('tmem-set')
        if item.startswith('cap='):
            cap = int(item[4:])
        if item.startswith('compress='):
            compress = int(item[9:])

    if weight is None and cap is None and compress is None:
        err('Unrecognized tmem configuration option: %s' % item)
        usage('tmem-set')
        
    if serverType == SERVER_XEN_API:
        if weight is not None:
            server.xenapi.host.tmem_set_weight(domid, weight)
        if cap is not None:
            server.xenapi.host.tmem_set_cap(domid, cap)
        if compress is not None:
            server.xenapi.host.tmem_set_compress(domid, compress)
    else:
        if weight is not None:
            server.xend.node.tmem_set_weight(domid, weight)
        if cap is not None:
            server.xend.node.tmem_set_cap(domid, cap)
        if compress is not None:
            server.xend.node.tmem_set_compress(domid, compress)

def xm_tmem_freeable_mb(args):
    if serverType == SERVER_XEN_API:
        print server.xenapi.host.tmem_query_freeable_mb()
    else:
        print server.xend.node.tmem_query_freeable_mb()

def xm_tmem_shared_auth(args):
    try:
        (options, params) = getopt.gnu_getopt(args, 'au:A:', ['all','uuid=','auth='])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('tmem-shared-auth')

    all = False
    for (k, v) in options:
        if k in ['-a', '--all']:
            all = True

    if not all and len(params) == 0:
        err('You must specify -a or --all or a domain id.')
        usage('tmem-shared-auth')

    if all:
        domid = -1
    else:
        try: 
            domid = int(params[0])
            params = params[1:]
        except:
            err('Unrecognized domain id: %s' % params[0])
            usage('tmem-shared-auth')

    for (k, v) in options:
        if k in ['-u', '--uuid']:
             uuid_str = v

    auth = 0
    for (k, v) in options:
        if k in ['-A', '--auth']:
            auth = v

    if serverType == SERVER_XEN_API:
        return server.xenapi.host.tmem_shared_auth(domid,uuid_str,auth)
    else:
        return server.xend.node.tmem_shared_auth(domid,uuid_str,auth)

def get_cpupool_ref(name):
    refs = server.xenapi.cpu_pool.get_by_name_label(name)
    if len(refs) > 0:
        return refs[0]
    else:
        err('unknown pool name')
        sys.exit(1)

def xm_cpupool_start(args):
    arg_check(args, "cpupool-start", 1)
    if serverType == SERVER_XEN_API:
        ref = get_cpupool_ref(args[0])
        server.xenapi.cpu_pool.activate(ref)
    else:
        server.xend.cpu_pool.start(args[0])

def brief_cpupool_list(sxprs):
    format_str = "%-16s   %3s  %8s       %s          %s"
    for sxpr in sxprs:
        if sxpr == sxprs[0]:
            print "Name               CPUs   Sched     Active   Domain count"
        record = sxp2map(sxpr)
        name = record['name_label']
        sched_policy = record['sched_policy']
        if record['activated']:
            cpus = record.get('host_CPU_numbers', [])
            vms = record.get('started_VM_names', [])
            if not isinstance(cpus, types.ListType):
                cpus = [cpus]
            if not isinstance(vms, types.ListType):
                vms = [vms]
            cpu_count = len(cpus)
            vm_count  = len(vms)
            active = 'y'
        else:
            cpu_count = record['ncpu']
            vm_count  = 0
            active = 'n'
        print format_str % (name, cpu_count, sched_policy, active, vm_count)

def brief_cpupool_list_cpus(sxprs):
    format_str = "%-16s %s"
    for sxpr in sxprs:
        if sxpr == sxprs[0]:
            print format_str % ("Name", "CPU list")
        record = sxp2map(sxpr)
        name = record['name_label']
        cpus = ""
        if record['activated']:
            cpus = record.get('host_CPU_numbers', [])
            if isinstance(cpus, types.ListType):
                cpus.sort()
                cpus = reduce(lambda x,y: x + "%s," % y, cpus, "")
                cpus = cpus[0:len(cpus)-1]
            else:
                cpus = str(cpus)
        if len(cpus) == 0:
            cpus = "-"
        print format_str % (name, cpus)

def xm_cpupool_list(args):
    arg_check(args, "cpupool-list", 0, 2)
    try:
        (options, params) = getopt.gnu_getopt(args, 'lc', ['long','cpus'])
    except getopt.GetoptError, opterr:
        err(opterr)
        usage('cpupool-list')
    if len(params) > 1:
        err("Only one cpupool name for selection allowed")
        usage('cpupool-list')

    use_long = False
    show_cpus = False
    for (k, _) in options:
        if k in ['-l', '--long']:
            use_long = True
        if k in ['-c', '--cpus']:
            show_cpus = True

    if serverType == SERVER_XEN_API:
        pools = server.xenapi.cpu_pool.get_all_records()
        cpu_recs = server.xenapi.host_cpu.get_all_records()
        sxprs = []
        for pool in pools.values():
            if pool['name_label'] in params or len(params) == 0:
                started_VM_names = [['started_VM_names'] + [
                    server.xenapi.VM.get_name_label(started_VM)
                    for started_VM in pool['started_VMs'] ] ]
                host_CPU_numbers = [['host_CPU_numbers'] + [
                    cpu_recs[cpu_ref]['number']
                    for cpu_ref in pool['host_CPUs'] ] ]
                sxpr = [ pool['uuid'] ] + map_to_sxp(pool) + \
                    host_CPU_numbers + started_VM_names
                sxprs.append(sxpr)
    else:
        sxprs = server.xend.cpu_pool.list(params)

    if len(params) > 0 and len(sxprs) == 0:
        # pool not found
        err("Pool '%s' does not exist." % params[0])

    if use_long:
        for sxpr in sxprs:
            PrettyPrint.prettyprint(sxpr)
    elif show_cpus:
        brief_cpupool_list_cpus(sxprs)
    else:
        brief_cpupool_list(sxprs)

def xm_cpupool_destroy(args):
    arg_check(args, "cpupool-destroy", 1)
    if serverType == SERVER_XEN_API:
        ref = get_cpupool_ref(args[0])
        server.xenapi.cpu_pool.deactivate(ref)
    else:
        server.xend.cpu_pool.destroy(args[0])

def xm_cpupool_delete(args):
    arg_check(args, "cpupool-delete", 1)
    if serverType == SERVER_XEN_API:
        ref = get_cpupool_ref(args[0])
        server.xenapi.cpu_pool.destroy(ref)
    else:
        server.xend.cpu_pool.delete(args[0])

def xm_cpupool_cpu_add(args):
    arg_check(args, "cpupool-cpu-add", 2)
    if serverType == SERVER_XEN_API:
        ref = get_cpupool_ref(args[0])
        cpu_ref_list = server.xenapi.host_cpu.get_all_records()
        cpu_ref = [ c_rec['uuid'] for c_rec in cpu_ref_list.values()
                                  if c_rec['number'] == args[1] ]
        if len(cpu_ref) == 0:
            err('cpu number unknown')
        else:
            server.xenapi.cpu_pool.add_host_CPU_live(ref, cpu_ref[0])
    else:
        server.xend.cpu_pool.cpu_add(args[0], args[1])

def xm_cpupool_cpu_remove(args):
    arg_check(args, "cpupool-cpu-remove", 2)
    if serverType == SERVER_XEN_API:
        ref = get_cpupool_ref(args[0])
        cpu_ref_list = server.xenapi.host_cpu.get_all_records()
        cpu_ref = [ c_rec['uuid'] for c_rec in cpu_ref_list.values()
                                  if c_rec['number'] ==  args[1] ]
        if len(cpu_ref) == 0:
            err('cpu number unknown')
        else:
            server.xenapi.cpu_pool.remove_host_CPU_live(ref, cpu_ref[0])
    else:
        server.xend.cpu_pool.cpu_remove(args[0], args[1])

def xm_cpupool_migrate(args):
    arg_check(args, "cpupool-migrate", 2)
    domname = args[0]
    poolname = args[1]
    if serverType == SERVER_XEN_API:
        pool_ref = get_cpupool_ref(poolname)
        server.xenapi.VM.cpu_pool_migrate(get_single_vm(domname), pool_ref)
    else:
        server.xend.cpu_pool.migrate(domname, poolname)


commands = {
    "shell": xm_shell,
    "event-monitor": xm_event_monitor,
    # console commands
    "console": xm_console,
    "vncviewer": xm_vncviewer,
    # xenstat commands
    "top": xm_top,
    # domain commands
    "delete": xm_delete,
    "destroy": xm_destroy,
    "domid": xm_domid,
    "domname": xm_domname,
    "dump-core": xm_dump_core,
    "reboot": xm_reboot,
    "rename": xm_rename,
    "reset": xm_reset,
    "restore": xm_restore,
    "resume": xm_resume,
    "save": xm_save,
    "shutdown": xm_shutdown,
    "start": xm_start,
    "sysrq": xm_sysrq,
    "trigger": xm_trigger,
    "uptime": xm_uptime,
    "suspend": xm_suspend,
    "list": xm_list,
    # memory commands
    "mem-max": xm_mem_max,
    "mem-set": xm_mem_set,
    # cpu commands
    "vcpu-pin": xm_vcpu_pin,
    "vcpu-list": xm_vcpu_list,
    "vcpu-set": xm_vcpu_set,
    # special
    "pause": xm_pause,
    "unpause": xm_unpause,
    # host commands
    "debug-keys": xm_debug_keys,
    "dmesg": xm_dmesg,
    "info": xm_info,
    "log": xm_log,
    "serve": xm_serve,
    # scheduler
    "sched-sedf": xm_sched_sedf,
    "sched-credit": xm_sched_credit,
    "sched-credit2": xm_sched_credit2,
    # block
    "block-attach": xm_block_attach,
    "block-detach": xm_block_detach,
    "block-list": xm_block_list,
    "block-configure": xm_block_configure,
    # network (AKA vifs)
    "network-attach": xm_network_attach,
    "network-detach": xm_network_detach,
    "network-list": xm_network_list,
    "network2-attach": xm_network2_attach,
    "network2-detach": xm_network2_detach,
    "network2-list": xm_network2_list,
    # network (as in XenAPI)
    "network-new": xm_network_new,
    "network-del": xm_network_del,
    "network-show": xm_network_show,
    # vnet
    "vnet-list": xm_vnet_list,
    "vnet-create": xm_vnet_create,
    "vnet-delete": xm_vnet_delete,
    # vtpm
    "vtpm-list": xm_vtpm_list,
    #pci
    "pci-attach": xm_pci_attach,
    "pci-detach": xm_pci_detach,
    "pci-list": xm_pci_list,
    "pci-list-assignable-devices": xm_pci_list_assignable_devices,
    # vscsi
    "scsi-attach": xm_scsi_attach,
    "scsi-detach": xm_scsi_detach,
    "scsi-list": xm_scsi_list,
    # vusb
    "usb-attach": xm_usb_attach,
    "usb-detach": xm_usb_detach,
    "usb-list": xm_usb_list,
    "usb-list-assignable-devices": xm_usb_list_assignable_devices,
    "usb-hc-create": xm_usb_hc_create,
    "usb-hc-destroy": xm_usb_hc_destroy,
    # cpupool
    "cpupool-start": xm_cpupool_start,
    "cpupool-list": xm_cpupool_list,
    "cpupool-destroy": xm_cpupool_destroy,
    "cpupool-delete": xm_cpupool_delete,
    "cpupool-cpu-add": xm_cpupool_cpu_add,
    "cpupool-cpu-remove": xm_cpupool_cpu_remove,
    "cpupool-migrate": xm_cpupool_migrate,
    # tmem
    "tmem-thaw": xm_tmem_thaw,
    "tmem-freeze": xm_tmem_freeze,
    "tmem-flush": xm_tmem_flush,
    "tmem-destroy": xm_tmem_destroy,
    "tmem-list": xm_tmem_list,
    "tmem-set": xm_tmem_set,
    "tmem-freeable": xm_tmem_freeable_mb,
    "tmem-shared-auth": xm_tmem_shared_auth,
    #usb
    "usb-add": xm_usb_add,
    "usb-del": xm_usb_del,
    #domstate
    "domstate": xm_domstate,
    }

## The commands supported by a separate argument parser in xend.xm.
IMPORTED_COMMANDS = [
    'create',
    'new',    
    'migrate',
    'labels',
    'dumppolicy',        
    'addlabel',
    'rmlabel',
    'getlabel',
    'dry-run',
    'resources',
    'getpolicy',
    'setpolicy',
    'resetpolicy',
    'getenforce',
    'setenforce',
    'cpupool-create',
    'cpupool-new',
    ]

for c in IMPORTED_COMMANDS:
    commands[c] = eval('lambda args: xm_importcommand("%s", args)' % c)

aliases = {
    "balloon": "mem-set",
    "pool-create": "cpupool-create",
    "pool-new": "cpupool-new",
    "pool-start": "cpupool-start",
    "pool-list": "cpupool-list",
    "pool-destroy": "cpupool-destroy",
    "pool-delete": "cpupool-delete",
    "pool-cpu-add": "cpupool-cpu-add",
    "pool-cpu-remove": "cpupool-cpu-remove",
    "pool-migrate": "cpupool-migrate",
    "set-vcpus": "vcpu-set",
    "vif-list": "network-list",
    "vbd-create": "block-attach",
    "vbd-destroy": "block-detach",
    "vbd-list": "block-list",
    }


def xm_lookup_cmd(cmd):
    if commands.has_key(cmd):
        return commands[cmd]
    elif aliases.has_key(cmd):
        deprecated(cmd,aliases[cmd])
        return commands[aliases[cmd]]
    elif cmd == 'help':
        longHelp()
        sys.exit(0)
    else:
        # simulate getopt's prefix matching behaviour
        if len(cmd) > 1:
            same_prefix_cmds = [commands[c] for c in commands.keys() \
                                if c[:len(cmd)] == cmd]
            # only execute if there is only 1 match
            if len(same_prefix_cmds) == 1:
                return same_prefix_cmds[0]
        return None

def deprecated(old,new):
    print >>sys.stderr, (
        "Command %s is deprecated.  Please use xm %s instead." % (old, new))

def main(argv=sys.argv):
    if len(argv) < 2:
        usage()

    # intercept --help(-h) and output our own help
    for help in ['--help', '-h']:
        if help in argv[1:]:
            if help == argv[1]:
                longHelp()
                sys.exit(0)
            else:
                usage(argv[1])

    cmd_name = argv[1]
    cmd = xm_lookup_cmd(cmd_name)
    if cmd:
        # strip off prog name and subcmd
        args = argv[2:]
        _, rc = _run_cmd(cmd, cmd_name, args)
        sys.exit(rc)
    else:
        err('Subcommand %s not found!' % cmd_name)
        usage()

def _run_cmd(cmd, cmd_name, args):
    global server

    try:
        if server is None:
            if serverType == SERVER_XEN_API:
                server = XenAPI.Session(serverURI)
                username, password = parseAuthentication()
                server.login_with_password(username, password)
                def logout():
                    try:
                        server.xenapi.session.logout()
                    except:
                        pass
                atexit.register(logout)
            else:
                server = ServerProxy(serverURI)

        return True, cmd(args)
    except socket.error, ex:
        if os.geteuid() != 0:
            err("Most commands need root access. Please try again as root.")
        else:
            err("Unable to connect to xend: %s. Is xend running?" % ex[1])
    except KeyboardInterrupt:
        print "Interrupted."
        return True, ''
    except IOError, ex:
        if os.geteuid() != 0:
            err("Most commands need root access.  Please try again as root.")
        else:
            err("Unable to connect to xend: %s." % ex[1])
    except SystemExit, code:
        return code == 0, code
    except XenAPI.Failure, exn:
        for line in [''] + wrap(str(exn), 80) + ['']:
            print >>sys.stderr, line
    except xmlrpclib.Fault, ex:
        if ex.faultCode == XendClient.ERROR_INVALID_DOMAIN:
            err("Domain '%s' does not exist." % ex.faultString)
            return False, ex.faultCode
        else:
            err(ex.faultString)
            _usage(cmd_name)
    except xmlrpclib.ProtocolError, ex:
        if ex.errcode == -1:
            print  >>sys.stderr, (
                "Xend has probably crashed!  Invalid or missing HTTP "
                "status code.")
        else:
            print  >>sys.stderr, (
                "Xend has probably crashed!  ProtocolError(%d, %s)." %
                (ex.errcode, ex.errmsg))
    except (ValueError, OverflowError):
        err("Invalid argument.")
        _usage(cmd_name)
    except OptionError, e:
        err(str(e))
        _usage(cmd_name)
        print e.usage
    except XenAPIUnsupportedException, e:
        err(str(e))
    except XSMError, e:
        err(str(e))
    except Exception, e:
        if serverType != SERVER_XEN_API:
           import xen.util.xsm.xsm as security
           if isinstance(e, security.XSMError):
               err(str(e))
               return False, 1
        print "Unexpected error:", sys.exc_info()[0]
        print
        print "Please report to xen-devel@lists.xensource.com"
        raise

    return False, 1

if __name__ == "__main__":
    main()
