src/Pure/ML-Systems/multithreading_polyml.ML
author wenzelm
Wed Oct 01 12:00:02 2008 +0200 (2008-10-01)
changeset 28443 de653f1ad78b
parent 28398 9aa3216e5f31
child 28465 db8667d84dd2
permissions -rw-r--r--
more robust treatment of Interrupt (cf. exn.ML);
wenzelm@23961
     1
(*  Title:      Pure/ML-Systems/multithreading_polyml.ML
wenzelm@23961
     2
    ID:         $Id$
wenzelm@23961
     3
    Author:     Makarius
wenzelm@23961
     4
wenzelm@28254
     5
Multithreading in Poly/ML 5.2 or later (cf. polyml/basis/Thread.sml).
wenzelm@23961
     6
*)
wenzelm@23961
     7
wenzelm@25704
     8
signature MULTITHREADING_POLYML =
wenzelm@25704
     9
sig
wenzelm@26083
    10
  val interruptible: ('a -> 'b) -> 'a -> 'b
wenzelm@26083
    11
  val uninterruptible: ((('c -> 'd) -> 'c -> 'd) -> 'a -> 'b) -> 'a -> 'b
wenzelm@26098
    12
  val system_out: string -> string * int
wenzelm@25704
    13
  structure TimeLimit: TIME_LIMIT
wenzelm@26390
    14
  val profile: int -> ('a -> 'b) -> 'a -> 'b
wenzelm@25704
    15
end;
wenzelm@25704
    16
wenzelm@25704
    17
signature BASIC_MULTITHREADING =
wenzelm@25704
    18
sig
wenzelm@25704
    19
  include BASIC_MULTITHREADING
wenzelm@25704
    20
  include MULTITHREADING_POLYML
wenzelm@25704
    21
end;
wenzelm@25704
    22
wenzelm@24208
    23
signature MULTITHREADING =
wenzelm@24208
    24
sig
wenzelm@24208
    25
  include MULTITHREADING
wenzelm@25704
    26
  include MULTITHREADING_POLYML
wenzelm@24208
    27
end;
wenzelm@24208
    28
wenzelm@23961
    29
structure Multithreading: MULTITHREADING =
wenzelm@23961
    30
struct
wenzelm@23961
    31
wenzelm@24072
    32
(* options *)
wenzelm@24069
    33
wenzelm@24119
    34
val trace = ref 0;
wenzelm@24119
    35
fun tracing level msg =
wenzelm@24119
    36
  if level <= ! trace
wenzelm@23981
    37
  then (TextIO.output (TextIO.stdErr, (">>> " ^ msg () ^ "\n")); TextIO.flushOut TextIO.stdErr)
wenzelm@23981
    38
  else ();
wenzelm@23961
    39
wenzelm@23981
    40
val available = true;
wenzelm@25775
    41
wenzelm@23973
    42
val max_threads = ref 1;
wenzelm@23973
    43
wenzelm@25775
    44
fun max_threads_value () =
wenzelm@25775
    45
  let val m = ! max_threads
wenzelm@28161
    46
  in if m <= 0 then Int.max (Thread.numProcessors (), 1) else m end;
wenzelm@25775
    47
wenzelm@23973
    48
wenzelm@24069
    49
(* misc utils *)
wenzelm@24069
    50
wenzelm@24208
    51
fun show "" = "" | show name = " " ^ name;
wenzelm@24208
    52
fun show' "" = "" | show' name = " [" ^ name ^ "]";
wenzelm@24208
    53
wenzelm@26098
    54
fun read_file name =
wenzelm@26098
    55
  let val is = TextIO.openIn name
wenzelm@26504
    56
  in Exn.release (Exn.capture TextIO.inputAll is before TextIO.closeIn is) end;
wenzelm@26098
    57
wenzelm@26098
    58
fun write_file name txt =
wenzelm@26098
    59
  let val os = TextIO.openOut name
wenzelm@26504
    60
  in Exn.release (Exn.capture TextIO.output (os, txt) before TextIO.closeOut os) end;
wenzelm@26098
    61
wenzelm@24208
    62
wenzelm@24208
    63
(* thread attributes *)
wenzelm@24208
    64
wenzelm@28161
    65
