src/Pure/Concurrent/future.ML
author wenzelm
Sun Sep 28 12:23:45 2008 +0200 (2008-09-28 ago)
changeset 28390 0b9fb63b8e1d
parent 28386 f2f1dd50da5a
child 28415 bf08f955e7db
permissions -rw-r--r--
proper setmp_thread_data for nested execute (cf. join_loop);
wenzelm@28156
     1
(*  Title:      Pure/Concurrent/future.ML
wenzelm@28156
     2
    ID:         $Id$
wenzelm@28156
     3
    Author:     Makarius
wenzelm@28156
     4
wenzelm@28201
     5
Future values.
wenzelm@28201
     6
wenzelm@28201
     7
Notes:
wenzelm@28201
     8
wenzelm@28201
     9
  * Futures are similar to delayed evaluation, i.e. delay/force is
wenzelm@28201
    10
    generalized to fork/join (and variants).  The idea is to model
wenzelm@28201
    11
    parallel value-oriented computations, but *not* communicating
wenzelm@28201
    12
    processes.
wenzelm@28201
    13
wenzelm@28201
    14
  * Futures are grouped; failure of one group member causes the whole
wenzelm@28201
    15
    group to be interrupted eventually.
wenzelm@28201
    16
wenzelm@28201
    17
  * Forked futures are evaluated spontaneously by a farm of worker
wenzelm@28201
    18
    threads in the background; join resynchronizes the computation and
wenzelm@28201
    19
    delivers results (values or exceptions).
wenzelm@28201
    20
wenzelm@28201
    21
  * The pool of worker threads is limited, usually in correlation with
wenzelm@28201
    22
    the number of physical cores on the machine.  Note that allocation
wenzelm@28201
    23
    of runtime resources is distorted either if workers yield CPU time
wenzelm@28201
    24
    (e.g. via system sleep or wait operations), or if non-worker
wenzelm@28201
    25
    threads contend for significant runtime resources independently.
wenzelm@28156
    26
*)
wenzelm@28156
    27
wenzelm@28156
    28
signature FUTURE =
wenzelm@28156
    29
sig
wenzelm@28166
    30
  type task = TaskQueue.task
wenzelm@28166
    31
  type group = TaskQueue.group
wenzelm@28386
    32
  val thread_data: unit -> (string * task * group) option
wenzelm@28156
    33
  type 'a T
wenzelm@28166
    34
  val task_of: 'a T -> task
wenzelm@28177
    35
  val group_of: 'a T -> group
wenzelm@28320
    36
  val is_finished: 'a T -> bool
