-
Notifications
You must be signed in to change notification settings - Fork 36
/
compile.rs
2041 lines (1944 loc) · 77.7 KB
/
compile.rs
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
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use crate::builtins;
use crate::bytecode;
use crate::cfg::{self, is_unused, Function, Ident, PrimExpr, PrimStmt, PrimVal, ProgramContext};
use crate::codegen;
#[cfg(feature = "llvm_backend")]
use crate::codegen::llvm;
use crate::common::{
CancelSignal, CompileError, Either, Graph, NodeIx, NumTy, Result, Stage, WorkList,
};
use crate::cross_stage;
use crate::input_taint::TaintedStringAnalysis;
use crate::pushdown::{FieldSet, UsedFieldAnalysis};
use crate::runtime::{self, Str};
use crate::string_constants::{self, StringConstantAnalysis};
use crate::types;
use hashbrown::{hash_map::Entry, HashMap, HashSet};
use regex::bytes::Regex;
use smallvec::smallvec;
use std::collections::VecDeque;
use std::mem;
use std::sync::Arc;
pub(crate) const UNUSED: u32 = u32::max_value();
pub(crate) const NULL_REG: u32 = UNUSED - 1;
#[derive(Copy, Clone, Eq, PartialEq, Debug, Hash, Default)]
pub(crate) enum Ty {
Int = 0,
Float = 1,
Str = 2,
MapIntInt = 3,
MapIntFloat = 4,
MapIntStr = 5,
MapStrInt = 6,
MapStrFloat = 7,
MapStrStr = 8,
IterInt = 9,
IterStr = 10,
#[default]
Null = 11,
}
pub(crate) const NUM_TYPES: usize = Ty::Null as usize + 1;
impl std::convert::TryFrom<u32> for Ty {
type Error = ();
fn try_from(u: u32) -> std::result::Result<Ty, ()> {
use Ty::*;
Ok(match u {
0 => Int,
1 => Float,
2 => Str,
3 => MapIntInt,
4 => MapIntFloat,
5 => MapIntStr,
6 => MapStrInt,
7 => MapStrFloat,
8 => MapStrStr,
9 => IterInt,
10 => IterStr,
11 => Null,
_ => return Err(()),
})
}
}
impl Ty {
fn is_iter(self) -> bool {
matches!(self, Ty::IterInt | Ty::IterStr)
}
pub(crate) fn key_iter(self) -> Result<Ty> {
use Ty::*;
match self {
MapIntInt | MapIntFloat | MapIntStr => Ok(IterInt),
MapStrInt | MapStrFloat | MapStrStr => Ok(IterStr),
Null | Int | Float | Str | IterInt | IterStr => {
err!("attempt to get iterator from non-map type: {:?}", self)
}
}
}
pub(crate) fn iter(self) -> Result<Ty> {
use Ty::*;
match self {
IterInt => Ok(Int),
IterStr => Ok(Str),
Null | Int | Float | Str | MapIntInt | MapIntFloat | MapIntStr | MapStrInt
| MapStrFloat | MapStrStr => {
err!("attempt to get element of non-iterator type: {:?}", self)
}
}
}
pub(crate) fn is_array(self) -> bool {
use Ty::*;
match self {
MapIntInt | MapIntFloat | MapIntStr | MapStrInt | MapStrFloat | MapStrStr => true,
Null | Int | Float | Str | IterInt | IterStr => false,
}
}
pub(crate) fn key(self) -> Result<Ty> {
use Ty::*;
match self {
MapIntInt | MapIntFloat | MapIntStr => Ok(Int),
MapStrInt | MapStrFloat | MapStrStr => Ok(Str),
Null | Int | Float | Str | IterInt | IterStr => {
err!("attempt to get key of non-map type: {:?}", self)
}
}
}
pub(crate) fn val(self) -> Result<Ty> {
use Ty::*;
match self {
MapStrInt | MapIntInt => Ok(Int),
MapStrFloat | MapIntFloat => Ok(Float),
MapStrStr | MapIntStr => Ok(Str),
Null | Int | Float | Str | IterInt | IterStr => {
err!("attempt to get val of non-map type: {:?}", self)
}
}
}
}
fn visit_used_fields(stmt: &Instr, cur_func_id: NumTy, ufa: &mut UsedFieldAnalysis) {
match stmt {
Either::Left(l) => ufa.visit_ll(l),
Either::Right(r) => ufa.visit_hl(cur_func_id, r),
}
}
fn visit_taint_analysis(stmt: &Instr, func_id: NumTy, tsa: &mut TaintedStringAnalysis) {
match stmt {
Either::Left(ll) => tsa.visit_ll(ll),
Either::Right(hl) => tsa.visit_hl(func_id, hl),
}
}
fn visit_string_constant_analysis<'a>(
stmt: &Instr<'a>,
func_id: NumTy,
sca: &mut StringConstantAnalysis<'a>,
) {
match stmt {
Either::Left(ll) => sca.visit_ll(ll),
Either::Right(hl) => sca.visit_hl(func_id, hl),
}
}
pub(crate) fn bytecode<'a, LR: runtime::LineReader>(
ctx: &mut cfg::ProgramContext<'a, &'a str>,
reader: LR,
ff: impl runtime::writers::FileFactory,
num_workers: usize,
) -> Result<bytecode::Interp<'a, LR>> {
Typer::init_from_ctx(ctx)?.to_interp(reader, ff, num_workers)
}
#[cfg(test)]
pub(crate) fn context_compiles<'a>(ctx: &mut cfg::ProgramContext<'a, &'a str>) -> Result<()> {
Typer::init_from_ctx(ctx)?;
Ok(())
}
#[cfg(test)]
pub(crate) fn used_fields<'a>(ctx: &mut cfg::ProgramContext<'a, &'a str>) -> Result<FieldSet> {
Ok(Typer::init_from_ctx(ctx)?.used_fields)
}
#[cfg(feature = "llvm_backend")]
pub(crate) fn dump_llvm<'a>(
ctx: &mut cfg::ProgramContext<'a, &'a str>,
cfg: llvm::Config,
) -> Result<String> {
use llvm::Generator;
let mut typer = Typer::init_from_ctx(ctx)?;
unsafe {
let mut gen = Generator::init(&mut typer, cfg)?;
gen.dump_module()
}
}
#[cfg(all(test, feature = "llvm_backend", feature = "unstable"))]
pub(crate) fn compile_llvm<'a>(
ctx: &mut cfg::ProgramContext<'a, &'a str>,
cfg: llvm::Config,
) -> Result<()> {
use llvm::Generator;
let mut typer = Typer::init_from_ctx(ctx)?;
unsafe {
let mut gen = Generator::init(&mut typer, cfg)?;
gen.compile_main()
}
}
#[cfg(feature = "llvm_backend")]
pub(crate) fn run_llvm<'a>(
ctx: &mut cfg::ProgramContext<'a, &'a str>,
reader: impl codegen::intrinsics::IntoRuntime,
ff: impl runtime::writers::FileFactory,
cfg: llvm::Config,
cancel_signal: CancelSignal,
) -> Result<()> {
use llvm::Generator;
let mut typer = Typer::init_from_ctx(ctx)?;
let used_fields = typer.used_fields.clone();
let named_cols = typer.named_columns.take();
unsafe {
let gen = Generator::init(&mut typer, cfg)?;
codegen::run_main(
gen,
reader,
ff,
&used_fields,
named_cols,
cfg.num_workers,
cancel_signal,
)
}
}
pub(crate) fn run_cranelift<'a>(
ctx: &mut cfg::ProgramContext<'a, &'a str>,
reader: impl codegen::intrinsics::IntoRuntime,
ff: impl runtime::writers::FileFactory,
cfg: codegen::Config,
cancel_signal: CancelSignal,
) -> Result<()> {
use codegen::clif::Generator;
let mut typer = Typer::init_from_ctx(ctx)?;
let used_fields = typer.used_fields.clone();
let named_cols = typer.named_columns.take();
unsafe {
let gen = Generator::init(&mut typer, cfg)?;
codegen::run_main(
gen,
reader,
ff,
&used_fields,
named_cols,
cfg.num_workers,
cancel_signal,
)
}
}
type SmallVec<T> = smallvec::SmallVec<[T; 2]>;
#[derive(Debug)]
pub(crate) enum HighLevel {
// TODO we may not strictly need Call's dst_ty and Ret's Ty field. Other information may have
// it available.
Call {
func_id: NumTy, /* monomorphized function id */
dst_reg: NumTy,
dst_ty: Ty,
args: SmallVec<(NumTy, Ty)>,
},
Ret(NumTy, Ty),
Phi(NumTy, Ty, SmallVec<(NodeIx /*pred*/, NumTy /*register*/)>),
DropIter(NumTy, Ty),
}
#[derive(Default)]
struct Registers {
stats: RegStatuses,
globals: HashMap<Ident, (u32, Ty)>,
}
#[derive(Debug, Copy, Clone)]
enum RegStatus {
Local,
Global,
Ret,
}
#[derive(Default, Debug)]
struct RegStatuses([Vec<RegStatus>; NUM_TYPES]);
impl RegStatuses {
fn reg_of_ty(&mut self, ty: Ty) -> NumTy {
self.new_reg(ty, RegStatus::Local)
}
fn new_reg(&mut self, ty: Ty, status: RegStatus) -> NumTy {
if let Ty::Null = ty {
return NULL_REG;
}
let v = &mut self.0[ty as usize];
let res = v.len();
v.push(status);
res as NumTy
}
fn count(&self, ty: Ty) -> NumTy {
self.0[ty as usize].len() as NumTy
}
fn get_status(&self, reg: NumTy, ty: Ty) -> RegStatus {
if ty == Ty::Null {
return RegStatus::Local;
}
self.0[ty as usize][reg as usize]
}
}
#[derive(Default)]
pub(crate) struct Node<'a> {
pub insts: VecDeque<Instr<'a>>,
pub exit: bool,
}
pub(crate) type LL<'a> = bytecode::Instr<'a>;
type Instr<'a> = Either<LL<'a>, HighLevel>;
type Cfg<'a> = Graph<Node<'a>, Option<NumTy /* Int register */>>;
type CallGraph = Graph<HashSet<(NumTy, Ty)>, ()>;
// Typer contains much of the state necessary for generating a typed CFG, which in turn can
// generate bytecode or LLVM.
#[derive(Default)]
pub(crate) struct Typer<'a> {
regs: Registers,
id_map: HashMap<
// TODO: make newtypes for these different Ids?
(
NumTy, /* cfg-level func id */
SmallVec<Ty>, /* arg types */
),
NumTy, /* bytecode-level func id */
>,
arity: HashMap<NumTy /* cfg-level func id */, NumTy>,
local_globals: HashSet<NumTy>,
// Why not just store FuncInfo's fields in a Frame?
// We access Frames one at a time (through a View); but we need access to function arity and
// return types across individual views. We expose these fields in a separate type immutably to
// facilitate that.
//
// Another option would be to pass a mutable reference to `frames` for all of bytecode-building
// functions below, but then each access to frame would have the form of
// self.frames[current_index], which is marginally less efficient and (more importantly)
// error-prone.
pub func_info: Vec<FuncInfo>,
pub frames: Vec<Frame<'a>>,
pub main_offset: Stage<usize>,
// For projection pushdown
used_fields: FieldSet,
// The fields referenced by name via the FI builtin variable
named_columns: Option<Vec<&'a [u8]>>,
// For rejecting suspcicious programs with commands.
taint_analysis: Option<TaintedStringAnalysis>,
// For analysis passes that introspect into the set of constant string values that will
// dynamically be assigned to a register
string_constants: Option<StringConstantAnalysis<'a>>,
// Not used for bytecode generation.
callgraph: Graph<HashSet<(NumTy, Ty)>, ()>,
// The global variables referenced (transitively) by each function. This is used both for
// cross-stage state propagation for parallel execution, as well as for implementing global
// variables in the LLVM backend. It is computed lazily because these are not needed for
// serial, bytecode-only scripts.
global_refs: Option<Vec<HashSet<(NumTy, Ty)>>>,
}
#[derive(Default)]
struct SlotCounter {
slots: HashMap<(NumTy, Ty), usize>,
counter: HashMap<Ty, usize>,
}
impl SlotCounter {
fn get_slot(&mut self, reg: (NumTy, Ty)) -> usize {
if let Some(c) = self.slots.get(®) {
return *c;
}
let ctr = self.counter.entry(reg.1).or_insert(0);
let res = *ctr;
*ctr += 1;
self.slots.insert(reg, res);
res
}
}
#[derive(Debug)]
pub(crate) struct FuncInfo {
pub ret_ty: Ty,
// For bytecode, we pop into each of these registers at the specified type.
pub arg_tys: SmallVec<Ty>,
}
#[derive(Default)]
pub(crate) struct Frame<'a> {
src_function: NumTy,
cur_ident: NumTy,
entry: NodeIx,
exit: NodeIx,
pub locals: HashMap<Ident, (u32, Ty)>,
pub arg_regs: SmallVec<NumTy>,
pub cfg: Cfg<'a>,
pub is_called: bool,
}
impl<'a> Frame<'a> {
fn load_slots(
&mut self,
regs: impl Iterator<Item = (NumTy, Ty)>,
ctr: &mut SlotCounter,
) -> Result<()> {
let stream = self.cfg.node_weight_mut(self.entry).unwrap();
for reg in regs {
let slot = ctr.get_slot(reg);
if let Some(inst) = cross_stage::load_slot_instr(reg.0, reg.1, slot)? {
stream.insts.push_front(Either::Left(inst))
}
}
Ok(())
}
fn store_slots(
&mut self,
regs: impl Iterator<Item = (NumTy, Ty)>,
ctr: &mut SlotCounter,
) -> Result<()> {
let stream = self.cfg.node_weight_mut(self.exit).unwrap();
for reg in regs {
let slot = ctr.get_slot(reg);
if let Some(inst) = cross_stage::store_slot_instr(reg.0, reg.1, slot)? {
stream.insts.push_front(Either::Left(inst))
}
}
Ok(())
}
}
struct View<'a, 'b> {
frame: &'b mut Frame<'a>,
regs: &'b mut Registers,
cg: &'b mut CallGraph,
id_map: &'b HashMap<(NumTy, SmallVec<Ty>), NumTy>,
local_globals: &'b HashSet<NumTy>,
arity: &'b HashMap<NumTy, NumTy>,
func_info: &'b Vec<FuncInfo>,
// The current basic block being filled; It'll be swapped into `frame.cfg` as we translate a
// given function cfg.
stream: &'b mut Node<'a>,
}
fn pop_var(instrs: &mut Vec<LL>, reg: NumTy, ty: Ty) -> Result<()> {
use Ty::*;
instrs.push(match ty {
Null => return Ok(()),
IterInt | IterStr => return err!("invalid argument type: {:?}", ty),
Int | Float | Str | MapIntInt | MapIntFloat | MapIntStr | MapStrInt | MapStrFloat
| MapStrStr => LL::Pop(ty, reg),
});
Ok(())
}
fn push_var(instrs: &mut Vec<LL>, reg: NumTy, ty: Ty) -> Result<()> {
use Ty::*;
match ty {
Null => Ok(()),
Int | Float | Str | MapIntInt | MapIntFloat | MapIntStr | MapStrInt | MapStrFloat
| MapStrStr => {
instrs.push(LL::Push(ty, reg));
Ok(())
}
IterInt | IterStr => err!("invalid argument type: {:?}", ty),
}
}
fn alloc_local<'a>(dst_reg: NumTy, dst_ty: Ty) -> Option<LL<'a>> {
use Ty::*;
match dst_ty {
MapIntInt | MapIntFloat | MapIntStr | MapStrInt | MapStrFloat | MapStrStr => {
Some(LL::AllocMap(dst_ty, dst_reg))
}
_ => None,
}
}
fn mov<'a>(dst_reg: u32, src_reg: u32, ty: Ty) -> Result<Option<LL<'a>>> {
use Ty::*;
if dst_reg == UNUSED || src_reg == UNUSED {
return Ok(None);
}
let res = match ty {
Null => return Ok(None),
IterInt | IterStr => return err!("attempt to move values of type {:?}", ty),
Int | Float | Str | MapIntInt | MapIntFloat | MapIntStr | MapStrInt | MapStrFloat
| MapStrStr => LL::Mov(ty, dst_reg, src_reg),
};
Ok(Some(res))
}
fn accum(inst: &Instr, mut f: impl FnMut(NumTy, Ty)) {
use {Either::*, HighLevel::*};
match inst {
Left(ll) => ll.accum(f),
Right(Call {
dst_reg,
dst_ty,
args,
..
}) => {
f(*dst_reg, *dst_ty);
for (reg, ty) in args.iter().cloned() {
f(reg, ty)
}
}
Right(Ret(reg, ty)) | Right(Phi(reg, ty, _)) | Right(DropIter(reg, ty)) => f(*reg, *ty),
}
}
impl<'a> Typer<'a> {
pub fn stage(&self) -> Stage<usize> {
self.main_offset.clone()
}
#[allow(clippy::wrong_self_convention)]
fn to_interp<LR: runtime::LineReader>(
&mut self,
reader: LR,
ff: impl runtime::writers::FileFactory,
num_workers: usize,
) -> Result<bytecode::Interp<'a, LR>> {
let instrs = self.to_bytecode()?;
let cols = self.named_columns.take();
Ok(bytecode::Interp::new(
instrs,
self.stage(),
num_workers,
|ty| self.regs.stats.count(ty) as usize,
reader,
ff,
&self.used_fields,
cols,
))
}
// At initialization time, we generate Either<LL, HL>, this function lowers the HL into LL.
#[allow(clippy::wrong_self_convention)]
fn to_bytecode(&mut self) -> Result<Vec<Vec<LL<'a>>>> {
let mut res = vec![vec![]; self.frames.len()];
let ret_regs: Vec<_> = (0..self.frames.len())
.map(|i| {
let ret_ty = self.func_info[i].ret_ty;
self.regs.stats.new_reg(ret_ty, RegStatus::Ret)
})
.collect();
let mut bb_map: Vec<usize> = Vec::new();
let mut jmps: Vec<usize> = Vec::new();
// If we wanted to, we could colocate locals and args, but absent a serious performance
// issue this seems cleaner.
let mut args: Vec<(NumTy, Ty)> = Vec::new();
let mut locals: Vec<(NumTy, Ty)> = Vec::new();
for (i, frame) in self.frames.iter().enumerate() {
if !frame.is_called {
continue;
}
let instrs = &mut res[i];
bb_map.clear();
bb_map.reserve(frame.cfg.node_count());
jmps.clear();
// Start by popping any args off of the stack.
args.extend(
frame
.arg_regs
.iter()
.cloned()
.zip(self.func_info[i].arg_tys.iter().cloned()),
);
args.reverse();
// Some local variables (maps, at time of writing) must be explicitly reallocated to
// handle the case where no value is passed as an argument. We do this before popping
// variables to ensure arguments are propagated if they are passed.
//
// This system currently is not shared with the LLVM backend, as both strings and maps
// have to be allocated there. It is possible that the two codepaths could be merged at
// some point.
for instr in frame
.locals
.values()
.cloned()
.flat_map(|(reg, ty)| alloc_local(reg, ty).into_iter())
{
instrs.push(instr);
}
for (a_reg, a_ty) in args.drain(..) {
pop_var(instrs, a_reg, a_ty)?;
}
for (j, n) in frame.cfg.raw_nodes().iter().enumerate() {
bb_map.push(instrs.len());
use HighLevel::*;
for stmt in &n.weight.insts {
match stmt {
Either::Left(ll) => instrs.push(ll.clone()),
Either::Right(Call {
func_id,
dst_reg,
dst_ty,
args,
}) => {
// args have already been normalized, and return type already matches.
// All we need to do is push local variables (to avoid clobbers) and
// push args onto the stack.
// NB locals does not contain all of the local registers, though the
// ones it does not cover are "transient" in that we have no way to get
// a handle on them outside of the immediate context in which they are
// constructed (e.g. through reg_of_ty). I believe that means we can
// rule them out as being needed across callsites.
//
// Today, function calls are a bit slow because of all these pushes (we
// have a lot of local variables because we do not reuse registers). We
// may want to optimize this by looking only over variables referenced
// in reachable BBs from the current one.
locals.clear();
locals.extend(frame.locals.values().cloned());
for (reg, ty) in locals.iter().cloned() {
if !ty.is_iter() {
push_var(instrs, reg, ty)?;
}
}
for (reg, ty) in args.iter().cloned() {
assert!(!ty.is_iter());
push_var(instrs, reg, ty)?;
}
let callee = *func_id as usize;
instrs.push(LL::Call(callee));
// Restore local variables
locals.reverse();
for (reg, ty) in locals.iter().cloned() {
if !ty.is_iter() {
pop_var(instrs, reg, ty)?;
}
}
let ret_reg = ret_regs[callee];
debug_assert_eq!(self.func_info[callee].ret_ty, *dst_ty);
if let Some(inst) = mov(*dst_reg, ret_reg, *dst_ty)? {
instrs.push(inst);
}
}
Either::Right(Ret(reg, ty)) => {
debug_assert_eq!(self.func_info[i].ret_ty, *ty);
if let Some(inst) = mov(ret_regs[i], *reg, *ty)? {
instrs.push(inst);
}
instrs.push(LL::Ret);
}
// handles by the predecessor.
Either::Right(Phi(_, _, _)) => {}
// we do not explicitly drop iterators in the bytecode interpreter.
Either::Right(DropIter(_, _)) => {}
}
}
let ix = NodeIx::new(j);
// Now handle phi nodes
for neigh in frame.cfg.neighbors(ix) {
for stmt in &frame.cfg.node_weight(neigh).unwrap().insts {
if let Either::Right(Phi(reg, ty, preds)) = stmt {
for (pred, src_reg) in preds.iter() {
if pred == &ix {
if let Some(inst) = mov(*reg, *src_reg, *ty)? {
instrs.push(inst);
}
break;
}
}
} else {
// Phis are all at the top;
break;
}
}
}
// And then jumps
let mut walker = frame.cfg.neighbors(ix).detach();
let mut edges = SmallVec::new();
while let Some(eix) = walker.next_edge(&frame.cfg) {
edges.push(eix)
}
edges.reverse();
for eix in edges.iter().cloned() {
let dst = frame.cfg.edge_endpoints(eix).unwrap().1.index();
if let Some(reg) = *frame.cfg.edge_weight(eix).unwrap() {
jmps.push(instrs.len());
instrs.push(LL::JmpIf(reg.into(), dst.into()));
} else if dst != j + 1 {
jmps.push(instrs.len());
instrs.push(LL::Jmp(dst.into()));
}
}
}
// Now rewrite jumps
for j in jmps.iter() {
match &mut instrs[*j] {
LL::Jmp(bb) | LL::JmpIf(_, bb) => *bb = bb_map[bb.0].into(),
_ => unreachable!(),
}
}
}
Ok(res)
}
fn init_from_ctx(pc: &mut ProgramContext<'a, &'a str>) -> Result<Typer<'a>> {
// Type-check the code, then initialize a Typer, assigning registers to local
// and global variables.
let mut gen = Typer::default();
if !pc.allow_arbitrary_commands {
gen.taint_analysis = Some(Default::default());
}
if pc.fold_regex_constants || pc.parse_header {
gen.string_constants = Some(StringConstantAnalysis::from_config(
string_constants::Config {
query_regex: pc.fold_regex_constants,
fi_refs: pc.parse_header,
},
));
}
let types::TypeInfo { var_tys, func_tys } = types::get_types(pc)?;
let local_globals = pc.local_globals();
macro_rules! init_entry {
($v:expr, $func_id:expr, $args:expr) => {
// If this returns None, it seems to mean that the function is never called.
if let Some(ret_ty) = func_tys.get(&($func_id, $args.clone())).cloned() {
let res = gen.frames.len() as NumTy;
$v.insert(res);
let mut f = Frame::default();
f.src_function = $func_id;
f.cur_ident = res;
gen.frames.push(f);
gen.callgraph.add_node(Default::default());
gen.func_info.push(FuncInfo {
ret_ty,
arg_tys: $args.clone(),
});
}
};
}
for (func_id, func) in pc.funcs.iter().enumerate() {
let arity = func.args.len() as NumTy;
gen.arity.insert(func_id as NumTy, arity);
if arity == 0 {
let args: SmallVec<_> = Default::default();
if let Entry::Vacant(v) = gen.id_map.entry((func_id as u32, args.clone())) {
init_entry!(v, func_id as u32, args);
}
}
}
for ((id, func_id, args), ty) in var_tys.iter() {
let map = if id.is_global(&local_globals) {
&mut gen.regs.globals
} else {
if let Entry::Vacant(v) = gen.id_map.entry((*func_id, args.clone())) {
init_entry!(v, *func_id, args);
}
&mut gen.frames[gen.id_map[&(*func_id, args.clone())] as usize].locals
};
let reg = gen.regs.stats.new_reg(
*ty,
if id.is_global(&local_globals) {
RegStatus::Global
} else {
RegStatus::Local
},
);
if let Some(old) = map.insert(*id, (reg, *ty)) {
return err!(
"internal error: duplicate entries for same local in types at id={:?}; {:?} vs {:?}",
id,
old,
(reg, *ty)
);
}
}
gen.main_offset = pc
.main_stage()
.map_ref(|o| gen.id_map[&(*o as NumTy, Default::default())] as usize);
gen.local_globals = local_globals;
for frame in gen.frames.iter_mut() {
let src_func = frame.src_function as usize;
let mut stream = Default::default();
View {
frame,
regs: &mut gen.regs,
cg: &mut gen.callgraph,
id_map: &gen.id_map,
arity: &gen.arity,
local_globals: &gen.local_globals,
func_info: &gen.func_info,
stream: &mut stream,
}
.process_function(&pc.funcs[src_func])?;
}
// TODO: mark used frames first and then exclude them from the analyses?
gen.run_analyses()?;
gen.mark_used_frames();
gen.add_slots()?;
Ok(gen)
}
fn run_analyses(&mut self) -> Result<()> {
let mut ufa = UsedFieldAnalysis::default();
let mut refs = SmallVec::new();
for (fix, frame) in self.frames.iter().enumerate() {
for (bbix, bb) in frame.cfg.raw_nodes().iter().enumerate() {
for (stmtix, stmt) in bb.weight.insts.iter().enumerate() {
// not tracking function calls
visit_used_fields(stmt, frame.cur_ident, &mut ufa);
if let Some(tsa) = &mut self.taint_analysis {
visit_taint_analysis(stmt, frame.cur_ident, tsa)
}
if let Some(sca) = &mut self.string_constants {
if sca.cfg().query_regex {
if let Either::Left(LL::IsMatch(_, _, pat))
| Either::Left(LL::Match(_, _, pat)) = stmt
{
refs.push((fix, bbix, stmtix, *pat));
}
}
visit_string_constant_analysis(stmt, frame.cur_ident, sca)
}
}
}
}
self.used_fields = ufa.solve();
if let Some(tsa) = &mut self.taint_analysis {
if !tsa.ok() {
return err!(concat!(
"command potentially containing interpolated user ",
"input detected.\nIf this is a false positive, you can pass the -A flag ",
"to bypass this check."
));
}
}
if let Some(sca) = &mut self.string_constants {
let mut strs = Vec::new();
if sca.cfg().query_regex {
// Fold any regex pattern constants that we see
for (frame, bb, stmt, reg) in refs.into_iter() {
strs.clear();
sca.possible_strings(®, &mut strs);
if strs.len() != 1 {
continue;
}
let text = std::str::from_utf8(strs[0]).map_err(|e| {
CompileError(format!("regex patterns must be valid UTF-8: {}", e))
})?;
let re = Arc::new(Regex::new(text).map_err(|err| {
CompileError(format!("regex parse error during compilation: {}", err))
})?);
// TODO: finish up
let inst = self.frames[frame]
.cfg
.node_weight_mut(NodeIx::new(bb))
.unwrap()
.insts
.get_mut(stmt)
.unwrap();
let new_inst: Instr = match inst {
Either::Left(LL::IsMatch(dst, s, _)) => {
if let Some(bs) = extract_anchored_literal(text) {
Either::Left(LL::StartsWithConst(*dst, *s, bs))
} else {
Either::Left(LL::IsMatchConst(*dst, *s, re))
}
}
Either::Left(LL::Match(dst, s, _)) => {
Either::Left(LL::MatchConst(*dst, *s, re))
}
_ => {
return err!(
"unexpected instruction during regex constant folding: {:?}",
inst
)
}
};
*inst = new_inst;
}
}
if sca.cfg().fi_refs {
strs.clear();
if sca.fi_info(&mut strs) {
self.named_columns = Some(strs);
}
}
}
Ok(())
}
fn mark_used_frames(&mut self) {
use petgraph::visit::Dfs;
for offset in self.main_offset.iter() {
let mut dfs = Dfs::new(&self.callgraph, NodeIx::new(*offset));
while let Some(ix) = dfs.next(&self.callgraph) {
self.frames[ix.index()].is_called = true;
}
}
}
fn add_slots(&mut self) -> Result<()> {
use cross_stage::compute_slots;
let (begin, main_loop, end) = match self.main_offset {
Stage::Main(_) => return Ok(()),
Stage::Par {
begin,
main_loop,
end,
} => (begin, main_loop, end),
};
let global_refs = self.get_global_refs();
let slots = compute_slots(&begin, &main_loop, &end, global_refs);
let mut ctr = SlotCounter::default();
// Begin stores the context of begin_stores
if let Some(off) = begin {
self.frames[off].store_slots(slots.begin_stores.iter().cloned(), &mut ctr)?;
}
if let Some(off) = main_loop {
self.frames[off].load_slots(slots.begin_stores.iter().cloned(), &mut ctr)?;
self.frames[off].store_slots(slots.loop_stores.iter().cloned(), &mut ctr)?;
}
if let Some(off) = end {
self.frames[off].load_slots(slots.loop_stores.iter().cloned(), &mut ctr)?;
}
Ok(())
}
pub(crate) fn get_global_refs(&mut self) -> Vec<HashSet<(NumTy, Ty)>> {
if let Some(globals) = &self.global_refs {
return globals.clone();
}
let mut globals = vec![HashSet::new(); self.frames.len()];
// First, accumulate all the local and global registers referenced in all the functions.
// We need these for LLVM because relevant globals are passed as function parameters, and
// locals need to be allocated explicitly at the top of each function.
for (i, frame) in self.frames.iter().enumerate() {
// Manually borrow fields so that we do not mutably borrow all of `self` in the
// closure.
let stats = &self.regs.stats;
let cg = &mut self.callgraph;
for bb in frame.cfg.raw_nodes() {
for stmt in &bb.weight.insts {
accum(stmt, |reg, ty| {
if reg == UNUSED {
return;
}
match stats.get_status(reg, ty) {
RegStatus::Global => {
cg.node_weight_mut(NodeIx::new(i))
.unwrap()
.insert((reg, ty));
}
RegStatus::Ret | RegStatus::Local => {}
}
});
}
}
}
// We use a simple iterative fixed-point algorithm for computing which globals are
// referenced by a given function. The globals we have found so far only list the globals
// directly referenced by a function, but we need the ones referenced transitively by all
// functions that a given function calls.
//
// TODO I think the traditional technique here is to use a bit set rather than a hash set.
// That's probably the right choice here, because there won't be that many globals and
// global references aren't likely to be sparse (which is the case where hash sets win).
//
// If this ever becomes a problem, that's the obvious optimization to make. Unions for
// bitsets should be a good deal faster than for hash sets so long as the sets are
// sufficiently dense.
let mut wl = WorkList::default();
wl.extend(0..self.frames.len());
while let Some(frame) = wl.pop() {
// All callees of a function inherit its globals.
use petgraph::Direction;
let frame_ix = NodeIx::new(frame);
let mut walker = self
.callgraph
.neighbors_directed(frame_ix, Direction::Incoming)
.detach();
while let Some(callee) = walker.next_node(&self.callgraph) {
if callee == frame_ix {
continue;
}
let (cur_globals, callee_globals) =
self.callgraph.index_twice_mut(frame_ix, callee);
let mut added = false;