val no_interrupts =
wenzelm@28161
    66
  [Thread.EnableBroadcastInterrupt false, Thread.InterruptState Thread.InterruptDefer];
wenzelm@28161
    67
wenzelm@28161
    68
val regular_interrupts =
wenzelm@28161
    69
  [Thread.EnableBroadcastInterrupt true, Thread.InterruptState Thread.InterruptAsynchOnce];
wenzelm@28161
    70
wenzelm@24208
    71
fun with_attributes new_atts f x =
wenzelm@24208
    72
  let
wenzelm@24208
    73
    val orig_atts = Thread.getAttributes ();
wenzelm@24208
    74
    fun restore () = Thread.setAttributes orig_atts;
wenzelm@24208
    75
  in
wenzelm@24208
    76
    Exn.release
wenzelm@24214
    77
    (*RACE for fully asynchronous interrupts!*)
wenzelm@24214
    78
    (let
wenzelm@24208
    79
        val _ = Thread.setAttributes new_atts;
wenzelm@24214
    80
        val result = Exn.capture (f orig_atts) x;
wenzelm@24208
    81
        val _ = restore ();
wenzelm@24208
    82
      in result end
wenzelm@28443
    83
      handle Exn.Interrupt => (restore (); Exn.Exn Exn.Interrupt))
wenzelm@24208
    84
  end;
wenzelm@24208
    85
wenzelm@28161
    86
fun interruptible f = with_attributes regular_interrupts (fn _ => f);
wenzelm@28150
    87
wenzelm@26083
    88
fun uninterruptible f =
wenzelm@28150
    89
  with_attributes no_interrupts (fn atts => f (fn g => with_attributes atts (fn _ => g)));
wenzelm@24668
    90
wenzelm@24688
    91
wenzelm@24688
    92
(* execution with time limit *)
wenzelm@24688
    93
wenzelm@24688
    94
structure TimeLimit =
wenzelm@24688
    95
struct
wenzelm@24688
    96
wenzelm@24688
    97
exception TimeOut;
wenzelm@24688
    98
wenzelm@26083
    99
fun timeLimit time f x = uninterruptible (fn restore_attributes => fn () =>
wenzelm@26083
   100
  let
wenzelm@26083
   101
    val worker = Thread.self ();
wenzelm@26083
   102
    val timeout = ref false;
wenzelm@26083
   103
    val watchdog = Thread.fork (fn () =>
wenzelm@26083
   104
      (OS.Process.sleep time; timeout := true; Thread.interrupt worker), []);
wenzelm@24688
   105
wenzelm@26083
   106
    (*RACE! timeout signal vs. external Interrupt*)
wenzelm@26083
   107
    val result = Exn.capture (restore_attributes f) x;
wenzelm@28443
   108
    val was_timeout = (case result of Exn.Exn Exn.Interrupt => ! timeout | _ => false);
wenzelm@24688
   109
wenzelm@26083
   110
    val _ = Thread.interrupt watchdog handle Thread _ => ();
wenzelm@26083
   111
  in if was_timeout then raise TimeOut else Exn.release result end) ();
wenzelm@24688
   112
wenzelm@24688
   113
end;
wenzelm@24668
   114
wenzelm@24069
   115
wenzelm@26098
   116
(* system shell processes, with propagation of interrupts *)
wenzelm@26098
   117
wenzelm@28254
   118
