forked from ocaml/opam
-
Notifications
You must be signed in to change notification settings - Fork 4
/
opamSolution.ml
630 lines (586 loc) · 22.8 KB
/
opamSolution.ml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
(**************************************************************************)
(* *)
(* Copyright 2012-2013 OCamlPro *)
(* Copyright 2012 INRIA *)
(* *)
(* All rights reserved.This file is distributed under the terms of the *)
(* GNU Lesser General Public License version 3.0 with linking *)
(* exception. *)
(* *)
(* OPAM is distributed in the hope that it will be useful, but WITHOUT *)
(* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *)
(* or FITNESS FOR A PARTICULAR PURPOSE.See the GNU General Public *)
(* License for more details. *)
(* *)
(**************************************************************************)
let log fmt = OpamGlobals.log "SOLUTION" fmt
open OpamTypes
open OpamTypesBase
open OpamState.Types
(* Graph of packages providing OpamParallel *)
module PackageGraph : OpamParallel.GRAPH with type V.t = package
= OpamParallel.MakeGraph (OpamPackage)
module PackageAction = OpamSolver.Action
module PackageActionGraph = OpamSolver.ActionGraph
let post_message ?(failed=false) state action =
let pkg = action_contents action in
let opam = OpamState.opam state pkg in
let messages = OpamFile.OPAM.post_messages opam in
let print_message message =
if failed then
(OpamGlobals.header_msg "%s troobleshooting" (OpamPackage.to_string pkg);
OpamGlobals.msg "%s\n" message)
else
(OpamGlobals.header_msg "%s information" (OpamPackage.to_string pkg);
OpamGlobals.msg "%s\n" message)
in
let local_variables = OpamVariable.Map.empty in
let local_variables =
OpamVariable.Map.add (OpamVariable.of_string "success")
(B (not failed)) local_variables
in
let local_variables =
OpamVariable.Map.add (OpamVariable.of_string "failure")
(B failed) local_variables
in
List.iter (fun (message,filter) ->
if OpamState.eval_filter state ~opam local_variables filter then
print_message
(OpamState.substitute_string state ~opam local_variables message))
messages
let check_solution state = function
| No_solution ->
OpamGlobals.msg "No solution found, exiting\n";
OpamGlobals.exit 3
| Error (success, failed, _remaining) ->
List.iter (post_message state) success;
List.iter (post_message ~failed:true state) failed;
OpamGlobals.exit 4
| OK actions ->
List.iter (post_message state) actions
| Nothing_to_do -> ()
| Aborted -> OpamGlobals.exit 0
let sum stats =
stats.s_install + stats.s_reinstall + stats.s_remove + stats.s_upgrade + stats.s_downgrade
let eq_atom name version =
name, Some (`Eq, version)
let eq_atoms_of_packages set =
List.rev_map (fun nv -> eq_atom (OpamPackage.name nv) (OpamPackage.version nv)) (OpamPackage.Set.elements set)
let atom_of_package nv =
OpamPackage.name nv, None
let atoms_of_packages set =
List.rev_map atom_of_package (OpamPackage.Set.elements set)
let atom_of_name name =
name, None
let check_availability ?permissive t set atoms =
let available = OpamPackage.to_map set in
let check_atom (name, _ as atom) =
let exists =
try
OpamPackage.Version.Set.exists
(fun v -> OpamFormula.check atom (OpamPackage.create name v))
(OpamPackage.Name.Map.find name available)
with Not_found -> false
in
if exists then None
else if permissive = Some true
then Some (OpamState.unknown_package t atom)
else Some (OpamState.unavailable_reason t atom) in
let errors = OpamMisc.filter_map check_atom atoms in
if errors <> [] then
(List.iter (OpamGlobals.error "%s") errors;
OpamGlobals.exit 66)
let sanitize_atom_list ?(permissive=false) t atoms =
let packages =
OpamPackage.to_map (OpamPackage.Set.union t.packages t.installed) in
(* gets back the original capitalization of the package name *)
let realname name =
let lc_name name = String.lowercase (OpamPackage.Name.to_string name) in
let m =
OpamPackage.Name.Map.filter (fun p _ -> lc_name name = lc_name p)
packages in
match OpamPackage.Name.Map.keys m with [name] -> name | _ -> name
in
let atoms = List.rev_map (fun (name,cstr) -> realname name, cstr) atoms in
if permissive then
check_availability ~permissive t
(OpamPackage.Set.union t.packages t.installed) atoms
else
check_availability t
(OpamPackage.Set.union (Lazy.force t.available_packages) t.installed)
atoms;
atoms
(* Pretty-print errors *)
let display_error (n, error) =
let f action nv =
let disp =
OpamGlobals.header_error "while %s %s" action (OpamPackage.to_string nv) in
match error with
| OpamParallel.Process_error r ->
disp "%s" (OpamProcess.string_of_result ~color:`red r)
| OpamParallel.Internal_error "User interruption" -> ()
| OpamParallel.Internal_error s ->
disp "Internal error:\n %s" s
| OpamParallel.Package_error s ->
disp "%s" s in
match n with
| To_change (Some o, nv) ->
if
OpamPackage.Version.compare
(OpamPackage.version o) (OpamPackage.version nv) < 0
then
f "upgrading to" nv
else
f "downgrading to" nv
| To_change (None, nv) -> f "installing" nv
| To_recompile nv -> f "recompiling" nv
| To_delete nv -> f "removing" nv
(* Prettify errors *)
let string_of_errors errors =
let actions = List.rev_map fst errors in
let packages = List.rev_map action_contents actions in
match packages with
| [] -> assert false
| [h] -> OpamPackage.to_string h
| l -> OpamPackage.Set.to_string (OpamPackage.Set.of_list l)
let new_variables e =
let e = List.filter (fun (_,s,_) -> s="=") e in
let e = List.rev_map (fun (v,_,_) -> v) e in
OpamMisc.StringSet.of_list e
let variable_warnings = ref false
let print_variable_warnings t =
let variables = ref [] in
if not !variable_warnings then (
let warn w =
let is_defined s =
try let _ = OpamMisc.getenv s in true
with Not_found -> false in
if is_defined w then
variables := w :: !variables in
(* 1. Warn about OCAMLFIND variables if it is installed *)
let ocamlfind_vars = [
"OCAMLFIND_DESTDIR";
"OCAMLFIND_CONF";
"OCAMLFIND_METADIR";
"OCAMLFIND_COMMANDS";
"OCAMLFIND_LDCONF";
] in
if OpamPackage.Set.exists (
fun nv -> OpamPackage.Name.to_string (OpamPackage.name nv) = "ocamlfind"
) t.installed then
List.iter warn ocamlfind_vars;
(* 2. Warn about variables possibly set by other compilers *)
let new_variables comp =
let comp_f = OpamPath.compiler_comp t.root comp in
let env = OpamFile.Comp.env (OpamFile.Comp.safe_read comp_f) in
new_variables env in
let vars = ref OpamMisc.StringSet.empty in
OpamSwitch.Map.iter (fun _ comp ->
vars := OpamMisc.StringSet.union !vars (new_variables comp)
) t.aliases;
vars := OpamMisc.StringSet.diff !vars (new_variables t.compiler);
OpamMisc.StringSet.iter warn !vars;
if !variables <> [] then (
OpamGlobals.msg "The following variables are set in your environment, it \
is advised to unset them for OPAM to work correctly.\n";
List.iter (OpamGlobals.msg " - %s\n") !variables;
if not (OpamState.confirm "Do you want to continue ?") then
OpamGlobals.exit 1;
);
variable_warnings := true;
)
(* Transient state (not flushed to disk) *)
type state = {
mutable s_installed : package_set;
mutable s_installed_roots: package_set;
mutable s_reinstall : package_set;
}
let output_json_solution solution =
let to_remove = List.map OpamPackage.to_json solution.to_remove in
let to_proceed = ref [] in
PackageActionGraph.Topological.iter (function
| To_change(o,p) ->
let json = match o with
| None -> `O ["install", OpamPackage.to_json p]
| Some o ->
if OpamPackage.Version.compare
(OpamPackage.version o) (OpamPackage.version p) < 0
then
`O ["upgrade", `A [OpamPackage.to_json o; OpamPackage.to_json p]]
else
`O ["downgrade", `A [OpamPackage.to_json o; OpamPackage.to_json p]] in
to_proceed := json :: !to_proceed
| To_recompile p ->
let json = `O ["recompile", OpamPackage.to_json p] in
to_proceed := json :: !to_proceed
| To_delete _ -> ()
) solution.to_process;
let json = `O [
"to-remove" , `A to_remove;
"to-proceed", `A (List.rev !to_proceed);
] in
OpamJson.add json
let output_json_actions action_errors =
let open OpamParallel in
let open OpamProcess in
let json_error = function
| Process_error r ->
`O [ ("process-error",
`O [ ("code", `String (string_of_int r.r_code));
("duration", `Float r.r_duration);
("info", `O (List.map (fun (k,v) -> (k, `String v)) r.r_info));
("stdout", `A (List.map (fun s -> `String s) r.r_stdout));
("stderr", `A (List.map (fun s -> `String s) r.r_stderr));
])]
| Internal_error s ->
`O [ ("internal-error", `String s) ]
| Package_error s ->
`O [ ("package-error", `String s) ] in
let json_action (a, e) =
`O [ ("package", `String (OpamPackage.to_string (action_contents a)));
("error" , json_error e) ] in
List.iter (fun a ->
let json = json_action a in
OpamJson.add json
) action_errors
(* Mean function for applying solver solutions. One main process is
deleting the packages and updating the global state of
OPAM. Children processes are spawned to deal with parallele builds
and installations. *)
let parallel_apply t action solution =
let state = {
s_installed = t.installed;
s_installed_roots = t.installed_roots;
s_reinstall = t.reinstall;
} in
let t_ref = ref t in
let update_state () =
let installed = state.s_installed in
let installed_roots = state.s_installed_roots in
let reinstall = state.s_reinstall in
t_ref :=
OpamAction.update_metadata t ~installed ~installed_roots ~reinstall in
let root_installs =
let names =
List.rev_map OpamPackage.name (OpamPackage.Set.elements t.installed_roots) in
OpamPackage.Name.Set.of_list names in
let root_installs = match action with
| Init r
| Install r
| Import r
| Switch r -> OpamPackage.Name.Set.union root_installs r
| Upgrade _
| Reinstall -> root_installs
| Depends
| Remove -> OpamPackage.Name.Set.empty in
(* flush the contents of installed and installed.root to disk. This
should be called as often as possible to keep the global state of
OPAM consistent (as the user is free to kill OPAM at every
moment). We are not guaranteed to always be consistent, but we
try hard to be.*)
let add_to_install nv =
state.s_installed <- OpamPackage.Set.add nv state.s_installed;
state.s_reinstall <- OpamPackage.Set.remove nv state.s_reinstall;
if OpamPackage.Name.Set.mem (OpamPackage.name nv) root_installs then
state.s_installed_roots <- OpamPackage.Set.add nv state.s_installed_roots;
update_state ();
if not !OpamGlobals.dryrun then
OpamState.install_metadata !t_ref nv in
let remove_from_install deleted =
state.s_installed <- OpamPackage.Set.diff state.s_installed deleted;
state.s_installed_roots <- OpamPackage.Set.diff state.s_installed_roots deleted;
state.s_reinstall <- OpamPackage.Set.diff state.s_reinstall deleted in
let actions_list a = PackageActionGraph.fold_vertex (fun a b -> a::b) a [] in
(* Installation and recompilation are done by child the processes *)
let child n =
(* We are guaranteed to get the state when all the dependencies
have been correctly updated. Thus [t.installed] should be
up-to-date. *)
let t = !t_ref in
match n with
| To_change (_, nv) | To_recompile nv ->
OpamAction.build_and_install_package ~metadata:false t nv
| To_delete _ -> assert false in
(* Not pre-condition (yet ?) *)
let pre _ = () in
(* Post-condition on the parent process: we modify of the global
OPAM state to keep the list of installed packages up-to-date. *)
let post = function
| To_delete _ -> assert false
| To_recompile nv
| To_change (_, nv) -> add_to_install nv in
(* - Start processing - *)
let finalize () = () in
(* 0/ Download everything that we will need, for parallelism and failing
early in case there is a failure *)
let status, finalize = try
let sources_needed = OpamAction.sources_needed t solution in
if OpamPackage.Set.is_empty sources_needed then
`Successful (), finalize
else
let _cache =
OpamPackage.Set.iter (fun nv ->
if not (OpamState.is_locally_pinned t (OpamPackage.name nv)) then
try
let repo =
OpamState.find_repository t
(fst (OpamPackage.Map.find nv t.package_index)) in
if repo.repo_kind = `http then OpamHTTP.preload_state repo
with Not_found -> ())
sources_needed
in
OpamGlobals.header_msg "Synchronizing package archives";
let dl_graph =
let g = PackageGraph.create () in
OpamPackage.Set.iter (fun nv -> PackageGraph.add_vertex g nv)
sources_needed;
g in
PackageGraph.Parallel.iter (OpamState.dl_jobs t) dl_graph
~pre:ignore ~post:ignore
~child:(OpamAction.download_package t);
`Successful (), finalize
with
| PackageGraph.Parallel.Errors (errors, _) ->
(* Error during download *)
let msg =
Printf.sprintf "Errors while downloading archives of %s"
(String.concat ", "
(List.map (fun (nv,_) -> OpamPackage.to_string nv) errors)) in
`Error (Aborted, msg), finalize
| e ->
`Exception e, finalize
in
(* 1/ We remove all installed packages appearing in the solution. *)
let status, finalize =
match status with
| #error as e -> e, finalize
| `Successful () ->
let (t,deleted),st =
OpamAction.remove_all_packages t ~metadata:true solution in
t_ref := t;
remove_from_install deleted;
match st with
| `Successful () ->
`Successful (),
fun () ->
OpamPackage.Set.iter
(fun nv ->
if not (OpamState.is_pinned t (OpamPackage.name nv)) then
OpamAction.cleanup_package_artefacts !t_ref nv)
deleted
| `Exception (e) ->
let err = Printexc.to_string e in
let msg = Printf.sprintf "%s during package removal" err in
let actions = actions_list solution.to_process in
let successful, remaining =
List.partition (function
| To_delete nv
when not (OpamPackage.Set.mem nv t.installed) -> true
| _ -> false) actions in
let failed, remaining =
List.partition (function
| To_change (Some nv, _) | To_recompile nv
when not (OpamPackage.Set.mem nv t.installed) -> true
| _ -> false) remaining in
`Error (Error (successful, failed, remaining), msg), finalize
in
(* 2/ We install the new packages *)
let status, finalize =
match status with
| #error -> status, finalize
| `Successful () ->
if not (PackageActionGraph.is_empty solution.to_process) then
OpamGlobals.header_msg "Installing packages";
try
PackageActionGraph.Parallel.iter
(OpamState.jobs t) solution.to_process ~pre ~child ~post;
`Successful (), finalize
with
| PackageActionGraph.Parallel.Cyclic actions ->
let packages = List.map (List.map action_contents) actions in
let strings = List.map (List.map OpamPackage.to_string) packages in
let mk l = Printf.sprintf " - %s" (String.concat ", " l) in
let msg =
Printf.sprintf
"Aborting, as the following packages have a cyclic dependency:\n%s"
(String.concat "\n" (List.map mk strings)) in
OpamGlobals.error "%s" msg;
`Error (Aborted, msg), finalize
| PackageActionGraph.Parallel.Errors (errors, remaining) ->
let msg =
Printf.sprintf
"Failure while processing %s" (string_of_errors errors) in
let failed = List.map fst errors in
let successful =
PackageActionGraph.fold_vertex
(fun pkg successful ->
if not (List.mem pkg failed) && not (List.mem pkg remaining)
then pkg::successful
else successful)
solution.to_process []
in
`Error (Error (successful, failed, remaining), msg),
fun () ->
finalize ();
List.iter display_error errors;
output_json_actions errors
| e -> `Exception e, finalize
in
(* 3/ Display errors and finalize *)
match status with
| `Successful () ->
finalize ();
OK (actions_list solution.to_process)
| `Exception e ->
OpamGlobals.error "Actions cancelled because of %s" (Printexc.to_string e);
finalize ();
raise e
| `Error (err, _msg) ->
(* OpamGlobals.msg "\n"; *)
(* OpamGlobals.error "%s" msg; *)
match err with
| Aborted -> finalize (); err
| Error (successful, failed, remaining) ->
OpamGlobals.msg "\n";
finalize ();
if
List.length successful + List.length failed + List.length remaining <= 1
then err else
let () = OpamGlobals.header_msg "Error report" in
let print_actions oc actions =
let pr a = Printf.fprintf oc " - %s\n" (PackageAction.to_string a) in
List.iter pr actions in
if successful <> [] then (
OpamGlobals.msg
"These actions have been completed %s\n%a"
(OpamGlobals.colorise `bold "successfully")
print_actions successful
);
if failed <> [] then (
OpamGlobals.msg
"The following %s\n%a"
(OpamGlobals.colorise `bold "failed")
print_actions failed
);
if remaining <> [] then (
OpamGlobals.msg
"Due to the errors, the following have been %s\n%a"
(OpamGlobals.colorise `bold "cancelled")
print_actions remaining
);
err
| _ -> assert false
let simulate_new_state state t =
let installed = List.fold_left
(fun installed p -> OpamPackage.Set.remove p installed)
state.installed t.to_remove in
let installed =
OpamSolver.ActionGraph.Topological.fold
(fun action installed ->
match action with
| To_change(_,p) | To_recompile p ->
OpamPackage.Set.add p installed
| To_delete p ->
OpamPackage.Set.remove p installed
)
t.to_process installed in
{ state with installed }
let print_external_tags t solution =
let packages = OpamSolver.new_packages solution in
let external_tags = OpamMisc.StringSet.of_list !OpamGlobals.external_tags in
let values =
OpamPackage.Set.fold (fun nv accu ->
let opam = OpamState.opam t nv in
match OpamFile.OPAM.depexts opam with
| None -> accu
| Some alltags ->
OpamMisc.StringSetMap.fold (fun tags values accu ->
if OpamMisc.StringSet.(
(* A \subseteq B <=> (A U B) / B = 0 *)
is_empty (diff (union external_tags tags) external_tags)
)
then
OpamMisc.StringSet.union values accu
else
accu
) alltags accu
) packages OpamMisc.StringSet.empty in
let values = OpamMisc.StringSet.elements values in
if values <> [] then
OpamGlobals.msg "%s\n" (String.concat " " values)
(* Ask confirmation whenever the packages to modify are not exactly
the packages in the user request *)
let confirmation ?ask requested solution =
!OpamGlobals.yes ||
match ask with
| Some false -> true
| Some true -> OpamState.confirm "Do you want to continue ?"
| None ->
let open PackageActionGraph in
let solution_packages =
fold_vertex (fun v acc ->
OpamPackage.Name.Set.add (OpamPackage.name (action_contents v)) acc)
solution.to_process
(OpamPackage.Name.Set.of_list
(List.map OpamPackage.name solution.to_remove)) in
OpamPackage.Name.Set.equal requested solution_packages
|| OpamState.confirm "Do you want to continue ?"
(* Apply a solution *)
let apply ?ask t action ~requested solution =
log "apply";
if !OpamGlobals.debug then
PackageActionGraph.Dot.output_graph stdout solution.to_process;
if OpamSolver.solution_is_empty solution then
(* The current state satisfies the request contraints *)
Nothing_to_do
else (
(* Otherwise, compute the actions to perform *)
let stats = OpamSolver.stats solution in
let show_solution = (!OpamGlobals.external_tags = []) in
if show_solution then (
OpamGlobals.msg
"The following actions %s be %s:\n"
(if !OpamGlobals.show then "would" else "will")
(if !OpamGlobals.fake then "simulated" else "performed");
let new_state = simulate_new_state t solution in
let messages p =
let opam = OpamState.opam new_state p in
let messages = OpamFile.OPAM.messages opam in
OpamMisc.filter_map (fun (s,f) ->
if OpamState.eval_filter new_state ~opam OpamVariable.Map.empty f
then Some s
else None
) messages in
let rewrite nv =
let n = OpamPackage.name nv in
if OpamState.is_pinned t n then
OpamPackage.create n
(OpamPackage.Version.of_string
(OpamPackage.Version.to_string (OpamPackage.version nv) ^ "*"))
else nv
in
OpamSolver.print_solution ~messages ~rewrite solution;
OpamGlobals.msg "=== %s ===\n" (OpamSolver.string_of_stats stats);
output_json_solution solution;
);
if !OpamGlobals.external_tags <> [] then (
print_external_tags t solution;
Aborted
) else if not !OpamGlobals.show &&
confirmation ?ask requested solution
then (
print_variable_warnings t;
parallel_apply t action solution
) else
Aborted
)
let resolve ?(verbose=true) t action ~requested request =
OpamSolver.resolve ~verbose (OpamState.universe t action) ~requested request
let resolve_and_apply ?ask t action ~requested request =
match resolve t action ~requested request with
| Conflicts cs ->
log "conflict!";
OpamGlobals.msg "%s"
(OpamCudf.string_of_conflict (OpamState.unavailable_reason t) cs);
No_solution
| Success solution -> apply ?ask t action ~requested solution