Diff for /wikisrc/ports/xen/howto.mdwn between versions 1.50 and 1.133

version 1.50, 2014/12/26 20:28:45 version 1.133, 2016/12/20 20:59:49
Line 2  Introduction Line 2  Introduction
 ============  ============
   
 [![[Xen  [![[Xen
 screenshot]](http://www.netbsd.org/gallery/in-Action/hubertf-xens.png)](../../gallery/in-Action/hubertf-xen.png)  screenshot]](http://www.netbsd.org/gallery/in-Action/hubertf-xens.png)](http://www.netbsd.org/gallery/in-Action/hubertf-xen.png)
   
 Xen is a virtual machine monitor or hypervisor for x86 hardware  Xen is a hypervisor (or virtual machine monitor) for x86 hardware
 (i686-class or higher), which supports running multiple guest  (i686-class or higher), which supports running multiple guest
 operating systems on a single physical machine.  With Xen, one uses  operating systems on a single physical machine.  Xen is a Type 1 or
 the Xen kernel to control the CPU, memory and console, a dom0  bare-metal hypervisor; one uses the Xen kernel to control the CPU,
 operating system which mediates access to other hardware (e.g., disks,  memory and console, a dom0 operating system which mediates access to
 network, USB), and one or more domU operating systems which operate in  other hardware (e.g., disks, network, USB), and one or more domU
 an unprivileged virtualized environment.  IO requests from the domU  operating systems which operate in an unprivileged virtualized
 systems are forwarded by the hypervisor (Xen) to the dom0 to be  environment.  IO requests from the domU systems are forwarded by the
 fulfilled.  hypervisor (Xen) to the dom0 to be fulfilled.
   
 Xen supports two styles of guests.  The original is Para-Virtualized  Xen supports two styles of guests.  The original is Para-Virtualized
 (PV) which means that the guest OS does not attempt to access hardware  (PV) which means that the guest OS does not attempt to access hardware
Line 27  code for Xen and need not be aware that  Line 27  code for Xen and need not be aware that 
 Attempts to access hardware registers are trapped and emulated.  This  Attempts to access hardware registers are trapped and emulated.  This
 style is less efficient but can run unmodified guests.  style is less efficient but can run unmodified guests.
   
 Generally any amd64 machine will work with Xen and PV guests.  In  Generally any machine that runs NetBSD/amd64 will work with Xen and PV
 theory i386 computers without amd64 support can be used for Xen <=  guests.  In theory i386 computers (without x86_64/amd64 support) can
 4.2, but we have no recent reports of this working (this is a hint).  be used for Xen <= 4.2, but we have no recent reports of this working
 For HVM guests, the VT or VMX cpu feature (Intel) or SVM/HVM/VT  (this is a hint).  For HVM guests, hardware support is needed, but it
 (amd64) is needed; "cpuctl identify 0" will show this.  TODO: Clean up  is common on recent machines.  For Intel CPUs, one needs the VT-x
 and check the above features.  extension, shown in "cpuctl identify 0" as VMX.  For AMD CPUs, one
   needs the AMD-V extensions, shown in "cpuctl identify 0" as SVM.
   There are further features for IOMMU virtualization, Intel's VT-d and
   AMD's AMD-Vi.  TODO: Explain whether Xen on NetBSD makes use of these
   features.  TODO: Review by someone who really understands this.
   
   Note that a FreeBSD dom0 requires VT-x and VT-d (or equivalent); this
   is because the FreeBSD dom0 does not run in PV mode.
   
 At boot, the dom0 kernel is loaded as a module with Xen as the kernel.  At boot, the dom0 kernel is loaded as a module with Xen as the kernel.
 The dom0 can start one or more domUs.  (Booting is explained in detail  The dom0 can start one or more domUs.  (Booting is explained in detail
Line 44  attempts to address both the case of run Line 51  attempts to address both the case of run
 and running domUs under it (NetBSD and other), and also running NetBSD  and running domUs under it (NetBSD and other), and also running NetBSD
 as a domU in a VPS.  as a domU in a VPS.
   
 Some versions of Xen support "PCI passthrough", which means that  Xen 3.1 in pkgsrc supports "PCI passthrough", which means that
 specific PCI devices can be made available to a specific domU instead  specific PCI devices can be made available to a specific domU instead
 of the dom0.  This can be useful to let a domU run X11, or access some  of the dom0.  This can be useful to let a domU run X11, or access some
 network interface or other peripheral.  network interface or other peripheral.
   
   NetBSD 6 and earlier supported Xen 2; support was removed from NetBSD
   7.  Xen 2 has been removed from pkgsrc.
   
 Prerequisites  Prerequisites
 -------------  -------------
   
Line 59  things must be done, guiding the reader  Line 69  things must be done, guiding the reader 
 path when there are no known good reasons to stray.  path when there are no known good reasons to stray.
   
 This HOWTO presumes a basic familiarity with the Xen system  This HOWTO presumes a basic familiarity with the Xen system
 architecture.  This HOWTO presumes familiarity with installing NetBSD  architecture, with installing NetBSD on i386/amd64 hardware, and with
 on i386/amd64 hardware and installing software from pkgsrc.  installing software from pkgsrc.  See also the [Xen
 See also the [Xen website](http://www.xenproject.org/).  website](http://www.xenproject.org/).
   
 History  
 -------  
   
 NetBSD used to support Xen2; this has been removed.  
   
 Before NetBSD's native bootloader could support Xen, the use of  
 grub was recommended.  If necessary, see the  
 [old grub information](/ports/xen/howto-grub/).  
   
 Versions of Xen and NetBSD  Versions of Xen and NetBSD
 ==========================  ==========================
Line 80  of Xen version and NetBSD version.  This Line 81  of Xen version and NetBSD version.  This
 which version to choose.  Versions not in pkgsrc and older unsupported  which version to choose.  Versions not in pkgsrc and older unsupported
 versions of NetBSD are intentionally ignored.  versions of NetBSD are intentionally ignored.
   
   The term "amd64" is used to refer to both the NetBSD port and to the
   hardware architecture on which it runs.  (Such hardware is made by
   both Intel and AMD, and in 2016 a normal PC has this CPU
   architecture.)
   
 Xen  Xen
 ---  ---
   
 In NetBSD, xen is provided in pkgsrc, via matching pairs of packages  In NetBSD, Xen is provided in pkgsrc, via matching pairs of packages
 xenkernel and xentools.  We will refer only to the kernel versions,  xenkernel and xentools.  We will refer only to the kernel versions,
 but note that both packages must be installed together and must have  but note that both packages must be installed together and must have
 matching versions.  matching versions.
   
 xenkernel3 and xenkernel33 provide Xen 3.1 and 3.3.  These no longer  xenkernel3 provides Xen 3.1.  It is no longer maintained by Xen, and
 receive security patches and should not be used.  Xen 3.1 supports PCI  the last applied security patch was in 2011. Thus, it should not be
 passthrough.  Xen 3.1 supports non-PAE on i386.  used.  It supports PCI passthrough, which is why people use it anyway.
   Xen 3.1 runs on i386 (both non-PAE and PAE) and amd64 hardware.
 xenkernel41 provides Xen 4.1.  This is no longer maintained by Xen,  
 but as of 2014-12 receives backported security patches.  It is a  xenkernel33 provides Xen 3.3.  It is no longer maintained by Xen, and
 reasonable although trailing-edge choice.  the last applied security patch was in 2012.  Thus, it should not be
   used.  Xen 3.3 runs on i386 PAE and amd64 hardware.  There are no good
   reasons to run this version.
   
   xenkernel41 provides Xen 4.1.  It is no longer maintained by Xen, but
   as of 2016-12 received backported security patches.  Xen 4.1 runs on
   i386 PAE and amd64 hardware.  There are no good reasons to run this
   version.
   
   xenkernel42 provides Xen 4.2.  It is no longer maintained by Xen, but
   as of 2016-12 received backported security patches.  Xen 4.2 runs on
   i386 PAE and amd64 hardware.  The only reason to run this is if you
   need to use xm instead of xl, or if you need to run on hardware that
   supports i386 but not amd64.  (This might also be useful if you need
   an i386 dom0, if it turns out that an amd64 Xen kernel and an i386
   dom0 is problematic.)
   
   xenkernel45 provides Xen 4.5.  As of 2016-12, security patches were
   released by Xen and applied to pkgsrc.  Xen 4.5 runs on amd64 hardware
   only.  While slightly old, 4.5 has been tested and run by others, so
   it is the conservative choice.
   
   xenkernel46 provides Xen 4.6.  It is new to pkgsrc as of 2016-05.  As
   of 2016-12, security patches were released by Xen and applied to
   pkgsrc.  Xen 4.6 runs on amd64 hardware only For new installations,
   4.6 is probably the appropriate choice and it will likely soon be the
   standard approach.
   
 xenkernel42 provides Xen 4.2.  This is maintained by Xen, but old as  Xen 4.7 (released 2016-06) and 4.8 (released 2016-12) are not yet in
 of 2014-12.  pkgsrc.
   
 Ideally newer versions of Xen will be added to pkgsrc.  See also the [Xen Security Advisory page](http://xenbits.xen.org/xsa/).
   
 Note that NetBSD support is called XEN3.  It works with 3.1 through  Note that NetBSD support is called XEN3.  It works with Xen 3 and Xen
 4.2 because the hypercall interface has been stable.  4 because the hypercall interface has been stable.
   
 Xen command program  Xen command program
 -------------------  -------------------
   
 Early Xen used a program called "xm" to manipulate the system from the  Early Xen used a program called xm to manipulate the system from the
 dom0.  Starting in 4.1, a replacement program with similar behavior  dom0.  Starting in 4.1, a replacement program with similar behavior
 called "xl" is provided.  In 4.2 and later, "xl" is preferred.  4.4 is  called xl is provided, but it does not work well in 4.1.  In 4.2, both
 the last version that has "xm".  xm and xl work fine.  4.4 is the last version that has xm.
   
   You must make a global choice to use xm or xl, because it affects not
   only which command you use, but the command used by rc.d scripts
   (specifically xendomains) and which daemons should be run.  The
   xentools packages provide xm for 3.1, 3.3 and 4.1 and xl for 4.2 and up.
   
   In 4.2, you can choose to use xm by simply changing the ctl_command
   variable.
   
   With xl, virtual devices are configured in parallel, which can cause
   problems if they are written assuming serial operation (e.g., updating
   firewall rules without explicit locking).  There is now locking for
   the provided scripts, which works for normal casses (e.g, file-backed
   xbd, where a vnd must be allocated).  But, as of 201612, it has not
   been adequately tested for a complex custom setup with a large number
   of interfaces.
   
 NetBSD  NetBSD
 ------  ------
   
 The netbsd-5, netbsd-6, netbsd-7, and -current branches are all  The netbsd-6, netbsd-7, and -current branches are all reasonable
 reasonable choices, with more or less the same considerations for  choices, with more or less the same considerations for non-Xen use.
 non-Xen use.  Therefore, netbsd-6 is recommended as the stable version  Therefore, netbsd-7 is recommended as the stable version of the most
 of the most recent release for production use.  For those wanting to  recent release for production use.  In addition, netbsd-7 and -current
 learn Xen or without production stability concerns, netbsd-7 is likely  have a important scheduler fix (in November of 2015) affecting
 most appropriate.  contention between dom0 and domUs; see
   https://releng.netbsd.org/cgi-bin/req-7.cgi?show=1040 for a
   description.  For those wanting to learn Xen or without production
   stability concerns, netbsd-7 is still likely most appropriate, but
   -current is also a reasonable choice.  (Xen runs ok on netbsd-5, but
   the xentools packages are likely difficult to build, and netbsd-5 is
   not supported.)
   
 As of NetBSD 6, a NetBSD domU will support multiple vcpus.  There is  As of NetBSD 6, a NetBSD domU will support multiple vcpus.  There is
 no SMP support for NetBSD as dom0.  (The dom0 itself doesn't really  no SMP support for NetBSD as dom0.  (The dom0 itself doesn't really
 need SMP; the lack of support is really a problem when using a dom0 as  need SMP for dom0 functions; the lack of support is really a problem
 a normal computer.)  when using a dom0 as a normal computer.)
   
 Architecture  Architecture
 ------------  ------------
   
 Xen itself can run on i386 or amd64 machines.  (Practically, almost  Xen itself can run on i386 (Xen < 4.2) or amd64 hardware (all Xen
 any computer where one would want to run Xen supports amd64.)  If  versions).  (Practically, almost any computer where one would want to
 using an i386 NetBSD kernel for the dom0, PAE is required (PAE  run Xen today supports amd64.)
 versions are built by default).  While i386 dom0 works fine, amd64 is  
 recommended as more normal.  Xen, the dom0 system, and each domU system can be either i386 or
   amd64.  When building a xenkernel package, one obtains an i386 Xen
 Xen 4.2 is the last version to support i386 as a host.  TODO: Clarify  kernel on an i386 host, and anamd64 Xen kernel on an amd64 host.  If
 if this is about the CPU having to be amd64, or about the dom0 kernel  the Xen kernel is i386, then the dom0 kernel and all domU kernels must
 having to be amd64.  be i386.  With an amd64 Xen kernel, an amd64 dom0 kernel is known to
   work, and an i386 dom0 kernel should in theory work.  An amd64
 One can then run i386 domUs and amd64 domUs, in any combination.  If  Xen/dom0 is known to support both i386 and amd64 domUs.
 running an i386 NetBSD kernel as a domU, the PAE version is required.  
 (Note that emacs (at least) fails if run on i386 with PAE when built  i386 dom0 and domU kernels must be PAE (except for an i386 Xen 3.1
 without, and vice versa, presumably due to bugs in the undump code.)  kernel, where one can use non-PAE for dom0 and all domUs); PAE
   versions are included in the NetBSD default build.  (Note that emacs
   (at least) fails if run on i386 with PAE when built without, and vice
   versa, presumably due to bugs in the undump code.)
   
   Because of the above, the standard approach is to use NetBSD/amd64 for
   the dom0 and therefore an amd64 Xen kernel, and to use PAE kernels for
   i386 domUs.
   
   Note that to use an i386 dom0 with Xen 4.5 or higher, one must build
   an amd64 Xen kernel and install that on the system.  One must also use
   a PAE i386 kernel.  There is no good reason to undertake these
   contortions; you should use a NetBSD/amd64 dom0 system.
   
   Stability
   ---------
   
   Mostly, NetBSD as a dom0 or domU is quite stable.
   However, there are some open PRs indicating problems.
   
    - [PR 48125](http://gnats.netbsd.org/48125)
    - [PR 47720](http://gnats.netbsd.org/47720)
   
   Note also that there are issues with sparse vnd(4) instances, but
   these are not about Xen -- they just are noticed with sparse vnd(4)
   instances in support of virtual disks in a dom0.
   
 Recommendation  Recommendation
 --------------  --------------
   
 Therefore, this HOWTO recommends running xenkernel42 (and xentools42),  Therefore, this HOWTO recommends running xenkernel45 or xenkernel46,
 xl, the NetBSD 6 stable branch, and to use an amd64 kernel as the  xl, the NetBSD 7 stable branch, and to use an amd64 kernel as the
 dom0.  Either the i386 or amd64 of NetBSD may be used as domUs.  dom0.  Either the i386PAE or amd64 version of NetBSD may be used as
   domUs.
   
 Build problems  Status
 --------------  ------
   
 Ideally, all versions of Xen in pkgsrc would build on all versions of  Ideally, all versions of Xen in pkgsrc would build on all supported
 NetBSD on both i386 and amd64.  However, that isn't the case.  Besides  versions of NetBSD/amd64, to the point where this section would be
 aging code and aging compilers, qemu (included in xentools for HVM  silly.  However, that has not always been the case.  Besides aging
 support) is difficult to build.  The following are known to fail:  code and aging compilers, qemu (included in xentools for HVM support)
   is difficult to build.  Note that there is intentionally no data for
         xenkernel3 netbsd-6 i386  4.5+ up for i386, and often omits xentools info if the corresponding
         xentools42 netbsd-6 i386   kernel fails.
   
 The following are known to work:  The following table gives status, with the date last checked
   (generally on the most recent quarterly branch).  The first code is
         xenkernel41 netbsd-5 amd64  "builds" if it builds ok, and "FAIL" for a failure to build.  The
         xentools41 netbsd-5 amd64  second code/date only appears for xenkernel* and is "works" if it runs
         xenkernel41 netbsd-6 i386  ok as a dom0, and "FAIL" if it won't boot or run a domU.
         xentools41 netbsd-6 i386  
           xenkernel3 netbsd-6 i386 FAIL 201612
           xenkernel33 netbsd-6 i386 FAIL 201612
           xenkernel41 netbsd-6 i386 builds 201612
           xenkernel42 netbsd-6 i386 builds 201612
           xentools3 netbsd-6 i386 FAIL 201612
           xentools33 netbsd-6 i386 FAIL 201612
           xentools41 netbsd-6 i386 builds 201612
           xentools42 netbsd-6 i386 FAIL 201612
   
           xenkernel3 netbsd-7 i386 FAIL 201412
           xenkernel33 netbsd-7 i386 FAIL 201412
           xenkernel41 netbsd-7 i386 builds 201412
           xenkernel42 netbsd-7 i386 builds 201412
           xentools41 netbsd-7 i386 builds 201412
           xentools42 netbsd-7 i386 ??FAIL 201412
   
           xenkernel3 netbsd-6 amd64 FAIL 201612
           xenkernel33 netbsd-6 amd64 FAIL 201612
           xenkernel41 netbsd-6 amd64 builds 201612 works 201612
           xenkernel42 netbsd-6 amd64 builds 201612 works 201612
           xenkernel45 netbsd-6 amd64 builds 201612
           xenkernel46 netbsd-6 amd64 builds 201612
           xentools41 netbsd-6 amd64 builds 201612
           xentools42 netbsd-6 amd64 builds 201612
           xentools45 netbsd-6 amd64 builds 201612
           xentools46 netbsd-6 amd64 FAIL 201612
   
           xenkernel3 netbsd-7 amd64 builds 201612
           xenkernel33 netbsd-7 amd64 builds 201612
           xenkernel41 netbsd-7 amd64 builds 201612
           xenkernel42 netbsd-7 amd64 builds 201612
           xenkernel45 netbsd-7 amd64 builds 201612
           xenkernel46 netbsd-7 amd64 builds 201612
           xentools3 netbsd-7 amd64 builds 201612
           xentools3-hvm netbsd-7 amd64 builds 201612
           xentools33 netbsd-7 amd64 FAIL 201612
           xentools41 netbsd-7 amd64 builds 201612
           xentools42 netbsd-7 amd64 builds 201612
           xentools45 netbsd-7 amd64 builds 201612
           xentools46 netbsd-7 amd64 builds 201612
   
 NetBSD as a dom0  NetBSD as a dom0
 ================  ================
Line 198  dom0 is what the computer would have bee Line 318  dom0 is what the computer would have bee
 desktop or laptop.  Then, one can run domUs at will.  Purists will  desktop or laptop.  Then, one can run domUs at will.  Purists will
 deride this as less secure than the previous approach, and for a  deride this as less secure than the previous approach, and for a
 computer whose purpose is to run domUs, they are right.  But Xen and a  computer whose purpose is to run domUs, they are right.  But Xen and a
 dom0 (without domUs) is not meaingfully less secure than the same  dom0 (without domUs) is not meaningfully less secure than the same
 things running without Xen.  One can boot Xen or boot regular NetBSD  things running without Xen.  One can boot Xen or boot regular NetBSD
 alternately with little problems, simply refraining from starting the  alternately with little problems, simply refraining from starting the
 Xen daemons when not running Xen.  Xen daemons when not running Xen.
   
 Note that NetBSD as dom0 does not support multiple CPUs.  This will  Note that NetBSD as dom0 does not support multiple CPUs.  This will
 limit the performance of the Xen/dom0 workstation approach.  limit the performance of the Xen/dom0 workstation approach.  In theory
   the only issue is that the "backend drivers" are not yet MPSAFE:
     http://mail-index.netbsd.org/netbsd-users/2014/08/29/msg015195.html
   
 Installation of NetBSD  Installation of NetBSD
 ----------------------  ----------------------
Line 217  However, the partitioning approach is ve Line 339  However, the partitioning approach is ve
 If you want to use RAIDframe for the dom0, there are no special issues  If you want to use RAIDframe for the dom0, there are no special issues
 for Xen.  Typically one provides RAID storage for the dom0, and the  for Xen.  Typically one provides RAID storage for the dom0, and the
 domU systems are unaware of RAID.  The 2nd-stage loader bootxx_* skips  domU systems are unaware of RAID.  The 2nd-stage loader bootxx_* skips
 over a RAID1 header to find /boot from a filesystem within a RAID  over a RAID1 header to find /boot from a file system within a RAID
 partition; this is no different when booting Xen.  partition; this is no different when booting Xen.
   
 There are 4 styles of providing backing storage for the virtual disks  There are 4 styles of providing backing storage for the virtual disks
 used by domUs: raw partitions, LVM, file-backed vnd(4), and SAN,  used by domUs: raw partitions, LVM, file-backed vnd(4), and SAN.
   
 With raw partitions, one has a disklabel (or gpt) partition sized for  With raw partitions, one has a disklabel (or gpt) partition sized for
 each virtual disk to be used by the domU.  (If you are able to predict  each virtual disk to be used by the domU.  (If you are able to predict
Line 233  for domU disks.  This is almost as effic Line 355  for domU disks.  This is almost as effic
 and more flexible.  Hence raw disk partitions should typically not  and more flexible.  Hence raw disk partitions should typically not
 be used.  be used.
   
 One can use files in the dom0 filesystem, typically created by dd'ing  One can use files in the dom0 file system, typically created by dd'ing
 /dev/zero to create a specific size.  This is somewhat less efficient,  /dev/zero to create a specific size.  This is somewhat less efficient,
 but very convenient, as one can cp the files for backup, or move them  but very convenient, as one can cp the files for backup, or move them
 between dom0 hosts.  between dom0 hosts.
Line 246  Installation of Xen Line 368  Installation of Xen
 -------------------  -------------------
   
 In the dom0, install sysutils/xenkernel42 and sysutils/xentools42 from  In the dom0, install sysutils/xenkernel42 and sysutils/xentools42 from
 pkgsrc (or another matching pair).  pkgsrc (or another matching pair).  See [the pkgsrc
 See [the pkgsrc  documentation](http://www.NetBSD.org/docs/pkgsrc/) for help with
 documentation](http://www.NetBSD.org/docs/pkgsrc/) for help with pkgsrc.  pkgsrc.  Ensure that your packages are recent; the HOWTO does not
   contemplate old builds.
   
   
 For Xen 3.1, support for HVM guests is in sysutils/xentool3-hvm.  More  For Xen 3.1, support for HVM guests is in sysutils/xentool3-hvm.  More
 recent versions have HVM support integrated in the main xentools  recent versions have HVM support integrated in the main xentools
Line 260  For debugging, one may copy xen-debug.gz Line 384  For debugging, one may copy xen-debug.gz
 to DIAGNOSTIC and DEBUG in NetBSD.  xen-debug.gz is basically only  to DIAGNOSTIC and DEBUG in NetBSD.  xen-debug.gz is basically only
 useful with a serial console.  Then, place a NetBSD XEN3_DOM0 kernel  useful with a serial console.  Then, place a NetBSD XEN3_DOM0 kernel
 in /, copied from releasedir/amd64/binary/kernel/netbsd-XEN3_DOM0.gz  in /, copied from releasedir/amd64/binary/kernel/netbsd-XEN3_DOM0.gz
 of a NetBSD build.  Both xen and NetBSD may be left compressed.  (If  of a NetBSD build.  If using i386, use
 using i386, use releasedir/i386/binary/kernel/netbsd-XEN3PAE_DOM0.gz.)  releasedir/i386/binary/kernel/netbsd-XEN3PAE_DOM0.gz.  (If using Xen
   3.1 and i386, you may use XEN3_DOM0 with the non-PAE Xen.  But you
 With Xen as the kernel, you must provide a dom0 NetBSD kernel to be  should not use Xen 3.1.)  Both xen and the NetBSD kernel may be (and
 used as a module; place this in /.  Suitable kernels are provided in  typically are) left compressed.
 releasedir/binary/kernel:  
   In a dom0 kernel, kernfs is mandatory for xend to communicate with the
         i386 XEN3_DOM0  kernel, so ensure that /kern is in fstab.  TODO: Say this is default,
         i386 XEN3PAE_DOM0  or file a PR and give a reference.
         amd64 XEN3_DOM0  
   
 The first one is only for use with Xen 3.1 and i386-mode Xen (and you  
 should not do this).  Current Xen always uses PAE on i386, but you  
 should generally use amd64 for the dom0.  In a dom0 kernel, kernfs is  
 mandatory for xend to comunicate with the kernel, so ensure that /kern  
 is in fstab.  TODO: Say this is default, or file a PR and give a  
 reference.  
   
 Because you already installed NetBSD, you have a working boot setup  Because you already installed NetBSD, you have a working boot setup
 with an MBR bootblock, either bootxx_ffsv1 or bootxx_ffsv2 at the  with an MBR bootblock, either bootxx_ffsv1 or bootxx_ffsv2 at the
 beginning of your root filesystem, /boot present, and likely  beginning of your root file system, /boot present, and likely
 /boot.cfg.  (If not, fix before continuing!)  /boot.cfg.  (If not, fix before continuing!)
   
 See boot.cfg(5) for an example.  The basic line is  Add a line to to /boot.cfg to boot Xen.  See boot.cfg(5) for an
   example.  The basic line is
   
         menu=Xen:load /netbsd-XEN3_DOM0.gz console=pc;multiboot /xen.gz dom0_mem=256M          menu=Xen:load /netbsd-XEN3_DOM0.gz console=pc;multiboot /xen.gz dom0_mem=256M
   
 which specifies that the dom0 should have 256M, leaving the rest to be  which specifies that the dom0 should have 256M, leaving the rest to be
 allocated for domUs.  In an attempt to add performance, one can also  allocated for domUs.  To use a serial console, use
 add  
           menu=Xen:load /netbsd-XEN3_DOM0.gz console=com0;multiboot /xen.gz dom0_mem=256M console=com1 com1=9600,8n1
   
   which will use the first serial port for Xen (which counts starting
   from 1), forcing speed/parity, and also for NetBSD (which counts
   starting at 0).  In an attempt to add performance, one can also add
   
         dom0_max_vcpus=1 dom0_vcpus_pin          dom0_max_vcpus=1 dom0_vcpus_pin
   
 to force only one vcpu to be provided (since NetBSD dom0 can't use  to force only one vcpu to be provided (since NetBSD dom0 can't use
 more) and to pin that vcpu to a physical cpu.  TODO: benchmark this.  more) and to pin that vcpu to a physical CPU.  TODO: benchmark this.
   
   Xen has [many boot
   options](http://xenbits.xenproject.org/docs/4.5-testing/misc/xen-command-line.html),
   and other than dom0 memory and max_vcpus, they are generally not
   necessary.
   
 As with non-Xen systems, you should have a line to boot /netbsd (a  As with non-Xen systems, you should have a line to boot /netbsd (a
 kernel that works without Xen) and fallback versions of the non-Xen  kernel that works without Xen).  Consider a line to boot /netbsd.ok (a
 kernel, Xen, and the dom0 kernel.  fallback version of the non-Xen kernel, updated manually when you are
   sure /netbsd is ok).  Consider also a line to boot fallback versions
   of Xen and the dom0 kernel, but note that non-Xen NetBSD can be used
   to resolve Xen booting issues.
   
   Probably you want a default=N line to choose Xen in the absence of
   intervention.
   
   Now, reboot so that you are running a DOM0 kernel under Xen, rather
   than GENERIC without Xen.
   
   Using grub (historic)
   ---------------------
   
   Before NetBSD's native bootloader could support Xen, the use of
   grub was recommended.  If necessary, see the
   [old grub information](/ports/xen/howto-grub/).
   
 The [HowTo on Installing into  The [HowTo on Installing into
 RAID-1](http://mail-index.NetBSD.org/port-xen/2006/03/01/0010.html)  RAID-1](http://mail-index.NetBSD.org/port-xen/2006/03/01/0010.html)
Line 309  boot.) Line 452  boot.)
 Configuring Xen  Configuring Xen
 ---------------  ---------------
   
 Now, you have a system that will boot Xen and the dom0 kernel, and  Xen logs will be in /var/log/xen.
 just run the dom0 kernel.  There will be no domUs, and none can be  
 started because you still have to configure the dom0 tools.  The  
 daemons which should be run vary with Xen version and with whether one  
 is using xm or xl.  Note that xend is for supporting "xm", and should  
 only be used if you plan on using "xm".  Do NOT enable xend if you  
 plan on using "xl" as it will cause problems.  
   
 The installation of NetBSD should already have created devices for xen  Now, you have a system that will boot Xen and the dom0 kernel, but not
 (xencons, xenevt), but if they are not present, create them:  do anything else special.  Make sure that you have rebooted into Xen.
   There will be no domUs, and none can be started because you still have
         cd /dev && sh MAKEDEV xen  to configure the dom0 daemons.
   
   The daemons which should be run vary with Xen version and with whether
   one is using xm or xl.  The Xen 3.1, 3.3 and 4.1 packages use xm.  Xen
   4.2 and up packages use xl.  To use xm with 4.2, edit xendomains to
   use xm instead.
   
 TODO: Give 3.1 advice (or remove it from pkgsrc).  For 3.1 and 3.3, you should enable xend and xenbackendd:
   
 For 3.3 (and thus xm), add to rc.conf (but note that you should have  
 installed 4.1 or 4.2):  
   
         xend=YES          xend=YES
         xenbackendd=YES          xenbackendd=YES
   
 For 4.1 (and thus xm; xl is believed not to work well), add to rc.conf:  For 4.1 and up, you should enable xencommons.  Not enabling xencommons
   will result in a hang; it is necessary to hit ^C on the console to let
         xend=YES  the machine finish booting.  If you are using xm (default in 4.1, or
         xencommons=YES  if you changed xendomains in 4.2), you should also enable xend:
   
 TODO: Explain why if xm is preferred on 4.1, rc.d/xendomains has xl.  
 Or fix the package.  
   
 For 4.2 with xm, add to rc.conf          xend=YES # only if using xm, and only installed <= 4.2
   
         xend=YES  
         xencommons=YES  
   
 For 4.2 with xl (preferred), add to rc.conf:  
   
         TODO: explain if there is a xend replacement  
         xencommons=YES          xencommons=YES
   
 TODO: Recommend for/against xen-watchdog.  TODO: Recommend for/against xen-watchdog.
   
 After you have configured the daemons and either started them or  After you have configured the daemons and either started them (in the
 rebooted, run the following (or use xl) to inspect Xen's boot  order given) or rebooted, use xm or xl to inspect Xen's boot messages,
 messages, available resources, and running domains:  available resources, and running domains.  An example with xl follows:
   
         # xm dmesg          # xl dmesg
         [xen's boot info]          [xen's boot info]
         # xm info          # xl info
         [available memory, etc.]          [available memory, etc.]
         # xm list          # xl list
         Name              Id  Mem(MB)  CPU  State  Time(s)  Console          Name              Id  Mem(MB)  CPU  State  Time(s)  Console
         Domain-0           0       64    0  r----     58.1          Domain-0           0       64    0  r----     58.1
   
 anita (for testing NetBSD)  ### Issues with xencommons
 --------------------------  
   
 With the setup so far, one should be able to run anita (see  xencommons starts xenstored, which stores data on behalf of dom0 and
 pkgsrc/sysutils/py-anita) to test NetBSD releases, by doing (as root,  domUs.  It does not currently work to stop and start xenstored.
 because anita must create a domU):  Certainly all domUs should be shutdown first, following the sort order
   of the rc.d scripts.  However, the dom0 sets up state with xenstored,
   and is not notified when xenstored exits, leading to not recreating
   the state when the new xenstored starts.  Until there's a mechanism to
   make this work, one should not expect to be able to restart xenstored
   (and thus xencommons).  There is currently no reason to expect that
   this will get fixed any time soon.
   
         anita --vmm=xm test file:///usr/obj/i386/  ### No-longer needed advice about devices
   
 Alternatively, one can use --vmm=xl to use xl-based domU creation instead.  The installation of NetBSD should already have created devices for xen
 TODO: check this.  (xencons, xenevt, xsd_kva), but if they are not present, create them:
   
           cd /dev && sh MAKEDEV xen
   
   anita (for testing NetBSD)
   --------------------------
   
   With the setup so far (assuming 4.2/xl), one should be able to run
   anita (see pkgsrc/misc/py-anita) to test NetBSD releases, by doing (as
   root, because anita must create a domU):
   
           anita --vmm=xl test file:///usr/obj/i386/
   
   Alternatively, one can use --vmm=xm to use xm-based domU creation
   instead (and must, on Xen <= 4.1).   TODO: confirm that anita xl really works.
       
 Xen-specific NetBSD issues  Xen-specific NetBSD issues
 --------------------------  --------------------------
   
 There are (at least) two additional things different about NetBSD as a  There are (at least) two additional things different about NetBSD as a
 dom0 kernel compared to hardware.  dom0 kernel compared to hardware.
   
 One is that modules are not usable in DOM0 kernels, so one must  One is that the module ABI is different because some of the #defines
 compile in what's needed.  It's not really that modules cannot work,  change, so one must build modules for Xen.  As of netbsd-7, the build
 but that modules must be built for XEN3_DOM0 because some of the  system does this automatically.  TODO: check this.  (Before building
 defines change and the normal module builds don't do this.  Basically,  Xen modules was added, it was awkward to use modules to the point
 enabling Xen changes the kernel ABI, and the module build system  where it was considered that it did not work.)
 doesn't cope with this.  
   
 The other difference is that XEN3_DOM0 does not have exactly the same  The other difference is that XEN3_DOM0 does not have exactly the same
 options as GENERIC.  While it is debatable whether or not this is a  options as GENERIC.  While it is debatable whether or not this is a
Line 403  and adjusts /etc. Line 550  and adjusts /etc.
 Note that one must update both the non-Xen kernel typically used for  Note that one must update both the non-Xen kernel typically used for
 rescue purposes and the DOM0 kernel used with Xen.  rescue purposes and the DOM0 kernel used with Xen.
   
 To convert from grub to /boot, install an mbr bootblock with fdisk,  Converting from grub to /boot
 bootxx_ with installboot, /boot and /boot.cfg.  This really should be  -----------------------------
 no different than completely reinstalling boot blocks on a non-Xen  
 system.  
   
 Updating Xen versions  These instructions were [TODO: will be] used to convert a system from
   grub to /boot.  The system was originally installed in February of
   2006 with a RAID1 setup and grub to boot Xen 2, and has been updated
   over time.  Before these commands, it was running NetBSD 6 i386, Xen
   4.1 and grub, much like the message linked earlier in the grub
   section.
   
           # Install MBR bootblocks on both disks. 
           fdisk -i /dev/rwd0d
           fdisk -i /dev/rwd1d
           # Install NetBSD primary boot loader (/ is FFSv1) into RAID1 components.
           installboot -v /dev/rwd0d /usr/mdec/bootxx_ffsv1
           installboot -v /dev/rwd1d /usr/mdec/bootxx_ffsv1
           # Install secondary boot loader
           cp -p /usr/mdec/boot /
           # Create boot.cfg following earlier guidance:
           menu=Xen:load /netbsd-XEN3PAE_DOM0.gz console=pc;multiboot /xen.gz dom0_mem=256M
           menu=Xen.ok:load /netbsd-XEN3PAE_DOM0.ok.gz console=pc;multiboot /xen.ok.gz dom0_mem=256M
           menu=GENERIC:boot
           menu=GENERIC single-user:boot -s
           menu=GENERIC.ok:boot netbsd.ok
           menu=GENERIC.ok single-user:boot netbsd.ok -s
           menu=Drop to boot prompt:prompt
           default=1
           timeout=30
   
   TODO: actually do this and fix it if necessary.
   
   Upgrading Xen versions
 ---------------------  ---------------------
   
 Updating Xen is conceptually not difficult, but can run into all the  Minor version upgrades are trivial.  Just rebuild/replace the
 issues found when installing Xen.  Assuming migration from 4.1 to 4.2,  xenkernel version and copy the new xen.gz to / (where /boot.cfg
 remove the xenkernel41 and xentools41 packages and install the  references it), and reboot.
 xenkernel42 and xentools42 packages.  Copy the 4.2 xen.gz to /.  
   Major version upgrades are conceptually not difficult, but can run
 Ensure that the contents of /etc/rc.d/xen* are correct.  Enable the  into all the issues found when installing Xen.  Assuming migration
 correct set of daemons.  Ensure that the domU config files are valid  from 4.1 to 4.2, remove the xenkernel41 and xentools41 packages and
 for the new version.  install the xenkernel42 and xentools42 packages.  Copy the 4.2 xen.gz
   to /.
   
   Ensure that the contents of /etc/rc.d/xen* are correct.  Specifically,
   they must match the package you just installed and not be left over
   from some previous installation.
   
   Enable the correct set of daemons; see the configuring section above.
   (Upgrading from 3.x to 4.x without doing this will result in a hang.)
   
   Ensure that the domU config files are valid for the new version.
   Specifically, for 4.x remove autorestart=True, and ensure that disks
   are specified with numbers as the second argument, as the examples
   above show, and not NetBSD device names.
   
   Hardware known to work
   ----------------------
   
   Arguably, this section is misplaced, and there should be a page of
   hardware that runs NetBSD/amd64 well, with the mostly-well-founded
   assumption that NetBSD/xen runs fine on any modern hardware that
   NetBSD/amd64 runs well on.  Until then, we give motherboard/CPU (and
   sometimes RAM) pairs/triples to aid those choosing a motherboard.
   Note that Xen systems usually do not run X, so a listing here does not
   imply that X works at all.
   
           Supermicro X9SRL-F, Xeon E5-1650 v2, 96 GiB ECC
           Supermicro ??, Atom C2758 (8 core), 32 GiB ECC
           ASUS M5A78L-M/USB3 AM3+ microATX, AMD Piledriver X8 4000MHz, 16 GiB ECC
   
   Older hardware:
   
           Intel D915GEV, Pentium4 CPU 3.40GHz, 4GB 533MHz Synchronous DDR2
           INTEL DG33FB, "Intel(R) Core(TM)2 Duo CPU     E6850  @ 3.00GHz"
           INTEL DG33FB, "Intel(R) Core(TM)2 Duo CPU     E8400  @ 3.00GHz"
   
   Running Xen under qemu
   ----------------------
   
   The astute reader will note that this section is somewhat twisted.
   However, it can be useful to run Xen under qemu either because the
   version of NetBSD as a dom0 does not run on the hardware in use, or to
   generate automated test cases involving Xen.
   
   In 2015-01, the following combination was reported to mostly work:
   
           host OS: NetBSD/amd64 6.1.4
           qemu: 2.2.0 from pkgsrc
           Xen kernel: xenkernel42-4.2.5nb1 from pkgsrc
           dom0 kernel: NetBSD/amd64 6.1.5
           Xen tools: xentools42-4.2.5 from pkgsrc
   
   See [PR 47720](http://gnats.netbsd.org/47720) for a problem with dom0
   shutdown.
   
 Unprivileged domains (domU)  Unprivileged domains (domU)
 ===========================  ===========================
Line 427  Unprivileged domains (domU) Line 652  Unprivileged domains (domU)
 This section describes general concepts about domUs.  It does not  This section describes general concepts about domUs.  It does not
 address specific domU operating systems or how to install them.  The  address specific domU operating systems or how to install them.  The
 config files for domUs are typically in /usr/pkg/etc/xen, and are  config files for domUs are typically in /usr/pkg/etc/xen, and are
 typically named so that the file anme, domU name and the domU's host  typically named so that the file name, domU name and the domU's host
 name match.  name match.
   
 The domU is provided with cpu and memory by Xen, configured by the  The domU is provided with CPU and memory by Xen, configured by the
 dom0.  The domU is provided with disk and network by the dom0,  dom0.  The domU is provided with disk and network by the dom0,
 mediated by Xen, and configured in the dom0.  mediated by Xen, and configured in the dom0.
   
Line 467  domUs independently.  The vif line cause Line 692  domUs independently.  The vif line cause
 with a specific mac address (do not reuse MAC addresses!), in bridge  with a specific mac address (do not reuse MAC addresses!), in bridge
 mode.  Two disks are provided, and they are both writable; the bits  mode.  Two disks are provided, and they are both writable; the bits
 are stored in files and Xen attaches them to a vnd(4) device in the  are stored in files and Xen attaches them to a vnd(4) device in the
 dom0 on domain creation.  The system treates xbd0 as the boot device  dom0 on domain creation.  The system treats xbd0 as the boot device
 without needing explicit configuration.  without needing explicit configuration.
   
 By default xm looks for domain config files in /usr/pkg/etc/xen.  Note  By default xm looks for domain config files in /usr/pkg/etc/xen.  Note
Line 481  domain, and see if it has finished stopp Line 706  domain, and see if it has finished stopp
         xm console foo          xm console foo
         xm create -c foo          xm create -c foo
         xm shutdown foo          xm shutdown foo
         xm list          xm list
   
 Typing ^] will exit the console session.  Shutting down a domain is  Typing ^] will exit the console session.  Shutting down a domain is
 equivalent to pushing the power button; a NetBSD domU will receive a  equivalent to pushing the power button; a NetBSD domU will receive a
Line 493  domU kernels Line 718  domU kernels
   
 On a physical computer, the BIOS reads sector 0, and a chain of boot  On a physical computer, the BIOS reads sector 0, and a chain of boot
 loaders finds and loads a kernel.  Normally this comes from the root  loaders finds and loads a kernel.  Normally this comes from the root
 filesystem.  With Xen domUs, the process is totally different.  The  file system.  With Xen domUs, the process is totally different.  The
 normal path is for the domU kernel to be a file in the dom0's  normal path is for the domU kernel to be a file in the dom0's
 filesystem.  At the request of the dom0, Xen loads that kernel into a  file system.  At the request of the dom0, Xen loads that kernel into a
 new domU instance and starts execution.  While domU kernels can be  new domU instance and starts execution.  While domU kernels can be
 anyplace, reasonable places to store domU kernels on the dom0 are in /  anyplace, reasonable places to store domU kernels on the dom0 are in /
 (so they are near the dom0 kernel), in /usr/pkg/etc/xen (near the  (so they are near the dom0 kernel), in /usr/pkg/etc/xen (near the
 config files), or in /u0/xen (where the vdisks are).  config files), or in /u0/xen (where the vdisks are).
   
   Note that loading the domU kernel from the dom0 implies that boot
   blocks, /boot, /boot.cfg, and so on are all ignored in the domU.
 See the VPS section near the end for discussion of alternate ways to  See the VPS section near the end for discussion of alternate ways to
 obtain domU kernels.  obtain domU kernels.
   
Line 508  CPU and memory Line 735  CPU and memory
 --------------  --------------
   
 A domain is provided with some number of vcpus, less than the number  A domain is provided with some number of vcpus, less than the number
 of cpus seen by the hypervisor.  (For a dom0, this is controlled by  of CPUs seen by the hypervisor.  (For a dom0, this is controlled by
 the boot argument "dom0_max_vcpus=1".)  For a domU, it is controlled  the boot argument "dom0_max_vcpus=1".)  For a domU, it is controlled
 from the config file by the "vcpus = N" directive.  from the config file by the "vcpus = N" directive.
   
Line 532  for the first virtual disk for the domU  Line 759  for the first virtual disk for the domU 
 the file serves two purposes.  One is that preallocating the contents  the file serves two purposes.  One is that preallocating the contents
 improves performance.  The other is that vnd on sparse files has  improves performance.  The other is that vnd on sparse files has
 failed to work.  TODO: give working/notworking NetBSD versions for  failed to work.  TODO: give working/notworking NetBSD versions for
 sparse vnd.  Note that the use of file/vnd for Xen is not really  sparse vnd and gnats reference.  Note that the use of file/vnd for Xen
 different than creating a file-backed virtual disk for some other  is not really different than creating a file-backed virtual disk for
 purpose, except that xentools handles the vnconfig commands.  To  some other purpose, except that xentools handles the vnconfig
 create an empty 4G virtual disk, simply do  commands.  To create an empty 4G virtual disk, simply do
   
         dd if=/dev/zero of=foo-xbd0 bs=1m count=4096          dd if=/dev/zero of=foo-xbd0 bs=1m count=4096
   
   Do not use qemu-img-xen, because this will create sparse file.  There
   have been recent (2015) reports of sparse vnd(4) devices causing
   lockups, but there is apparently no PR.
   
 With the lvm style, one creates logical devices.  They are then used  With the lvm style, one creates logical devices.  They are then used
 similarly to vnds.  TODO: Add an example with lvm.  similarly to vnds.  TODO: Add an example with lvm.
   
Line 565  guest, one can create /dev/hda1 in /dev, Line 796  guest, one can create /dev/hda1 in /dev,
 The third element is "w" for writable disks, and "r" for read-only  The third element is "w" for writable disks, and "r" for read-only
 disks.  disks.
   
   Note that NetBSD by default creates only vnd[0123].  If you need more
   than 4 total virtual disks at a time, run e.g. "./MAKEDEV vnd4" in the
   dom0.
   
   Note that NetBSD by default creates only xbd[0123].  If you need more
   virtual disks in a domU, run e.g. "./MAKEDEV xbd4" in the domU.
   
 Virtual Networking  Virtual Networking
 ------------------  ------------------
   
 Xen provides virtual ethernets, each of which connects the dom0 and a  Xen provides virtual Ethernets, each of which connects the dom0 and a
 domU.  For each virtual network, there is an interface "xvifN.M" in  domU.  For each virtual network, there is an interface "xvifN.M" in
 the dom0, and in domU index N, a matching interface xennetM (NetBSD  the dom0, and in domU index N, a matching interface xennetM (NetBSD
 name).  The interfaces behave as if there is an Ethernet with two  name).  The interfaces behave as if there is an Ethernet with two
 adaptors connected.  From this primitive, one can construct various  adapters connected.  From this primitive, one can construct various
 configurations.  We focus on two common and useful cases for which  configurations.  We focus on two common and useful cases for which
 there are existing scripts: bridging and NAT.  there are existing scripts: bridging and NAT.
   
Line 593  dom0.  This is often appropriate when ru Line 831  dom0.  This is often appropriate when ru
 TODO: NAT appears to be configured by "vif = [ '' ]".  TODO: NAT appears to be configured by "vif = [ '' ]".
   
 The MAC address specified is the one used for the interface in the new  The MAC address specified is the one used for the interface in the new
 domain.  The interface in domain0 will use this address XOR'd with  domain.  The interface in dom0 will use this address XOR'd with
 00:00:00:01:00:00.  Random MAC addresses are assigned if not given.  00:00:00:01:00:00.  Random MAC addresses are assigned if not given.
   
 Sizing domains  Sizing domains
Line 616  shutdown, in rc.conf add: Line 854  shutdown, in rc.conf add:
   
         xendomains="foo bar"          xendomains="foo bar"
   
 TODO: Explain why 4.1 rc.d/xendomains has xl, when one should use xm  Note that earlier versions of the xentools41 xendomains rc.d script
 on 4.1.  Or fix the xentools41 package to have xm  used xl, when one should use xm with 4.1.
   
 Creating specific unprivileged domains (domU)  Creating specific unprivileged domains (domU)
 =============================================  =============================================
Line 633  Creating an unprivileged NetBSD domain ( Line 871  Creating an unprivileged NetBSD domain (
 See the earlier config file, and adjust memory.  Decide on how much  See the earlier config file, and adjust memory.  Decide on how much
 storage you will provide, and prepare it (file or lvm).  storage you will provide, and prepare it (file or lvm).
   
 While the kernel will be obtained from the dom0 filesystem, the same  While the kernel will be obtained from the dom0 file system, the same
 file should be present in the domU as /netbsd so that tools like  file should be present in the domU as /netbsd so that tools like
 savecore(8) can work.   (This is helpful but not necessary.)  savecore(8) can work.   (This is helpful but not necessary.)
   
Line 642  i386 and amd64 provide the following ker Line 880  i386 and amd64 provide the following ker
   
         i386 XEN3_DOMU          i386 XEN3_DOMU
         i386 XEN3PAE_DOMU          i386 XEN3PAE_DOMU
         amd64 XEN3_DOMU          amd64 XEN3_DOMU
   
 Unless using Xen 3.1 (and you shouldn't) with i386-mode Xen, you must  Unless using Xen 3.1 (and you shouldn't) with i386-mode Xen, you must
 use the PAE version of the i386 kernel.  use the PAE version of the i386 kernel.
Line 693  It is also desirable to add Line 931  It is also desirable to add
         powerd=YES          powerd=YES
   
 in rc.conf. This way, the domain will be properly shut down if  in rc.conf. This way, the domain will be properly shut down if
 `xm shutdown -R` or `xm shutdown -H` is used on the domain0.  `xm shutdown -R` or `xm shutdown -H` is used on the dom0.
   
 Your domain should be now ready to work, enjoy.  It is not strictly necessary to have a kernel (as /netbsd) in the domU
   file system.  However, various programs (e.g. netstat) will use that
   kernel to look up symbols to read from kernel virtual memory.  If
   /netbsd is not the running kernel, those lookups will fail.  (This is
   not really a Xen-specific issue, but because the domU kernel is
   obtained from the dom0, it is far more likely to be out of sync or
   missing with Xen.)
   
 Creating an unprivileged Linux domain (domU)  Creating an unprivileged Linux domain (domU)
 --------------------------------------------  --------------------------------------------
Line 729  Then copy the files from a working Linux Line 973  Then copy the files from a working Linux
 `/etc` (fstab, network config).  It should also be possible to extract  `/etc` (fstab, network config).  It should also be possible to extract
 binary packages such as .rpm or .deb directly to the mounted partition  binary packages such as .rpm or .deb directly to the mounted partition
 using the appropriate tool, possibly running under NetBSD's Linux  using the appropriate tool, possibly running under NetBSD's Linux
 emulation.  Once the filesystem has been populated, umount it.  If  emulation.  Once the file system has been populated, umount it.  If
 desirable, the filesystem can be converted to ext3 using tune2fs -j.  desirable, the file system can be converted to ext3 using tune2fs -j.
 It should now be possible to boot the Linux guest domain, using one of  It should now be possible to boot the Linux guest domain, using one of
 the vmlinuz-\*-xenU kernels available in the Xen binary distribution.  the vmlinuz-\*-xenU kernels available in the Xen binary distribution.
   
 To get the linux console right, you need to add:  To get the Linux console right, you need to add:
   
     extra = "xencons=tty1"      extra = "xencons=tty1"
   
 to your configuration since not all linux distributions auto-attach a  to your configuration since not all Linux distributions auto-attach a
 tty to the xen console.  tty to the xen console.
   
 Creating an unprivileged Solaris domain (domU)  Creating an unprivileged Solaris domain (domU)
Line 748  See possibly outdated Line 992  See possibly outdated
 [Solaris domU instructions](/ports/xen/howto-solaris/).  [Solaris domU instructions](/ports/xen/howto-solaris/).
   
   
 Using PCI devices in guest domains  PCI passthrough: Using PCI devices in guest domains
 ----------------------------------  ---------------------------------------------------
   
 The domain0 can give other domains access to selected PCI devices. This  The dom0 can give other domains access to selected PCI
 can allow, for example, a non-privileged domain to have access to a  devices. This can allow, for example, a non-privileged domain to have
 physical network interface or disk controller. However, keep in mind  access to a physical network interface or disk controller.  However,
 that giving a domain access to a PCI device most likely will give the  keep in mind that giving a domain access to a PCI device most likely
 domain read/write access to the whole physical memory, as PCs don't have  will give the domain read/write access to the whole physical memory,
 an IOMMU to restrict memory access to DMA-capable device. Also, it's not  as PCs don't have an IOMMU to restrict memory access to DMA-capable
 possible to export ISA devices to non-domain0 domains (which means that  device.  Also, it's not possible to export ISA devices to non-dom0
 the primary VGA adapter can't be exported. A guest domain trying to  domains, which means that the primary VGA adapter can't be exported.
 access the VGA registers will panic).  A guest domain trying to access the VGA registers will panic.
   
 This functionality is only available in NetBSD-5.1 (and later) domain0  If the dom0 is NetBSD, it has to be running Xen 3.1, as support has
 and domU. If the domain0 is NetBSD, it has to be running Xen 3.1, as  not been ported to later versions at this time.
 support has not been ported to later versions at this time.  
   For a PCI device to be exported to a domU, is has to be attached to
 For a PCI device to be exported to a domU, is has to be attached to the  the "pciback" driver in dom0.  Devices passed to the dom0 via the
 `pciback` driver in domain0. Devices passed to the domain0 via the  pciback.hide boot parameter will attach to "pciback" instead of the
 pciback.hide boot parameter will attach to `pciback` instead of the  usual driver.  The list of devices is specified as "(bus:dev.func)",
 usual driver. The list of devices is specified as `(bus:dev.func)`,  
 where bus and dev are 2-digit hexadecimal numbers, and func a  where bus and dev are 2-digit hexadecimal numbers, and func a
 single-digit number:  single-digit number:
   
     pciback.hide=(00:0a.0)(00:06.0)          pciback.hide=(00:0a.0)(00:06.0)
   
 pciback devices should show up in the domain0's boot messages, and the  pciback devices should show up in the dom0's boot messages, and the
 devices should be listed in the `/kern/xen/pci` directory.  devices should be listed in the `/kern/xen/pci` directory.
   
 PCI devices to be exported to a domU are listed in the `pci` array of  PCI devices to be exported to a domU are listed in the "pci" array of
 the domU's config file, with the format `'0000:bus:dev.func'`  the domU's config file, with the format "0000:bus:dev.func".
   
     pci = [ '0000:00:06.0', '0000:00:0a.0' ]  
   
 In the domU an `xpci` device will show up, to which one or more pci  
 busses will attach. Then the PCI drivers will attach to PCI busses as  
 usual. Note that the default NetBSD DOMU kernels do not have `xpci` or  
 any PCI drivers built in by default; you have to build your own kernel  
 to use PCI devices in a domU. Here's a kernel config example:  
   
     include         "arch/i386/conf/XEN3_DOMU"  
     #include         "arch/i386/conf/XENU"           # in NetBSD 3.0  
   
     # Add support for PCI busses to the XEN3_DOMU kernel  
     xpci* at xenbus ?  
     pci* at xpci ?  
   
     # Now add PCI and related devices to be used by this domain  
     # USB Controller and Devices  
   
     # PCI USB controllers  
     uhci*   at pci? dev ? function ?        # Universal Host Controller (Intel)  
   
     # USB bus support  
     usb*    at uhci?  
   
     # USB Hubs  
     uhub*   at usb?  
     uhub*   at uhub? port ? configuration ? interface ?  
   
     # USB Mass Storage          pci = [ '0000:00:06.0', '0000:00:0a.0' ]
     umass*  at uhub? port ? configuration ? interface ?  
     wd*     at umass?  
     # SCSI controllers  
     ahc*    at pci? dev ? function ?        # Adaptec [23]94x, aic78x0 SCSI  
   
     # SCSI bus support (for both ahc and umass)  In the domU an "xpci" device will show up, to which one or more pci
     scsibus* at scsi?  buses will attach.  Then the PCI drivers will attach to PCI buses as
   usual.  Note that the default NetBSD DOMU kernels do not have "xpci"
     # SCSI devices  or any PCI drivers built in by default; you have to build your own
     sd*     at scsibus? target ? lun ?      # SCSI disk drives  kernel to use PCI devices in a domU.  Here's a kernel config example;
     cd*     at scsibus? target ? lun ?      # SCSI CD-ROM drives  note that only the "xpci" lines are unusual.
   
           include         "arch/i386/conf/XEN3_DOMU"
   
           # Add support for PCI buses to the XEN3_DOMU kernel
           xpci* at xenbus ?
           pci* at xpci ?
   
           # PCI USB controllers
           uhci*   at pci? dev ? function ?        # Universal Host Controller (Intel)
   
           # USB bus support
           usb*    at uhci?
   
           # USB Hubs
           uhub*   at usb?
           uhub*   at uhub? port ? configuration ? interface ?
   
           # USB Mass Storage
           umass*  at uhub? port ? configuration ? interface ?
           wd*     at umass?
           # SCSI controllers
           ahc*    at pci? dev ? function ?        # Adaptec [23]94x, aic78x0 SCSI
   
           # SCSI bus support (for both ahc and umass)
           scsibus* at scsi?
   
           # SCSI devices
           sd*     at scsibus? target ? lun ?      # SCSI disk drives
           cd*     at scsibus? target ? lun ?      # SCSI CD-ROM drives
   
   
 NetBSD as a domU in a VPS  NetBSD as a domU in a VPS
Line 828  NetBSD as a domU in a VPS Line 1068  NetBSD as a domU in a VPS
 The bulk of the HOWTO is about using NetBSD as a dom0 on your own  The bulk of the HOWTO is about using NetBSD as a dom0 on your own
 hardware.  This section explains how to deal with Xen in a domU as a  hardware.  This section explains how to deal with Xen in a domU as a
 virtual private server where you do not control or have access to the  virtual private server where you do not control or have access to the
 dom0.  dom0.  This is not intended to be an exhaustive list of VPS providers;
   only a few are mentioned that specifically support NetBSD.
   
   VPS operators provide varying degrees of access and mechanisms for
   configuration.  The big issue is usually how one controls which kernel
   is booted, because the kernel is nominally in the dom0 file system (to
   which VPS users do not normally have access).  A second issue is how
   to install NetBSD.
   A VPS user may want to compile a kernel for security updates, to run
   npf, run IPsec, or any other reason why someone would want to change
   their kernel.
   
   One approach is to have an administrative interface to upload a kernel,
   or to select from a prepopulated list.  Other approaches are pygrub
   (deprecated) and pvgrub, which are ways to have a bootloader obtain a
   kernel from the domU file system.  This is closer to a regular physical
   computer, where someone who controls a machine can replace the kernel.
   
   A second issue is multiple CPUs.  With NetBSD 6, domUs support
   multiple vcpus, and it is typical for VPS providers to enable multiple
   CPUs for NetBSD domUs.
   
   pygrub
   -------
   
 TODO: Perhaps reference panix, prmgr, amazon as interesting examples.  pygrub runs in the dom0 and looks into the domU file system.  This
   implies that the domU must have a kernel in a file system in a format
   known to pygrub.  As of 2014, pygrub seems to be of mostly historical
   interest.
   
   pvgrub
   ------
   
   pvgrub is a version of grub that uses PV operations instead of BIOS
   calls.  It is booted from the dom0 as the domU kernel, and then reads
   /grub/menu.lst and loads a kernel from the domU file system.
   
   [Panix](http://www.panix.com/) lets users use pvgrub.  Panix reports
   that pvgrub works with FFsv2 with 16K/2K and 32K/4K block/frag sizes
   (and hence with defaults from "newfs -O 2").  See [Panix's pvgrub
   page](http://www.panix.com/v-colo/grub.html), which describes only
   Linux but should be updated to cover NetBSD :-).
   
   [prgmr.com](http://prgmr.com/) also lets users with pvgrub to boot
   their own kernel.  See then [prgmr.com NetBSD
   HOWTO](http://wiki.prgmr.com/mediawiki/index.php/NetBSD_as_a_DomU)
   (which is in need of updating).
   
   It appears that [grub's FFS
   code](http://xenbits.xensource.com/hg/xen-unstable.hg/file/bca284f67702/tools/libfsimage/ufs/fsys_ufs.c)
   does not support all aspects of modern FFS, but there are also reports
   that FFSv2 works fine.  At prgmr, typically one has an ext2 or FAT
   partition for the kernel with the intent that grub can understand it,
   which leads to /netbsd not being the actual kernel.  One must remember
   to update the special boot partition.
   
   Amazon
   ------
   
 TODO: Somewhere, discuss pvgrub and py-grub to load the domU kernel  See the [Amazon EC2 page](../amazon_ec2/).
 from the domU filesystem.  
   
 Using npf  Using npf
 ---------  ---------
   
 In standard kernels, npf is a module, and thus cannot be loadeed in a  In standard kernels, npf is a module, and thus cannot be loaded in a
 DOMU kernel.  DOMU kernel.
   
 TODO: explain how to compile npf into a custom kernel, answering:  TODO: Explain how to compile npf into a custom kernel, answering (but
 http://mail-index.netbsd.org/netbsd-users/2014/12/26/msg015576.html  note that the problem was caused by not booting the right kernel)
   [this email to
   netbsd-users](http://mail-index.netbsd.org/netbsd-users/2014/12/26/msg015576.html).
   
   TODO items for improving NetBSD/xen
   ===================================
   
   * Make the NetBSD dom0 kernel work with SMP.
   * Test the Xen 4.5 packages adequately to be able to recommend them as
     the standard approach.
   * Get PCI passthrough working on Xen 4.5
   * Get pvgrub into pkgsrc, either via xentools or separately.
   * grub
     * Check/add support to pkgsrc grub2 for UFS2 and arbitrary
       fragsize/blocksize (UFS2 support may be present; the point is to
       make it so that with any UFS1/UFS2 file system setup that works
       with NetBSD grub will also work).
       See [pkg/40258](http://gnats.netbsd.org/40258).
     * Push patches upstream.
     * Get UFS2 patches into pvgrub.
   * Add support for PV ops to a version of /boot, and make it usable as
     a kernel in Xen, similar to pvgrub.
   * Solve somehow the issue with modules for GENERIC not being loadable
     in a Xen dom0 or domU kernel.
   
   Random pointers
   ===============
   
   This section contains links from elsewhere not yet integrated into the
   HOWTO, and other guides.
   
   * http://www.lumbercartel.ca/library/xen/
   * http://pbraun.nethence.com/doc/sysutils/xen_netbsd_dom0.html
   * https://gmplib.org/~tege/xen.html

Removed from v.1.50  
changed lines
  Added in v.1.133


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