wenzelm@28304
    37
  val future: group option -> task list -> bool -> (unit -> 'a) -> 'a T
wenzelm@28166
    38
  val fork: (unit -> 'a) -> 'a T
wenzelm@28304
    39
  val fork_irrelevant: (unit -> 'a) -> 'a T
wenzelm@28193
    40
  val join_results: 'a T list -> 'a Exn.result list
wenzelm@28166
    41
  val join: 'a T -> 'a
wenzelm@28382
    42
  val release_results: 'a Exn.result list -> 'a list
wenzelm@28202
    43
  val focus: task list -> unit
wenzelm@28206
    44
  val interrupt_task: string -> unit
wenzelm@28197
    45
  val cancel: 'a T -> unit
wenzelm@28203
    46
  val shutdown: unit -> unit
wenzelm@28156
    47
end;
wenzelm@28156
    48
wenzelm@28156
    49
structure Future: FUTURE =
wenzelm@28156
    50
struct
wenzelm@28156
    51
wenzelm@28177
    52
(** future values **)
wenzelm@28177
    53
wenzelm@28167
    54
(* identifiers *)
wenzelm@28167
    55
wenzelm@28167
    56
type task = TaskQueue.task;
wenzelm@28167
    57
type group = TaskQueue.group;
wenzelm@28167
    58
wenzelm@28386
    59
local val tag = Universal.tag () : (string * task * group) option Universal.tag in
wenzelm@28177
    60
  fun thread_data () = the_default NONE (Thread.getLocal tag);
wenzelm@28390
    61
  fun setmp_thread_data data f x = Library.setmp_thread_data tag (thread_data ()) (SOME data) f x;
wenzelm@28167
    62
end;
wenzelm@28167
    63
wenzelm@28167
    64
wenzelm@28167
    65
(* datatype future *)
wenzelm@28167
    66
wenzelm@28167
    67
datatype 'a T = Future of
wenzelm@28167
    68
 {task: task,
wenzelm@28177
    69
  group: group,
wenzelm@28167
    70
  result: 'a Exn.result option ref};
wenzelm@28167
    71
wenzelm@28167
    72
fun task_of (Future {task, ...}) = task;
wenzelm@28167
    73
fun group_of (Future {group, ...}) = group;
wenzelm@28167
    74
wenzelm@28320
    75
fun is_finished (Future {result, ...}) = is_some (! result);
wenzelm@28320
    76
wenzelm@28167
    77
wenzelm@28177
    78
wenzelm@28177
    79
(** scheduling **)
wenzelm@28177
    80
wenzelm@28177
    81
(* global state *)
wenzelm@28177
    82
wenzelm@28177
    83
val queue = ref TaskQueue.empty;
wenzelm@28192
    84
val workers = ref ([]: (Thread.thread * bool) list);
wenzelm@28177
    85
val scheduler = ref (NONE: Thread.thread option);
wenzelm@28177
    86
val excessive = ref 0;
wenzelm@28206
    87
val canceled = ref ([]: TaskQueue.group list);
wenzelm@28206
    88
val do_shutdown = ref false;
wenzelm@28177
    89
wenzelm@28177
    90
wenzelm@28177
    91
(* synchronization *)
wenzelm@28156
    92
wenzelm@28156
    93
local
wenzelm@28156
    94
  val lock = Mutex.mutex ();
wenzelm@28156
    95
  val cond = ConditionVar.conditionVar ();
wenzelm@28156
    96
in
wenzelm@28156
    97
wenzelm@28192
    98
fun SYNCHRONIZED name e = uninterruptible (fn restore_attributes => fn () =>
wenzelm@28162
    99
  let
wenzelm@28380
   100
    val _ = Multithreading.tracing 3 (fn () => name ^ ": locking");
wenzelm@28162
   101
    val _ = Mutex.lock lock;
wenzelm@28380
   102
    val _ = Multithreading.tracing 3 (fn () => name ^ ": locked");
wenzelm@28162
   103
    val result = Exn.capture (restore_attributes e) ();
wenzelm@28162
   104
    val _ = Mutex.unlock lock;
wenzelm@28380
   105
    val _ = Multithreading.tracing 3 (fn () => name ^ ": unlocked");
wenzelm@28162
   106
  in Exn.release result end) ();
wenzelm@28156
   107
wenzelm@28167
   108
fun wait name = (*requires SYNCHRONIZED*)
wenzelm@28206
   109
  ConditionVar.wait (cond, lock);
wenzelm@28206
   110
wenzelm@28206
   111
fun wait_timeout name timeout = (*requires SYNCHRONIZED*)
wenzelm@28206
   112
  ConditionVar.waitUntil (cond, lock, Time.+ (Time.now (), timeout));
wenzelm@28166
   113
wenzelm@28166
   114
fun notify_all () = (*requires SYNCHRONIZED*)
wenzelm@28166
   115
  ConditionVar.broadcast cond;
wenzelm@28156
   116
wenzelm@28156
   117
end;
wenzelm@28156
   118
wenzelm@28156
   119
wenzelm@28382
   120
(* worker activity *)
wenzelm@28382
   121
wenzelm@28382
   122
fun trace_active () =
wenzelm@28382
   123
  let
wenzelm@28382
   124
    val ws = ! workers;
wenzelm@28382
   125
    val m = string_of_int (length ws);
wenzelm@28382
   126
    val n = string_of_int (length (filter #2 ws));
wenzelm@28382
   127
  in Multithreading.tracing 1 (fn () => "SCHEDULE: " ^ m ^ " workers, " ^ n ^ " active") end;
wenzelm@28382
   128
wenzelm@28382
   129
fun change_active active = (*requires SYNCHRONIZED*)
wenzelm@28382
   130
  change workers (AList.update Thread.equal (Thread.self (), active));
wenzelm@28382
   131
wenzelm@28382
   132
wenzelm@28177
   133
(* execute *)
wenzelm@28156
   134
wenzelm@28167
   135
fun execute name (task, group, run) =
wenzelm@28167
   136
  let
wenzelm@28382
   137
    val _ = trace_active ();
wenzelm@28380
   138
    val _ = Multithreading.tracing 3 (fn () => name ^ ": running");
wenzelm@28390
   139
    val ok = setmp_thread_data (name, task, group) run ();
wenzelm@28380
   140
    val _ = Multithreading.tracing 3 (fn () => name ^ ": finished");
wenzelm@28192
   141
    val _ = SYNCHRONIZED "execute" (fn () =>
wenzelm@28177
   142
     (change queue (TaskQueue.finish task);
wenzelm@28186
   143
      if ok then ()
wenzelm@28191
   144
      else if TaskQueue.cancel (! queue) group then ()
wenzelm@28206
   145
      else change canceled (cons group);
wenzelm@28177
   146
      notify_all ()));
wenzelm@28167
   147
  in () end;
wenzelm@28167
   148
wenzelm@28167
   149
wenzelm@28167
   150
(* worker threads *)
wenzelm@28167
   151
wenzelm@28186
   152
fun worker_wait name = (*requires SYNCHRONIZED*)
wenzelm@28186
   153
  (change_active false; wait name; change_active true);
wenzelm@28162
   154
wenzelm@28167
   155
fun worker_next name = (*requires SYNCHRONIZED*)
wenzelm@28167
   156
  if ! excessive > 0 then
wenzelm@28167
   157
    (dec excessive;
wenzelm@28192
   158
     change workers (filter_out (fn (thread, _) => Thread.equal (thread, Thread.self ())));
wenzelm@28203
   159
     notify_all ();
wenzelm@28167
   160
     NONE)
wenzelm@28166
   161
  else
wenzelm@28186
   162
    (case change_result queue TaskQueue.dequeue of
wenzelm@28186
   163
      NONE => (worker_wait name; worker_next name)
wenzelm@28166
   164
    | some => some);
wenzelm@28156
   165
wenzelm@28167
   166
fun worker_loop name =
wenzelm@28192
   167
  (case SYNCHRONIZED name (fn () => worker_next name) of
wenzelm@28380
   168
    NONE => Multithreading.tracing 3 (fn () => name ^ ": exit")
wenzelm@28167
   169
  | SOME work => (execute name work; worker_loop name));
wenzelm@28156
   170
wenzelm@28167
   171
fun worker_start name = (*requires SYNCHRONIZED*)
wenzelm@28242
   172
  change workers (cons (SimpleThread.fork false (fn () => worker_loop name), true));
wenzelm@28156
   173
wenzelm@28156
   174
wenzelm@28156
   175
(* scheduler *)
wenzelm@28156
   176
wenzelm@28206
   177
fun scheduler_next () = (*requires SYNCHRONIZED*)
wenzelm@28156
   178
  let
wenzelm@28206
   179
    (*worker threads*)
wenzelm@28191
   180
    val _ =
wenzelm@28192
   181
      (case List.partition (Thread.isActive o #1) (! workers) of
wenzelm@28191
   182
        (_, []) => ()
wenzelm@28191
   183
      | (active, inactive) =>
wenzelm@28191
   184
          (workers := active; Multithreading.tracing 0 (fn () =>
wenzelm@28192
   185
            "SCHEDULE: disposed " ^ string_of_int (length inactive) ^ " dead worker threads")));
wenzelm@28382
   186
    val _ = trace_active ();
wenzelm@28191
   187
wenzelm@28206
   188
    val m = if ! do_shutdown then 0 else Multithreading.max_threads_value ();
wenzelm@28167
   189
    val l = length (! workers);
wenzelm@28167
   190
    val _ = excessive := l - m;
wenzelm@28203
   191
    val _ =
wenzelm@28203
   192
      if m > l then funpow (m - l) (fn () => worker_start ("worker " ^ serial_string ())) ()
wenzelm@28203
   193
      else ();
wenzelm@28206
   194
wenzelm@28206
   195
    (*canceled groups*)
wenzelm@28206
   196
    val _ =  change canceled (filter_out (TaskQueue.cancel (! queue)));
wenzelm@28206
   197
wenzelm@28206
   198
    (*shutdown*)
wenzelm@28206
   199
    val continue = not (! do_shutdown andalso null (! workers));
wenzelm@28206
   200
    val _ = if continue then () else scheduler := NONE;
wenzelm@28167
   201
wenzelm@28206
   202
    val _ = notify_all ();
wenzelm@28206
   203
    val _ = wait_timeout "scheduler" (Time.fromSeconds 1);
wenzelm@28206
   204
  in continue end;
wenzelm@28206
   205
wenzelm@28206
   206
fun scheduler_loop () =
wenzelm@28206
   207
 (while SYNCHRONIZED "scheduler" scheduler_next do ();
wenzelm@28380
   208
  Multithreading.tracing 3 (fn () => "scheduler: exit"));
wenzelm@28156
   209
wenzelm@28203
   210
fun scheduler_active () = (*requires SYNCHRONIZED*)
wenzelm@28203
   211
  (case ! scheduler of NONE => false | SOME thread => Thread.isActive thread);
wenzelm@28203
   212
wenzelm@28192
   213
fun scheduler_check () = SYNCHRONIZED "scheduler_check" (fn () =>
wenzelm@28206
   214
  if not (scheduler_active ()) then
wenzelm@28386
   215
    (Multithreading.tracing 3 (fn () => "scheduler: fork");
wenzelm@28386
   216
     do_shutdown := false; scheduler := SOME (SimpleThread.fork false scheduler_loop))
wenzelm@28206
   217
  else if ! do_shutdown then error "Scheduler shutdown in progress"
wenzelm@28206
   218
  else ());
wenzelm@28156
   219
wenzelm@28156
   220
wenzelm@28191
   221
(* future values: fork independent computation *)
wenzelm@28156
   222
wenzelm@28304
   223
fun future opt_group deps pri (e: unit -> 'a) =
wenzelm@28156
   224
  let
wenzelm@28191
   225
    val _ = scheduler_check ();
wenzelm@28177
   226
wenzelm@28191
   227
    val group = (case opt_group of SOME group => group | NONE => TaskQueue.new_group ());
wenzelm@28177
   228
wenzelm@28166
   229
    val result = ref (NONE: 'a Exn.result option);
wenzelm@28177
   230
    val run = Multithreading.with_attributes (Thread.getAttributes ())
wenzelm@28177
   231
      (fn _ => fn ok =>
wenzelm@28177
   232
        let val res = if ok then Exn.capture e () else Exn.Exn Interrupt
wenzelm@28177
   233
        in result := SOME res; is_some (Exn.get_result res) end);
wenzelm@28177
   234
wenzelm@28192
   235
    val task = SYNCHRONIZED "future" (fn () =>
wenzelm@28304
   236
      change_result queue (TaskQueue.enqueue group deps pri run) before notify_all ());
wenzelm@28166
   237
  in Future {task = task, group = group, result = result} end;
wenzelm@28162
   238
wenzelm@28386
   239
fun fork e = future (Option.map #3 (thread_data ())) [] true e;
wenzelm@28386
   240
fun fork_irrelevant e = future (Option.map #3 (thread_data ())) [] false e;
wenzelm@28186
   241
wenzelm@28186
   242
wenzelm@28191
   243
(* join: retrieve results *)
wenzelm@28186
   244
wenzelm@28331
   245
fun join_results [] = []
wenzelm@28331
   246
  | join_results xs =
wenzelm@28331
   247
      let
wenzelm@28331
   248
        val _ = scheduler_check ();
wenzelm@28331
   249
        val _ = Multithreading.self_critical () andalso
wenzelm@28331
   250
          error "Cannot join future values within critical section";
wenzelm@28177
   251
wenzelm@28386
   252
        fun join_loop _ [] = ()
wenzelm@28386
   253
          | join_loop name tasks =
wenzelm@28386
   254
              (case SYNCHRONIZED name (fn () =>
wenzelm@28382
   255
                  change_result queue (TaskQueue.dequeue_towards tasks)) of
wenzelm@28382
   256
                NONE => ()
wenzelm@28386
   257
              | SOME (work, tasks') => (execute name work; join_loop name tasks'));
wenzelm@28331
   258
        val _ =
wenzelm@28331
   259
          (case thread_data () of
wenzelm@28382
   260
            NONE =>
wenzelm@28382
   261
              (*alien thread -- refrain from contending for resources*)
wenzelm@28382
   262
              while exists (not o is_finished) xs
wenzelm@28382
   263
              do SYNCHRONIZED "join_thread" (fn () => wait "join_thread")
wenzelm@28386
   264
          | SOME (name, task, _) =>
wenzelm@28382
   265
              (*proper task -- actively work towards results*)
wenzelm@28382
   266
              let
wenzelm@28382
   267
                val unfinished = xs |> map_filter
wenzelm@28382
   268
                  (fn Future {task, result = ref NONE, ...} => SOME task | _ => NONE);
wenzelm@28382
   269
                val _ = SYNCHRONIZED "join" (fn () =>
wenzelm@28382
   270
                  (change queue (TaskQueue.depend unfinished task); notify_all ()));
wenzelm@28386
   271
                val _ = join_loop ("join_loop: " ^ name) unfinished;
wenzelm@28382
   272
                val _ =
wenzelm@28382
   273
                  while exists (not o is_finished) xs
wenzelm@28382
   274
                  do SYNCHRONIZED "join_task" (fn () => worker_wait "join_task");
wenzelm@28382
   275
              in () end);
wenzelm@28186
   276
wenzelm@28331
   277
      in xs |> map (fn Future {result = ref (SOME res), ...} => res) end;
wenzelm@28186
   278
wenzelm@28193
   279
fun join x = Exn.release (singleton join_results x);
wenzelm@28156
   280
wenzelm@28191
   281
wenzelm@28382
   282
(* release results *)
wenzelm@28382
   283
wenzelm@28382
   284
fun proper_exn (Exn.Result _) = NONE
wenzelm@28382
   285
  | proper_exn (Exn.Exn Interrupt) = NONE
wenzelm@28382
   286
  | proper_exn (Exn.Exn exn) = SOME exn;
wenzelm@28382
   287
wenzelm@28382
   288
fun release_results results =
wenzelm@28382
   289
  (case get_first proper_exn results of
wenzelm@28382
   290
    SOME exn => raise exn
wenzelm@28382
   291
  | NONE => List.map Exn.release results);
wenzelm@28382
   292
wenzelm@28382
   293
wenzelm@28202
   294
(* misc operations *)
wenzelm@28202
   295
wenzelm@28202
   296
(*focus: collection of high-priority task*)
wenzelm@28202
   297
fun focus tasks = SYNCHRONIZED "interrupt" (fn () =>
wenzelm@28202
   298
  change queue (TaskQueue.focus tasks));
wenzelm@28191
   299
wenzelm@28202
   300
(*interrupt: permissive signal, may get ignored*)
wenzelm@28197
   301
fun interrupt_task id = SYNCHRONIZED "interrupt"
wenzelm@28197
   302
  (fn () => TaskQueue.interrupt_external (! queue) id);
wenzelm@28191
   303
wenzelm@28206
   304
(*cancel: present and future group members will be interrupted eventually*)
wenzelm@28206
   305
fun cancel x =
wenzelm@28208
   306
 (scheduler_check ();
wenzelm@28208
   307
  SYNCHRONIZED "cancel" (fn () => (change canceled (cons (group_of x)); notify_all ())));
wenzelm@28206
   308
wenzelm@28206
   309
wenzelm@28203
   310
(*global join and shutdown*)
wenzelm@28203
   311
fun shutdown () =
wenzelm@28276
   312
  if Multithreading.available then
wenzelm@28276
   313
   (scheduler_check ();
wenzelm@28276
   314
    SYNCHRONIZED "shutdown" (fn () =>
wenzelm@28276
   315
     (while not (scheduler_active ()) do wait "shutdown: scheduler inactive";
wenzelm@28276
   316
      while not (TaskQueue.is_empty (! queue)) do wait "shutdown: join";
wenzelm@28276
   317
      do_shutdown := true;
wenzelm@28276
   318
      notify_all ();
wenzelm@28276
   319
      while not (null (! workers)) do wait "shutdown: workers";
wenzelm@28276
   320
      while scheduler_active () do wait "shutdown: scheduler still active")))
wenzelm@28276
   321
  else ();
wenzelm@28203
   322
wenzelm@28156
   323
end;