forked from HaxeFoundation/haxe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dce.ml
573 lines (544 loc) · 18.4 KB
/
dce.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
(*
* Copyright (C)2005-2013 Haxe Foundation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*)
open Ast
open Common
open Type
type dce = {
com : context;
full : bool;
std_dirs : string list;
debug : bool;
follow_expr : dce -> texpr -> unit;
mutable added_fields : (tclass * tclass_field * bool) list;
mutable marked_fields : tclass_field list;
mutable marked_maybe_fields : tclass_field list;
mutable t_stack : t list;
mutable ts_stack : t list;
mutable features : (string,(tclass * tclass_field * bool) list) Hashtbl.t;
}
(* checking *)
(* check for @:keepSub metadata, which forces @:keep on child classes *)
let rec super_forces_keep c =
Meta.has Meta.KeepSub c.cl_meta || match c.cl_super with
| Some (csup,_) -> super_forces_keep csup
| _ -> false
let is_std_file dce file =
List.exists (ExtString.String.starts_with file) dce.std_dirs
(* check if a class is kept entirely *)
let keep_whole_class dce c =
Meta.has Meta.Keep c.cl_meta
|| not (dce.full || is_std_file dce c.cl_module.m_extra.m_file || has_meta Meta.Dce c.cl_meta)
|| super_forces_keep c
|| (match c with
| { cl_path = ([],("Math"|"Array"))} when dce.com.platform = Js -> false
| { cl_extern = true }
| { cl_path = ["flash";"_Boot"],"RealBoot" } -> true
| { cl_path = [],"String" }
| { cl_path = [],"Array" } -> not (dce.com.platform = Js)
| _ -> false)
let keep_whole_enum dce en =
Meta.has Meta.Keep en.e_meta
|| not (dce.full || is_std_file dce en.e_module.m_extra.m_file || has_meta Meta.Dce en.e_meta)
(* check if a field is kept *)
let keep_field dce cf =
Meta.has Meta.Keep cf.cf_meta
|| Meta.has Meta.Used cf.cf_meta
|| cf.cf_name = "__init__"
(* marking *)
let rec check_feature dce s =
try
let l = Hashtbl.find dce.features s in
List.iter (fun (c,cf,stat) ->
mark_field dce c cf stat
) l;
Hashtbl.remove dce.features s;
with Not_found ->
()
(* mark a field as kept *)
and mark_field dce c cf stat =
let add cf =
if not (Meta.has Meta.Used cf.cf_meta) then begin
cf.cf_meta <- (Meta.Used,[],cf.cf_pos) :: cf.cf_meta;
dce.added_fields <- (c,cf,stat) :: dce.added_fields;
dce.marked_fields <- cf :: dce.marked_fields;
check_feature dce (Printf.sprintf "%s.%s" (s_type_path c.cl_path) cf.cf_name);
end
in
if cf.cf_name = "new" then begin
let rec loop c = match c.cl_super with
| None -> ()
| Some (csup,_) ->
begin match csup.cl_constructor with
| None -> ()
| Some cf -> add cf
end;
loop csup
in
loop c
end;
if not (PMap.mem cf.cf_name (if stat then c.cl_statics else c.cl_fields)) then begin
match c.cl_super with
| None -> add cf
| Some (c,_) -> mark_field dce c cf stat
end else
add cf
let rec update_marked_class_fields dce c =
(* mark all :?used fields as surely :used now *)
List.iter (fun cf ->
if Meta.has Meta.MaybeUsed cf.cf_meta then mark_field dce c cf true
) c.cl_ordered_statics;
List.iter (fun cf ->
if Meta.has Meta.MaybeUsed cf.cf_meta then mark_field dce c cf false
) c.cl_ordered_fields;
(* we always have to keep super classes and implemented interfaces *)
(match c.cl_init with None -> () | Some init -> dce.follow_expr dce init);
List.iter (fun (c,_) -> mark_class dce c) c.cl_implements;
(match c.cl_super with None -> () | Some (csup,pl) -> mark_class dce csup)
(* mark a class as kept. If the class has fields marked as @:?keep, make sure to keep them *)
and mark_class dce c = if not (Meta.has Meta.Used c.cl_meta) then begin
c.cl_meta <- (Meta.Used,[],c.cl_pos) :: c.cl_meta;
update_marked_class_fields dce c;
end
let rec mark_enum dce e = if not (Meta.has Meta.Used e.e_meta) then begin
e.e_meta <- (Meta.Used,[],e.e_pos) :: e.e_meta;
PMap.iter (fun _ ef -> mark_t dce ef.ef_pos ef.ef_type) e.e_constrs;
end
and mark_abstract dce a = if not (Meta.has Meta.Used a.a_meta) then
a.a_meta <- (Meta.Used,[],a.a_pos) :: a.a_meta
(* mark a type as kept *)
and mark_t dce p t =
if not (List.exists (fun t2 -> Type.fast_eq t t2) dce.t_stack) then begin
dce.t_stack <- t :: dce.t_stack;
begin match follow t with
| TInst({cl_kind = KTypeParameter tl} as c,pl) ->
if not (Meta.has Meta.Used c.cl_meta) then begin
c.cl_meta <- (Meta.Used,[],c.cl_pos) :: c.cl_meta;
List.iter (mark_t dce p) tl;
end;
List.iter (mark_t dce p) pl
| TInst(c,pl) ->
mark_class dce c;
List.iter (mark_t dce p) pl
| TFun(args,ret) ->
List.iter (fun (_,_,t) -> mark_t dce p t) args;
mark_t dce p ret
| TEnum(e,pl) ->
mark_enum dce e;
List.iter (mark_t dce p) pl
| TAbstract(a,pl) when Meta.has Meta.MultiType a.a_meta ->
begin try
mark_t dce p (snd (Codegen.Abstract.find_multitype_specialization a pl p))
with Typecore.Error _ ->
()
end
| TAbstract(a,pl) ->
mark_abstract dce a;
List.iter (mark_t dce p) pl
| TLazy _ | TDynamic _ | TAnon _ | TType _ | TMono _ -> ()
end;
dce.t_stack <- List.tl dce.t_stack
end
let mark_mt dce mt = match mt with
| TClassDecl c ->
mark_class dce c;
| TEnumDecl e ->
mark_enum dce e
| TAbstractDecl a ->
(* abstract 'feature' is defined as the abstract type beeing used as a value, not as a type *)
if not (Meta.has Meta.ValueUsed a.a_meta) then a.a_meta <- (Meta.ValueUsed,[],a.a_pos) :: a.a_meta;
mark_abstract dce a
| TTypeDecl _ ->
()
(* find all dependent fields by checking implementing/subclassing types *)
let rec mark_dependent_fields dce csup n stat =
List.iter (fun mt -> match mt with
| TClassDecl c when is_parent csup c ->
let rec loop c =
(try
let cf = PMap.find n (if stat then c.cl_statics else c.cl_fields) in
(* if it's clear that the class is kept, the field has to be kept as well. This is also true for
extern interfaces because we cannot remove fields from them *)
if Meta.has Meta.Used c.cl_meta || (csup.cl_interface && csup.cl_extern) then mark_field dce c cf stat
(* otherwise it might be kept if the class is kept later, so mark it as :?used *)
else if not (Meta.has Meta.MaybeUsed cf.cf_meta) then begin
cf.cf_meta <- (Meta.MaybeUsed,[],cf.cf_pos) :: cf.cf_meta;
dce.marked_maybe_fields <- cf :: dce.marked_maybe_fields;
end
with Not_found ->
(* if the field is not present on current class, it might come from a base class *)
(match c.cl_super with None -> () | Some (csup,_) -> loop csup))
in
loop c
| _ -> ()
) dce.com.types
(* expr and field evaluation *)
let opt f e = match e with None -> () | Some e -> f e
let rec to_string dce t = match t with
| TInst(c,tl) ->
field dce c "toString" false;
| TType(tt,tl) ->
if not (List.exists (fun t2 -> Type.fast_eq t t2) dce.ts_stack) then begin
dce.ts_stack <- t :: dce.ts_stack;
to_string dce (apply_params tt.t_types tl tt.t_type)
end
| TAbstract({a_impl = Some c} as a,tl) ->
if Meta.has Meta.CoreType a.a_meta then
field dce c "toString" false
else
to_string dce (Codegen.Abstract.get_underlying_type a tl)
| TMono r ->
(match !r with
| Some t -> to_string dce t
| _ -> ())
| TLazy f ->
to_string dce (!f())
| TDynamic t ->
if t == t_dynamic then
()
else
to_string dce t
| TEnum _ | TFun _ | TAnon _ | TAbstract({a_impl = None},_) ->
(* if we to_string these it does not imply that we need all its sub-types *)
()
and field dce c n stat =
let find_field n =
if n = "new" then match c.cl_constructor with
| None -> raise Not_found
| Some cf -> cf
else PMap.find n (if stat then c.cl_statics else c.cl_fields)
in
(try
let cf = find_field n in
mark_field dce c cf stat;
with Not_found -> try
(* me might have a property access on an interface *)
let l = String.length n - 4 in
if l < 0 then raise Not_found;
let prefix = String.sub n 0 4 in
let pn = String.sub n 4 l in
let cf = find_field pn in
let keep () =
mark_dependent_fields dce c n stat;
field dce c pn stat
in
(match prefix,cf.cf_kind with
| "get_",Var {v_read = AccCall} when "get_" ^ cf.cf_name = n -> keep()
| "set_",Var {v_write = AccCall} when "set_" ^ cf.cf_name = n -> keep()
| _ -> raise Not_found
);
raise Not_found
with Not_found -> try
if c.cl_interface then begin
let rec loop cl = match cl with
| [] -> raise Not_found
| (c,_) :: cl ->
try field dce c n stat with Not_found -> loop cl
in
loop c.cl_implements
end else match c.cl_super with Some (csup,_) -> field dce csup n stat | None -> raise Not_found
with Not_found -> try
match c.cl_kind with
| KTypeParameter tl ->
let rec loop tl = match tl with
| [] -> raise Not_found
| TInst(c,_) :: cl ->
(try field dce c n stat with Not_found -> loop cl)
| t :: tl ->
loop tl
in
loop tl
| _ -> raise Not_found
with Not_found ->
if dce.debug then prerr_endline ("[DCE] Field " ^ n ^ " not found on " ^ (s_type_path c.cl_path)) else ())
and expr dce e =
mark_t dce e.epos e.etype;
match e.eexpr with
| TNew(c,pl,el) ->
mark_class dce c;
field dce c "new" false;
List.iter (expr dce) el;
List.iter (mark_t dce e.epos) pl;
| TVar (v,e1) ->
opt (expr dce) e1;
mark_t dce e.epos v.v_type;
| TCast(e, Some mt) ->
check_feature dce "typed_cast";
mark_mt dce mt;
expr dce e;
| TTypeExpr mt ->
mark_mt dce mt
| TTry(e, vl) ->
expr dce e;
List.iter (fun (v,e) ->
if v.v_type != t_dynamic then check_feature dce "typed_catch";
expr dce e;
mark_t dce e.epos v.v_type;
) vl;
| TCall ({eexpr = TLocal ({v_name = "__define_feature__"})},[{eexpr = TConst (TString ft)};e]) ->
Common.add_feature dce.com ft;
check_feature dce ft;
expr dce e
(* keep toString method when the class is argument to Std.string or haxe.Log.trace *)
| TCall ({eexpr = TField({eexpr = TTypeExpr (TClassDecl ({cl_path = (["haxe"],"Log")} as c))},FStatic (_,{cf_name="trace"}))} as ef, ((e2 :: el) as args))
| TCall ({eexpr = TField({eexpr = TTypeExpr (TClassDecl ({cl_path = ([],"Std")} as c))},FStatic (_,{cf_name="string"}))} as ef, ((e2 :: el) as args)) ->
mark_class dce c;
to_string dce e2.etype;
begin match el with
| [{eexpr = TObjectDecl fl}] ->
begin try
begin match List.assoc "customParams" fl with
| {eexpr = TArrayDecl el} ->
List.iter (fun e -> to_string dce e.etype) el
| _ ->
()
end
with Not_found ->
()
end
| _ ->
()
end;
expr dce ef;
List.iter (expr dce) args;
| TCall ({eexpr = TConst TSuper} as e,el) ->
mark_t dce e.epos e.etype;
List.iter (expr dce) el;
| TField(e,fa) ->
begin match fa with
| FStatic(c,cf) ->
mark_class dce c;
mark_field dce c cf true;
| FInstance(c,cf) ->
mark_class dce c;
mark_field dce c cf false;
| _ ->
let n = field_name fa in
begin match follow e.etype with
| TInst(c,_) ->
mark_class dce c;
field dce c n false;
| TAnon a ->
(match !(a.a_status) with
| Statics c ->
mark_class dce c;
field dce c n true;
| _ -> ())
| _ -> ()
end;
end;
expr dce e;
| TThrow e ->
to_string dce e.etype;
expr dce e
| _ ->
Type.iter (expr dce) e
let run com main full =
let dce = {
com = com;
full = full;
std_dirs = if full then [] else List.map Common.unique_full_path com.std_path;
debug = Common.defined com Define.DceDebug;
added_fields = [];
follow_expr = expr;
marked_fields = [];
marked_maybe_fields = [];
t_stack = [];
ts_stack = [];
features = Hashtbl.create 0;
} in
begin match main with
| Some {eexpr = TCall({eexpr = TField(e,(FStatic(c,cf)))},_)} ->
cf.cf_meta <- (Meta.Keep,[],cf.cf_pos) :: cf.cf_meta
| _ ->
()
end;
List.iter (fun m ->
List.iter (fun (s,v) ->
if Hashtbl.mem dce.features s then Hashtbl.replace dce.features s (v :: Hashtbl.find dce.features s)
else Hashtbl.add dce.features s [v]
) m.m_extra.m_features;
) com.modules;
(* first step: get all entry points, which is the main method and all class methods which are marked with @:keep *)
List.iter (fun t -> match t with
| TClassDecl c ->
let keep_class = keep_whole_class dce c && (not c.cl_extern || c.cl_interface) in
let loop stat cf =
if keep_class || keep_field dce cf then mark_field dce c cf stat
in
List.iter (loop true) c.cl_ordered_statics;
List.iter (loop false) c.cl_ordered_fields;
begin match c.cl_constructor with
| Some cf -> loop false cf
| None -> ()
end
| TEnumDecl en when keep_whole_enum dce en ->
mark_enum dce en
| _ ->
()
) com.types;
if dce.debug then begin
List.iter (fun (c,cf,_) -> match cf.cf_expr with
| None -> ()
| Some _ -> print_endline ("[DCE] Entry point: " ^ (s_type_path c.cl_path) ^ "." ^ cf.cf_name)
) dce.added_fields;
end;
(* second step: initiate DCE passes and keep going until no new fields were added *)
let rec loop () =
match dce.added_fields with
| [] -> ()
| cfl ->
dce.added_fields <- [];
(* extend to dependent (= overriding/implementing) class fields *)
List.iter (fun (c,cf,stat) -> mark_dependent_fields dce c cf.cf_name stat) cfl;
(* mark fields as used *)
List.iter (fun (c,cf,stat) ->
mark_class dce c;
mark_field dce c cf stat;
mark_t dce cf.cf_pos cf.cf_type
) cfl;
(* follow expressions to new types/fields *)
List.iter (fun (_,cf,_) ->
opt (expr dce) cf.cf_expr;
List.iter (fun cf -> if cf.cf_expr <> None then opt (expr dce) cf.cf_expr) cf.cf_overloads
) cfl;
loop ()
in
loop ();
(* third step: filter types *)
let rec loop acc types =
match types with
| (TClassDecl c) as mt :: l when keep_whole_class dce c ->
loop (mt :: acc) l
| (TClassDecl c) as mt :: l ->
let check_property cf stat =
let add_accessor_metadata cf =
if not (Meta.has Meta.Accessor cf.cf_meta) then cf.cf_meta <- (Meta.Accessor,[],c.cl_pos) :: cf.cf_meta
in
begin match cf.cf_kind with
| Var {v_read = AccCall} ->
begin try
add_accessor_metadata (PMap.find ("get_" ^ cf.cf_name) (if stat then c.cl_statics else c.cl_fields))
with Not_found ->
()
end
| _ ->
()
end;
begin match cf.cf_kind with
| Var {v_write = AccCall} ->
begin try
add_accessor_metadata (PMap.find ("set_" ^ cf.cf_name) (if stat then c.cl_statics else c.cl_fields))
with Not_found ->
()
end
| _ ->
()
end;
in
(* add :keep so subsequent filter calls do not process class fields again *)
c.cl_meta <- (Meta.Keep,[],c.cl_pos) :: c.cl_meta;
c.cl_ordered_statics <- List.filter (fun cf ->
let b = keep_field dce cf in
if not b then begin
if dce.debug then print_endline ("[DCE] Removed field " ^ (s_type_path c.cl_path) ^ "." ^ (cf.cf_name));
check_property cf true;
c.cl_statics <- PMap.remove cf.cf_name c.cl_statics;
end;
b
) c.cl_ordered_statics;
c.cl_ordered_fields <- List.filter (fun cf ->
let b = keep_field dce cf in
if not b then begin
if dce.debug then print_endline ("[DCE] Removed field " ^ (s_type_path c.cl_path) ^ "." ^ (cf.cf_name));
check_property cf false;
c.cl_fields <- PMap.remove cf.cf_name c.cl_fields;
end;
b
) c.cl_ordered_fields;
(match c.cl_constructor with Some cf when not (keep_field dce cf) -> c.cl_constructor <- None | _ -> ());
(* we keep a class if it was used or has a used field *)
if Meta.has Meta.Used c.cl_meta || c.cl_ordered_statics <> [] || c.cl_ordered_fields <> [] then loop (mt :: acc) l else begin
(match c.cl_init with
| Some f when Meta.has Meta.KeepInit c.cl_meta ->
(* it means that we only need the __init__ block *)
c.cl_extern <- true;
loop (mt :: acc) l
| _ ->
if dce.debug then print_endline ("[DCE] Removed class " ^ (s_type_path c.cl_path));
loop acc l)
end
| (TEnumDecl en) as mt :: l when Meta.has Meta.Used en.e_meta || en.e_extern || keep_whole_enum dce en ->
loop (mt :: acc) l
| TEnumDecl e :: l ->
if dce.debug then print_endline ("[DCE] Removed enum " ^ (s_type_path e.e_path));
loop acc l
| mt :: l ->
loop (mt :: acc) l
| [] ->
acc
in
com.types <- loop [] (List.rev com.types);
(* extra step to adjust properties that had accessors removed (required for Php and Cpp) *)
List.iter (fun mt -> match mt with
| (TClassDecl c) ->
let rec has_accessor c n stat =
PMap.mem n (if stat then c.cl_statics else c.cl_fields)
|| match c.cl_super with Some (csup,_) -> has_accessor csup n stat | None -> false
in
let check_prop stat cf =
(match cf.cf_kind with
| Var {v_read = AccCall; v_write = a} ->
let s = "get_" ^ cf.cf_name in
cf.cf_kind <- Var {v_read = if has_accessor c s stat then AccCall else AccNever; v_write = a}
| _ -> ());
(match cf.cf_kind with
| Var {v_write = AccCall; v_read = a} ->
let s = "set_" ^ cf.cf_name in
cf.cf_kind <- Var {v_write = if has_accessor c s stat then AccCall else AccNever; v_read = a}
| _ -> ())
in
List.iter (check_prop true) c.cl_ordered_statics;
List.iter (check_prop false) c.cl_ordered_fields;
| _ -> ()
) com.types;
(* remove "override" from fields that do not override anything anymore *)
List.iter (fun mt -> match mt with
| TClassDecl c ->
c.cl_overrides <- List.filter (fun s ->
let rec loop c =
match c.cl_super with
| Some (csup,_) when PMap.mem s.cf_name csup.cl_fields -> true
| Some (csup,_) -> loop csup
| None -> false
in
loop c
) c.cl_overrides;
| _ -> ()
) com.types;
(* cleanup added fields metadata - compatibility with compilation server *)
let rec remove_meta m = function
| [] -> []
| (m2,_,_) :: l when m = m2 -> l
| x :: l -> x :: remove_meta m l
in
List.iter (fun cf -> cf.cf_meta <- remove_meta Meta.Used cf.cf_meta) dce.marked_fields;
List.iter (fun cf -> cf.cf_meta <- remove_meta Meta.MaybeUsed cf.cf_meta) dce.marked_maybe_fields;