Admin/PLATFORMS
author wenzelm
Fri Oct 21 20:58:51 2016 +0200 (2016-10-21)
changeset 64339 321065f9f55b
parent 64337 e3b57c8046cb
child 64344 c1695143de35
permissions -rw-r--r--
misc tuning and updates;
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@35610
    20
room of Isabelle, and refrain from overly ambitious system hacking.
wenzelm@64339
    21
The existing Isabelle bash scripts follow a peculiar style that
wenzelm@64339
    22
reflects long years of experience in getting system plumbing right.
wenzelm@35610
    23
wenzelm@35610
    24
wenzelm@35610
    25
Supported platforms
wenzelm@35610
    26
-------------------
wenzelm@35610
    27
wenzelm@35610
    28
The following hardware and operating system platforms are officially
wenzelm@36204
    29
supported by the Isabelle distribution (and bundled tools), with the
wenzelm@64339
    30
following base-line versions (which have been selected to be neither
wenzelm@36204
    31
too old nor too new):
wenzelm@35610
    32
wenzelm@63520
    33
  x86-linux         Ubuntu 12.04 LTS
wenzelm@63520
    34
  x86_64-linux      Ubuntu 12.04 LTS
wenzelm@35610
    35
wenzelm@61741
    36
  x86_64-darwin     Mac OS X 10.8 Mountain Lion (macbroy30)
wenzelm@59114
    37
                    Mac OS X 10.9 Mavericks (macbroy2)
wenzelm@59114
    38
                    Mac OS X 10.10 Yosemite (macbroy31)
wenzelm@64337
    39
                    Mac OS X 10.11 El Capitan (??)
wenzelm@64337
    40
                    macOS 10.12 Sierra (???)
wenzelm@48833
    41
wenzelm@64339
    42
  x86-windows       Windows 7
wenzelm@64339
    43
  x86_64-windows    Windows 7
wenzelm@64339
    44
  x86-cygwin        http://isabelle.in.tum.de/cygwin_2016 (x86/release)
wenzelm@36204
    45
wenzelm@36204
    46
All of the above platforms are 100% supported by Isabelle -- end-users
wenzelm@44876
    47
should not have to care about the differences (at least in theory).
wenzelm@35610
    48
wenzelm@64339
    49
Fringe platforms like BSD or Solaris are not supported.
wenzelm@36204
    50
wenzelm@36204
    51
wenzelm@36204
    52
32 bit vs. 64 bit platforms
wenzelm@36204
    53
---------------------------
wenzelm@36204
    54
wenzelm@48833
    55
Most users have 64 bit hardware and are running a 64 bit operating
wenzelm@55391
    56
system by default.  For Linux this usually means missing 32 bit shared
wenzelm@48833
    57
libraries, so native x86_64-linux needs to be used by default, despite
wenzelm@48833
    58
its doubled space requirements for Poly/ML heaps.  For Mac OS X, the
wenzelm@48833
    59
x86-darwin personality usually works seamlessly for C/C++ programs,
wenzelm@64339
    60
but the Java platform is only available for x86_64-darwin.
wenzelm@48833
    61
wenzelm@49144
    62
Add-on executables are expected to work without manual user
wenzelm@49144
    63
configuration.  Each component settings script needs to determine the
wenzelm@49144
    64
platform details appropriately.
wenzelm@48833
    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@48833
    70
  ISABELLE_PLATFORM32
wenzelm@48833
    71
  ISABELLE_PLATFORM
wenzelm@36204
    72
wenzelm@36204
    73
The ISABELLE_PLATFORM setting variable refers to the 32 bit version of
wenzelm@48833
    74
the platform, even on 64 bit hardware.  Using regular bash notation,
wenzelm@48833
    75
tools may express their preference for 64 bit with a fall-back for 32
wenzelm@48833
    76
bit as follows:
wenzelm@48833
    77
wenzelm@48833
    78
  "${ISABELLE_PLATFORM64:-$ISABELLE_PLATFORM32}"
wenzelm@36204
    79
wenzelm@48833
    80
Moreover note that ML and JVM usually have a different idea of the
wenzelm@48833
    81
platform, depending on the respective binaries that are actually run.
wenzelm@64339
    82
Poly/ML 5.6.x performs best in 32 bit mode, even for large
wenzelm@49144
    83
applications, thanks to its sophisticated heap management.  The JVM
wenzelm@49144
    84
usually works better in 64 bit mode, which allows its heap to grow
wenzelm@49144
    85
beyond 2 GB.
wenzelm@36204
    86
wenzelm@64339
    87
The traditional "uname" Unix tool only tells about its own executable
wenzelm@64339
    88
format, not the underlying platform!
wenzelm@35610
    89
wenzelm@35610
    90
wenzelm@35610
    91
Dependable system tools
wenzelm@35610
    92
-----------------------
wenzelm@35610
    93
wenzelm@35610
    94
The following portable system tools can be taken for granted:
wenzelm@35610
    95
wenzelm@64339
    96
* Scala on top of Java 8.  Isabelle/Scala irons out many oddities and
wenzelm@64339
    97
  portability issues of the Java platform.
wenzelm@64339
    98
wenzelm@36204
    99
* GNU bash as uniform shell on all platforms.  The POSIX "standard"
wenzelm@64339
   100
  shell /bin/sh does *not* work -- there are too many non-standard
wenzelm@64339
   101
  implementations of it.
wenzelm@35610
   102
wenzelm@58780
   103
* Perl as largely portable system programming language, with its
wenzelm@58780
   104
  fairly robust support for processes, signals, sockets etc.
wenzelm@35610
   105
wenzelm@35610
   106
wenzelm@35610
   107
Known problems
wenzelm@35610
   108
--------------
wenzelm@35610
   109
wenzelm@55391
   110
* Mac OS X: If MacPorts is installed there is some danger that
wenzelm@41668
   111
  accidental references to its shared libraries are created
wenzelm@41668
   112
  (e.g. libgmp).  Use otool -L to check if compiled binaries also work
wenzelm@41668
   113
  without MacPorts.
wenzelm@41668
   114
wenzelm@55391
   115
* Mac OS X: If MacPorts is installed and its version of Perl takes
wenzelm@35610
   116
  precedence over /usr/bin/perl in the PATH, then the end-user needs
wenzelm@36204
   117
  to take care of installing extra modules, e.g. for HTTP support.
wenzelm@36204
   118
  Such add-ons are usually included in Apple's /usr/bin/perl by
wenzelm@36204
   119
  default.
wenzelm@35610
   120
wenzelm@35610
   121
* The Java runtime has its own idea about the underlying platform,
wenzelm@48833
   122
  which affects Java native libraries in particular.  In
wenzelm@49144
   123
  Isabelle/Scala the function isabelle.Platform.jvm_platform
wenzelm@49144
   124
  identifies the JVM platform.  Since a particular Java version is
wenzelm@49144
   125
  always bundled with Isabelle, the resulting settings also provide
wenzelm@49144
   126
  some clues about its platform, without running it.
wenzelm@55438
   127
wenzelm@55438
   128
* Common Unix tools like /bin/sh, /bin/kill, sed, ulimit are
wenzelm@64339
   129
  notoriously non-portable an should be avoided.