====== Darwin VM ======

===== Distribution files =====

  - Darwin 8.0.1 (corresponding to Mac OS X 10.4) seems to be the latest available full installer image, at least, until the [[http://www.puredarwin.org|PureDarwin]] project produces a new one.
    * List of available [[http://www.opensource.apple.com/static/iso|ISO images]]
  - More recent versions of packages are available in source form:
    * [[http://opensource.apple.com|Open Source]] website (links by OS release)
    * Full [[http://www.opensource.apple.com/tarballs|list of packages]] (some aren't linked under any OS release)

===== Installing =====

  - Download and extract installation CD image:
    * [[http://www.opensource.apple.com/darwinsource/images/darwinx86-801.iso.gz|Darwin 8.0.1]] (was under "Darwin 8.0.1 Installer CD" on old website)
      * ,,MD5: dbd260dda994093a11c31afbe624aa34,,
      * ,,SHA-256: a26f9f14795fe0687bd647d41b712464c9a61430736fae4aa0fdb89207e1a62a,,
    * <cmd $>gunzip darwinx86-801.iso.gz</cmd>
  - Set up [[http://www.qemu.org/|QEMU]] VM:
      * <cmd $>qemu-img create -f qcow2 <var darwin.qcow2> <var 10G></cmd>
  - Start VM:
      * <cmd $>qemu -net none -drive file=<var darwin.qcow2>,cache=writeback -cdrom darwinx86-801.iso -boot d</cmd>
      * Other useful qemu options: <cmd>-m 512</cmd> and <cmd>-enable-kqemu</cmd>
  - Installation steps:
      * First boot:
        * Select disk
        * "<cmd>2</cmd>" (manual partitioning)
        * "<cmd>y</cmd>" (initialize MBR)
        * In fdisk:
          * <cmd >>auto hfs</cmd>
          * Ignore the warning
          * <cmd >>update</cmd>
          * <cmd >>write</cmd>
          * <cmd >>quit</cmd>
        * Enter partition name
        * "<cmd>yes</cmd>" (clean install)
        * "<cmd><var darwin></cmd>" (volume name)
        * Continue (reboot)
      * Second boot (make sure to boot from CD again):
        * Select disk
        * "<cmd>3</cmd>" (existing partition)
        * Enter partition name
        * "<cmd>hfs</cmd>" (HFS+ filesystem)
        * "<cmd>yes</cmd>" (clean install)
        * "<cmd><var darwin></cmd>" (volume name)
        * Wait for installation to complete...
        * Enter root password
        * "<cmd><var darwin></cmd>" (hostname)
        * "<cmd>3</cmd>" (spawn shell)
        * <cmd #>halt</cmd>
  - Configure VM for normal startup:
    * Remove QEMU flags <cmd>-cdrom darwinx86-801.iso -boot d</cmd>

===== Basic configuration =====

==== Enable VM networking ====

  * Change QEMU flags: <cmd>-net none</cmd> -> <cmd>-net nic,model=rtl8139 -net user</cmd>

==== SSH access ====

  - Change QEMU flags: <cmd>-net user</cmd> -> <cmd>-net user,hostfwd=tcp:127.0.0.1:<var 10022>-:22</cmd> (pick any port instead of <var 10022>)
  - Log in to VM, enable SSH:
    * <cmd #>service ssh start</cmd>
  - Connect to VM with
    * <cmd $>ssh -p <var 10022> root@localhost</cmd>
  - Optionally add an alias to host <cmd>~/.ssh/config</cmd> to simplify connecting:
    ** <cmd>Host <var darwin-vm></cmd>
    .. <cmd>HostName localhost</cmd>
    .. <cmd>Port <var 10022></cmd>
    .. <cmd>User root</cmd>
    * Connect to VM with
      * <cmd $>ssh darwin-vm</cmd>
  - Install public key to simplify logging in:
    * <cmd $>cat .ssh/id_rsa.pub | ssh <var darwin-vm> 'mkdir .ssh; cat >>.ssh/authorized_keys'</cmd>
  - Add <cmd>-nographic</cmd> to QEMU flags to disable console window, which is no longer required

==== Some familiar aliases ====

  ** <cmd #>echo "alias ll='ls -l'" >>/etc/bashrc</cmd>
  .. <cmd #>echo "alias la='ls -lA'" >>/etc/bashrc</cmd>

==== Timezone ====

  * <cmd #>ln -sf /usr/share/zoneinfo/UTC /etc/localtime</cmd>

==== Temporary filesystem ====

Using a temporary disk image to build software helps keep the main disk image file smaller.

  - <cmd $>qemu-img create -f qcow2 <var scratch.qcow2> <var 10G></cmd>
  - Add QEMU flag: <cmd>-drive file=<var scratch.qcow2>,cache=writeback</cmd> and boot
  - Figure out which disk number corresponds to the scratch drive:
    * <cmd #>mount</cmd>
    * <cmd #>ls /dev/rdisk*</cmd>
    * It's the one that isn't mounted and doesn't have any partitions (s<var n>-suffixed files)
    * It's usually, but not always, <var /dev/rdisk1>
  - <cmd #>newfs_hfs -v scratch <var /dev/rdisk1></cmd>
  - <cmd #>reboot</cmd>
  - Available as <cmd>/Volumes/scratch</cmd> on next boot

===== Notes =====

  - The VM sometimes fails to boot with "panic(...): nfs_boot_init failed"; if this happens, restart it.

===== Updating the system =====

==== Kernel (xnu) ====

  * It breaks support for FAT (and thus the QEMU virtual FAT drive)
    * Support for FAT is in the <keyword msdosfs> package which requires Xcode to build
    * An alternative to the virtual FAT drive for transferring files is writing tar archives directly to an unpartitioned drive
    * SSH scp is another alternative
  * Requires:
    * corresponding <keyword cctools> (e.g. initially installed version or <var cctools-590.42.1>, but not <var cctools-667.3>)
    * <keyword gcc 3.3> (revert if changed with <cmd>gcc_select 3.3</cmd>)
  * Source package: [[http://www.opensource.apple.com/tarballs/xnu/xnu-792.6.76.tar.gz|xnu-792.6.76.tar.gz]] (update to version listed under "Mac OS X 10.4.3")
    * ,,MD5: 854f44519778e8bde4283e275ed154e6,,
    * ,,SHA-256: 35c5ed2f1399c770583a229a733d064dc302ae6327a7fcb40996e1f3c474f568,,
  * Building:
    * <cmd #>cd /Volumes/scratch</cmd>
    * <cmd #>tar xzf <var xnu-792.6.76.tar.gz></cmd>
    * <cmd #>cd xnu-792.6.76</cmd>
    * Patch to help build <var gcc_42-5577>:
      * <cmd #>sed -i.tmp 's/defined *(__i386__)/& || defined(__x86_64__)/' bsd/{machine,sys}/*.h</cmd>
    * <cmd #>make DSTROOT= install</cmd>
  * Reboot. <cmd>uname -r</cmd> is now <var 8.7.0>.

==== Standard library (Libc) ====

  * Requires updated <keyword xnu> (<var xnu-792.6.76>).
  * Source package: [[http://opensource.apple.com/tarballs/Libc/Libc-391.2.10.tar.gz|Libc-391.2.10.tar.gz]] (update to version listed under "Mac OS X 10.4.3")
    * ,,MD5: 7a1a08d1b68668fc41916d6cf39182a4,,
    * ,,SHA-256: e90b78d310235544623f26c6f18e27b329b5bc778deab8e57332e8e90ab92f11,,
  * Building:
    * <cmd #>cd /Volumes/scratch</cmd>
    * <cmd #>tar xzf <var Libc-391.2.10.tar.gz></cmd>
    * <cmd #>cd Libc-391.2.10</cmd>
    * <cmd #>sed -i.tmp s/NOTIFY_STATUS_OK/0/g gen/{asl.c,syslog.c}</cmd>
    * Patch to help build <var gcc_42-5577>:
      * <cmd #>sed -i.tmp 's/defined *(__i386__)/& || defined(__x86_64__)/' include/machine/*.h</cmd>
    * <cmd #>make OBJROOT="$PWD"/obj install</cmd>

===== Upgrading GCC =====

==== dyld ====

  * This is optional.
  * Source package: [[http://www.opensource.apple.com/tarballs/dyld/dyld-46.16.tar.gz|dyld-46.16.tar.gz]] (under "Mac OS X 10.4.11.x86")
    * ,,MD5: a97d4d2a77b3e5f2ff9757007cae0596,,
    * ,,SHA256: cf753c3a2cef239b1334c56603b36d206f54d613daa078ce0f2d73c3e2a0dd82,,
  * Makefile: [[http://althenia.net/svn/wiki/darwin/dyld.mk?rev=5|dyld.mk]]
    * Darwin doesn't include Xcode, which is required to build this package. This makefile provides alternative build instructions.
  * Building:
    * <cmd #>cd /Volumes/scratch</cmd>
    * <cmd #>tar xzf <var dyld-46.16.tar.gz></cmd>
    * <cmd #>cd dyld-46.16</cmd>
    * <cmd #>sed -i.tmp '/case CPU_TYPE_X86_64:/,/break;/d;/__pthread_tsd_first/d' src/dyld.cpp</cmd>
    * <cmd #>ln -s libstdc++.a /usr/lib/gcc/i686-apple-darwin8/4.0.0/libstdc++-static.a</cmd>
    * <cmd #>bsdmake -f <var dyld.mk> VERSION_DYLD=46 install</cmd>

==== cctools ====

  * Choice of version:
    * <var cctools-667.3>
      * Too new to build <keyword xnu>.
      * Source package: [[http://opensource.apple.com/tarballs/cctools/cctools-667.3.tar.gz|cctools-667.3.tar.gz]] (under "Mac OS X 10.5.8")
        * ,,MD5: 518166e6ddbd0287bebee3d00fddee7d,,
        * ,,SHA256: 1ba43a3d3bcf138a196e714666927c706857226adccf2e69db4f08e940631c0d,,
    * <var cctools-590.42.1>
      * Too old to build <keyword gcc>.
      * Source package: [[http://opensource.apple.com/tarballs/cctools/cctools-590.42.1.tar.gz|cctools-590.42.1.tar.gz]] (update to version listed under "Mac OS X 10.4.3")
        * ,,MD5: 6d875c5483699fd0f1e150facae35256,,
        * ,,SHA256: 61c86c4dc556daafbabebd8162bfbce8214843b218fefbd15c6c1ba03d225a10,,
  * Building:
    * <cmd #>cd /Volumes/scratch</cmd>
    * <cmd #>tar xzf <var cctools-667.3.tar.gz></cmd>
    * <cmd #>cd cctools-667.3</cmd>
    * <cmd #>sed -i.tmp '/install.*strip/{h;s/strip/seg_hack/gp;g;s/ -s / /;}' misc/Makefile</cmd>
    * <cmd #>sed -i.tmp s/ld_classic/ld/ ld/Makefile</cmd>
    * <cmd #>make install</cmd>
  * The new assembler will often show the warning "indirect jmp without '*'" on code generated by the old GCC.

==== gcc ====

  * Choice of version:
    * <var gcc_42-5577>
      * Latests <var gcc_42> package (newer packages are named <var gcc>). GCC 4.2.1. Requires patched system include files, which can be done when upgrading <keyword xnu> and <keyword Libc> (see above).
      * Source package: [[http://opensource.apple.com/tarballs/gcc_42/gcc_42-5577.tar.gz|gcc_42-5577.tar.gz]] (update to version listed under "Mac OS X 10.5.8")
        * ,,MD5: dab7ad45f76919f058a6f1cf3a0e91d8,,
        * ,,SHA256: fd6459ab701b41dc1297cdbc27f302c558d766505cfe8dd1d6ec0d257fef0e81,,
    * <var gcc_42-5531>
      * Slightly older version. Doesn't require any changes to include files.
      * Source package: [[http://opensource.apple.com/tarballs/gcc_42/gcc_42-5531.tar.gz|gcc_42-5531.tar.gz]] (under "Mac OS X 10.5.8")
        * ,,MD5: 959ecd224cea2477d57b1c3026fe05ee,,
        * ,,SHA256: 924862e2092fa11754ec9226a0de4772d831c40500231728055d00d1bb3a632e,,
  * Requires <var cctools-667.3> and optionally <keyword dyld>
  * Building:
    * <cmd #>cd /Volumes/scratch</cmd>
    * <cmd #>tar xzf <var gcc_42-5577.tar.gz></cmd>
    * <cmd #>cd gcc_42-5577</cmd>
    * If <keyword dyld> isn't upgraded, patch to revert debugging format from DWARF to stabs:
      * <cmd #>sed -i.tmp 's/\(#define PREFERRED_DEBUGGING_TYPE \).*/\1DBX_DEBUG/' gcc/config/darwin.h</cmd>
      * <cmd #>sed -i.tmp '/darwin_macho_att_stub/s/Init.*//' gcc/config/darwin.opt</cmd>
    * <cmd #>sed -i.tmp '/x86_64/s/|| exit 1//' build_gcc</cmd>
    * <cmd #>ln -s true /usr/bin/dsymutil</cmd>
    * <cmd #>gnumake RC_ARCHS=i386 install</cmd>
      * Don't try to set <cmd>DSTROOT=/</cmd>, it deletes everything.
    * <cmd #>cp -pR dst/* /</cmd>
    * <cmd #>cp -pR obj/dst-i686-i686/usr/lib/libgcc_s* /usr/lib/gcc/i686-apple-darwin8/4.2.1/</cmd>
  * GCC is now installed as <keyword gcc-4.2>.
    * It can be made default with <cmd>gcc_select 4.2</cmd>.