src/Pure/Concurrent/future.ML
author wenzelm
Thu, 09 Sep 2010 17:20:27 +0200
changeset 39232 69c6d3e87660
parent 38236 d8c7be27e01d
child 39243 307e3d07d19f
permissions -rw-r--r--
more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
     1
(*  Title:      Pure/Concurrent/future.ML
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
     3
32246
d4f7934e9555 misc tuning;
wenzelm
parents: 32230
diff changeset
     4
Future values, see also
d4f7934e9555 misc tuning;
wenzelm
parents: 32230
diff changeset
     5
http://www4.in.tum.de/~wenzelm/papers/parallel-isabelle.pdf
37904
332cd0197d34 tuned comments;
wenzelm
parents: 37865
diff changeset
     6
http://www4.in.tum.de/~wenzelm/papers/parallel-ml.pdf
28201
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
     7
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
     8
Notes:
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
     9
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    10
  * Futures are similar to delayed evaluation, i.e. delay/force is
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    11
    generalized to fork/join (and variants).  The idea is to model
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    12
    parallel value-oriented computations, but *not* communicating
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    13
    processes.
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    14
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    15
  * Futures are grouped; failure of one group member causes the whole
32220
wenzelm
parents: 32219
diff changeset
    16
    group to be interrupted eventually.  Groups are block-structured.
28201
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    17
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    18
  * Forked futures are evaluated spontaneously by a farm of worker
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    19
    threads in the background; join resynchronizes the computation and
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    20
    delivers results (values or exceptions).
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    21
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    22
  * The pool of worker threads is limited, usually in correlation with
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    23
    the number of physical cores on the machine.  Note that allocation
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    24
    of runtime resources is distorted either if workers yield CPU time
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    25
    (e.g. via system sleep or wait operations), or if non-worker
7ae5cdb7b122 some general notes on future values;
wenzelm
parents: 28197
diff changeset
    26
    threads contend for significant runtime resources independently.
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    27
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    28
  * Promised futures are fulfilled by external means.  There is no
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    29
    associated evaluation task, but other futures can depend on them
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    30
    as usual.
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
    31
*)
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
    32
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
    33
signature FUTURE =
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
    34
sig
29119
99941fd0cb0e renamed structure TaskQueue to Task_Queue;
wenzelm
parents: 29118
diff changeset
    35
  type task = Task_Queue.task
99941fd0cb0e renamed structure TaskQueue to Task_Queue;
wenzelm
parents: 29118
diff changeset
    36
  type group = Task_Queue.group
32058
c76fd93b3b99 more abstract Future.is_worker;
wenzelm
parents: 32055
diff changeset
    37
  val is_worker: unit -> bool
32814
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
    38
  val worker_task: unit -> Task_Queue.task option
32102
81d03a29980c added worker_group;
wenzelm
parents: 32099
diff changeset
    39
  val worker_group: unit -> Task_Queue.group option
37865
3a6ec95a9f68 clarified/exported Future.worker_subgroup, which is already the default for Future.fork;
wenzelm
parents: 37854
diff changeset
    40
  val worker_subgroup: unit -> Task_Queue.group
28972
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    41
  type 'a future
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    42
  val task_of: 'a future -> task
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    43
  val group_of: 'a future -> group
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    44
  val peek: 'a future -> 'a Exn.result option
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    45
  val is_finished: 'a future -> bool
28979
3ce619d8d432 fork/map: no inheritance of group (structure is nested, not parallel);
wenzelm
parents: 28972
diff changeset
    46
  val fork_group: group -> (unit -> 'a) -> 'a future
32724
aaeeb0ba2035 added fork_deps_pri;
wenzelm
parents: 32644
diff changeset
    47
  val fork_deps_pri: 'b future list -> int -> (unit -> 'a) -> 'a future
28979
3ce619d8d432 fork/map: no inheritance of group (structure is nested, not parallel);
wenzelm
parents: 28972
diff changeset
    48
  val fork_deps: 'b future list -> (unit -> 'a) -> 'a future
29119
99941fd0cb0e renamed structure TaskQueue to Task_Queue;
wenzelm
parents: 29118
diff changeset
    49
  val fork_pri: int -> (unit -> 'a) -> 'a future
32724
aaeeb0ba2035 added fork_deps_pri;
wenzelm
parents: 32644
diff changeset
    50
  val fork: (unit -> 'a) -> 'a future
28972
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    51
  val join_results: 'a future list -> 'a Exn.result list
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    52
  val join_result: 'a future -> 'a Exn.result
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    53
  val join: 'a future -> 'a
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    54
  val value: 'a -> 'a future
28972
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    55
  val map: ('a -> 'b) -> 'a future -> 'b future
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    56
  val promise_group: group -> 'a future
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    57
  val promise: unit -> 'a future
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    58
  val fulfill_result: 'a future -> 'a Exn.result -> unit
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    59
  val fulfill: 'a future -> 'a -> unit
30618
046f4f986fb5 restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents: 30612
diff changeset
    60
  val interruptible_task: ('a -> 'b) -> 'a -> 'b
29431
0ebe652bfd5a added cancel_group;
wenzelm
parents: 29384
diff changeset
    61
  val cancel_group: group -> unit
28972
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    62
  val cancel: 'a future -> unit
28203
88f18387f1c9 shutdown: global join-and-shutdown operation;
wenzelm
parents: 28202
diff changeset
    63
  val shutdown: unit -> unit
38236
d8c7be27e01d explicitly distinguish Output.status (essential feedback) vs. Output.report (useful markup);
wenzelm
parents: 37904
diff changeset
    64
  val status: (unit -> 'a) -> 'a
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
    65
end;
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
    66
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
    67
structure Future: FUTURE =
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
    68
struct
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
    69
28177
8c0335bc9336 inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents: 28170
diff changeset
    70
(** future values **)
8c0335bc9336 inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents: 28170
diff changeset
    71
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
    72
(* identifiers *)
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
    73
29119
99941fd0cb0e renamed structure TaskQueue to Task_Queue;
wenzelm
parents: 29118
diff changeset
    74
type task = Task_Queue.task;
99941fd0cb0e renamed structure TaskQueue to Task_Queue;
wenzelm
parents: 29118
diff changeset
    75
type group = Task_Queue.group;
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
    76
32058
c76fd93b3b99 more abstract Future.is_worker;
wenzelm
parents: 32055
diff changeset
    77
local
33408
a69ddd7dce95 tuned thread data;
wenzelm
parents: 33407
diff changeset
    78
  val tag = Universal.tag () : (task * group) option Universal.tag;
32058
c76fd93b3b99 more abstract Future.is_worker;
wenzelm
parents: 32055
diff changeset
    79
in
28177
8c0335bc9336 inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents: 28170
diff changeset
    80
  fun thread_data () = the_default NONE (Thread.getLocal tag);
32058
c76fd93b3b99 more abstract Future.is_worker;
wenzelm
parents: 32055
diff changeset
    81
  fun setmp_thread_data data f x =
c76fd93b3b99 more abstract Future.is_worker;
wenzelm
parents: 32055
diff changeset
    82
    Library.setmp_thread_data tag (thread_data ()) (SOME data) f x;
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
    83
end;
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
    84
32058
c76fd93b3b99 more abstract Future.is_worker;
wenzelm
parents: 32055
diff changeset
    85
val is_worker = is_some o thread_data;
33408
a69ddd7dce95 tuned thread data;
wenzelm
parents: 33407
diff changeset
    86
val worker_task = Option.map #1 o thread_data;
a69ddd7dce95 tuned thread data;
wenzelm
parents: 33407
diff changeset
    87
val worker_group = Option.map #2 o thread_data;
37865
3a6ec95a9f68 clarified/exported Future.worker_subgroup, which is already the default for Future.fork;
wenzelm
parents: 37854
diff changeset
    88
fun worker_subgroup () = Task_Queue.new_group (worker_group ());
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    89
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
    90
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
    91
(* datatype future *)
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
    92
35016
c0f2e49bccfc result: Single_Assignment.var;
wenzelm
parents: 34281
diff changeset
    93
type 'a result = 'a Exn.result Single_Assignment.var;
c0f2e49bccfc result: Single_Assignment.var;
wenzelm
parents: 34281
diff changeset
    94
28972
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
    95
datatype 'a future = Future of
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    96
 {promised: bool,
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
    97
  task: task,
28177
8c0335bc9336 inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents: 28170
diff changeset
    98
  group: group,
35016
c0f2e49bccfc result: Single_Assignment.var;
wenzelm
parents: 34281
diff changeset
    99
  result: 'a result};
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   100
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   101
fun task_of (Future {task, ...}) = task;
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   102
fun group_of (Future {group, ...}) = group;
32253
d9def420c84e future result: Synchronized.var;
wenzelm
parents: 32249
diff changeset
   103
fun result_of (Future {result, ...}) = result;
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   104
35016
c0f2e49bccfc result: Single_Assignment.var;
wenzelm
parents: 34281
diff changeset
   105
fun peek x = Single_Assignment.peek (result_of x);
28558
2a6297b4273c replaced str_of by general peek;
wenzelm
parents: 28548
diff changeset
   106
fun is_finished x = is_some (peek x);
28320
c6aef67f964d added is_finished;
wenzelm
parents: 28304
diff changeset
   107
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   108
fun assign_result group result res =
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   109
  let
37854
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   110
    val _ = Single_Assignment.assign result res
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   111
      handle exn as Fail _ =>
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   112
        (case Single_Assignment.peek result of
39232
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   113
          SOME (Exn.Exn e) => reraise (if Exn.is_interrupt e then e else exn)
37854
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   114
        | _ => reraise exn);
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   115
    val ok =
37854
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   116
      (case the (Single_Assignment.peek result) of
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   117
        Exn.Exn exn => (Task_Queue.cancel_group group exn; false)
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   118
      | Exn.Result _ => true);
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   119
  in ok end;
28997
1b99dcae2156 added constant value;
wenzelm
parents: 28979
diff changeset
   120
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   121
28177
8c0335bc9336 inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents: 28170
diff changeset
   122
8c0335bc9336 inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents: 28170
diff changeset
   123
(** scheduling **)
8c0335bc9336 inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents: 28170
diff changeset
   124
8c0335bc9336 inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents: 28170
diff changeset
   125
(* synchronization *)
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   126
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   127
val scheduler_event = ConditionVar.conditionVar ();
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   128
val work_available = ConditionVar.conditionVar ();
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   129
val work_finished = ConditionVar.conditionVar ();
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   130
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   131
local
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   132
  val lock = Mutex.mutex ();
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   133
in
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   134
37216
3165bc303f66 modernized some structure names, keeping a few legacy aliases;
wenzelm
parents: 37182
diff changeset
   135
fun SYNCHRONIZED name = Simple_Thread.synchronized name lock;
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   136
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   137
fun wait cond = (*requires SYNCHRONIZED*)
32295
400cc493d466 renamed Multithreading.regular_interrupts to Multithreading.public_interrupts;
wenzelm
parents: 32293
diff changeset
   138
  Multithreading.sync_wait NONE NONE cond lock;
28206
bcd48c6897d4 eliminated requests, use global state variables uniformly;
wenzelm
parents: 28203
diff changeset
   139
32295
400cc493d466 renamed Multithreading.regular_interrupts to Multithreading.public_interrupts;
wenzelm
parents: 32293
diff changeset
   140
fun wait_timeout timeout cond = (*requires SYNCHRONIZED*)
400cc493d466 renamed Multithreading.regular_interrupts to Multithreading.public_interrupts;
wenzelm
parents: 32293
diff changeset
   141
  Multithreading.sync_wait NONE (SOME (Time.+ (Time.now (), timeout))) cond lock;
28166
43087721a66e moved task, thread_data, group, queue to task_queue.ML;
wenzelm
parents: 28163
diff changeset
   142
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   143
fun signal cond = (*requires SYNCHRONIZED*)
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   144
  ConditionVar.signal cond;
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   145
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   146
fun broadcast cond = (*requires SYNCHRONIZED*)
28166
43087721a66e moved task, thread_data, group, queue to task_queue.ML;
wenzelm
parents: 28163
diff changeset
   147
  ConditionVar.broadcast cond;
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   148
32248
0241916a5f06 more precise treatment of scheduler_event: continous pulse (50ms) instead of flooding, which was burning many CPU cycles in spare threads;
wenzelm
parents: 32247
diff changeset
   149
fun broadcast_work () = (*requires SYNCHRONIZED*)
0241916a5f06 more precise treatment of scheduler_event: continous pulse (50ms) instead of flooding, which was burning many CPU cycles in spare threads;
wenzelm
parents: 32247
diff changeset
   150
 (ConditionVar.broadcast work_available;
32225
d5d6f47fb018 cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents: 32224
diff changeset
   151
  ConditionVar.broadcast work_finished);
d5d6f47fb018 cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents: 32224
diff changeset
   152
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   153
end;
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   154
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   155
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   156
(* global state *)
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   157
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   158
val queue = Unsynchronized.ref Task_Queue.empty;
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   159
val next = Unsynchronized.ref 0;
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   160
val scheduler = Unsynchronized.ref (NONE: Thread.thread option);
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   161
val canceled = Unsynchronized.ref ([]: Task_Queue.group list);
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   162
val do_shutdown = Unsynchronized.ref false;
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   163
val max_workers = Unsynchronized.ref 0;
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   164
val max_active = Unsynchronized.ref 0;
33411
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   165
val worker_trend = Unsynchronized.ref 0;
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   166
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   167
datatype worker_state = Working | Waiting | Sleeping;
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   168
val workers = Unsynchronized.ref ([]: (Thread.thread * worker_state Unsynchronized.ref) list);
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   169
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   170
fun count_workers state = (*requires SYNCHRONIZED*)
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   171
  fold (fn (_, state_ref) => fn i => if ! state_ref = state then i + 1 else i) (! workers) 0;
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   172
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   173
32099
5382c93108db propagate exceptions within future groups;
wenzelm
parents: 32096
diff changeset
   174
(* execute future jobs *)
5382c93108db propagate exceptions within future groups;
wenzelm
parents: 32096
diff changeset
   175
5382c93108db propagate exceptions within future groups;
wenzelm
parents: 32096
diff changeset
   176
fun future_job group (e: unit -> 'a) =
5382c93108db propagate exceptions within future groups;
wenzelm
parents: 32096
diff changeset
   177
  let
35016
c0f2e49bccfc result: Single_Assignment.var;
wenzelm
parents: 34281
diff changeset
   178
    val result = Single_Assignment.var "future" : 'a result;
37046
78d88b670a53 future_job: propagate current Position.thread_data to the forked job -- this is important to provide a default position, e.g. for parallelizied Goal.prove within a package (proper command transactions are wrapped via Toplevel.setmp_thread_position);
wenzelm
parents: 35016
diff changeset
   179
    val pos = Position.thread_data ();
32107
47d0da617fcc future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents: 32102
diff changeset
   180
    fun job ok =
47d0da617fcc future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents: 32102
diff changeset
   181
      let
47d0da617fcc future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents: 32102
diff changeset
   182
        val res =
47d0da617fcc future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents: 32102
diff changeset
   183
          if ok then
32230
9f6461b1c9cc interruptible: Thread.testInterrupt before changing thread attributes;
wenzelm
parents: 32229
diff changeset
   184
            Exn.capture (fn () =>
37046
78d88b670a53 future_job: propagate current Position.thread_data to the forked job -- this is important to provide a default position, e.g. for parallelizied Goal.prove within a package (proper command transactions are wrapped via Toplevel.setmp_thread_position);
wenzelm
parents: 35016
diff changeset
   185
              Multithreading.with_attributes Multithreading.private_interrupts
78d88b670a53 future_job: propagate current Position.thread_data to the forked job -- this is important to provide a default position, e.g. for parallelizied Goal.prove within a package (proper command transactions are wrapped via Toplevel.setmp_thread_position);
wenzelm
parents: 35016
diff changeset
   186
                (fn _ => Position.setmp_thread_data pos e ())) ()
39232
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   187
          else Exn.interrupt_exn;
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   188
      in assign_result group result res end;
32099
5382c93108db propagate exceptions within future groups;
wenzelm
parents: 32096
diff changeset
   189
  in (result, job) end;
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   190
34279
02936e77a07c tasks of canceled groups are considered "ready" -- enables to purge the queue from tasks depending on unfinished promises (also improves general reactivity);
wenzelm
parents: 34277
diff changeset
   191
fun cancel_now group = (*requires SYNCHRONIZED*)
34280
16bf3e9786a3 eliminated cache, which complicates the code without making a real difference (NB: deque_towards often disrupts caching, and daisy-chaining of workers already reduces queue overhead);
wenzelm
parents: 34279
diff changeset
   192
  Task_Queue.cancel (! queue) group;
34279
02936e77a07c tasks of canceled groups are considered "ready" -- enables to purge the queue from tasks depending on unfinished promises (also improves general reactivity);
wenzelm
parents: 34277
diff changeset
   193
02936e77a07c tasks of canceled groups are considered "ready" -- enables to purge the queue from tasks depending on unfinished promises (also improves general reactivity);
wenzelm
parents: 34277
diff changeset
   194
fun cancel_later group = (*requires SYNCHRONIZED*)
32738
15bb09ca0378 explicit indication of Unsynchronized.ref;
wenzelm
parents: 32724
diff changeset
   195
 (Unsynchronized.change canceled (insert Task_Queue.eq_group group);
15bb09ca0378 explicit indication of Unsynchronized.ref;
wenzelm
parents: 32724
diff changeset
   196
  broadcast scheduler_event);
29341
6bb007a0f9f2 more reactive scheduler: reduced loop timeout, propagate broadcast interrupt via TaskQueue.cancel_all;
wenzelm
parents: 29119
diff changeset
   197
33408
a69ddd7dce95 tuned thread data;
wenzelm
parents: 33407
diff changeset
   198
fun execute (task, group, jobs) =
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   199
  let
32102
81d03a29980c added worker_group;
wenzelm
parents: 32099
diff changeset
   200
    val valid = not (Task_Queue.is_canceled group);
33408
a69ddd7dce95 tuned thread data;
wenzelm
parents: 33407
diff changeset
   201
    val ok = setmp_thread_data (task, group) (fn () =>
29384
a3c7e9ae9b71 more robust propagation of errors through bulk jobs;
wenzelm
parents: 29366
diff changeset
   202
      fold (fn job => fn ok => job valid andalso ok) jobs true) ();
32246
d4f7934e9555 misc tuning;
wenzelm
parents: 32230
diff changeset
   203
    val _ = SYNCHRONIZED "finish" (fn () =>
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   204
      let
32738
15bb09ca0378 explicit indication of Unsynchronized.ref;
wenzelm
parents: 32724
diff changeset
   205
        val maximal = Unsynchronized.change_result queue (Task_Queue.finish task);
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   206
        val _ =
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   207
          if ok then ()
34279
02936e77a07c tasks of canceled groups are considered "ready" -- enables to purge the queue from tasks depending on unfinished promises (also improves general reactivity);
wenzelm
parents: 34277
diff changeset
   208
          else if cancel_now group then ()
02936e77a07c tasks of canceled groups are considered "ready" -- enables to purge the queue from tasks depending on unfinished promises (also improves general reactivity);
wenzelm
parents: 34277
diff changeset
   209
          else cancel_later group;
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   210
        val _ = broadcast work_finished;
33413
cb409680dda8 avoid broadcast work_available, use daisy-chained signal instead;
wenzelm
parents: 33411
diff changeset
   211
        val _ = if maximal then () else signal work_available;
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   212
      in () end);
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   213
  in () end;
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   214
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   215
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   216
(* worker threads *)
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   217
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   218
fun worker_wait active cond = (*requires SYNCHRONIZED*)
33406
1ddcb8472bd2 slightly leaner and more direct control of worker activity etc.;
wenzelm
parents: 33061
diff changeset
   219
  let
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   220
    val state =
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   221
      (case AList.lookup Thread.equal (! workers) (Thread.self ()) of
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   222
        SOME state => state
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   223
      | NONE => raise Fail "Unregistered worker thread");
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   224
    val _ = state := (if active then Waiting else Sleeping);
33406
1ddcb8472bd2 slightly leaner and more direct control of worker activity etc.;
wenzelm
parents: 33061
diff changeset
   225
    val _ = wait cond;
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   226
    val _ = state := Working;
33406
1ddcb8472bd2 slightly leaner and more direct control of worker activity etc.;
wenzelm
parents: 33061
diff changeset
   227
  in () end;
28162
55772e4e95e0 tuned check_cache;
wenzelm
parents: 28156
diff changeset
   228
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   229
fun worker_next () = (*requires SYNCHRONIZED*)
33406
1ddcb8472bd2 slightly leaner and more direct control of worker activity etc.;
wenzelm
parents: 33061
diff changeset
   230
  if length (! workers) > ! max_workers then
1ddcb8472bd2 slightly leaner and more direct control of worker activity etc.;
wenzelm
parents: 33061
diff changeset
   231
    (Unsynchronized.change workers (AList.delete Thread.equal (Thread.self ()));
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   232
     signal work_available;
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   233
     NONE)
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   234
  else if count_workers Working > ! max_active then
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   235
    (worker_wait false work_available; worker_next ())
28166
43087721a66e moved task, thread_data, group, queue to task_queue.ML;
wenzelm
parents: 28163
diff changeset
   236
  else
32738
15bb09ca0378 explicit indication of Unsynchronized.ref;
wenzelm
parents: 32724
diff changeset
   237
    (case Unsynchronized.change_result queue (Task_Queue.dequeue (Thread.self ())) of
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   238
      NONE => (worker_wait false work_available; worker_next ())
33413
cb409680dda8 avoid broadcast work_available, use daisy-chained signal instead;
wenzelm
parents: 33411
diff changeset
   239
    | some => (signal work_available; some));
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   240
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   241
fun worker_loop name =
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   242
  (case SYNCHRONIZED name (fn () => worker_next ()) of
29119
99941fd0cb0e renamed structure TaskQueue to Task_Queue;
wenzelm
parents: 29118
diff changeset
   243
    NONE => ()
33408
a69ddd7dce95 tuned thread data;
wenzelm
parents: 33407
diff changeset
   244
  | SOME work => (execute work; worker_loop name));
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   245
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   246
fun worker_start name = (*requires SYNCHRONIZED*)
37216
3165bc303f66 modernized some structure names, keeping a few legacy aliases;
wenzelm
parents: 37182
diff changeset
   247
  Unsynchronized.change workers (cons (Simple_Thread.fork false (fn () => worker_loop name),
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   248
    Unsynchronized.ref Working));
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   249
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   250
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   251
(* scheduler *)
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   252
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   253
val status_ticks = Unsynchronized.ref 0;
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   254
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   255
val last_round = Unsynchronized.ref Time.zeroTime;
32248
0241916a5f06 more precise treatment of scheduler_event: continous pulse (50ms) instead of flooding, which was burning many CPU cycles in spare threads;
wenzelm
parents: 32247
diff changeset
   256
val next_round = Time.fromMilliseconds 50;
32226
23511e4da055 tuned tracing;
wenzelm
parents: 32225
diff changeset
   257
28206
bcd48c6897d4 eliminated requests, use global state variables uniformly;
wenzelm
parents: 28203
diff changeset
   258
fun scheduler_next () = (*requires SYNCHRONIZED*)
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   259
  let
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   260
    val now = Time.now ();
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   261
    val tick = Time.<= (Time.+ (! last_round, next_round), now);
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   262
    val _ = if tick then last_round := now else ();
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   263
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   264
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   265
    (* queue and worker status *)
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   266
32226
23511e4da055 tuned tracing;
wenzelm
parents: 32225
diff changeset
   267
    val _ =
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   268
      if tick then Unsynchronized.change status_ticks (fn i => (i + 1) mod 10) else ();
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   269
    val _ =
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   270
      if tick andalso ! status_ticks = 0 then
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   271
        Multithreading.tracing 1 (fn () =>
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   272
          let
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   273
            val {ready, pending, running, passive} = Task_Queue.status (! queue);
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   274
            val total = length (! workers);
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   275
            val active = count_workers Working;
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   276
            val waiting = count_workers Waiting;
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   277
          in
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   278
            "SCHEDULE " ^ Time.toString now ^ ": " ^
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   279
              string_of_int ready ^ " ready, " ^
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   280
              string_of_int pending ^ " pending, " ^
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   281
              string_of_int running ^ " running, " ^
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   282
              string_of_int passive ^ " passive; " ^
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   283
              string_of_int total ^ " workers, " ^
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   284
              string_of_int active ^ " active, " ^
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   285
              string_of_int waiting ^ " waiting "
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   286
          end)
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   287
      else ();
32053
257eac3946e9 scheduler: tuned tracing (status);
wenzelm
parents: 31631
diff changeset
   288
28191
9e5f556409c6 future: allow explicit group;
wenzelm
parents: 28186
diff changeset
   289
    val _ =
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   290
      if forall (Thread.isActive o #1) (! workers) then ()
32095
ad4be204fdfe tuned tracing;
wenzelm
parents: 32058
diff changeset
   291
      else
33409
wenzelm
parents: 33408
diff changeset
   292
        let
37682
ad5489a6be48 tuned white space;
wenzelm
parents: 37216
diff changeset
   293
          val (alive, dead) = List.partition (Thread.isActive o #1) (! workers);
33409
wenzelm
parents: 33408
diff changeset
   294
          val _ = workers := alive;
wenzelm
parents: 33408
diff changeset
   295
        in
wenzelm
parents: 33408
diff changeset
   296
          Multithreading.tracing 0 (fn () =>
wenzelm
parents: 33408
diff changeset
   297
            "SCHEDULE: disposed " ^ string_of_int (length dead) ^ " dead worker threads")
wenzelm
parents: 33408
diff changeset
   298
        end;
28191
9e5f556409c6 future: allow explicit group;
wenzelm
parents: 28186
diff changeset
   299
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   300
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   301
    (* worker pool adjustments *)
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   302
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   303
    val max_active0 = ! max_active;
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   304
    val max_workers0 = ! max_workers;
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   305
28206
bcd48c6897d4 eliminated requests, use global state variables uniformly;
wenzelm
parents: 28203
diff changeset
   306
    val m = if ! do_shutdown then 0 else Multithreading.max_threads_value ();
33406
1ddcb8472bd2 slightly leaner and more direct control of worker activity etc.;
wenzelm
parents: 33061
diff changeset
   307
    val _ = max_active := m;
1ddcb8472bd2 slightly leaner and more direct control of worker activity etc.;
wenzelm
parents: 33061
diff changeset
   308
33411
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   309
    val mm =
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   310
      if ! do_shutdown then 0
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   311
      else if m = 9999 then 1
33413
cb409680dda8 avoid broadcast work_available, use daisy-chained signal instead;
wenzelm
parents: 33411
diff changeset
   312
      else Int.min (Int.max (count_workers Working + 2 * count_workers Waiting, m), 4 * m);
33411
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   313
    val _ =
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   314
      if tick andalso mm > ! max_workers then
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   315
        Unsynchronized.change worker_trend (fn w => if w < 0 then 0 else w + 1)
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   316
      else if tick andalso mm < ! max_workers then
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   317
        Unsynchronized.change worker_trend (fn w => if w > 0 then 0 else w - 1)
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   318
      else ();
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   319
    val _ =
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   320
      if mm = 0 orelse ! worker_trend > 50 orelse ! worker_trend < ~50 then
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   321
        max_workers := mm
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   322
      else if ! worker_trend > 5 andalso ! max_workers < 2 * m then
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   323
        max_workers := Int.min (mm, 2 * m)
33411
a07558eb5029 worker_next: treat wait for work_available as Sleeping, not Waiting;
wenzelm
parents: 33410
diff changeset
   324
      else ();
33406
1ddcb8472bd2 slightly leaner and more direct control of worker activity etc.;
wenzelm
parents: 33061
diff changeset
   325
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   326
    val missing = ! max_workers - length (! workers);
28203
88f18387f1c9 shutdown: global join-and-shutdown operation;
wenzelm
parents: 28202
diff changeset
   327
    val _ =
33407
1427333220bc worker_next: ensure that work_available is passed on before sleeping (was occasionally lost when worker configuration changed, causing scheduler deadlock);
wenzelm
parents: 33406
diff changeset
   328
      if missing > 0 then
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   329
        funpow missing (fn () =>
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   330
          ignore (worker_start ("worker " ^ string_of_int (Unsynchronized.inc next)))) ()
28203
88f18387f1c9 shutdown: global join-and-shutdown operation;
wenzelm
parents: 28202
diff changeset
   331
      else ();
28206
bcd48c6897d4 eliminated requests, use global state variables uniformly;
wenzelm
parents: 28203
diff changeset
   332
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   333
    val _ =
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   334
      if ! max_active = max_active0 andalso ! max_workers = max_workers0 then ()
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   335
      else signal work_available;
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   336
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   337
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   338
    (* canceled groups *)
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   339
32225
d5d6f47fb018 cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents: 32224
diff changeset
   340
    val _ =
d5d6f47fb018 cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents: 32224
diff changeset
   341
      if null (! canceled) then ()
32293
e0b8da3fae4d tuned tracing;
wenzelm
parents: 32286
diff changeset
   342
      else
e0b8da3fae4d tuned tracing;
wenzelm
parents: 32286
diff changeset
   343
       (Multithreading.tracing 1 (fn () =>
e0b8da3fae4d tuned tracing;
wenzelm
parents: 32286
diff changeset
   344
          string_of_int (length (! canceled)) ^ " canceled groups");
34279
02936e77a07c tasks of canceled groups are considered "ready" -- enables to purge the queue from tasks depending on unfinished promises (also improves general reactivity);
wenzelm
parents: 34277
diff changeset
   345
        Unsynchronized.change canceled (filter_out cancel_now);
32293
e0b8da3fae4d tuned tracing;
wenzelm
parents: 32286
diff changeset
   346
        broadcast_work ());
28206
bcd48c6897d4 eliminated requests, use global state variables uniformly;
wenzelm
parents: 28203
diff changeset
   347
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   348
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   349
    (* delay loop *)
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   350
32295
400cc493d466 renamed Multithreading.regular_interrupts to Multithreading.public_interrupts;
wenzelm
parents: 32293
diff changeset
   351
    val _ = Exn.release (wait_timeout next_round scheduler_event);
28167
27e2ca41b58c more interrupt operations;
wenzelm
parents: 28166
diff changeset
   352
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   353
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   354
    (* shutdown *)
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   355
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   356
    val _ = if Task_Queue.all_passive (! queue) then do_shutdown := true else ();
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   357
    val continue = not (! do_shutdown andalso null (! workers));
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   358
    val _ = if continue then () else scheduler := NONE;
33415
352fe8e9162d worker_next: plain signalling via work_available only, not scheduler_event;
wenzelm
parents: 33413
diff changeset
   359
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   360
    val _ = broadcast scheduler_event;
32295
400cc493d466 renamed Multithreading.regular_interrupts to Multithreading.public_interrupts;
wenzelm
parents: 32293
diff changeset
   361
  in continue end
39232
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   362
  handle exn =>
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   363
    if Exn.is_interrupt exn then
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   364
     (Multithreading.tracing 1 (fn () => "Interrupt");
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   365
      List.app cancel_later (Task_Queue.cancel_all (! queue));
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   366
      broadcast_work (); true)
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   367
    else reraise exn;
32295
400cc493d466 renamed Multithreading.regular_interrupts to Multithreading.public_interrupts;
wenzelm
parents: 32293
diff changeset
   368
28206
bcd48c6897d4 eliminated requests, use global state variables uniformly;
wenzelm
parents: 28203
diff changeset
   369
fun scheduler_loop () =
33416
13d00799fe49 scheduler: clarified interrupt attributes and handling;
wenzelm
parents: 33415
diff changeset
   370
  while
13d00799fe49 scheduler: clarified interrupt attributes and handling;
wenzelm
parents: 33415
diff changeset
   371
    Multithreading.with_attributes
13d00799fe49 scheduler: clarified interrupt attributes and handling;
wenzelm
parents: 33415
diff changeset
   372
      (Multithreading.sync_interrupts Multithreading.public_interrupts)
13d00799fe49 scheduler: clarified interrupt attributes and handling;
wenzelm
parents: 33415
diff changeset
   373
      (fn _ => SYNCHRONIZED "scheduler" (fn () => scheduler_next ()))
13d00799fe49 scheduler: clarified interrupt attributes and handling;
wenzelm
parents: 33415
diff changeset
   374
  do ();
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   375
28203
88f18387f1c9 shutdown: global join-and-shutdown operation;
wenzelm
parents: 28202
diff changeset
   376
fun scheduler_active () = (*requires SYNCHRONIZED*)
88f18387f1c9 shutdown: global join-and-shutdown operation;
wenzelm
parents: 28202
diff changeset
   377
  (case ! scheduler of NONE => false | SOME thread => Thread.isActive thread);
88f18387f1c9 shutdown: global join-and-shutdown operation;
wenzelm
parents: 28202
diff changeset
   378
32228
7622c03141b0 scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents: 32227
diff changeset
   379
fun scheduler_check () = (*requires SYNCHRONIZED*)
7622c03141b0 scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents: 32227
diff changeset
   380
 (do_shutdown := false;
32248
0241916a5f06 more precise treatment of scheduler_event: continous pulse (50ms) instead of flooding, which was burning many CPU cycles in spare threads;
wenzelm
parents: 32247
diff changeset
   381
  if scheduler_active () then ()
37216
3165bc303f66 modernized some structure names, keeping a few legacy aliases;
wenzelm
parents: 37182
diff changeset
   382
  else scheduler := SOME (Simple_Thread.fork false scheduler_loop));
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   383
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   384
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   385
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   386
(** futures **)
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   387
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   388
(* fork *)
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   389
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   390
fun fork_future opt_group deps pri e =
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   391
  let
32102
81d03a29980c added worker_group;
wenzelm
parents: 32099
diff changeset
   392
    val group =
81d03a29980c added worker_group;
wenzelm
parents: 32099
diff changeset
   393
      (case opt_group of
37865
3a6ec95a9f68 clarified/exported Future.worker_subgroup, which is already the default for Future.fork;
wenzelm
parents: 37854
diff changeset
   394
        NONE => worker_subgroup ()
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   395
      | SOME group => group);
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   396
    val (result, job) = future_job group e;
32246
d4f7934e9555 misc tuning;
wenzelm
parents: 32230
diff changeset
   397
    val task = SYNCHRONIZED "enqueue" (fn () =>
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   398
      let
32738
15bb09ca0378 explicit indication of Unsynchronized.ref;
wenzelm
parents: 32724
diff changeset
   399
        val (task, minimal) =
15bb09ca0378 explicit indication of Unsynchronized.ref;
wenzelm
parents: 32724
diff changeset
   400
          Unsynchronized.change_result queue (Task_Queue.enqueue group deps pri job);
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   401
        val _ = if minimal then signal work_available else ();
32228
7622c03141b0 scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents: 32227
diff changeset
   402
        val _ = scheduler_check ();
32219
9a2566d1fdbd more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents: 32186
diff changeset
   403
      in task end);
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   404
  in Future {promised = false, task = task, group = group, result = result} end;
28162
55772e4e95e0 tuned check_cache;
wenzelm
parents: 28156
diff changeset
   405
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   406
fun fork_group group e = fork_future (SOME group) [] 0 e;
32724
aaeeb0ba2035 added fork_deps_pri;
wenzelm
parents: 32644
diff changeset
   407
fun fork_deps_pri deps pri e = fork_future NONE (map task_of deps) pri e;
aaeeb0ba2035 added fork_deps_pri;
wenzelm
parents: 32644
diff changeset
   408
fun fork_deps deps e = fork_deps_pri deps 0 e;
aaeeb0ba2035 added fork_deps_pri;
wenzelm
parents: 32644
diff changeset
   409
fun fork_pri pri e = fork_deps_pri [] pri e;
aaeeb0ba2035 added fork_deps_pri;
wenzelm
parents: 32644
diff changeset
   410
fun fork e = fork_deps [] e;
28186
6a8417f36837 cancel: check_scheduler;
wenzelm
parents: 28177
diff changeset
   411
6a8417f36837 cancel: check_scheduler;
wenzelm
parents: 28177
diff changeset
   412
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   413
(* join *)
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   414
29551
95e469919c3e join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents: 29431
diff changeset
   415
local
95e469919c3e join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents: 29431
diff changeset
   416
32099
5382c93108db propagate exceptions within future groups;
wenzelm
parents: 32096
diff changeset
   417
fun get_result x =
5382c93108db propagate exceptions within future groups;
wenzelm
parents: 32096
diff changeset
   418
  (case peek x of
37852
a902f158b4fc eliminated old-style sys_error/SYS_ERROR in favour of exception Fail -- after careful checking that there is no overlap with existing handling of that;
wenzelm
parents: 37690
diff changeset
   419
    NONE => Exn.Exn (Fail "Unfinished future")
39232
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   420
  | SOME res =>
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   421
      if Exn.is_interrupt_exn res then
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   422
        (case Exn.flatten_list (Task_Queue.group_status (group_of x)) of
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   423
          [] => res
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   424
        | exns => Exn.Exn (Exn.EXCEPTIONS exns))
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   425
      else res);
28186
6a8417f36837 cancel: check_scheduler;
wenzelm
parents: 28177
diff changeset
   426
32095
ad4be204fdfe tuned tracing;
wenzelm
parents: 32058
diff changeset
   427
fun join_next deps = (*requires SYNCHRONIZED*)
32224
a46f5e9b1718 dequeue_towards: always return active tasks;
wenzelm
parents: 32222
diff changeset
   428
  if null deps then NONE
a46f5e9b1718 dequeue_towards: always return active tasks;
wenzelm
parents: 32222
diff changeset
   429
  else
32738
15bb09ca0378 explicit indication of Unsynchronized.ref;
wenzelm
parents: 32724
diff changeset
   430
    (case Unsynchronized.change_result queue (Task_Queue.dequeue_towards (Thread.self ()) deps) of
32224
a46f5e9b1718 dequeue_towards: always return active tasks;
wenzelm
parents: 32222
diff changeset
   431
      (NONE, []) => NONE
33410
e351f4c1f18c worker activity: distinguish between waiting (formerly active) and sleeping;
wenzelm
parents: 33409
diff changeset
   432
    | (NONE, deps') => (worker_wait true work_finished; join_next deps')
32224
a46f5e9b1718 dequeue_towards: always return active tasks;
wenzelm
parents: 32222
diff changeset
   433
    | (SOME work, deps') => SOME (work, deps'));
32095
ad4be204fdfe tuned tracing;
wenzelm
parents: 32058
diff changeset
   434
32814
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   435
fun execute_work NONE = ()
33408
a69ddd7dce95 tuned thread data;
wenzelm
parents: 33407
diff changeset
   436
  | execute_work (SOME (work, deps')) = (execute work; join_work deps')
32814
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   437
and join_work deps =
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   438
  execute_work (SYNCHRONIZED "join" (fn () => join_next deps));
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   439
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   440
fun join_depend task deps =
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   441
  execute_work (SYNCHRONIZED "join" (fn () =>
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   442
    (Unsynchronized.change queue (Task_Queue.depend task deps); join_next deps)));
29551
95e469919c3e join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents: 29431
diff changeset
   443
95e469919c3e join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents: 29431
diff changeset
   444
in
95e469919c3e join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents: 29431
diff changeset
   445
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   446
fun join_results xs =
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   447
  if forall is_finished xs then map get_result xs
32246
d4f7934e9555 misc tuning;
wenzelm
parents: 32230
diff changeset
   448
  else if Multithreading.self_critical () then
d4f7934e9555 misc tuning;
wenzelm
parents: 32230
diff changeset
   449
    error "Cannot join future values within critical section"
32814
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   450
  else
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   451
    (case worker_task () of
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   452
      SOME task => join_depend task (map task_of xs)
35016
c0f2e49bccfc result: Single_Assignment.var;
wenzelm
parents: 34281
diff changeset
   453
    | NONE => List.app (ignore o Single_Assignment.await o result_of) xs;
32814
81897d30b97f added Task_Queue.depend (again) -- light-weight version for transitive graph;
wenzelm
parents: 32738
diff changeset
   454
    map get_result xs);
28186
6a8417f36837 cancel: check_scheduler;
wenzelm
parents: 28177
diff changeset
   455
29551
95e469919c3e join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents: 29431
diff changeset
   456
end;
95e469919c3e join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents: 29431
diff changeset
   457
28647
8068cdc84e7e join_results: allow CRITICAL join of finished futures;
wenzelm
parents: 28645
diff changeset
   458
fun join_result x = singleton join_results x;
8068cdc84e7e join_results: allow CRITICAL join of finished futures;
wenzelm
parents: 28645
diff changeset
   459
fun join x = Exn.release (join_result x);
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   460
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   461
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   462
(* fast-path versions -- bypassing full task management *)
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   463
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   464
fun value (x: 'a) =
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   465
  let
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   466
    val group = Task_Queue.new_group NONE;
35016
c0f2e49bccfc result: Single_Assignment.var;
wenzelm
parents: 34281
diff changeset
   467
    val result = Single_Assignment.var "value" : 'a result;
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   468
    val _ = assign_result group result (Exn.Result x);
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   469
  in Future {promised = false, task = Task_Queue.dummy_task, group = group, result = result} end;
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   470
29384
a3c7e9ae9b71 more robust propagation of errors through bulk jobs;
wenzelm
parents: 29366
diff changeset
   471
fun map_future f x =
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   472
  let
29384
a3c7e9ae9b71 more robust propagation of errors through bulk jobs;
wenzelm
parents: 29366
diff changeset
   473
    val task = task_of x;
32102
81d03a29980c added worker_group;
wenzelm
parents: 32099
diff changeset
   474
    val group = Task_Queue.new_group (SOME (group_of x));
29384
a3c7e9ae9b71 more robust propagation of errors through bulk jobs;
wenzelm
parents: 29366
diff changeset
   475
    val (result, job) = future_job group (fn () => f (join x));
a3c7e9ae9b71 more robust propagation of errors through bulk jobs;
wenzelm
parents: 29366
diff changeset
   476
32246
d4f7934e9555 misc tuning;
wenzelm
parents: 32230
diff changeset
   477
    val extended = SYNCHRONIZED "extend" (fn () =>
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   478
      (case Task_Queue.extend task job (! queue) of
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   479
        SOME queue' => (queue := queue'; true)
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   480
      | NONE => false));
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   481
  in
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   482
    if extended then Future {promised = false, task = task, group = group, result = result}
32099
5382c93108db propagate exceptions within future groups;
wenzelm
parents: 32096
diff changeset
   483
    else fork_future (SOME group) [task] (Task_Queue.pri_of_task task) (fn () => f (join x))
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   484
  end;
28979
3ce619d8d432 fork/map: no inheritance of group (structure is nested, not parallel);
wenzelm
parents: 28972
diff changeset
   485
28191
9e5f556409c6 future: allow explicit group;
wenzelm
parents: 28186
diff changeset
   486
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   487
(* promised futures -- fulfilled by external means *)
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   488
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   489
fun promise_group group : 'a future =
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   490
  let
35016
c0f2e49bccfc result: Single_Assignment.var;
wenzelm
parents: 34281
diff changeset
   491
    val result = Single_Assignment.var "promise" : 'a result;
39232
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   492
    fun abort () = assign_result group result Exn.interrupt_exn handle Fail _ => true;
37854
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   493
    val task = SYNCHRONIZED "enqueue_passive" (fn () =>
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   494
      Unsynchronized.change_result queue (Task_Queue.enqueue_passive group abort));
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   495
  in Future {promised = true, task = task, group = group, result = result} end;
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   496
37865
3a6ec95a9f68 clarified/exported Future.worker_subgroup, which is already the default for Future.fork;
wenzelm
parents: 37854
diff changeset
   497
fun promise () = promise_group (worker_subgroup ());
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   498
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   499
fun fulfill_result (Future {promised, task, group, result}) res =
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   500
  let
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   501
    val _ = promised orelse raise Fail "Not a promised future";
39232
69c6d3e87660 more abstract treatment of interrupts in structure Exn -- hardly ever need to mention Interrupt literally;
wenzelm
parents: 38236
diff changeset
   502
    fun job ok = assign_result group result (if ok then res else Exn.interrupt_exn);
34277
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   503
    val _ = execute (task, group, [job]);
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   504
  in () end;
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   505
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   506
fun fulfill x res = fulfill_result x (Exn.Result res);
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   507
7325a5e3587f added Future.promise/fulfill -- promised futures that are fulfilled by external means;
wenzelm
parents: 33416
diff changeset
   508
29431
0ebe652bfd5a added cancel_group;
wenzelm
parents: 29384
diff changeset
   509
(* cancellation *)
28202
23cb9a974630 added focus, which indicates a particular collection of high-priority tasks;
wenzelm
parents: 28201
diff changeset
   510
30618
046f4f986fb5 restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents: 30612
diff changeset
   511
fun interruptible_task f x =
046f4f986fb5 restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents: 30612
diff changeset
   512
  if Multithreading.available then
046f4f986fb5 restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents: 30612
diff changeset
   513
    Multithreading.with_attributes
32058
c76fd93b3b99 more abstract Future.is_worker;
wenzelm
parents: 32055
diff changeset
   514
      (if is_worker ()
32295
400cc493d466 renamed Multithreading.regular_interrupts to Multithreading.public_interrupts;
wenzelm
parents: 32293
diff changeset
   515
       then Multithreading.private_interrupts
400cc493d466 renamed Multithreading.regular_interrupts to Multithreading.public_interrupts;
wenzelm
parents: 32293
diff changeset
   516
       else Multithreading.public_interrupts)
400cc493d466 renamed Multithreading.regular_interrupts to Multithreading.public_interrupts;
wenzelm
parents: 32293
diff changeset
   517
      (fn _ => f x)
30618
046f4f986fb5 restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents: 30612
diff changeset
   518
  else interruptible f x;
046f4f986fb5 restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents: 30612
diff changeset
   519
32228
7622c03141b0 scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents: 32227
diff changeset
   520
(*cancel: present and future group members will be interrupted eventually*)
37854
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   521
fun cancel_group group = SYNCHRONIZED "cancel" (fn () =>
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   522
 (if cancel_now group then () else cancel_later group;
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   523
  signal work_available; scheduler_check ()));
047c96f41455 back to more strict dependencies, even for canceled groups (reverting parts of 02936e77a07c);
wenzelm
parents: 37852
diff changeset
   524
29431
0ebe652bfd5a added cancel_group;
wenzelm
parents: 29384
diff changeset
   525
fun cancel x = cancel_group (group_of x);
28206
bcd48c6897d4 eliminated requests, use global state variables uniformly;
wenzelm
parents: 28203
diff changeset
   526
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   527
32228
7622c03141b0 scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents: 32227
diff changeset
   528
(* shutdown *)
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   529
28203
88f18387f1c9 shutdown: global join-and-shutdown operation;
wenzelm
parents: 28202
diff changeset
   530
fun shutdown () =
28276
fbc707811203 shutdown only if Multithreading.available;
wenzelm
parents: 28242
diff changeset
   531
  if Multithreading.available then
fbc707811203 shutdown only if Multithreading.available;
wenzelm
parents: 28242
diff changeset
   532
    SYNCHRONIZED "shutdown" (fn () =>
32228
7622c03141b0 scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents: 32227
diff changeset
   533
     while scheduler_active () do
34279
02936e77a07c tasks of canceled groups are considered "ready" -- enables to purge the queue from tasks depending on unfinished promises (also improves general reactivity);
wenzelm
parents: 34277
diff changeset
   534
      (wait scheduler_event; broadcast_work ()))
28276
fbc707811203 shutdown only if Multithreading.available;
wenzelm
parents: 28242
diff changeset
   535
  else ();
28203
88f18387f1c9 shutdown: global join-and-shutdown operation;
wenzelm
parents: 28202
diff changeset
   536
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   537
38236
d8c7be27e01d explicitly distinguish Output.status (essential feedback) vs. Output.report (useful markup);
wenzelm
parents: 37904
diff changeset
   538
(* status markup *)
37690
b16231572c61 general Future.report -- also for Toplevel.async_state;
wenzelm
parents: 37682
diff changeset
   539
38236
d8c7be27e01d explicitly distinguish Output.status (essential feedback) vs. Output.report (useful markup);
wenzelm
parents: 37904
diff changeset
   540
fun status e =
37690
b16231572c61 general Future.report -- also for Toplevel.async_state;
wenzelm
parents: 37682
diff changeset
   541
  let
b16231572c61 general Future.report -- also for Toplevel.async_state;
wenzelm
parents: 37682
diff changeset
   542
    val _ = Output.status (Markup.markup Markup.forked "");
b16231572c61 general Future.report -- also for Toplevel.async_state;
wenzelm
parents: 37682
diff changeset
   543
    val x = e ();  (*sic -- report "joined" only for success*)
b16231572c61 general Future.report -- also for Toplevel.async_state;
wenzelm
parents: 37682
diff changeset
   544
    val _ = Output.status (Markup.markup Markup.joined "");
b16231572c61 general Future.report -- also for Toplevel.async_state;
wenzelm
parents: 37682
diff changeset
   545
  in x end;
b16231572c61 general Future.report -- also for Toplevel.async_state;
wenzelm
parents: 37682
diff changeset
   546
b16231572c61 general Future.report -- also for Toplevel.async_state;
wenzelm
parents: 37682
diff changeset
   547
29366
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   548
(*final declarations of this structure!*)
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   549
val map = map_future;
1ffc8cbf39ec tuned map: reduced overhead due to bulk jobs;
wenzelm
parents: 29341
diff changeset
   550
28156
5205f7979b4f Functional threads as future values.
wenzelm
parents:
diff changeset
   551
end;
28972
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
   552
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
   553
type 'a future = 'a Future.future;
cb8a2c3e188f renamed type Future.T to future;
wenzelm
parents: 28647
diff changeset
   554