Admin/PLATFORMS
author wenzelm
Fri Oct 27 13:50:08 2017 +0200 (21 months ago)
changeset 66924 b4d4027f743b
parent 66911 d122c24a93d6
child 67088 89e82aed7813
permissions -rw-r--r--
more permissive;
wenzelm@64339
     1
Multi-platform support of Isabelle
wenzelm@64339
     2
==================================
wenzelm@35610
     3
wenzelm@35610
     4
Preamble
wenzelm@35610
     5
--------
wenzelm@35610
     6
wenzelm@35610
     7
The general programming model is that of a stylized ML + Scala + POSIX
wenzelm@48833
     8
environment, with as little system-specific code in user-space tools
wenzelm@48833
     9
as possible.
wenzelm@35610
    10
wenzelm@35610
    11
The basic Isabelle system infrastructure provides some facilities to
wenzelm@48833
    12
make this work, e.g. see the ML and Scala modules File and Path, or
wenzelm@48833
    13
functions like Isabelle_System.bash.  The settings environment also
wenzelm@61294
    14
provides some means for portability, e.g. the bash function
wenzelm@61294
    15
"platform_path" to keep the impression that Windows/Cygwin adheres to
wenzelm@64339
    16
Isabelle/POSIX standards, although Poly/ML and the JVM are native on
wenzelm@64339
    17
Windows.
wenzelm@35610
    18
wenzelm@35610
    19
When producing add-on tools, it is important to stay within this clean
wenzelm@66911
    20
room of Isabelle, and refrain from low-level access to the operating
wenzelm@66911
    21
system. The Isabelle environment uses peculiar scripts for GNU bash and
wenzelm@66911
    22
perl to get the plumbing right. This style should be imitated as far as
wenzelm@66911
    23
possible.
wenzelm@35610
    24
wenzelm@35610
    25
wenzelm@35610
    26
Supported platforms
wenzelm@35610
    27
-------------------
wenzelm@35610
    28
wenzelm@35610
    29
The following hardware and operating system platforms are officially
wenzelm@36204
    30
supported by the Isabelle distribution (and bundled tools), with the
wenzelm@64339
    31
following base-line versions (which have been selected to be neither
wenzelm@36204
    32
too old nor too new):
wenzelm@35610
    33
wenzelm@63520
    34
  x86_64-linux      Ubuntu 12.04 LTS
wenzelm@35610
    35
wenzelm@65369
    36
  x86_64-darwin     Mac OS X 10.9 Mavericks (macbroy2 MacPro4,1)
wenzelm@64406
    37
                    Mac OS X 10.10 Yosemite (macbroy31 MacBookPro6,2)
wenzelm@64402
    38
                    Mac OS X 10.11 El Capitan (?)
wenzelm@65369
    39
                    macOS 10.12 Sierra (macbroy30 MacBookPro6,2)
wenzelm@48833
    40
wenzelm@64339
    41
  x86_64-windows    Windows 7
wenzelm@66691
    42
  x86_64-cygwin     Cygwin 2.8 http://isabelle.in.tum.de/cygwin_2017 (x86_64/release)
wenzelm@36204
    43
wenzelm@36204
    44
All of the above platforms are 100% supported by Isabelle -- end-users
wenzelm@44876
    45
should not have to care about the differences (at least in theory).
wenzelm@35610
    46
wenzelm@64339
    47
Fringe platforms like BSD or Solaris are not supported.
wenzelm@36204
    48
wenzelm@36204
    49
wenzelm@66911
    50
64 bit vs. 32 bit platform personality
wenzelm@66911
    51
--------------------------------------
wenzelm@36204
    52
wenzelm@66911
    53
Isabelle requires 64 bit hardware running a 64 bit operating. Windows
wenzelm@66911
    54
and Mac OS X allow x86 executables as well, but for Linux this requires
wenzelm@66911
    55
separate installation of 32 bit shared libraries. The POSIX emulation on
wenzelm@66911
    56
Windows via Cygwin64 is exclusively for x86_64.
wenzelm@66911
    57
wenzelm@66911
    58
ML works both for x86_64 and x86, and the latter is preferred for space
wenzelm@66911
    59
and performance reasons. Java is always for x86_64 on all platforms.
wenzelm@48833
    60
wenzelm@49144
    61
Add-on executables are expected to work without manual user
wenzelm@66911
    62
configuration. Each component settings script needs to determine the
wenzelm@49144
    63
platform details appropriately.
wenzelm@48833
    64
wenzelm@65073
    65
wenzelm@48833
    66
The Isabelle settings environment provides the following variables to
wenzelm@48833
    67
help configuring platform-dependent tools:
wenzelm@48833
    68