fun system_out script = uninterruptible (fn restore_attributes => fn () =>
wenzelm@26098
   119
  let
wenzelm@26098
   120
    val script_name = OS.FileSys.tmpName ();
wenzelm@26098
   121
    val _ = write_file script_name script;
wenzelm@26098
   122
wenzelm@26098
   123
    val pid_name = OS.FileSys.tmpName ();
wenzelm@26098
   124
    val output_name = OS.FileSys.tmpName ();
wenzelm@26098
   125
wenzelm@26098
   126
    (*result state*)
wenzelm@26098
   127
    datatype result = Wait | Signal | Result of int;
wenzelm@26098
   128
    val result = ref Wait;
wenzelm@26098
   129
    val result_mutex = Mutex.mutex ();
wenzelm@26098
   130
    val result_cond = ConditionVar.conditionVar ();
wenzelm@26098
   131
    fun set_result res =
wenzelm@26098
   132
      (Mutex.lock result_mutex; result := res; Mutex.unlock result_mutex;
wenzelm@26098
   133
        ConditionVar.signal result_cond);
wenzelm@26098
   134
wenzelm@26098
   135
    val _ = Mutex.lock result_mutex;
wenzelm@26098
   136
wenzelm@26098
   137
    (*system thread*)
wenzelm@26098
   138
    val system_thread = Thread.fork (fn () =>
wenzelm@26098
   139
      let
wenzelm@26098
   140
        val status =
wenzelm@26098
   141
          OS.Process.system ("perl -w \"$ISABELLE_HOME/lib/scripts/system.pl\" group " ^
wenzelm@26098
   142
            script_name ^ " " ^ pid_name ^ " " ^ output_name);
wenzelm@26098
   143
        val res =
wenzelm@26098
   144
          (case Posix.Process.fromStatus status of
wenzelm@26098
   145
            Posix.Process.W_EXITED => Result 0
wenzelm@26098
   146
          | Posix.Process.W_EXITSTATUS 0wx82 => Signal
wenzelm@26098
   147
          | Posix.Process.W_EXITSTATUS w => Result (Word8.toInt w)
wenzelm@26098
   148
          | Posix.Process.W_SIGNALED s =>
wenzelm@26098
   149
              if s = Posix.Signal.int then Signal
wenzelm@26098
   150
              else Result (256 + LargeWord.toInt (Posix.Signal.toWord s))
wenzelm@26098
   151
          | Posix.Process.W_STOPPED s => Result (512 + LargeWord.toInt (Posix.Signal.toWord s)));
wenzelm@28398
   152
      in set_result res end handle _ (*sic*) => set_result (Result 2), []);
wenzelm@26098
   153
wenzelm@26098
   154
    (*main thread -- proxy for interrupts*)
wenzelm@26098
   155
    fun kill n =
wenzelm@26098
   156
      (case Int.fromString (read_file pid_name) of
wenzelm@26098
   157
        SOME pid =>
wenzelm@26098
   158
          Posix.Process.kill
wenzelm@26098
   159
            (Posix.Process.K_GROUP (Posix.Process.wordToPid (LargeWord.fromInt pid)),
wenzelm@26098
   160
              Posix.Signal.int)
wenzelm@26098
   161
      | NONE => ())
wenzelm@26098
   162
      handle OS.SysErr _ => () | IO.Io _ =>
wenzelm@26098
   163
        (OS.Process.sleep (Time.fromMilliseconds 100); if n > 0 then kill (n - 1) else ());
wenzelm@26098
   164
wenzelm@26098
   165
    val _ = while ! result = Wait do
wenzelm@26098
   166
      restore_attributes (fn () =>
wenzelm@26098
   167
        (ConditionVar.waitUntil (result_cond, result_mutex, Time.now () + Time.fromMilliseconds 100); ())
wenzelm@28443
   168
          handle Exn.Interrupt => kill 10) ();
wenzelm@26098
   169
wenzelm@26098
   170
    (*cleanup*)
wenzelm@26098
   171
    val output = read_file output_name handle IO.Io _ => "";
wenzelm@26098
   172
    val _ = OS.FileSys.remove script_name handle OS.SysErr _ => ();
wenzelm@26098
   173
    val _ = OS.FileSys.remove pid_name handle OS.SysErr _ => ();
wenzelm@26098
   174
    val _ = OS.FileSys.remove output_name handle OS.SysErr _ => ();
wenzelm@26098
   175
    val _ = Thread.interrupt system_thread handle Thread _ => ();
wenzelm@28443
   176
    val rc = (case ! result of Signal => raise Exn.Interrupt | Result rc => rc);
wenzelm@26098
   177
  in (output, rc) end) ();
wenzelm@26098
   178
wenzelm@26098
   179
wenzelm@23961
   180
(* critical section -- may be nested within the same thread *)
wenzelm@23961
   181
wenzelm@23961
   182
local
wenzelm@23961
   183
wenzelm@24063
   184
val critical_lock = Mutex.mutex ();
wenzelm@24063
   185
val critical_thread = ref (NONE: Thread.thread option);
wenzelm@24063
   186
val critical_name = ref "";
wenzelm@24063
   187
wenzelm@23961
   188
in
wenzelm@23961
   189
wenzelm@23961
   190
