doc-src/System/Thy/Sessions.thy
author wenzelm
Mon Aug 06 16:05:29 2012 +0200 (2012-08-06)
changeset 48693 ceeea46bdeba
parent 48684 9170e10c651e
child 48737 f3bbb9ca57d6
permissions -rw-r--r--
"isabelle options" prints Isabelle system options;
wenzelm@48578
     1
theory Sessions
wenzelm@48578
     2
imports Base
wenzelm@48578
     3
begin
wenzelm@48578
     4
wenzelm@48584
     5
chapter {* Isabelle sessions and build management \label{ch:session} *}
wenzelm@48584
     6
wenzelm@48584
     7
text {* An Isabelle \emph{session} consists of a collection of related
wenzelm@48604
     8
  theories that may be associated with formal documents (see also
wenzelm@48604
     9
  \chref{ch:present}).  There is also a notion of \emph{persistent
wenzelm@48604
    10
  heap} image to capture the state of a session, similar to
wenzelm@48604
    11
  object-code in compiled programming languages.  Thus the concept of
wenzelm@48604
    12
  session resembles that of a ``project'' in common IDE environments,
wenzelm@48604
    13
  but the specific name emphasizes the connection to interactive
wenzelm@48604
    14
  theorem proving: the session wraps-up the results of
wenzelm@48604
    15
  user-interaction with the prover in a persistent form.
wenzelm@48584
    16
wenzelm@48604
    17
  Application sessions are built on a given parent session, which may
wenzelm@48604
    18
  be built recursively on other parents.  Following this path in the
wenzelm@48604
    19
  hierarchy eventually leads to some major object-logic session like
wenzelm@48604
    20
  @{text "HOL"}, which itself is based on @{text "Pure"} as the common
wenzelm@48604
    21
  root of all sessions.
wenzelm@48584
    22
wenzelm@48604
    23
  Processing sessions may take considerable time.  Isabelle build
wenzelm@48604
    24
  management helps to organize this efficiently.  This includes
wenzelm@48604
    25
  support for parallel build jobs, in addition to the multithreaded
wenzelm@48604
    26
  theory and proof checking that is already provided by the prover
wenzelm@48604
    27
  process itself.  *}
wenzelm@48604
    28
wenzelm@48578
    29
wenzelm@48578
    30
section {* Session ROOT specifications \label{sec:session-root} *}
wenzelm@48578
    31
wenzelm@48579
    32
