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
|
(* Js_of_ocaml compiler
* http://www.ocsigen.org/js_of_ocaml/
* Copyright (C) 2017 Hugo Heuzard
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, with linking exception;
* either version 2.1 of the License, or (at your option) any later version.
*
* This program 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*)
open! Stdlib
let times = Debug.find "times"
let debug = Debug.find "link"
let sourceMappingURL = "//# sourceMappingURL="
let sourceMappingURL_base64 = "//# sourceMappingURL=data:application/json;base64,"
module Line_reader : sig
type t
val open_ : string -> t
val next : t -> string
val peek : t -> string option
val drop : t -> unit
val close : t -> unit
val lnum : t -> int
val fname : t -> string
end = struct
type t =
{ ic : in_channel
; fname : string
; mutable next : string option
; mutable lnum : int
}
let close t = close_in t.ic
let open_ fname =
let ic = open_in_bin fname in
{ ic; lnum = 0; fname; next = None }
let next t =
let lnum = t.lnum in
let s =
match t.next with
| None -> input_line t.ic
| Some s ->
t.next <- None;
s
in
t.lnum <- lnum + 1;
s
let peek t =
match t.next with
| Some x -> Some x
| None -> (
try
let s = input_line t.ic in
t.next <- Some s;
Some s
with End_of_file -> None)
let drop t =
match t.next with
| Some _ ->
t.next <- None;
t.lnum <- t.lnum + 1
| None -> (
try
let (_ : string) = input_line t.ic in
t.lnum <- t.lnum + 1
with End_of_file -> ())
let lnum t = t.lnum
let fname t = t.fname
end
module Line_writer : sig
type t
val of_channel : out_channel -> t
val write : t -> string -> unit
val write_lines : t -> string -> unit
val lnum : t -> int
end = struct
type t =
{ oc : out_channel
; mutable lnum : int
}
let of_channel oc = { oc; lnum = 0 }
let write t s =
output_string t.oc s;
output_string t.oc "\n";
t.lnum <- t.lnum + 1
let write_lines t lines =
let l = String.split_on_char ~sep:'\n' lines in
let rec w = function
| [ "" ] | [] -> ()
| s :: xs ->
write t s;
w xs
in
w l
let lnum t = t.lnum
end
type action =
| Keep
| Drop
| Unit
| Build_info of Build_info.t
| Source_map of Source_map.t
let prefix_kind line =
match String.is_prefix ~prefix:sourceMappingURL line with
| false -> (
match Build_info.parse line with
| Some bi -> `Build_info bi
| None -> (
match Unit_info.parse Unit_info.empty line with
| Some _ -> `Unit
| None -> `Other))
| true -> (
match String.is_prefix ~prefix:sourceMappingURL_base64 line with
| true -> `Json_base64 (String.length sourceMappingURL_base64)
| false -> `Url (String.length sourceMappingURL))
let action ~resolve_sourcemap_url ~drop_source_map file line =
match prefix_kind line, drop_source_map with
| `Other, (true | false) -> (
match line with
| "" -> Drop
| s when String.equal s Global_constant.header -> Drop
| _ -> Keep)
| `Unit, (true | false) -> Unit
| `Build_info bi, _ -> Build_info bi
| (`Json_base64 _ | `Url _), true -> Drop
| `Json_base64 offset, false ->
let raw = Base64.decode_exn ~off:offset line in
let sm = Source_map.of_string raw in
Source_map sm
| `Url _, false when not resolve_sourcemap_url -> Drop
| `Url offset, false ->
let url = String.sub line ~pos:offset ~len:(String.length line - offset) in
let base = Filename.dirname file in
let ic = open_in_bin (Filename.concat base url) in
let l = in_channel_length ic in
let content = really_input_string ic l in
close_in ic;
Source_map (Source_map.of_string content)
module Units : sig
val read : Line_reader.t -> Unit_info.t -> Unit_info.t
val scan_file : string -> Build_info.t option * Unit_info.t list
end = struct
let rec read ic uinfo =
match Line_reader.peek ic with
| None -> uinfo
| Some line -> (
match Unit_info.parse uinfo line with
| None -> uinfo
| Some uinfo ->
Line_reader.drop ic;
read ic uinfo)
let find_unit_info ic =
let rec find_next ic =
match Line_reader.peek ic with
| None -> None
| Some line -> (
match prefix_kind line with
| `Json_base64 _ | `Url _ | `Other | `Build_info _ ->
Line_reader.drop ic;
find_next ic
| `Unit -> Some (read ic Unit_info.empty))
in
find_next ic
let find_build_info ic =
let rec find_next ic =
match Line_reader.peek ic with
| None -> None
| Some line -> (
match prefix_kind line with
| `Other ->
Line_reader.drop ic;
find_next ic
| `Build_info bi -> Some bi
| `Unit | `Json_base64 _ | `Url _ -> None)
in
find_next ic
let scan_file file =
let ic = Line_reader.open_ file in
let rec scan_all ic acc =
match find_unit_info ic with
| None -> List.rev acc
| Some x -> scan_all ic (x :: acc)
in
let build_info = find_build_info ic in
let units = scan_all ic [] in
Line_reader.close ic;
build_info, units
end
let link ~output ~linkall ~mklib ~toplevel ~files ~resolve_sourcemap_url ~source_map =
(* we currently don't do anything with [toplevel]. It could be used
to conditionally include link_info ?*)
ignore (toplevel : bool);
let t = Timer.make () in
let oc = Line_writer.of_channel output in
let warn_effects = ref false in
let files = List.map files ~f:(fun file -> file, Units.scan_file file) in
let missing, to_link, all =
List.fold_right
files
~init:(StringSet.empty, StringSet.empty, StringSet.empty)
~f:(fun (_file, (build_info, units)) acc ->
let cmo_file =
match build_info with
| Some bi -> (
match Build_info.kind bi with
| `Cmo -> true
| `Cma | `Exe | `Runtime | `Unknown -> false)
| None -> false
in
List.fold_right
units
~init:acc
~f:(fun (info : Unit_info.t) (requires, to_link, all) ->
let all = StringSet.union all info.provides in
if (not (Config.Flag.auto_link ()))
|| mklib
|| cmo_file
|| linkall
|| info.force_link
|| not (StringSet.is_empty (StringSet.inter requires info.provides))
then
( StringSet.diff (StringSet.union info.requires requires) info.provides
, StringSet.union to_link info.provides
, all )
else requires, to_link, all))
in
let _skip = StringSet.diff all to_link in
if (not (StringSet.is_empty missing)) && not mklib
then
failwith
(Printf.sprintf
"Could not find compilation unit for %s"
(String.concat ~sep:", " (StringSet.elements missing)));
if times () then Format.eprintf " scan: %a@." Timer.print t;
let sm = ref [] in
let build_info = ref None in
let t = Timer.make () in
let sym = ref Ocaml_compiler.Symtable.GlobalMap.empty in
let sym_js = ref [] in
List.iter files ~f:(fun (_, (_, units)) ->
List.iter units ~f:(fun (u : Unit_info.t) ->
StringSet.iter
(fun s ->
ignore
(Ocaml_compiler.Symtable.GlobalMap.enter
sym
(Ocaml_compiler.Symtable.Global.Glob_compunit s)
: int);
sym_js := s :: !sym_js)
u.Unit_info.provides));
let build_info_emitted = ref false in
List.iter files ~f:(fun (file, (build_info_for_file, units)) ->
let is_runtime =
match build_info_for_file with
| Some bi -> (
match Build_info.kind bi with
| `Runtime -> Some bi
| `Cma | `Exe | `Cmo | `Unknown -> None)
| None -> None
in
let sm_for_file = ref None in
let ic = Line_reader.open_ file in
let skip ic = Line_reader.drop ic in
let line_offset = Line_writer.lnum oc in
let reloc = ref [] in
let copy ic oc =
let line = Line_reader.next ic in
Line_writer.write oc line
in
let rec read () =
match Line_reader.peek ic with
| None -> ()
| Some line ->
(match
action
~resolve_sourcemap_url
~drop_source_map:Poly.(source_map = None)
file
line
with
| Keep -> copy ic oc
| Build_info bi ->
skip ic;
if not !build_info_emitted
then (
let bi = Build_info.with_kind bi (if mklib then `Cma else `Unknown) in
Line_writer.write oc Global_constant.header;
Line_writer.write_lines oc (Build_info.to_string bi);
build_info_emitted := true)
| Drop -> skip ic
| Unit ->
let u = Units.read ic Unit_info.empty in
if StringSet.cardinal (StringSet.inter u.Unit_info.provides to_link) > 0
then (
if u.effects_without_cps && not !warn_effects
then (
warn_effects := true;
warn
"Warning: your program contains effect handlers; you should \
probably run js_of_ocaml with option '--enable=effects'@.");
(if mklib
then
let u = if linkall then { u with force_link = true } else u in
Line_writer.write_lines oc (Unit_info.to_string u));
Line_writer.write
oc
(Printf.sprintf
"//# %d %S"
(Line_reader.lnum ic)
(Line_reader.fname ic));
let read_loffset = Line_reader.lnum ic in
let write_loffset = Line_writer.lnum oc in
let bsize = ref 0 in
let lsize = ref 0 in
while
match Line_reader.peek ic with
| None -> false
| Some line -> (
match prefix_kind line with
| `Other -> true
| `Json_base64 _ | `Url _ | `Build_info _ | `Unit -> false)
do
bsize := !bsize + String.length line + 1;
incr lsize;
copy ic oc
done;
assert (read_loffset + !lsize = Line_reader.lnum ic);
assert (write_loffset + !lsize = Line_writer.lnum oc);
reloc := `Copy (read_loffset, write_loffset, !lsize) :: !reloc;
if debug ()
then
Format.eprintf
"Copy %d bytes for %s@."
!bsize
(match is_runtime with
| None -> String.concat ~sep:", " (StringSet.elements u.provides)
| Some _ -> "the js runtime"))
else (
if debug ()
then
Format.eprintf
"Skip %s@."
(String.concat ~sep:"," (StringSet.elements u.provides));
let lnum = ref 0 in
let read_loffset = Line_reader.lnum ic in
while
match Line_reader.peek ic with
| None -> false
| Some line -> (
match prefix_kind line with
| `Other -> true
| `Json_base64 _ | `Url _ | `Build_info _ | `Unit -> false)
do
skip ic;
incr lnum
done;
assert (read_loffset + !lnum = Line_reader.lnum ic);
reloc := `Drop (read_loffset, !lnum) :: !reloc)
| Source_map x ->
skip ic;
sm_for_file := Some x);
read ()
in
read ();
Line_reader.close ic;
(match is_runtime with
| None -> ()
| Some bi ->
Build_info.configure bi;
let primitives =
List.fold_left units ~init:StringSet.empty ~f:(fun acc (u : Unit_info.t) ->
StringSet.union acc (StringSet.of_list u.primitives))
in
let code = Parse_bytecode.link_info ~symbols:!sym ~primitives ~crcs:[] in
let b = Buffer.create 100 in
let fmt = Pretty_print.to_buffer b in
Driver.configure fmt;
Driver.f'
~standalone:false
~link:`No
~wrap_with_fun:`Iife
fmt
(Parse_bytecode.Debug.create ~include_cmis:false false)
code;
let content = Buffer.contents b in
Line_writer.write_lines oc content;
Line_writer.write oc "");
(match !sm_for_file with
| None -> ()
| Some x -> sm := (x, List.rev !reloc, line_offset) :: !sm);
match !build_info, build_info_for_file with
| None, None -> ()
| Some _, None -> ()
| None, Some build_info_for_file -> build_info := Some (file, build_info_for_file)
| Some (first_file, bi), Some build_info_for_file ->
build_info :=
Some (first_file, Build_info.merge first_file bi file build_info_for_file));
if times () then Format.eprintf " emit: %a@." Timer.print t;
let t = Timer.make () in
match source_map with
| None -> ()
| Some (file, init_sm) ->
let sections =
List.rev_map !sm ~f:(fun (sm, reloc, _offset) ->
let sm =
match (sm : Source_map.t) with
| Standard sm ->
[ ( Source_map.Mappings.first_line sm.mappings
, Source_map.Mappings.number_of_lines sm.mappings
, 0
, 0
, sm )
]
| Index sm ->
List.map
sm.Source_map.Index.sections
~f:(fun { offset = { gen_line; gen_column }; map } ->
( gen_line + Source_map.Mappings.first_line map.mappings
, gen_line + Source_map.Mappings.number_of_lines map.mappings
, gen_line
, gen_column
, map ))
in
(* select sourcemaps that cover copied section *)
let maps =
List.concat_map reloc ~f:(function
| `Drop _ -> []
| `Copy (src, dst, len) ->
List.filter_map
sm
~f:(fun (first, last, gen_line, gen_column, sm) ->
if first > src + len || last < src
then None
else (
(* We don't want to deal with overlapping but not included
sourcemap, but we could in theory filter out part of it. *)
assert (src <= first && last <= src + len);
Some (first, last, gen_line + dst - src, gen_column, sm))))
in
(* Make sure dropped sections are not overlapping selected sourcemap. *)
List.iter reloc ~f:(function
| `Copy _ -> ()
| `Drop (src, len) ->
List.iter maps ~f:(fun (first, last, _, _, _) ->
if first > src + len || last < src then () else assert false));
maps)
in
let sections = List.concat sections in
let sm =
{ Source_map.Index.version = init_sm.Source_map.Standard.version
; file = init_sm.file
; sections =
(* preserve some info from [init_sm] *)
List.map sections ~f:(fun (_, _, gen_line, gen_column, sm) ->
{ Source_map.Index.offset = { gen_line; gen_column }
; map = { sm with sourceroot = init_sm.sourceroot }
})
}
in
let sm = Source_map.Index sm in
(match file with
| None ->
let data = Source_map.to_string sm in
let s = sourceMappingURL_base64 ^ Base64.encode_exn data in
Line_writer.write oc s
| Some file ->
Source_map.to_file sm file;
let s = sourceMappingURL ^ Filename.basename file in
Line_writer.write oc s);
if times () then Format.eprintf " sourcemap: %a@." Timer.print t
let link ~output ~linkall ~mklib ~toplevel ~files ~resolve_sourcemap_url ~source_map =
try link ~output ~linkall ~toplevel ~mklib ~files ~resolve_sourcemap_url ~source_map
with Build_info.Incompatible_build_info { key; first = f1, v1; second = f2, v2 } ->
let string_of_v = function
| None -> "<empty>"
| Some v -> v
in
failwith
(Printf.sprintf
"Incompatible build info detected while linking.\n - %s: %s=%s\n - %s: %s=%s"
f1
key
(string_of_v v1)
f2
key
(string_of_v v2))
|