doc/manual/cp-directory.tex

   1 \chapter{CP Directory}
   2 \label{chap:directory}
   3 The directory contains a list of all valid users on the system.  Currently,
   4 any changes to the directory require that the nucleus be rebuilt, and the
   5 system re-IPLed.
   6
   7 \section{Directory Syntax}
   8 The directory is a simple text file with a declarative syntax used to
   9 describe all the virtual machines.
  10
  11 All empty lines and lines with only white space are ignored.
  12
  13 \cbstart
  14 Each virtual machine definition must begin with a USER statement specifying
  15 the userid and the authorization level.  All statements following the USER
  16 statement are applied to this userid definition until another USER statement
  17 is encountered.
  18
  19 \begin{syntdiag}
  20 \tok{USER} <userid> <auth>
  21 \end{syntdiag}
  22 \cbend
  23
  24 A \cbstart MACHINE \cbend statement specifies the architectural level and
  25 number of virtual processors.  Currently, HVF ignores this statement and
  26 always instantiates a single z/Architecture virtual processor.
  27
  28 \cbstart
  29 \begin{syntdiag}
  30 \tok{MACHINE} <type> <numcpus>
  31 \end{syntdiag}
  32 \cbend
  33
  34 The STORAGE statement may appear only once within a virtual machine's
  35 definition.  It specifies the amount of memory allocated to the guest.  The
  36 size is scaled by the optional scale --- K (\mbox{1,024}), M
  37 (\mbox{1,048,576}), or G (\mbox{1,073,741,824}).
  38
  39 Note that the size must be a multiple of 64kB and that the directory parser
  40 does not check for this.
  41
  42 \begin{syntdiag}
  43 \tok{STORAGE} <size>
  44 \begin{stack}
  45         \\
  46         \tok{K} \\
  47         \tok{M} \\
  48         \tok{G}
  49 \end{stack}
  50 \end{syntdiag}
  51
  52 \cbstart
  53 The CONSOLE statement defines a system console.  There can be only one
  54 CONSOLE statement per virtual machine definition of type 3125.  Currently,
  55 HVF does not check for this.
  56
  57 \begin{syntdiag}
  58 \tok{CONSOLE} <vdev> <type>
  59 \end{syntdiag}
  60
  61 The SPOOL statement may appear arbitrary number of times per virtual machine
  62 definision.  Each occurence defines a virtual device with the virtual device
  63 number vdev handled by HVF's spooling facility.
  64
  65 The expected type for a READER is 3505.  The expected type for a PUNCH is
  66 3525.  The expected type for PRINT is 1403.
  67
  68 \begin{syntdiag}
  69 \tok{SPOOL} <vdev> <type>
  70 \begin{stack}
  71         \tok{READER}\\
  72         \tok{PUNCH} \\
  73         \tok{PRINT}
  74 \end{stack}
  75 \end{syntdiag}
  76
  77 The MDISK statement defines a minidisk residing on rdev (a DASD of type
  78 type) starting at cylinder off and being len cylinders long.
  79
  80 \begin{syntdiag}
  81 \tok{MDISK} <vdev> <type> <off> <len> <rdev>
  82 \end{syntdiag}
  83
  84 The DEDICATE statement defines a dedicated virtual device.
  85
  86 \begin{syntdiag}
  87 \tok{DEDICATE} <vdev> <rdev>
  88 \end{syntdiag}
  89 \cbend
  90
  91 \section{Example Directory}
  92 Figure~\ref{fig:directory-sample} is the default directory distributed with
  93 HVF.  It defines several users with nearly identical configurations.
  94
  95 \begin{figure*}[htb]
  96 \small
  97 \lstinputlisting{../../cp/config/hvf.directory}
  98 \captionfont
  99 \caption{\capfont Example directory defining three users.}
 100 \label{fig:directory-sample}
 101 \end{figure*}
 102