File:  [NetBSD Developer Wiki] / wikisrc / ports / xen / howto.mdwn
Revision 1.136: download - view: text, annotated - select for diffs
Wed Dec 21 17:03:03 2016 UTC (2 years, 11 months ago) by gdt
Branches: MAIN
CVS tags: HEAD
Advise staying up to date

Mention the 2016-12 ubuntu/46 fix.

    1: Introduction
    2: ============
    3: 
    4: [![[Xen
    5: screenshot]](http://www.netbsd.org/gallery/in-Action/hubertf-xens.png)](http://www.netbsd.org/gallery/in-Action/hubertf-xen.png)
    6: 
    7: Xen is a hypervisor (or virtual machine monitor) for x86 hardware
    8: (i686-class or higher), which supports running multiple guest
    9: operating systems on a single physical machine.  Xen is a Type 1 or
   10: bare-metal hypervisor; one uses the Xen kernel to control the CPU,
   11: memory and console, a dom0 operating system which mediates access to
   12: other hardware (e.g., disks, network, USB), and one or more domU
   13: operating systems which operate in an unprivileged virtualized
   14: environment.  IO requests from the domU systems are forwarded by the
   15: hypervisor (Xen) to the dom0 to be fulfilled.
   16: 
   17: Xen supports two styles of guests.  The original is Para-Virtualized
   18: (PV) which means that the guest OS does not attempt to access hardware
   19: directly, but instead makes hypercalls to the hypervisor.  This is
   20: analogous to a user-space program making system calls.  (The dom0
   21: operating system uses PV calls for some functions, such as updating
   22: memory mapping page tables, but has direct hardware access for disk
   23: and network.)   PV guests must be specifically coded for Xen.
   24: 
   25: The more recent style is HVM, which means that the guest does not have
   26: code for Xen and need not be aware that it is running under Xen.
   27: Attempts to access hardware registers are trapped and emulated.  This
   28: style is less efficient but can run unmodified guests.
   29: 
   30: Generally any machine that runs NetBSD/amd64 will work with Xen and PV
   31: guests.  In theory i386 computers (without x86_64/amd64 support) can
   32: be used for Xen <= 4.2, but we have no recent reports of this working
   33: (this is a hint).  For HVM guests, hardware support is needed, but it
   34: is common on recent machines.  For Intel CPUs, one needs the VT-x
   35: extension, shown in "cpuctl identify 0" as VMX.  For AMD CPUs, one
   36: needs the AMD-V extensions, shown in "cpuctl identify 0" as SVM.
   37: There are further features for IOMMU virtualization, Intel's VT-d and
   38: AMD's AMD-Vi.  TODO: Explain whether Xen on NetBSD makes use of these
   39: features.  TODO: Review by someone who really understands this.
   40: 
   41: Note that a FreeBSD dom0 requires VT-x and VT-d (or equivalent); this
   42: is because the FreeBSD dom0 does not run in PV mode.
   43: 
   44: At boot, the dom0 kernel is loaded as a module with Xen as the kernel.
   45: The dom0 can start one or more domUs.  (Booting is explained in detail
   46: in the dom0 section.)
   47: 
   48: NetBSD supports Xen in that it can serve as dom0, be used as a domU,
   49: and that Xen kernels and tools are available in pkgsrc.  This HOWTO
   50: attempts to address both the case of running a NetBSD dom0 on hardware
   51: and running domUs under it (NetBSD and other), and also running NetBSD
   52: as a domU in a VPS.
   53: 
   54: Xen 3.1 in pkgsrc supports "PCI passthrough", which means that
   55: specific PCI devices can be made available to a specific domU instead
   56: of the dom0.  This can be useful to let a domU run X11, or access some
   57: network interface or other peripheral.
   58: 
   59: NetBSD 6 and earlier supported Xen 2; support was removed from NetBSD
   60: 7.  Xen 2 has been removed from pkgsrc.
   61: 
   62: Prerequisites
   63: -------------
   64: 
   65: Installing NetBSD/Xen is not extremely difficult, but it is more
   66: complex than a normal installation of NetBSD.
   67: In general, this HOWTO is occasionally overly restrictive about how
   68: things must be done, guiding the reader to stay on the established
   69: path when there are no known good reasons to stray.
   70: 
   71: This HOWTO presumes a basic familiarity with the Xen system
   72: architecture, with installing NetBSD on i386/amd64 hardware, and with
   73: installing software from pkgsrc.  See also the [Xen
   74: website](http://www.xenproject.org/).
   75: 
   76: Versions of Xen and NetBSD
   77: ==========================
   78: 
   79: Most of the installation concepts and instructions are independent
   80: of Xen version and NetBSD version.  This section gives advice on
   81: which version to choose.  Versions not in pkgsrc and older unsupported
   82: versions of NetBSD are intentionally ignored.
   83: 
   84: The term "amd64" is used to refer to both the NetBSD port and to the
   85: hardware architecture on which it runs.  (Such hardware is made by
   86: both Intel and AMD, and in 2016 a normal PC has this CPU
   87: architecture.)
   88: 
   89: Xen
   90: ---
   91: 
   92: In NetBSD, Xen is provided in pkgsrc, via matching pairs of packages
   93: xenkernel and xentools.  We will refer only to the kernel versions,
   94: but note that both packages must be installed together and must have
   95: matching versions.
   96: 
   97: xenkernel3 provides Xen 3.1.  It is no longer maintained by Xen, and
   98: the last applied security patch was in 2011. Thus, it should not be
   99: used.  It supports PCI passthrough, which is why people use it anyway.
  100: Xen 3.1 runs on i386 (both non-PAE and PAE) and amd64 hardware.
  101: 
  102: xenkernel33 provides Xen 3.3.  It is no longer maintained by Xen, and
  103: the last applied security patch was in 2012.  Thus, it should not be
  104: used.  Xen 3.3 runs on i386 PAE and amd64 hardware.  There are no good
  105: reasons to run this version.
  106: 
  107: xenkernel41 provides Xen 4.1.  It is no longer maintained by Xen, but
  108: as of 2016-12 received backported security patches.  Xen 4.1 runs on
  109: i386 PAE and amd64 hardware.  There are no good reasons to run this
  110: version.
  111: 
  112: xenkernel42 provides Xen 4.2.  It is no longer maintained by Xen, but
  113: as of 2016-12 received backported security patches.  Xen 4.2 runs on
  114: i386 PAE and amd64 hardware.  The only reason to run this is if you
  115: need to use xm instead of xl, or if you need to run on hardware that
  116: supports i386 but not amd64.  (This might also be useful if you need
  117: an i386 dom0, if it turns out that an amd64 Xen kernel and an i386
  118: dom0 is problematic.)
  119: 
  120: xenkernel45 provides Xen 4.5.  As of 2016-12, security patches were
  121: released by Xen and applied to pkgsrc.  Xen 4.5 runs on amd64 hardware
  122: only.  While slightly old, 4.5 has been tested and run by others, so
  123: it is the conservative choice.
  124: 
  125: xenkernel46 provides Xen 4.6.  It is new to pkgsrc as of 2016-05.  As
  126: of 2016-12, security patches were released by Xen and applied to
  127: pkgsrc.  Xen 4.6 runs on amd64 hardware only For new installations,
  128: 4.6 is probably the appropriate choice and it will likely soon be the
  129: standard approach.  (If using Ubuntu guests, be sure to have the
  130: xentools46 from December, 2016).
  131: 
  132: Xen 4.7 (released 2016-06) and 4.8 (released 2016-12) are not yet in
  133: pkgsrc.
  134: 
  135: See also the [Xen Security Advisory page](http://xenbits.xen.org/xsa/).
  136: 
  137: Note that NetBSD support is called XEN3.  It works with Xen 3 and Xen
  138: 4 because the hypercall interface has been stable.
  139: 
  140: Xen command program
  141: -------------------
  142: 
  143: Early Xen used a program called xm to manipulate the system from the
  144: dom0.  Starting in 4.1, a replacement program with similar behavior
  145: called xl is provided, but it does not work well in 4.1.  In 4.2, both
  146: xm and xl work fine.  4.4 is the last version that has xm.
  147: 
  148: You must make a global choice to use xm or xl, because it affects not
  149: only which command you use, but the command used by rc.d scripts
  150: (specifically xendomains) and which daemons should be run.  The
  151: xentools packages provide xm for 3.1, 3.3 and 4.1 and xl for 4.2 and up.
  152: 
  153: In 4.2, you can choose to use xm by simply changing the ctl_command
  154: variable and setting xend=YES in rc.conf.
  155: 
  156: With xl, virtual devices are configured in parallel, which can cause
  157: problems if they are written assuming serial operation (e.g., updating
  158: firewall rules without explicit locking).  There is now locking for
  159: the provided scripts, which works for normal casses (e.g, file-backed
  160: xbd, where a vnd must be allocated).  But, as of 201612, it has not
  161: been adequately tested for a complex custom setup with a large number
  162: of interfaces.
  163: 
  164: NetBSD
  165: ------
  166: 
  167: The netbsd-6, netbsd-7, and -current branches are all reasonable
  168: choices, with more or less the same considerations for non-Xen use.
  169: Therefore, netbsd-7 is recommended as the stable version of the most
  170: recent release for production use.  In addition, netbsd-7 and -current
  171: have a important scheduler fix (in November of 2015) affecting
  172: contention between dom0 and domUs; see
  173: https://releng.netbsd.org/cgi-bin/req-7.cgi?show=1040 for a
  174: description.  For those wanting to learn Xen or without production
  175: stability concerns, netbsd-7 is still likely most appropriate, but
  176: -current is also a reasonable choice.  (Xen runs ok on netbsd-5, but
  177: the xentools packages are likely difficult to build, and netbsd-5 is
  178: not supported.)
  179: 
  180: As of NetBSD 6, a NetBSD domU will support multiple vcpus.  There is
  181: no SMP support for NetBSD as dom0.  (The dom0 itself doesn't really
  182: need SMP for dom0 functions; the lack of support is really a problem
  183: when using a dom0 as a normal computer.)
  184: 
  185: Architecture
  186: ------------
  187: 
  188: Xen itself can run on i386 (Xen < 4.2) or amd64 hardware (all Xen
  189: versions).  (Practically, almost any computer where one would want to
  190: run Xen today supports amd64.)
  191: 
  192: Xen, the dom0 system, and each domU system can be either i386 or
  193: amd64.  When building a xenkernel package, one obtains an i386 Xen
  194: kernel on an i386 host, and an amd64 Xen kernel on an amd64 host.  If
  195: the Xen kernel is i386, then the dom0 kernel and all domU kernels must
  196: be i386.  With an amd64 Xen kernel, an amd64 dom0 kernel is known to
  197: work, and an i386 dom0 kernel should in theory work.  An amd64
  198: Xen/dom0 is known to support both i386 and amd64 domUs.
  199: 
  200: i386 dom0 and domU kernels must be PAE (except for an i386 Xen 3.1
  201: kernel, where one can use non-PAE for dom0 and all domUs); PAE kernels
  202: are included in the NetBSD default build.  (Note that emacs (at least)
  203: fails if run on i386 with PAE when built without, and vice versa,
  204: presumably due to bugs in the undump code.)
  205: 
  206: Because of the above, the standard approach is to use an amd64 Xen
  207: kernel and NetBSD/amd64 for the dom0.  For domUs, NetBSD/i386 (with
  208: the PAE kernel) and NetBSD/amd64 are in widespread use, and there is
  209: little to no Xen-specific reason to prefer one over the other.
  210: 
  211: Note that to use an i386 dom0 with Xen 4.5 or higher, one must build
  212: (or obtain from pre-built packages) an amd64 Xen kernel and install
  213: that on the system.  (One must also use a PAE i386 kernel, but this is
  214: also required with an i386 Xen kernel.).  Almost no one in the
  215: NetBSD/Xen community does this, and the standard, well-tested,
  216: approach is to use an amd64 dom0.
  217: 
  218: A [posting on
  219: xen-devel](https://lists.xen.org/archives/html/xen-devel/2012-07/msg00085.html)
  220: explained that PV system call overhead was higher on amd64, and thus
  221: there is some notion that i386 guests are faster.  It goes on to
  222: caution that the total situation is complex and not entirely
  223: understood. On top of that caution, the post is about Linux, not
  224: NetBSD.  TODO: Include link to benchmarks, if someone posts them.
  225: 
  226: Stability
  227: ---------
  228: 
  229: Mostly, NetBSD as a dom0 or domU is quite stable.
  230: However, there are some open PRs indicating problems.
  231: 
  232:  - [PR 48125](http://gnats.netbsd.org/48125)
  233:  - [PR 47720](http://gnats.netbsd.org/47720)
  234: 
  235: Note also that there are issues with sparse vnd(4) instances, but
  236: these are not about Xen -- they just are noticed with sparse vnd(4)
  237: instances in support of virtual disks in a dom0.
  238: 
  239: Recommendation
  240: --------------
  241: 
  242: Therefore, this HOWTO recommends running xenkernel45 or xenkernel46,
  243: xl, the NetBSD 7 stable branch, and to use an amd64 kernel as the
  244: dom0.  Either the i386PAE or amd64 version of NetBSD may be used as
  245: domUs.
  246: 
  247: Because bugs are fixed quite often, and because of Xen security
  248: advisories, it is good to stay up to date with NetBSD (tracking a
  249: stable branch), with the Xen kernel (tracking a Xen version via
  250: pkgsrc), and with the Xen tools.  Specifically, NetBSD (-7 and
  251: -current) got an important fix affecting dom0/domU timesharing in
  252: November, 2015, and xentools46 got a fix to enable Ubuntu guests to
  253: boot in December, 2016.
  254: 
  255: Status
  256: ------
  257: 
  258: Ideally, all versions of Xen in pkgsrc would build on all supported
  259: versions of NetBSD/amd64, to the point where this section would be
  260: silly.  However, that has not always been the case.  Besides aging
  261: code and aging compilers, qemu (included in xentools for HVM support)
  262: is difficult to build.  Note that there is intentionally no data for
  263: 4.5+ up for i386, and often omits xentools info if the corresponding
  264: kernel fails.
  265: 
  266: The following table gives status, with the date last checked
  267: (generally on the most recent quarterly branch).  The first code is
  268: "builds" if it builds ok, and "FAIL" for a failure to build.  The
  269: second code/date only appears for xenkernel* and is "works" if it runs
  270: ok as a dom0 and can support a domU, and "FAIL" if it won't boot or
  271: run a domU.
  272: 
  273: 	xenkernel3 netbsd-6 i386 FAIL 201612
  274: 	xenkernel33 netbsd-6 i386 FAIL 201612
  275: 	xenkernel41 netbsd-6 i386 builds 201612
  276: 	xenkernel42 netbsd-6 i386 builds 201612
  277: 	xentools3 netbsd-6 i386 FAIL 201612
  278: 	xentools33 netbsd-6 i386 FAIL 201612
  279: 	xentools41 netbsd-6 i386 builds 201612
  280: 	xentools42 netbsd-6 i386 FAIL 201612
  281: 
  282: 	xenkernel3 netbsd-7 i386 FAIL 201412
  283: 	xenkernel33 netbsd-7 i386 FAIL 201412
  284: 	xenkernel41 netbsd-7 i386 builds 201412
  285: 	xenkernel42 netbsd-7 i386 builds 201412
  286: 	xentools41 netbsd-7 i386 builds 201412
  287: 	xentools42 netbsd-7 i386 ??FAIL 201412
  288: 
  289: 	xenkernel3 netbsd-6 amd64 FAIL 201612
  290: 	xenkernel33 netbsd-6 amd64 FAIL 201612
  291: 	xenkernel41 netbsd-6 amd64 builds 201612 works 201612
  292: 	xenkernel42 netbsd-6 amd64 builds 201612 works 201612
  293: 	xenkernel45 netbsd-6 amd64 builds 201612
  294: 	xenkernel46 netbsd-6 amd64 builds 201612
  295: 	xentools41 netbsd-6 amd64 builds 201612
  296: 	xentools42 netbsd-6 amd64 builds 201612
  297: 	xentools45 netbsd-6 amd64 builds 201612
  298: 	xentools46 netbsd-6 amd64 FAIL 201612
  299: 
  300: 	xenkernel3 netbsd-7 amd64 builds 201612
  301: 	xenkernel33 netbsd-7 amd64 builds 201612
  302: 	xenkernel41 netbsd-7 amd64 builds 201612
  303: 	xenkernel42 netbsd-7 amd64 builds 201612
  304: 	xenkernel45 netbsd-7 amd64 builds 201612
  305: 	xenkernel46 netbsd-7 amd64 builds 201612
  306: 	xentools3 netbsd-7 amd64 builds 201612
  307: 	xentools3-hvm netbsd-7 amd64 builds 201612
  308: 	xentools33 netbsd-7 amd64 FAIL 201612
  309: 	xentools41 netbsd-7 amd64 builds 201612
  310: 	xentools42 netbsd-7 amd64 builds 201612
  311: 	xentools45 netbsd-7 amd64 builds 201612
  312: 	xentools46 netbsd-7 amd64 builds 201612
  313: 
  314: NetBSD as a dom0
  315: ================
  316: 
  317: NetBSD can be used as a dom0 and works very well.  The following
  318: sections address installation, updating NetBSD, and updating Xen.
  319: Note that it doesn't make sense to talk about installing a dom0 OS
  320: without also installing Xen itself.  We first address installing
  321: NetBSD, which is not yet a dom0, and then adding Xen, pivoting the
  322: NetBSD install to a dom0 install by just changing the kernel and boot
  323: configuration.
  324: 
  325: For experimenting with Xen, a machine with as little as 1G of RAM and
  326: 100G of disk can work.  For running many domUs in productions, far
  327: more will be needed; e.g. 4-8G and 1T of disk is reasonable for a
  328: half-dozen domUs of 512M and 32G each.  Basically, the RAM and disk
  329: have to be bigger than the sum of the RAM/disk needs of the dom0 and
  330: all the domUs.
  331: 
  332: Styles of dom0 operation
  333: ------------------------
  334: 
  335: There are two basic ways to use Xen.  The traditional method is for
  336: the dom0 to do absolutely nothing other than providing support to some
  337: number of domUs.  Such a system was probably installed for the sole
  338: purpose of hosting domUs, and sits in a server room on a UPS.
  339: 
  340: The other way is to put Xen under a normal-usage computer, so that the
  341: dom0 is what the computer would have been without Xen, perhaps a
  342: desktop or laptop.  Then, one can run domUs at will.  Purists will
  343: deride this as less secure than the previous approach, and for a
  344: computer whose purpose is to run domUs, they are right.  But Xen and a
  345: dom0 (without domUs) is not meaningfully less secure than the same
  346: things running without Xen.  One can boot Xen or boot regular NetBSD
  347: alternately with little problems, simply refraining from starting the
  348: Xen daemons when not running Xen.
  349: 
  350: Note that NetBSD as dom0 does not support multiple CPUs.  This will
  351: limit the performance of the Xen/dom0 workstation approach.  In theory
  352: the only issue is that the "backend drivers" are not yet MPSAFE:
  353:   http://mail-index.netbsd.org/netbsd-users/2014/08/29/msg015195.html
  354: 
  355: Installation of NetBSD
  356: ----------------------
  357: 
  358: First,
  359: [install NetBSD/amd64](/guide/inst/)
  360: just as you would if you were not using Xen.
  361: However, the partitioning approach is very important.
  362: 
  363: If you want to use RAIDframe for the dom0, there are no special issues
  364: for Xen.  Typically one provides RAID storage for the dom0, and the
  365: domU systems are unaware of RAID.  The 2nd-stage loader bootxx_* skips
  366: over a RAID1 header to find /boot from a file system within a RAID
  367: partition; this is no different when booting Xen.
  368: 
  369: There are 4 styles of providing backing storage for the virtual disks
  370: used by domUs: raw partitions, LVM, file-backed vnd(4), and SAN.
  371: 
  372: With raw partitions, one has a disklabel (or gpt) partition sized for
  373: each virtual disk to be used by the domU.  (If you are able to predict
  374: how domU usage will evolve, please add an explanation to the HOWTO.
  375: Seriously, needs tend to change over time.)
  376: 
  377: One can use [lvm(8)](/guide/lvm/) to create logical devices to use
  378: for domU disks.  This is almost as efficient as raw disk partitions
  379: and more flexible.  Hence raw disk partitions should typically not
  380: be used.
  381: 
  382: One can use files in the dom0 file system, typically created by dd'ing
  383: /dev/zero to create a specific size.  This is somewhat less efficient,
  384: but very convenient, as one can cp the files for backup, or move them
  385: between dom0 hosts.
  386: 
  387: Finally, in theory one can place the files backing the domU disks in a
  388: SAN.  (This is an invitation for someone who has done this to add a
  389: HOWTO page.)
  390: 
  391: Installation of Xen
  392: -------------------
  393: 
  394: In the dom0, install sysutils/xenkernel42 and sysutils/xentools42 from
  395: pkgsrc (or another matching pair).  See [the pkgsrc
  396: documentation](http://www.NetBSD.org/docs/pkgsrc/) for help with
  397: pkgsrc.  Ensure that your packages are recent; the HOWTO does not
  398: contemplate old builds.
  399: 
  400: 
  401: For Xen 3.1, support for HVM guests is in sysutils/xentool3-hvm.  More
  402: recent versions have HVM support integrated in the main xentools
  403: package.  It is entirely reasonable to run only PV guests.
  404: 
  405: Next you need to install the selected Xen kernel itself, which is
  406: installed by pkgsrc as "/usr/pkg/xen*-kernel/xen.gz".  Copy it to /.
  407: For debugging, one may copy xen-debug.gz; this is conceptually similar
  408: to DIAGNOSTIC and DEBUG in NetBSD.  xen-debug.gz is basically only
  409: useful with a serial console.  Then, place a NetBSD XEN3_DOM0 kernel
  410: in /, copied from releasedir/amd64/binary/kernel/netbsd-XEN3_DOM0.gz
  411: of a NetBSD build.  If using i386, use
  412: releasedir/i386/binary/kernel/netbsd-XEN3PAE_DOM0.gz.  (If using Xen
  413: 3.1 and i386, you may use XEN3_DOM0 with the non-PAE Xen.  But you
  414: should not use Xen 3.1.)  Both xen and the NetBSD kernel may be (and
  415: typically are) left compressed.
  416: 
  417: In a dom0, kernfs is mandatory for xend to communicate with the
  418: kernel, so ensure that /kern is in fstab.  (A standard NetBSD install
  419: should already mount /kern.)
  420: 
  421: Because you already installed NetBSD, you have a working boot setup
  422: with an MBR bootblock, either bootxx_ffsv1 or bootxx_ffsv2 at the
  423: beginning of your root file system, have /boot, and likely also
  424: /boot.cfg.  (If not, fix before continuing!)
  425: 
  426: Add a line to to /boot.cfg to boot Xen.  See boot.cfg(5) for an
  427: example.  The basic line is
  428: 
  429:         menu=Xen:load /netbsd-XEN3_DOM0.gz console=pc;multiboot /xen.gz dom0_mem=256M
  430: 
  431: which specifies that the dom0 should have 256M, leaving the rest to be
  432: allocated for domUs.  To use a serial console, use
  433: 
  434:         menu=Xen:load /netbsd-XEN3_DOM0.gz console=com0;multiboot /xen.gz dom0_mem=256M console=com1 com1=9600,8n1
  435: 
  436: which will use the first serial port for Xen (which counts starting
  437: from 1), forcing speed/parity, and also for NetBSD (which counts
  438: starting at 0).  In an attempt to add performance, one can also add
  439: 
  440:         dom0_max_vcpus=1 dom0_vcpus_pin
  441: 
  442: to force only one vcpu to be provided (since NetBSD dom0 can't use
  443: more) and to pin that vcpu to a physical CPU.  TODO: benchmark this.
  444: 
  445: Xen has [many boot
  446: options](http://xenbits.xenproject.org/docs/4.5-testing/misc/xen-command-line.html),
  447: and other than dom0 memory and max_vcpus, they are generally not
  448: necessary.
  449: 
  450: As with non-Xen systems, you should have a line to boot /netbsd (a
  451: kernel that works without Xen).  Consider a line to boot /netbsd.ok (a
  452: fallback version of the non-Xen kernel, updated manually when you are
  453: sure /netbsd is ok).  Consider also a line to boot fallback versions
  454: of Xen and the dom0 kernel, but note that non-Xen NetBSD can be used
  455: to resolve Xen booting issues.
  456: 
  457: Probably you want a default=N line to choose Xen in the absence of
  458: intervention.
  459: 
  460: Now, reboot so that you are running a DOM0 kernel under Xen, rather
  461: than GENERIC without Xen.
  462: 
  463: Using grub (historic)
  464: ---------------------
  465: 
  466: Before NetBSD's native bootloader could support Xen, the use of
  467: grub was recommended.  If necessary, see the
  468: [old grub information](/ports/xen/howto-grub).
  469: 
  470: The [HowTo on Installing into
  471: RAID-1](http://mail-index.NetBSD.org/port-xen/2006/03/01/0010.html)
  472: explains how to set up booting a dom0 with Xen using grub with
  473: NetBSD's RAIDframe.  (This is obsolete with the use of NetBSD's native
  474: boot.  Now, just create a system with RAID-1, and alter /boot.cfg as
  475: described above.)
  476: 
  477: Configuring Xen
  478: ---------------
  479: 
  480: Xen logs will be in /var/log/xen.
  481: 
  482: Now, you have a system that will boot Xen and the dom0 kernel, but not
  483: do anything else special.  Make sure that you have rebooted into Xen.
  484: There will be no domUs, and none can be started because you still have
  485: to configure the dom0 daemons.
  486: 
  487: The daemons which should be run vary with Xen version and with whether
  488: one is using xm or xl.  The Xen 3.1, 3.3 and 4.1 packages use xm.  Xen
  489: 4.2 and up packages use xl.  To use xm with 4.2, edit xendomains to
  490: use xm instead.
  491: 
  492: For 3.1 and 3.3, you should enable xend and xenbackendd:
  493: 
  494:         xend=YES
  495:         xenbackendd=YES
  496: 
  497: For 4.1 and up, you should enable xencommons.  Not enabling xencommons
  498: will result in a hang; it is necessary to hit ^C on the console to let
  499: the machine finish booting.  If you are using xm (default in 4.1, or
  500: if you changed xendomains in 4.2), you should also enable xend:
  501: 
  502:         xend=YES # only if using xm, and only installed <= 4.2
  503:         xencommons=YES
  504: 
  505: TODO: Recommend for/against xen-watchdog.
  506: 
  507: After you have configured the daemons and either started them (in the
  508: order given) or rebooted, use xm or xl to inspect Xen's boot messages,
  509: available resources, and running domains.  An example with xl follows:
  510: 
  511:         # xl dmesg
  512: 	[xen's boot info]
  513:         # xl info
  514: 	[available memory, etc.]
  515:         # xl list
  516:         Name              Id  Mem(MB)  CPU  State  Time(s)  Console
  517:         Domain-0           0       64    0  r----     58.1
  518: 
  519: ### Issues with xencommons
  520: 
  521: xencommons starts xenstored, which stores data on behalf of dom0 and
  522: domUs.  It does not currently work to stop and start xenstored.
  523: Certainly all domUs should be shutdown first, following the sort order
  524: of the rc.d scripts.  However, the dom0 sets up state with xenstored,
  525: and is not notified when xenstored exits, leading to not recreating
  526: the state when the new xenstored starts.  Until there's a mechanism to
  527: make this work, one should not expect to be able to restart xenstored
  528: (and thus xencommons).  There is currently no reason to expect that
  529: this will get fixed any time soon.
  530: 
  531: ### No-longer needed advice about devices
  532: 
  533: The installation of NetBSD should already have created devices for xen
  534: (xencons, xenevt, xsd_kva), but if they are not present, create them:
  535: 
  536:         cd /dev && sh MAKEDEV xen
  537: 
  538: anita (for testing NetBSD)
  539: --------------------------
  540: 
  541: With the setup so far (assuming 4.2/xl), one should be able to run
  542: anita (see pkgsrc/misc/py-anita) to test NetBSD releases, by doing (as
  543: root, because anita must create a domU):
  544: 
  545:         anita --vmm=xl test file:///usr/obj/i386/
  546: 
  547: Alternatively, one can use --vmm=xm to use xm-based domU creation
  548: instead (and must, on Xen <= 4.1).   TODO: confirm that anita xl really works.
  549:     
  550: Xen-specific NetBSD issues
  551: --------------------------
  552: 
  553: There are (at least) two additional things different about NetBSD as a
  554: dom0 kernel compared to hardware.
  555: 
  556: One is that the module ABI is different because some of the #defines
  557: change, so one must build modules for Xen.  As of netbsd-7, the build
  558: system does this automatically.  TODO: check this.  (Before building
  559: Xen modules was added, it was awkward to use modules to the point
  560: where it was considered that it did not work.)
  561: 
  562: The other difference is that XEN3_DOM0 does not have exactly the same
  563: options as GENERIC.  While it is debatable whether or not this is a
  564: bug, users should be aware of this and can simply add missing config
  565: items if desired.
  566: 
  567: Updating NetBSD in a dom0
  568: -------------------------
  569: 
  570: This is just like updating NetBSD on bare hardware, assuming the new
  571: version supports the version of Xen you are running.  Generally, one
  572: replaces the kernel and reboots, and then overlays userland binaries
  573: and adjusts /etc.
  574: 
  575: Note that one must update both the non-Xen kernel typically used for
  576: rescue purposes and the DOM0 kernel used with Xen.
  577: 
  578: Converting from grub to /boot
  579: -----------------------------
  580: 
  581: These instructions were [TODO: will be] used to convert a system from
  582: grub to /boot.  The system was originally installed in February of
  583: 2006 with a RAID1 setup and grub to boot Xen 2, and has been updated
  584: over time.  Before these commands, it was running NetBSD 6 i386, Xen
  585: 4.1 and grub, much like the message linked earlier in the grub
  586: section.
  587: 
  588:         # Install MBR bootblocks on both disks. 
  589:         fdisk -i /dev/rwd0d
  590:         fdisk -i /dev/rwd1d
  591:         # Install NetBSD primary boot loader (/ is FFSv1) into RAID1 components.
  592:         installboot -v /dev/rwd0d /usr/mdec/bootxx_ffsv1
  593:         installboot -v /dev/rwd1d /usr/mdec/bootxx_ffsv1
  594:         # Install secondary boot loader
  595:         cp -p /usr/mdec/boot /
  596:         # Create boot.cfg following earlier guidance:
  597:         menu=Xen:load /netbsd-XEN3PAE_DOM0.gz console=pc;multiboot /xen.gz dom0_mem=256M
  598:         menu=Xen.ok:load /netbsd-XEN3PAE_DOM0.ok.gz console=pc;multiboot /xen.ok.gz dom0_mem=256M
  599:         menu=GENERIC:boot
  600:         menu=GENERIC single-user:boot -s
  601:         menu=GENERIC.ok:boot netbsd.ok
  602:         menu=GENERIC.ok single-user:boot netbsd.ok -s
  603:         menu=Drop to boot prompt:prompt
  604:         default=1
  605:         timeout=30
  606: 
  607: TODO: actually do this and fix it if necessary.
  608: 
  609: Upgrading Xen versions
  610: ---------------------
  611: 
  612: Minor version upgrades are trivial.  Just rebuild/replace the
  613: xenkernel version and copy the new xen.gz to / (where /boot.cfg
  614: references it), and reboot.
  615: 
  616: Major version upgrades are conceptually not difficult, but can run
  617: into all the issues found when installing Xen.  Assuming migration
  618: from 4.1 to 4.2, remove the xenkernel41 and xentools41 packages and
  619: install the xenkernel42 and xentools42 packages.  Copy the 4.2 xen.gz
  620: to /.
  621: 
  622: Ensure that the contents of /etc/rc.d/xen* are correct.  Specifically,
  623: they must match the package you just installed and not be left over
  624: from some previous installation.
  625: 
  626: Enable the correct set of daemons; see the configuring section above.
  627: (Upgrading from 3.x to 4.x without doing this will result in a hang.)
  628: 
  629: Ensure that the domU config files are valid for the new version.
  630: Specifically, for 4.x remove autorestart=True, and ensure that disks
  631: are specified with numbers as the second argument, as the examples
  632: above show, and not NetBSD device names.
  633: 
  634: Hardware known to work
  635: ----------------------
  636: 
  637: Arguably, this section is misplaced, and there should be a page of
  638: hardware that runs NetBSD/amd64 well, with the mostly-well-founded
  639: assumption that NetBSD/xen runs fine on any modern hardware that
  640: NetBSD/amd64 runs well on.  Until then, we give motherboard/CPU (and
  641: sometimes RAM) pairs/triples to aid those choosing a motherboard.
  642: Note that Xen systems usually do not run X, so a listing here does not
  643: imply that X works at all.
  644: 
  645:         Supermicro X9SRL-F, Xeon E5-1650 v2, 96 GiB ECC
  646:         Supermicro ??, Atom C2758 (8 core), 32 GiB ECC
  647:         ASUS M5A78L-M/USB3 AM3+ microATX, AMD Piledriver X8 4000MHz, 16 GiB ECC
  648: 
  649: Older hardware:
  650: 
  651:         Intel D915GEV, Pentium4 CPU 3.40GHz, 4GB 533MHz Synchronous DDR2
  652:         INTEL DG33FB, "Intel(R) Core(TM)2 Duo CPU     E6850  @ 3.00GHz"
  653:         INTEL DG33FB, "Intel(R) Core(TM)2 Duo CPU     E8400  @ 3.00GHz"
  654: 
  655: Running Xen under qemu
  656: ----------------------
  657: 
  658: The astute reader will note that this section is somewhat twisted.
  659: However, it can be useful to run Xen under qemu either because the
  660: version of NetBSD as a dom0 does not run on the hardware in use, or to
  661: generate automated test cases involving Xen.
  662: 
  663: In 2015-01, the following combination was reported to mostly work:
  664: 
  665:         host OS: NetBSD/amd64 6.1.4
  666:         qemu: 2.2.0 from pkgsrc
  667:         Xen kernel: xenkernel42-4.2.5nb1 from pkgsrc
  668:         dom0 kernel: NetBSD/amd64 6.1.5
  669:         Xen tools: xentools42-4.2.5 from pkgsrc
  670: 
  671: See [PR 47720](http://gnats.netbsd.org/47720) for a problem with dom0
  672: shutdown.
  673: 
  674: Unprivileged domains (domU)
  675: ===========================
  676: 
  677: This section describes general concepts about domUs.  It does not
  678: address specific domU operating systems or how to install them.  The
  679: config files for domUs are typically in /usr/pkg/etc/xen, and are
  680: typically named so that the file name, domU name and the domU's host
  681: name match.
  682: 
  683: The domU is provided with CPU and memory by Xen, configured by the
  684: dom0.  The domU is provided with disk and network by the dom0,
  685: mediated by Xen, and configured in the dom0.
  686: 
  687: Entropy in domUs can be an issue; physical disks and network are on
  688: the dom0.  NetBSD's /dev/random system works, but is often challenged.
  689: 
  690: Config files
  691: ------------
  692: 
  693: There is no good order to present config files and the concepts
  694: surrounding what is being configured.  We first show an example config
  695: file, and then in the various sections give details.
  696: 
  697: See (at least in xentools41) /usr/pkg/share/examples/xen/xmexample*,
  698: for a large number of well-commented examples, mostly for running
  699: GNU/Linux.
  700: 
  701: The following is an example minimal domain configuration file
  702: "/usr/pkg/etc/xen/foo".  It is (with only a name change) an actual
  703: known working config file on Xen 4.1 (NetBSD 5 amd64 dom0 and NetBSD 5
  704: i386 domU).  The domU serves as a network file server.
  705: 
  706:         # -*- mode: python; -*-
  707: 
  708:         kernel = "/netbsd-XEN3PAE_DOMU-i386-foo.gz"
  709:         memory = 1024
  710:         vif = [ 'mac=aa:00:00:d1:00:09,bridge=bridge0' ]
  711:         disk = [ 'file:/n0/xen/foo-wd0,0x0,w',
  712:                  'file:/n0/xen/foo-wd1,0x1,w' ]
  713: 
  714: The domain will have the same name as the file.  The kernel has the
  715: host/domU name in it, so that on the dom0 one can update the various
  716: domUs independently.  The vif line causes an interface to be provided,
  717: with a specific mac address (do not reuse MAC addresses!), in bridge
  718: mode.  Two disks are provided, and they are both writable; the bits
  719: are stored in files and Xen attaches them to a vnd(4) device in the
  720: dom0 on domain creation.  The system treats xbd0 as the boot device
  721: without needing explicit configuration.
  722: 
  723: By default xm looks for domain config files in /usr/pkg/etc/xen.  Note
  724: that "xm create" takes the name of a config file, while other commands
  725: take the name of a domain.  To create the domain, connect to the
  726: console, create the domain while attaching the console, shutdown the
  727: domain, and see if it has finished stopping, do (or xl with Xen >=
  728: 4.2):
  729: 
  730:         xm create foo
  731:         xm console foo
  732:         xm create -c foo
  733:         xm shutdown foo
  734:         xm list
  735: 
  736: Typing ^] will exit the console session.  Shutting down a domain is
  737: equivalent to pushing the power button; a NetBSD domU will receive a
  738: power-press event and do a clean shutdown.  Shutting down the dom0
  739: will trigger controlled shutdowns of all configured domUs.
  740: 
  741: domU kernels
  742: ------------
  743: 
  744: On a physical computer, the BIOS reads sector 0, and a chain of boot
  745: loaders finds and loads a kernel.  Normally this comes from the root
  746: file system.  With Xen domUs, the process is totally different.  The
  747: normal path is for the domU kernel to be a file in the dom0's
  748: file system.  At the request of the dom0, Xen loads that kernel into a
  749: new domU instance and starts execution.  While domU kernels can be
  750: anyplace, reasonable places to store domU kernels on the dom0 are in /
  751: (so they are near the dom0 kernel), in /usr/pkg/etc/xen (near the
  752: config files), or in /u0/xen (where the vdisks are).
  753: 
  754: Note that loading the domU kernel from the dom0 implies that boot
  755: blocks, /boot, /boot.cfg, and so on are all ignored in the domU.
  756: See the VPS section near the end for discussion of alternate ways to
  757: obtain domU kernels.
  758: 
  759: CPU and memory
  760: --------------
  761: 
  762: A domain is provided with some number of vcpus, less than the number
  763: of CPUs seen by the hypervisor.  (For a dom0, this is controlled by
  764: the boot argument "dom0_max_vcpus=1".)  For a domU, it is controlled
  765: from the config file by the "vcpus = N" directive.
  766: 
  767: A domain is provided with memory; this is controlled in the config
  768: file by "memory = N" (in megabytes).  In the straightforward case, the
  769: sum of the the memory allocated to the dom0 and all domUs must be less
  770: than the available memory.
  771: 
  772: Xen also provides a "balloon" driver, which can be used to let domains
  773: use more memory temporarily.  TODO: Explain better, and explain how
  774: well it works with NetBSD.
  775: 
  776: Virtual disks
  777: -------------
  778: 
  779: With the file/vnd style, typically one creates a directory,
  780: e.g. /u0/xen, on a disk large enough to hold virtual disks for all
  781: domUs.  Then, for each domU disk, one writes zeros to a file that then
  782: serves to hold the virtual disk's bits; a suggested name is foo-xbd0
  783: for the first virtual disk for the domU called foo.  Writing zeros to
  784: the file serves two purposes.  One is that preallocating the contents
  785: improves performance.  The other is that vnd on sparse files has
  786: failed to work.  TODO: give working/notworking NetBSD versions for
  787: sparse vnd and gnats reference.  Note that the use of file/vnd for Xen
  788: is not really different than creating a file-backed virtual disk for
  789: some other purpose, except that xentools handles the vnconfig
  790: commands.  To create an empty 4G virtual disk, simply do
  791: 
  792:         dd if=/dev/zero of=foo-xbd0 bs=1m count=4096
  793: 
  794: Do not use qemu-img-xen, because this will create sparse file.  There
  795: have been recent (2015) reports of sparse vnd(4) devices causing
  796: lockups, but there is apparently no PR.
  797: 
  798: With the lvm style, one creates logical devices.  They are then used
  799: similarly to vnds.  TODO: Add an example with lvm.
  800: 
  801: In domU config files, the disks are defined as a sequence of 3-tuples.
  802: The first element is "method:/path/to/disk".  Common methods are
  803: "file:" for file-backed vnd. and "phy:" for something that is already
  804: a (TODO: character or block) device.
  805: 
  806: The second element is an artifact of how virtual disks are passed to
  807: Linux, and a source of confusion with NetBSD Xen usage.  Linux domUs
  808: are given a device name to associate with the disk, and values like
  809: "hda1" or "sda1" are common.  In a NetBSD domU, the first disk appears
  810: as xbd0, the second as xbd1, and so on.  However, xm/xl demand a
  811: second argument.  The name given is converted to a major/minor by
  812: calling stat(2) on the name in /dev and this is passed to the domU.
  813: In the general case, the dom0 and domU can be different operating
  814: systems, and it is an unwarranted assumption that they have consistent
  815: numbering in /dev, or even that the dom0 OS has a /dev.  With NetBSD
  816: as both dom0 and domU, using values of 0x0 for the first disk and 0x1
  817: for the second works fine and avoids this issue.  For a GNU/Linux
  818: guest, one can create /dev/hda1 in /dev, or to pass 0x301 for
  819: /dev/hda1.
  820: 
  821: The third element is "w" for writable disks, and "r" for read-only
  822: disks.
  823: 
  824: Note that NetBSD by default creates only vnd[0123].  If you need more
  825: than 4 total virtual disks at a time, run e.g. "./MAKEDEV vnd4" in the
  826: dom0.
  827: 
  828: Note that NetBSD by default creates only xbd[0123].  If you need more
  829: virtual disks in a domU, run e.g. "./MAKEDEV xbd4" in the domU.
  830: 
  831: Virtual Networking
  832: ------------------
  833: 
  834: Xen provides virtual Ethernets, each of which connects the dom0 and a
  835: domU.  For each virtual network, there is an interface "xvifN.M" in
  836: the dom0, and in domU index N, a matching interface xennetM (NetBSD
  837: name).  The interfaces behave as if there is an Ethernet with two
  838: adapters connected.  From this primitive, one can construct various
  839: configurations.  We focus on two common and useful cases for which
  840: there are existing scripts: bridging and NAT.
  841: 
  842: With bridging (in the example above), the domU perceives itself to be
  843: on the same network as the dom0.  For server virtualization, this is
  844: usually best.  Bridging is accomplished by creating a bridge(4) device
  845: and adding the dom0's physical interface and the various xvifN.0
  846: interfaces to the bridge.  One specifies "bridge=bridge0" in the domU
  847: config file.  The bridge must be set up already in the dom0; an
  848: example /etc/ifconfig.bridge0 is:
  849: 
  850:         create
  851:         up
  852:         !brconfig bridge0 add wm0
  853: 
  854: With NAT, the domU perceives itself to be behind a NAT running on the
  855: dom0.  This is often appropriate when running Xen on a workstation.
  856: TODO: NAT appears to be configured by "vif = [ '' ]".
  857: 
  858: The MAC address specified is the one used for the interface in the new
  859: domain.  The interface in dom0 will use this address XOR'd with
  860: 00:00:00:01:00:00.  Random MAC addresses are assigned if not given.
  861: 
  862: Sizing domains
  863: --------------
  864: 
  865: Modern x86 hardware has vast amounts of resources.  However, many
  866: virtual servers can function just fine on far less.  A system with
  867: 256M of RAM and a 4G disk can be a reasonable choice.  Note that it is
  868: far easier to adjust virtual resources than physical ones.  For
  869: memory, it's just a config file edit and a reboot.  For disk, one can
  870: create a new file and vnconfig it (or lvm), and then dump/restore,
  871: just like updating physical disks, but without having to be there and
  872: without those pesky connectors.
  873: 
  874: Starting domains automatically
  875: ------------------------------
  876: 
  877: To start domains foo at bar at boot and shut them down cleanly on dom0
  878: shutdown, in rc.conf add:
  879: 
  880:         xendomains="foo bar"
  881: 
  882: Note that earlier versions of the xentools41 xendomains rc.d script
  883: used xl, when one should use xm with 4.1.
  884: 
  885: Creating specific unprivileged domains (domU)
  886: =============================================
  887: 
  888: Creating domUs is almost entirely independent of operating system.  We
  889: have already presented the basics of config files.  Note that you must
  890: have already completed the dom0 setup so that "xl list" (or "xm list")
  891: works.
  892: 
  893: Creating an unprivileged NetBSD domain (domU)
  894: ---------------------------------------------
  895: 
  896: See the earlier config file, and adjust memory.  Decide on how much
  897: storage you will provide, and prepare it (file or lvm).
  898: 
  899: While the kernel will be obtained from the dom0 file system, the same
  900: file should be present in the domU as /netbsd so that tools like
  901: savecore(8) can work.   (This is helpful but not necessary.)
  902: 
  903: The kernel must be specifically for Xen and for use as a domU.  The
  904: i386 and amd64 provide the following kernels:
  905: 
  906:         i386 XEN3_DOMU
  907:         i386 XEN3PAE_DOMU
  908:         amd64 XEN3_DOMU
  909: 
  910: Unless using Xen 3.1 (and you shouldn't) with i386-mode Xen, you must
  911: use the PAE version of the i386 kernel.
  912: 
  913: This will boot NetBSD, but this is not that useful if the disk is
  914: empty.  One approach is to unpack sets onto the disk outside of xen
  915: (by mounting it, just as you would prepare a physical disk for a
  916: system you can't run the installer on).
  917: 
  918: A second approach is to run an INSTALL kernel, which has a miniroot
  919: and can load sets from the network.  To do this, copy the INSTALL
  920: kernel to / and change the kernel line in the config file to:
  921: 
  922:         kernel = "/home/bouyer/netbsd-INSTALL_XEN3_DOMU"
  923: 
  924: Then, start the domain as "xl create -c configname".
  925: 
  926: Alternatively, if you want to install NetBSD/Xen with a CDROM image, the following
  927: line should be used in the config file.
  928: 
  929:     disk = [ 'phy:/dev/wd0e,0x1,w', 'phy:/dev/cd0a,0x2,r' ]
  930: 
  931: After booting the domain, the option to install via CDROM may be
  932: selected.  The CDROM device should be changed to `xbd1d`.
  933: 
  934: Once done installing, "halt -p" the new domain (don't reboot or halt,
  935: it would reload the INSTALL_XEN3_DOMU kernel even if you changed the
  936: config file), switch the config file back to the XEN3_DOMU kernel,
  937: and start the new domain again. Now it should be able to use "root on
  938: xbd0a" and you should have a, functional NetBSD domU.
  939: 
  940: TODO: check if this is still accurate.
  941: When the new domain is booting you'll see some warnings about *wscons*
  942: and the pseudo-terminals. These can be fixed by editing the files
  943: `/etc/ttys` and `/etc/wscons.conf`. You must disable all terminals in
  944: `/etc/ttys`, except *console*, like this:
  945: 
  946:     console "/usr/libexec/getty Pc"         vt100   on secure
  947:     ttyE0   "/usr/libexec/getty Pc"         vt220   off secure
  948:     ttyE1   "/usr/libexec/getty Pc"         vt220   off secure
  949:     ttyE2   "/usr/libexec/getty Pc"         vt220   off secure
  950:     ttyE3   "/usr/libexec/getty Pc"         vt220   off secure
  951: 
  952: Finally, all screens must be commented out from `/etc/wscons.conf`.
  953: 
  954: It is also desirable to add
  955: 
  956:         powerd=YES
  957: 
  958: in rc.conf. This way, the domain will be properly shut down if
  959: `xm shutdown -R` or `xm shutdown -H` is used on the dom0.
  960: 
  961: It is not strictly necessary to have a kernel (as /netbsd) in the domU
  962: file system.  However, various programs (e.g. netstat) will use that
  963: kernel to look up symbols to read from kernel virtual memory.  If
  964: /netbsd is not the running kernel, those lookups will fail.  (This is
  965: not really a Xen-specific issue, but because the domU kernel is
  966: obtained from the dom0, it is far more likely to be out of sync or
  967: missing with Xen.)
  968: 
  969: Creating an unprivileged Linux domain (domU)
  970: --------------------------------------------
  971: 
  972: Creating unprivileged Linux domains isn't much different from
  973: unprivileged NetBSD domains, but there are some details to know.
  974: 
  975: First, the second parameter passed to the disk declaration (the '0x1' in
  976: the example below)
  977: 
  978:     disk = [ 'phy:/dev/wd0e,0x1,w' ]
  979: 
  980: does matter to Linux. It wants a Linux device number here (e.g. 0x300
  981: for hda).  Linux builds device numbers as: (major \<\< 8 + minor).
  982: So, hda1 which has major 3 and minor 1 on a Linux system will have
  983: device number 0x301.  Alternatively, devices names can be used (hda,
  984: hdb, ...)  as xentools has a table to map these names to devices
  985: numbers.  To export a partition to a Linux guest we can use:
  986: 
  987:         disk = [ 'phy:/dev/wd0e,0x300,w' ]
  988:         root = "/dev/hda1 ro"
  989: 
  990: and it will appear as /dev/hda on the Linux system, and be used as root
  991: partition.
  992: 
  993: To install the Linux system on the partition to be exported to the
  994: guest domain, the following method can be used: install
  995: sysutils/e2fsprogs from pkgsrc.  Use mke2fs to format the partition
  996: that will be the root partition of your Linux domain, and mount it.
  997: Then copy the files from a working Linux system, make adjustments in
  998: `/etc` (fstab, network config).  It should also be possible to extract
  999: binary packages such as .rpm or .deb directly to the mounted partition
 1000: using the appropriate tool, possibly running under NetBSD's Linux
 1001: emulation.  Once the file system has been populated, umount it.  If
 1002: desirable, the file system can be converted to ext3 using tune2fs -j.
 1003: It should now be possible to boot the Linux guest domain, using one of
 1004: the vmlinuz-\*-xenU kernels available in the Xen binary distribution.
 1005: 
 1006: To get the Linux console right, you need to add:
 1007: 
 1008:     extra = "xencons=tty1"
 1009: 
 1010: to your configuration since not all Linux distributions auto-attach a
 1011: tty to the xen console.
 1012: 
 1013: Creating an unprivileged Solaris domain (domU)
 1014: ----------------------------------------------
 1015: 
 1016: See possibly outdated
 1017: [Solaris domU instructions](/ports/xen/howto-solaris/).
 1018: 
 1019: 
 1020: PCI passthrough: Using PCI devices in guest domains
 1021: ---------------------------------------------------
 1022: 
 1023: The dom0 can give other domains access to selected PCI
 1024: devices. This can allow, for example, a non-privileged domain to have
 1025: access to a physical network interface or disk controller.  However,
 1026: keep in mind that giving a domain access to a PCI device most likely
 1027: will give the domain read/write access to the whole physical memory,
 1028: as PCs don't have an IOMMU to restrict memory access to DMA-capable
 1029: device.  Also, it's not possible to export ISA devices to non-dom0
 1030: domains, which means that the primary VGA adapter can't be exported.
 1031: A guest domain trying to access the VGA registers will panic.
 1032: 
 1033: If the dom0 is NetBSD, it has to be running Xen 3.1, as support has
 1034: not been ported to later versions at this time.
 1035: 
 1036: For a PCI device to be exported to a domU, is has to be attached to
 1037: the "pciback" driver in dom0.  Devices passed to the dom0 via the
 1038: pciback.hide boot parameter will attach to "pciback" instead of the
 1039: usual driver.  The list of devices is specified as "(bus:dev.func)",
 1040: where bus and dev are 2-digit hexadecimal numbers, and func a
 1041: single-digit number:
 1042: 
 1043:         pciback.hide=(00:0a.0)(00:06.0)
 1044: 
 1045: pciback devices should show up in the dom0's boot messages, and the
 1046: devices should be listed in the `/kern/xen/pci` directory.
 1047: 
 1048: PCI devices to be exported to a domU are listed in the "pci" array of
 1049: the domU's config file, with the format "0000:bus:dev.func".
 1050: 
 1051:         pci = [ '0000:00:06.0', '0000:00:0a.0' ]
 1052: 
 1053: In the domU an "xpci" device will show up, to which one or more pci
 1054: buses will attach.  Then the PCI drivers will attach to PCI buses as
 1055: usual.  Note that the default NetBSD DOMU kernels do not have "xpci"
 1056: or any PCI drivers built in by default; you have to build your own
 1057: kernel to use PCI devices in a domU.  Here's a kernel config example;
 1058: note that only the "xpci" lines are unusual.
 1059: 
 1060:         include         "arch/i386/conf/XEN3_DOMU"
 1061: 
 1062:         # Add support for PCI buses to the XEN3_DOMU kernel
 1063:         xpci* at xenbus ?
 1064:         pci* at xpci ?
 1065: 
 1066:         # PCI USB controllers
 1067:         uhci*   at pci? dev ? function ?        # Universal Host Controller (Intel)
 1068: 
 1069:         # USB bus support
 1070:         usb*    at uhci?
 1071: 
 1072:         # USB Hubs
 1073:         uhub*   at usb?
 1074:         uhub*   at uhub? port ? configuration ? interface ?
 1075: 
 1076:         # USB Mass Storage
 1077:         umass*  at uhub? port ? configuration ? interface ?
 1078:         wd*     at umass?
 1079:         # SCSI controllers
 1080:         ahc*    at pci? dev ? function ?        # Adaptec [23]94x, aic78x0 SCSI
 1081: 
 1082:         # SCSI bus support (for both ahc and umass)
 1083:         scsibus* at scsi?
 1084: 
 1085:         # SCSI devices
 1086:         sd*     at scsibus? target ? lun ?      # SCSI disk drives
 1087:         cd*     at scsibus? target ? lun ?      # SCSI CD-ROM drives
 1088: 
 1089: 
 1090: NetBSD as a domU in a VPS
 1091: =========================
 1092: 
 1093: The bulk of the HOWTO is about using NetBSD as a dom0 on your own
 1094: hardware.  This section explains how to deal with Xen in a domU as a
 1095: virtual private server where you do not control or have access to the
 1096: dom0.  This is not intended to be an exhaustive list of VPS providers;
 1097: only a few are mentioned that specifically support NetBSD.
 1098: 
 1099: VPS operators provide varying degrees of access and mechanisms for
 1100: configuration.  The big issue is usually how one controls which kernel
 1101: is booted, because the kernel is nominally in the dom0 file system (to
 1102: which VPS users do not normally have access).  A second issue is how
 1103: to install NetBSD.
 1104: A VPS user may want to compile a kernel for security updates, to run
 1105: npf, run IPsec, or any other reason why someone would want to change
 1106: their kernel.
 1107: 
 1108: One approach is to have an administrative interface to upload a kernel,
 1109: or to select from a prepopulated list.  Other approaches are pygrub
 1110: (deprecated) and pvgrub, which are ways to have a bootloader obtain a
 1111: kernel from the domU file system.  This is closer to a regular physical
 1112: computer, where someone who controls a machine can replace the kernel.
 1113: 
 1114: A second issue is multiple CPUs.  With NetBSD 6, domUs support
 1115: multiple vcpus, and it is typical for VPS providers to enable multiple
 1116: CPUs for NetBSD domUs.
 1117: 
 1118: pygrub
 1119: -------
 1120: 
 1121: pygrub runs in the dom0 and looks into the domU file system.  This
 1122: implies that the domU must have a kernel in a file system in a format
 1123: known to pygrub.  As of 2014, pygrub seems to be of mostly historical
 1124: interest.
 1125: 
 1126: pvgrub
 1127: ------
 1128: 
 1129: pvgrub is a version of grub that uses PV operations instead of BIOS
 1130: calls.  It is booted from the dom0 as the domU kernel, and then reads
 1131: /grub/menu.lst and loads a kernel from the domU file system.
 1132: 
 1133: [Panix](http://www.panix.com/) lets users use pvgrub.  Panix reports
 1134: that pvgrub works with FFsv2 with 16K/2K and 32K/4K block/frag sizes
 1135: (and hence with defaults from "newfs -O 2").  See [Panix's pvgrub
 1136: page](http://www.panix.com/v-colo/grub.html), which describes only
 1137: Linux but should be updated to cover NetBSD :-).
 1138: 
 1139: [prgmr.com](http://prgmr.com/) also lets users with pvgrub to boot
 1140: their own kernel.  See then [prgmr.com NetBSD
 1141: HOWTO](http://wiki.prgmr.com/mediawiki/index.php/NetBSD_as_a_DomU)
 1142: (which is in need of updating).
 1143: 
 1144: It appears that [grub's FFS
 1145: code](http://xenbits.xensource.com/hg/xen-unstable.hg/file/bca284f67702/tools/libfsimage/ufs/fsys_ufs.c)
 1146: does not support all aspects of modern FFS, but there are also reports
 1147: that FFSv2 works fine.  At prgmr, typically one has an ext2 or FAT
 1148: partition for the kernel with the intent that grub can understand it,
 1149: which leads to /netbsd not being the actual kernel.  One must remember
 1150: to update the special boot partition.
 1151: 
 1152: Amazon
 1153: ------
 1154: 
 1155: See the [Amazon EC2 page](../amazon_ec2/).
 1156: 
 1157: Using npf
 1158: ---------
 1159: 
 1160: In standard kernels, npf is a module, and thus cannot be loaded in a
 1161: DOMU kernel.
 1162: 
 1163: TODO: Explain how to compile npf into a custom kernel, answering (but
 1164: note that the problem was caused by not booting the right kernel)
 1165: [this email to
 1166: netbsd-users](http://mail-index.netbsd.org/netbsd-users/2014/12/26/msg015576.html).
 1167: 
 1168: TODO items for improving NetBSD/xen
 1169: ===================================
 1170: 
 1171: * Make the NetBSD dom0 kernel work with SMP.
 1172: * Test the Xen 4.5 packages adequately to be able to recommend them as
 1173:   the standard approach.
 1174: * Get PCI passthrough working on Xen 4.5
 1175: * Get pvgrub into pkgsrc, either via xentools or separately.
 1176: * grub
 1177:   * Check/add support to pkgsrc grub2 for UFS2 and arbitrary
 1178:     fragsize/blocksize (UFS2 support may be present; the point is to
 1179:     make it so that with any UFS1/UFS2 file system setup that works
 1180:     with NetBSD grub will also work).
 1181:     See [pkg/40258](http://gnats.netbsd.org/40258).
 1182:   * Push patches upstream.
 1183:   * Get UFS2 patches into pvgrub.
 1184: * Add support for PV ops to a version of /boot, and make it usable as
 1185:   a kernel in Xen, similar to pvgrub.
 1186: * Solve somehow the issue with modules for GENERIC not being loadable
 1187:   in a Xen dom0 or domU kernel.
 1188: 
 1189: Random pointers
 1190: ===============
 1191: 
 1192: This section contains links from elsewhere not yet integrated into the
 1193: HOWTO, and other guides.
 1194: 
 1195: * http://www.lumbercartel.ca/library/xen/
 1196: * http://pbraun.nethence.com/doc/sysutils/xen_netbsd_dom0.html
 1197: * https://gmplib.org/~tege/xen.html

CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb