[XenAccess-devel] [PATCH] README Update

[<hi...@cc...>]

This patch includes a revised description of the configuration file.

Index: README
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- README      (revision 68)
+++ README      (working copy)
@@ -49,21 +49,64 @@
  place the following entry in the configuration file:

  Fedora-HVM {
-    sysmap =3D "/boot/System.map-2.6.18-1.2798.fc6";
+    sysmap      =3D "/boot/System.map-2.6.18-1.2798.fc6";
+    ostype      =3D "Linux";
+    linux_tasks =3D 268;
+    linux_mm    =3D 276;
+    linux_pid   =3D 312;
+    linux_name  =3D 548;
+    linux_pgd   =3D 40;
+    linux_addr  =3D 132;
  }

+or for Windows:
+
+WinXPSP2 {
+    ostype      =3D "Windows";
+    win_tasks   =3D 0x88;
+    win_pdbase  =3D 0x18;
+    win_pid     =3D 0x84;
+    win_peb     =3D 0x1b0;
+    win_iba     =3D 0x8;
+    win_ph      =3D 0x18;
+}
+
+You need not specify offsets.  Default values are found within
+linux_memory.c and windows_memory.c, respectively.  However, you will
+probably need to calculate these values if you do not use the kernel
+distributed with xen.
+
  In general, the configuration file contains records that look like:

  <domain name> {
      <key> =3D <value>;
  }

-Currently, the only available key is 'sysmap'.  In the future, additional
-keys may be added as needed.  The list of keys is provided below:
+Currently there are 14 different keys available.  Only ostype is common
+between Windows and Linux guests.

-- sysmap: path to the System.map file corresponding to the domain's kernel
+The list of keys is provided below:

+sysmap:         The path to the System.map file corresponding to the
+                domain's Linux kernel.
+ostype:         Linux or Windows guests are supported.

+linux_tasks:    The number of bytes (offset) from the start of the
+                struct until task_struct->tasks.  All of these
+                offsets are in linux/sched.h.
+linux_mm:       Offset to task_struct->mm.
+linux_pid:      Offset to task_struct->pid.
+linux_name:     Offset to task_struct->name.
+linux_pgd:      Offset to task_struct->pgd.
+linux_addr:     Offset to task_struct->start_code.
+
+win_tasks:      Offset to EPROCESS->ActiveProcessLinks.
+win_pdbase:     Offset to EPROCESS->Pcb->DirectoryTableBase.
+win_pid:        Offset to EPROCESS->UniqueProcessId.
+win_peb:        Offset to EPROCESS->Peb.
+win_iba:        Offset to EPROCESS->Peb->ImageBaseAddress.
+win_ph_offset:  Offset to EPROCESS->Peb->ProcessHeap.
+
  Using XenAccess
  ---------------
  A quick way to see XenAccess in action is to try out the example code.  Yo=
u