text {* Session specifications reside in files called @{verbatim ROOT}
wenzelm@48579
    33
  within certain directories, such as the home locations of registered
wenzelm@48579
    34
  Isabelle components or additional project directories given by the
wenzelm@48579
    35
  user.
wenzelm@48579
    36
wenzelm@48579
    37
  The ROOT file format follows the lexical conventions of the
wenzelm@48579
    38
  \emph{outer syntax} of Isabelle/Isar, see also
wenzelm@48579
    39
  \cite{isabelle-isar-ref}.  This defines common forms like
wenzelm@48579
    40
  identifiers, names, quoted strings, verbatim text, nested comments
wenzelm@48579
    41
  etc.  The grammar for a single @{syntax session_entry} is given as
wenzelm@48579
    42
  syntax diagram below; each ROOT file may contain multiple session
wenzelm@48579
    43
  specifications like this.
wenzelm@48579
    44
wenzelm@48582
    45
  Isabelle/jEdit (\secref{sec:tool-jedit}) includes a simple editing
wenzelm@48582
    46
  mode @{verbatim "isabelle-root"} for session ROOT files.
wenzelm@48579
    47
wenzelm@48579
    48
  @{rail "
wenzelm@48579
    49
    @{syntax_def session_entry}: @'session' spec '=' (@{syntax name} '+')? body
wenzelm@48579
    50
    ;
wenzelm@48579
    51
    body: description? options? ( theories * ) files?
wenzelm@48579
    52
    ;
wenzelm@48579
    53
    spec: @{syntax name} '!'? groups? dir?
wenzelm@48579
    54
    ;
wenzelm@48579
    55
    groups: '(' (@{syntax name} +) ')'
wenzelm@48579
    56
    ;
wenzelm@48579
    57
    dir: @'in' @{syntax name}
wenzelm@48579
    58
    ;
wenzelm@48579
    59
    description: @'description' @{syntax text}
wenzelm@48579
    60
    ;
wenzelm@48579
    61
    options: @'options' opts
wenzelm@48579
    62
    ;
wenzelm@48605
    63
    opts: '[' ( (@{syntax name} '=' value | @{syntax name}) + ',' ) ']'
wenzelm@48605
    64
    ;
wenzelm@48605
    65
    value: @{syntax name} | @{syntax real}
wenzelm@48579
    66
    ;
wenzelm@48579
    67
    theories: @'theories' opts? ( @{syntax name} + )
wenzelm@48579
    68
    ;
wenzelm@48579
    69
    files: @'files' ( @{syntax name} + )
wenzelm@48579
    70
    "}
wenzelm@48579
    71
wenzelm@48579
    72
  \begin{description}
wenzelm@48579
    73
wenzelm@48579
    74
  \item \isakeyword{session}~@{text "A = B + body"} defines a new
wenzelm@48579
    75
  session @{text "A"} based on parent session @{text "B"}, with its
wenzelm@48579
    76
  content given in @{text body} (theories and auxiliary source files).
wenzelm@48579
    77
  Note that a parent (like @{text "HOL"}) is mandatory in practical
wenzelm@48579
    78
  applications: only Isabelle/Pure can bootstrap itself from nothing.
wenzelm@48579
    79
wenzelm@48579
    80
  All such session specifications together describe a hierarchy (tree)
wenzelm@48579
    81
  of sessions, with globally unique names.  By default, names are
wenzelm@48579
    82
  derived from parent ones by concatenation, i.e.\ @{text "B\<dash>A"}
wenzelm@48579
    83
  above.  Cumulatively, this leads to session paths of the form @{text
wenzelm@48579
    84
  "X\<dash>Y\<dash>Z\<dash>W"}.  Note that in the specification,
wenzelm@48579
    85
  @{text B} is already such a fully-qualified name, while @{text "A"}
wenzelm@48579
    86
  is the new base name.
wenzelm@48579
    87
wenzelm@48579
    88
  \item \isakeyword{session}~@{text "A! = B"} indicates a fresh start
wenzelm@48579
    89
  in the naming scheme: the session is called just @{text "A"} instead
wenzelm@48579
    90
  of @{text "B\<dash>A"}.  Here the name @{text "A"} should be
wenzelm@48579
    91
  sufficiently long to stand on its own in a potentially large
wenzelm@48579
    92
  library.
wenzelm@48579
    93
wenzelm@48579
    94
  \item \isakeyword{session}~@{text "A (groups)"} indicates a
wenzelm@48579
    95
  collection of groups where the new session is a member.  Group names
wenzelm@48579
    96
  are uninterpreted and merely follow certain conventions.  For
wenzelm@48579
    97
  example, the Isabelle distribution tags some important sessions by
wenzelm@48604
    98
  the group name called ``@{text "main"}''.  Other projects may invent
wenzelm@48604
    99
  their own conventions, but this requires some care to avoid clashes
wenzelm@48604
   100
  within this unchecked name space.
wenzelm@48579
   101
wenzelm@48579
   102
  \item \isakeyword{session}~@{text "A"}~\isakeyword{in}~@{text "dir"}
wenzelm@48579
   103
  specifies an explicit directory for this session.  By default,
wenzelm@48579
   104
  \isakeyword{session}~@{text "A"} abbreviates
wenzelm@48579
   105
  \isakeyword{session}~@{text "A"}~\isakeyword{in}~@{text "A"}.  This
wenzelm@48579
   106
  accommodates the common scheme where some base directory contains
wenzelm@48579
   107
  several sessions in sub-directories of corresponding names.  Another
wenzelm@48579
   108
  common scheme is \isakeyword{session}~@{text
wenzelm@48579
   109
  "A"}~\isakeyword{in}~@{verbatim "\".\""} to refer to the current
wenzelm@48579
   110
  directory of the ROOT file.
wenzelm@48579
   111
wenzelm@48579
   112
  All theories and auxiliary source files are located relatively to
wenzelm@48579
   113
  the session directory.  The prover process is run within the same as
wenzelm@48579
   114
  its current working directory.
wenzelm@48579
   115
wenzelm@48579
   116
  \item \isakeyword{description}~@{text "text"} is a free-form
wenzelm@48579
   117
  annotation for this session.
wenzelm@48579
   118
wenzelm@48579
   119
  \item \isakeyword{options}~@{text "[x = a, y = b, z]"} defines
wenzelm@48604
   120
  separate options (\secref{sec:system-options}) that are used when
wenzelm@48604
   121
  processing this session, but \emph{without} propagation to child
wenzelm@48604
   122
  sessions.  Note that @{text "z"} abbreviates @{text "z = true"} for
wenzelm@48604
   123
  Boolean options.
wenzelm@48579
   124
wenzelm@48579
   125
  \item \isakeyword{theories}~@{text "options names"} specifies a
wenzelm@48579
   126
  block of theories that are processed within an environment that is
wenzelm@48604
   127
  augmented by the given options, in addition to the global session
wenzelm@48604
   128
  options given before.  Any number of blocks of \isakeyword{theories}
wenzelm@48604
   129
  may be given.  Options are only active for each
wenzelm@48604
   130
  \isakeyword{theories} block separately.
wenzelm@48579
   131
wenzelm@48579
   132
  \item \isakeyword{files}~@{text "files"} lists additional source
wenzelm@48604
   133
  files that are involved in the processing of this session.  This
wenzelm@48604
   134
  should cover anything outside the formal content of the theory
wenzelm@48579
   135
  sources, say some auxiliary {\TeX} files that are required for
wenzelm@48579
   136
  document processing.  In contrast, files that are specified in
wenzelm@48579
   137
  formal theory headers as @{keyword "uses"} need not be declared
wenzelm@48579
   138
  again.
wenzelm@48579
   139
wenzelm@48579
   140
  \end{description}
wenzelm@48580
   141
*}
wenzelm@48579
   142
wenzelm@48580
   143
subsubsection {* Examples *}
wenzelm@48580
   144
wenzelm@48580
   145
text {* See @{file "~~/src/HOL/ROOT"} for a diversity of practically
wenzelm@48580
   146
  relevant situations. *}
wenzelm@48578
   147
wenzelm@48578
   148
wenzelm@48578
   149
section {* System build options \label{sec:system-options} *}
wenzelm@48578
   150
wenzelm@48580
   151
text {* See @{file "~~/etc/options"} for the main defaults provided by
wenzelm@48582
   152
  the Isabelle distribution.  Isabelle/jEdit (\secref{sec:tool-jedit})
wenzelm@48582
   153
  includes a simple editing mode @{verbatim "isabelle-options"} for
wenzelm@48582
   154
  this file-format.
wenzelm@48693
   155
wenzelm@48693
   156
  The @{tool_def options} tool prints Isabelle system options.  Its
wenzelm@48693
   157
  command-line usage is:
wenzelm@48693
   158
\begin{ttbox}
wenzelm@48693
   159
Usage: isabelle options [OPTIONS] [MORE_OPTIONS ...]
wenzelm@48693
   160
wenzelm@48693
   161
  Options are:
wenzelm@48693
   162
    -b           include $ISABELLE_BUILD_OPTIONS
wenzelm@48693
   163
    -x FILE      export to FILE in YXML format
wenzelm@48693
   164
wenzelm@48693
   165
  Print Isabelle system options, augmented by MORE_OPTIONS given as
wenzelm@48693
   166
  arguments NAME=VAL or NAME.
wenzelm@48693
   167
\end{ttbox}
wenzelm@48693
   168
wenzelm@48693
   169
  The command line arguments provide additional system options of the
wenzelm@48693
   170
  form @{text "name"}@{verbatim "="}@{text "value"} or @{text name}
wenzelm@48693
   171
  for Boolean options.
wenzelm@48693
   172
wenzelm@48693
   173
  Option @{verbatim "-b"} augments the implicit environment of system
wenzelm@48693
   174
  options by the ones of @{setting ISABELLE_BUILD_OPTIONS}, cf.\
wenzelm@48693
   175
  \secref{sec:tool-build}.
wenzelm@48693
   176
wenzelm@48693
   177
  Option @{verbatim "-x"} specifies a file to export the result in
wenzelm@48693
   178
  YXML format, instead of printing it in human-readable form.
wenzelm@48580
   179
*}
wenzelm@48578
   180
wenzelm@48578
   181
wenzelm@48578
   182
section {* Invoking the build process \label{sec:tool-build} *}
wenzelm@48578
   183
wenzelm@48602
   184
text {* The @{tool_def build} tool invokes the build process for
wenzelm@48578
   185
  Isabelle sessions.  It manages dependencies between sessions,
wenzelm@48578
   186
  related sources of theories and auxiliary files, and target heap
wenzelm@48578
   187
  images.  Accordingly, it runs instances of the prover process with
wenzelm@48578
   188
  optional document preparation.  Its command-line usage
wenzelm@48578
   189
  is:\footnote{Isabelle/Scala provides the same functionality via
wenzelm@48578
   190
  \texttt{isabelle.Build.build}.}
wenzelm@48602
   191
\begin{ttbox}
wenzelm@48602
   192
Usage: isabelle build [OPTIONS] [SESSIONS ...]
wenzelm@48578
   193
wenzelm@48578
   194
  Options are:
wenzelm@48578
   195
    -a           select all sessions
wenzelm@48578
   196
    -b           build heap images
wenzelm@48595
   197
    -c           clean build
wenzelm@48578
   198
    -d DIR       include session directory with ROOT file
wenzelm@48578
   199
    -g NAME      select session group NAME
wenzelm@48578
   200
    -j INT       maximum number of parallel jobs (default 1)
wenzelm@48578
   201
    -n           no build -- test dependencies only
wenzelm@48578
   202
    -o OPTION    override session configuration OPTION
wenzelm@48578
   203
                 (via NAME=VAL or NAME)
wenzelm@48578
   204
    -s           system build mode: produce output in ISABELLE_HOME
wenzelm@48578
   205
    -v           verbose
wenzelm@48578
   206
wenzelm@48578
   207
  Build and manage Isabelle sessions, depending on implicit
wenzelm@48578
   208
  ISABELLE_BUILD_OPTIONS="..."
wenzelm@48578
   209
wenzelm@48578
   210
  ML_PLATFORM="..."
wenzelm@48578
   211
  ML_HOME="..."
wenzelm@48578
   212
  ML_SYSTEM="..."
wenzelm@48578
   213
  ML_OPTIONS="..."
wenzelm@48578
   214
\end{ttbox}
wenzelm@48578
   215
wenzelm@48578
   216
  \medskip Isabelle sessions are defined via session ROOT files as
wenzelm@48578
   217
  described in (\secref{sec:session-root}).  The totality of sessions
wenzelm@48578
   218
  is determined by collecting such specifications from all Isabelle
wenzelm@48578
   219
  component directories (\secref{sec:components}), augmented by more
wenzelm@48578
   220
  directories given via options @{verbatim "-d"}~@{text "DIR"} on the
wenzelm@48578
   221
  command line.  Each such directory may contain a session
wenzelm@48650
   222
  \texttt{ROOT} file with several session specifications.
wenzelm@48578
   223
wenzelm@48684
   224
  Any session root directory may refer recursively to further
wenzelm@48684
   225
  directories of the same kind, by listing them in a catalog file
wenzelm@48684
   226
  @{verbatim "ROOTS"} line-by-line.  This helps to organize large
wenzelm@48684
   227
  collections of session specifications, or to make @{verbatim "-d"}
wenzelm@48684
   228
  command line options persistent (say within @{verbatim
wenzelm@48684
   229
  "$ISABELLE_HOME_USER/ROOTS"}).
wenzelm@48684
   230
wenzelm@48604
   231
  \medskip The subset of sessions to be managed is determined via
wenzelm@48578
   232
  individual @{text "SESSIONS"} given as command-line arguments, or
wenzelm@48604
   233
  session groups that are given via one or more options @{verbatim
wenzelm@48578
   234
  "-g"}~@{text "NAME"}.  Option @{verbatim "-a"} selects all sessions.
wenzelm@48604
   235
  The build tool takes session dependencies into account: the set of
wenzelm@48604
   236
  selected sessions is completed by including all ancestors.
wenzelm@48578
   237
wenzelm@48604
   238
  \medskip The build process depends on additional options
wenzelm@48604
   239
  (\secref{sec:system-options}) that are passed to the prover
wenzelm@48604
   240
  eventually.  The settings variable @{setting_ref
wenzelm@48604
   241
  ISABELLE_BUILD_OPTIONS} allows to provide additional defaults, e.g.\
wenzelm@48604
   242
  \texttt{ISABELLE_BUILD_OPTIONS="document=pdf threads=4"}. Moreover,
wenzelm@48604
   243
  the environment of system build options may be augmented on the
wenzelm@48604
   244
  command line via @{verbatim "-o"}~@{text "name"}@{verbatim
wenzelm@48604
   245
  "="}@{text "value"} or @{verbatim "-o"}~@{text "name"}, which
wenzelm@48604
   246
  abbreviates @{verbatim "-o"}~@{text "name"}@{verbatim"=true"} for
wenzelm@48604
   247
  Boolean options.  Multiple occurrences of @{verbatim "-o"} on the
wenzelm@48604
   248
  command-line are applied in the given order.
wenzelm@48578
   249
wenzelm@48578
   250
  \medskip Option @{verbatim "-b"} ensures that heap images are
wenzelm@48578
   251
  produced for all selected sessions.  By default, images are only
wenzelm@48578
   252
  saved for inner nodes of the hierarchy of sessions, as required for
wenzelm@48578
   253
  other sessions to continue later on.
wenzelm@48578
   254
wenzelm@48595
   255
  \medskip Option @{verbatim "-c"} cleans all descendants of the
wenzelm@48595
   256
  selected sessions before performing the specified build operation.
wenzelm@48595
   257
wenzelm@48595
   258
  \medskip Option @{verbatim "-n"} omits the actual build process
wenzelm@48595
   259
  after the preparatory stage (including optional cleanup).  Note that
wenzelm@48595
   260
  the return code always indicates the status of the set of selected
wenzelm@48595
   261
  sessions.
wenzelm@48595
   262
wenzelm@48578
   263
  \medskip Option @{verbatim "-j"} specifies the maximum number of
wenzelm@48604
   264
  parallel build jobs (prover processes).  Each prover process is
wenzelm@48604
   265
  subject to a separate limit of parallel worker threads, cf.\ system
wenzelm@48604
   266
  option @{system_option_ref threads}.
wenzelm@48578
   267
wenzelm@48578
   268
  \medskip Option @{verbatim "-s"} enables \emph{system mode}, which
wenzelm@48578
   269
  means that resulting heap images and log files are stored in
wenzelm@48578
   270
  @{verbatim "$ISABELLE_HOME/heaps"} instead of the default location
wenzelm@48578
   271
  @{setting ISABELLE_OUTPUT} (which is normally in @{setting
wenzelm@48578
   272
  ISABELLE_HOME_USER}, i.e.\ the user's home directory).
wenzelm@48578
   273
wenzelm@48578
   274
  \medskip Option @{verbatim "-v"} enables verbose mode.
wenzelm@48578
   275
*}
wenzelm@48578
   276
wenzelm@48578
   277
subsubsection {* Examples *}
wenzelm@48578
   278
wenzelm@48578
   279
text {*
wenzelm@48578
   280
  Build a specific logic image:
wenzelm@48578
   281
\begin{ttbox}
wenzelm@48578
   282
isabelle build -b HOLCF
wenzelm@48578
   283
\end{ttbox}
wenzelm@48578
   284
wenzelm@48604
   285
  \smallskip Build the main group of logic images:
wenzelm@48578
   286
\begin{ttbox}
wenzelm@48578
   287
isabelle build -b -g main
wenzelm@48578
   288
\end{ttbox}
wenzelm@48578
   289
wenzelm@48595
   290
  \smallskip Provide a general overview of the status of all Isabelle
wenzelm@48595
   291
  sessions, without building anything:
wenzelm@48578
   292
\begin{ttbox}
wenzelm@48578
   293
isabelle build -a -n -v
wenzelm@48578
   294
\end{ttbox}
wenzelm@48578
   295
wenzelm@48595
   296
  \smallskip Build all sessions with HTML browser info and PDF
wenzelm@48595
   297
  document preparation:
wenzelm@48578
   298
\begin{ttbox}
wenzelm@48578
   299
isabelle build -a -o browser_info -o document=pdf
wenzelm@48578
   300
\end{ttbox}
wenzelm@48578
   301
wenzelm@48604
   302
  \smallskip Build all sessions with a maximum of 8 parallel prover
wenzelm@48604
   303
  processes and 4 worker threads each (on a machine with many cores):
wenzelm@48578
   304
\begin{ttbox}
wenzelm@48578
   305
isabelle build -a -j8 -o threads=4
wenzelm@48578
   306
\end{ttbox}
wenzelm@48595
   307
wenzelm@48595
   308
  \smallskip Build some session images with cleanup of their
wenzelm@48595
   309
  descendants, while retaining their ancestry:
wenzelm@48595
   310
\begin{ttbox}
wenzelm@48595
   311
isabelle build -b -c HOL-Boogie HOL-SPARK
wenzelm@48595
   312
\end{ttbox}
wenzelm@48595
   313
wenzelm@48595
   314
  \smallskip Clean all sessions without building anything:
wenzelm@48595
   315
\begin{ttbox}
wenzelm@48595
   316
isabelle build -a -n -c
wenzelm@48595
   317
\end{ttbox}
wenzelm@48578
   318
*}
wenzelm@48578
   319
wenzelm@48683
   320
wenzelm@48683
   321
section {* Preparing session root directories \label{sec:tool-mkroot} *}
wenzelm@48683
   322
wenzelm@48683
   323
text {* The @{tool_def mkroot} tool prepares Isabelle session source
wenzelm@48683
   324
  directories, including some @{verbatim ROOT} entry, an example
wenzelm@48683
   325
  theory file, and some initial configuration for document preparation
wenzelm@48683
   326
  (see also \chref{ch:present}).  The usage of @{tool mkroot} is:
wenzelm@48683
   327
wenzelm@48683
   328
\begin{ttbox}
wenzelm@48683
   329
Usage: isabelle mkroot NAME
wenzelm@48683
   330
wenzelm@48683
   331
  Prepare session root directory, adding session NAME with
wenzelm@48683
   332
  built-in document preparation.
wenzelm@48683
   333
\end{ttbox}
wenzelm@48683
   334
wenzelm@48683
   335
  All session-specific files are placed into a separate sub-directory
wenzelm@48683
   336
  given as @{verbatim NAME} above.  The @{verbatim ROOT} file is in
wenzelm@48683
   337
  the parent position relative to that --- it could refer to several
wenzelm@48683
   338
  such sessions.  The @{tool mkroot} tool is conservative in the sense
wenzelm@48683
   339
  that does not overwrite an existing session sub-directory; an
wenzelm@48683
   340
  already existing @{verbatim ROOT} file is extended.
wenzelm@48683
   341
wenzelm@48683
   342
  The implicit Isabelle settings variable @{setting ISABELLE_LOGIC}
wenzelm@48683
   343
  specifies the parent session, and @{setting
wenzelm@48683
   344
  ISABELLE_DOCUMENT_FORMAT} the document format to be filled filled
wenzelm@48683
   345
  into the generated @{verbatim ROOT} file.  *}
wenzelm@48683
   346
wenzelm@48683
   347
wenzelm@48683
   348
subsubsection {* Examples *}
wenzelm@48683
   349
wenzelm@48683
   350
text {* The following produces an example session, relatively to the
wenzelm@48683
   351
  @{verbatim ROOT} in the current directory:
wenzelm@48683
   352
\begin{ttbox}
wenzelm@48683
   353
isabelle mkroot Test && isabelle build -v -d. Test
wenzelm@48683
   354
\end{ttbox}
wenzelm@48683
   355
wenzelm@48683
   356
  Option @{verbatim "-v"} is not required, but useful to reveal the
wenzelm@48683
   357
  the location of generated documents.  *}
wenzelm@48683
   358
wenzelm@48578
   359
end