fun self_critical () =
wenzelm@23961
   191
  (case ! critical_thread of
wenzelm@23961
   192
    NONE => false
wenzelm@28150
   193
  | SOME t => Thread.equal (t, Thread.self ()));
wenzelm@23961
   194
wenzelm@23991
   195
fun NAMED_CRITICAL name e =
wenzelm@23961
   196
  if self_critical () then e ()
wenzelm@23961
   197
  else
wenzelm@26083
   198
    uninterruptible (fn restore_attributes => fn () =>
wenzelm@24208
   199
      let
wenzelm@24208
   200
        val name' = ! critical_name;
wenzelm@24208
   201
        val _ =
wenzelm@24208
   202
          if Mutex.trylock critical_lock then ()
wenzelm@24208
   203
          else
wenzelm@24208
   204
            let
wenzelm@24208
   205
              val timer = Timer.startRealTimer ();
wenzelm@24208
   206
              val _ = tracing 4 (fn () => "CRITICAL" ^ show name ^ show' name' ^ ": waiting");
wenzelm@24208
   207
              val _ = Mutex.lock critical_lock;
wenzelm@24208
   208
              val time = Timer.checkRealTimer timer;
wenzelm@26493
   209
              val trace_time =
wenzelm@26493
   210
                if Time.>= (time, Time.fromMilliseconds 1000) then 1
wenzelm@26493
   211
                else if Time.>= (time, Time.fromMilliseconds 100) then 2
wenzelm@26493
   212
                else if Time.>= (time, Time.fromMilliseconds 10) then 3 else 4;
wenzelm@26493
   213
              val _ = tracing trace_time (fn () =>
wenzelm@24208
   214
                "CRITICAL" ^ show name ^ show' name' ^ ": passed after " ^ Time.toString time);
wenzelm@24208
   215
            in () end;
wenzelm@24208
   216
        val _ = critical_thread := SOME (Thread.self ());
wenzelm@24208
   217
        val _ = critical_name := name;
wenzelm@26083
   218
        val result = Exn.capture (restore_attributes e) ();
wenzelm@24208
   219
        val _ = critical_name := "";
wenzelm@24208
   220
        val _ = critical_thread := NONE;
wenzelm@24208
   221
        val _ = Mutex.unlock critical_lock;
wenzelm@24208
   222
      in Exn.release result end) ();
wenzelm@23961
   223
wenzelm@23991
   224
fun CRITICAL e = NAMED_CRITICAL "" e;
wenzelm@23981
   225
wenzelm@23961
   226
end;
wenzelm@23961
   227
wenzelm@23973
   228
wenzelm@26390
   229
(* profiling *)
wenzelm@26390
   230
wenzelm@26390
   231
local val profile_orig = profile in
wenzelm@26390
   232
wenzelm@26390
   233
fun profile 0 f x = f x
wenzelm@26390
   234
  | profile n f x = NAMED_CRITICAL "profile" (fn () => profile_orig n f x);
wenzelm@26390
   235
wenzelm@26390
   236
end;
wenzelm@26390
   237
wenzelm@26390
   238
wenzelm@25704
   239
(* serial numbers *)
wenzelm@25704
   240
wenzelm@25704
   241
local
wenzelm@25704
   242
wenzelm@25704
   243
val serial_lock = Mutex.mutex ();
wenzelm@25704
   244
val serial_count = ref 0;
wenzelm@25704
   245
wenzelm@25704
   246
in
wenzelm@25704
   247
wenzelm@25704
   248
val serial = uninterruptible (fn _ => fn () =>
wenzelm@25704
   249
  let
wenzelm@25704
   250
    val _ = Mutex.lock serial_lock;
wenzelm@28124
   251
    val _ = serial_count := ! serial_count + 1;
wenzelm@28124
   252
    val res = ! serial_count;
wenzelm@25704
   253
    val _ = Mutex.unlock serial_lock;
wenzelm@25704
   254
  in res end);
wenzelm@25704
   255
wenzelm@23961
   256
end;
wenzelm@23961
   257
wenzelm@25704
   258
end;
wenzelm@24688
   259
wenzelm@25704
   260
structure BasicMultithreading: BASIC_MULTITHREADING = Multithreading;
wenzelm@25704
   261
open BasicMultithreading;