wenzelm@48833
    69
  ISABELLE_PLATFORM64  (potentially empty)
wenzelm@66691
    70
  ISABELLE_PLATFORM32  (potentially empty)
wenzelm@48833
    71
  ISABELLE_PLATFORM
wenzelm@36204
    72
wenzelm@66911
    73
The ISABELLE_PLATFORM setting variable prefers the 32 bit personality of
wenzelm@66911
    74
the platform, if possible. Using regular bash notation, tools may
wenzelm@66911
    75
express their preference for 64 bit with a fall-back for 32 bit as
wenzelm@66911
    76
follows:
wenzelm@48833
    77
wenzelm@48833
    78
  "${ISABELLE_PLATFORM64:-$ISABELLE_PLATFORM32}"
wenzelm@36204
    79
wenzelm@65073
    80
wenzelm@65073
    81
There is a second set of settings for native Windows (instead of the
wenzelm@65073
    82
POSIX emulation of Cygwin used before):
wenzelm@65073
    83
wenzelm@66732
    84
  ISABELLE_WINDOWS_PLATFORM64
wenzelm@65073
    85
  ISABELLE_WINDOWS_PLATFORM32
wenzelm@65073
    86
  ISABELLE_WINDOWS_PLATFORM
wenzelm@65073
    87
wenzelm@65073
    88
It can be used like this:
wenzelm@65073
    89
wenzelm@65073
    90
  "${ISABELLE_WINDOWS_PLATFORM:-$ISABELLE_PLATFORM}"
wenzelm@65073
    91
wenzelm@65073
    92
  "${ISABELLE_WINDOWS_PLATFORM64:-${ISABELLE_WINDOWS_PLATFORM32:-${ISABELLE_PLATFORM64:-$ISABELLE_PLATFORM32}}}"
wenzelm@65073
    93
wenzelm@65073
    94
wenzelm@35610
    95
Dependable system tools
wenzelm@35610
    96
-----------------------
wenzelm@35610
    97
wenzelm@35610
    98
The following portable system tools can be taken for granted:
wenzelm@35610
    99
wenzelm@64339
   100
* Scala on top of Java 8.  Isabelle/Scala irons out many oddities and
wenzelm@64339
   101
  portability issues of the Java platform.
wenzelm@64339
   102
wenzelm@66911
   103
* GNU bash as uniform shell on all platforms. The POSIX "standard" shell
wenzelm@66911
   104
  /bin/sh does *not* work -- there are too many non-standard
wenzelm@66911
   105
  implementations of it. On Debian and Ubuntu /bin/sh is actually
wenzelm@66911
   106
  /bin/dash and thus introduces many oddities.
wenzelm@35610
   107
wenzelm@58780
   108
* Perl as largely portable system programming language, with its
wenzelm@58780
   109
  fairly robust support for processes, signals, sockets etc.
wenzelm@35610
   110
wenzelm@35610
   111
wenzelm@35610
   112
Known problems
wenzelm@35610
   113
--------------
wenzelm@35610
   114
wenzelm@55391
   115
* Mac OS X: If MacPorts is installed there is some danger that
wenzelm@41668
   116
  accidental references to its shared libraries are created
wenzelm@41668
   117
  (e.g. libgmp).  Use otool -L to check if compiled binaries also work
wenzelm@41668
   118
  without MacPorts.
wenzelm@41668
   119
wenzelm@55391
   120
* Mac OS X: If MacPorts is installed and its version of Perl takes
wenzelm@35610
   121
  precedence over /usr/bin/perl in the PATH, then the end-user needs
wenzelm@36204
   122
  to take care of installing extra modules, e.g. for HTTP support.
wenzelm@36204
   123
  Such add-ons are usually included in Apple's /usr/bin/perl by
wenzelm@36204
   124
  default.
wenzelm@35610
   125
wenzelm@66911
   126
* The Java runtime has its own idea about the underlying platform, which
wenzelm@66911
   127
  affects Java native libraries in particular. In Isabelle/Scala the
wenzelm@66911
   128
  function isabelle.Platform.jvm_platform identifies the JVM platform.
wenzelm@66911
   129
  In the settings environment, ISABELLE_JAVA_PLATFORM provides the same
wenzelm@66911
   130
  information without running the JVM.
wenzelm@55438
   131
wenzelm@55438
   132
* Common Unix tools like /bin/sh, /bin/kill, sed, ulimit are
wenzelm@64339
   133
  notoriously non-portable an should be avoided.
wenzelm@66911
   134
wenzelm@66911
   135
* The traditional "uname" Unix tool only tells about its own executable
wenzelm@66911
   136
  format, not the underlying platform!