forked from nodejs/node
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwasm-debug.cc
More file actions
1323 lines (1159 loc) Β· 51.6 KB
/
wasm-debug.cc
File metadata and controls
1323 lines (1159 loc) Β· 51.6 KB
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
// Copyright 2016 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "src/wasm/wasm-debug.h"
#include <iomanip>
#include <unordered_map>
#include "src/common/assert-scope.h"
#include "src/common/simd128.h"
#include "src/compiler/wasm-compiler.h"
#include "src/debug/debug-evaluate.h"
#include "src/debug/debug.h"
#include "src/execution/frames-inl.h"
#include "src/heap/factory.h"
#include "src/wasm/baseline/liftoff-compiler.h"
#include "src/wasm/baseline/liftoff-register.h"
#include "src/wasm/compilation-environment-inl.h"
#include "src/wasm/module-decoder.h"
#include "src/wasm/std-object-sizes.h"
#include "src/wasm/value-type.h"
#include "src/wasm/wasm-code-manager.h"
#include "src/wasm/wasm-engine.h"
#include "src/wasm/wasm-limits.h"
#include "src/wasm/wasm-module.h"
#include "src/wasm/wasm-objects-inl.h"
#include "src/wasm/wasm-opcodes-inl.h"
#include "src/wasm/wasm-subtyping.h"
#include "src/wasm/wasm-value.h"
#include "src/zone/accounting-allocator.h"
namespace v8 {
namespace internal {
namespace wasm {
namespace {
using ImportExportKey = std::pair<ImportExportKindCode, uint32_t>;
enum ReturnLocation { kAfterBreakpoint, kAfterWasmCall };
Address FindNewPC(WasmFrame* frame, WasmCode* wasm_code, int byte_offset,
ReturnLocation return_location) {
base::Vector<const uint8_t> new_pos_table = wasm_code->source_positions();
DCHECK_LE(0, byte_offset);
// Find the size of the call instruction by computing the distance from the
// source position entry to the return address.
WasmCode* old_code = frame->wasm_code();
int pc_offset = static_cast<int>(frame->pc() - old_code->instruction_start());
base::Vector<const uint8_t> old_pos_table = old_code->source_positions();
SourcePositionTableIterator old_it(old_pos_table);
int call_offset = -1;
while (!old_it.done() && old_it.code_offset() < pc_offset) {
call_offset = old_it.code_offset();
old_it.Advance();
}
DCHECK_LE(0, call_offset);
int call_instruction_size = pc_offset - call_offset;
// If {return_location == kAfterBreakpoint} we search for the first code
// offset which is marked as instruction (i.e. not the breakpoint).
// If {return_location == kAfterWasmCall} we return the last code offset
// associated with the byte offset.
SourcePositionTableIterator it(new_pos_table);
while (!it.done() && it.source_position().ScriptOffset() != byte_offset) {
it.Advance();
}
if (return_location == kAfterBreakpoint) {
while (!it.is_statement()) it.Advance();
DCHECK_EQ(byte_offset, it.source_position().ScriptOffset());
return wasm_code->instruction_start() + it.code_offset() +
call_instruction_size;
}
DCHECK_EQ(kAfterWasmCall, return_location);
int code_offset;
do {
code_offset = it.code_offset();
it.Advance();
} while (!it.done() && it.source_position().ScriptOffset() == byte_offset);
return wasm_code->instruction_start() + code_offset + call_instruction_size;
}
} // namespace
void DebugSideTable::Print(std::ostream& os) const {
os << "Debug side table (" << num_locals_ << " locals, " << entries_.size()
<< " entries):\n";
for (auto& entry : entries_) entry.Print(os);
os << "\n";
}
void DebugSideTable::Entry::Print(std::ostream& os) const {
os << std::setw(6) << std::hex << pc_offset_ << std::dec << " stack height "
<< stack_height_ << " [";
for (auto& value : changed_values_) {
os << " " << value.type.name() << ":";
switch (value.storage) {
case kConstant:
os << "const#" << value.i32_const;
break;
case kRegister:
os << "reg#" << value.reg_code;
break;
case kStack:
os << "stack#" << value.stack_offset;
break;
}
}
os << " ]\n";
}
size_t DebugSideTable::Entry::EstimateCurrentMemoryConsumption() const {
UPDATE_WHEN_CLASS_CHANGES(DebugSideTable::Entry, 32);
return ContentSize(changed_values_);
}
size_t DebugSideTable::EstimateCurrentMemoryConsumption() const {
UPDATE_WHEN_CLASS_CHANGES(DebugSideTable, 32);
size_t result = sizeof(DebugSideTable) + ContentSize(entries_);
for (const Entry& entry : entries_) {
result += entry.EstimateCurrentMemoryConsumption();
}
return result;
}
class DebugInfoImpl {
public:
explicit DebugInfoImpl(NativeModule* native_module)
: native_module_(native_module) {}
DebugInfoImpl(const DebugInfoImpl&) = delete;
DebugInfoImpl& operator=(const DebugInfoImpl&) = delete;
int GetNumLocals(Address pc, Isolate* isolate) {
FrameInspectionScope scope(this, pc, isolate);
if (!scope.is_inspectable()) return 0;
return scope.debug_side_table->num_locals();
}
WasmValue GetLocalValue(int local, Address pc, Address fp,
Address debug_break_fp, Isolate* isolate) {
FrameInspectionScope scope(this, pc, isolate);
return GetValue(scope.debug_side_table, scope.debug_side_table_entry, local,
fp, debug_break_fp, isolate);
}
int GetStackDepth(Address pc, Isolate* isolate) {
FrameInspectionScope scope(this, pc, isolate);
if (!scope.is_inspectable()) return 0;
int num_locals = scope.debug_side_table->num_locals();
int stack_height = scope.debug_side_table_entry->stack_height();
return stack_height - num_locals;
}
WasmValue GetStackValue(int index, Address pc, Address fp,
Address debug_break_fp, Isolate* isolate) {
FrameInspectionScope scope(this, pc, isolate);
int num_locals = scope.debug_side_table->num_locals();
int value_count = scope.debug_side_table_entry->stack_height();
if (num_locals + index >= value_count) return {};
return GetValue(scope.debug_side_table, scope.debug_side_table_entry,
num_locals + index, fp, debug_break_fp, isolate);
}
const WasmFunction& GetFunctionAtAddress(Address pc, Isolate* isolate) {
FrameInspectionScope scope(this, pc, isolate);
auto* module = native_module_->module();
return module->functions[scope.code->index()];
}
// If the frame position is not in the list of breakpoints, return that
// position. Return 0 otherwise.
// This is used to generate a "dead breakpoint" in Liftoff, which is necessary
// for OSR to find the correct return address.
int DeadBreakpoint(WasmFrame* frame, base::Vector<const int> breakpoints) {
const auto& function =
native_module_->module()->functions[frame->function_index()];
int offset = frame->position() - function.code.offset();
if (std::binary_search(breakpoints.begin(), breakpoints.end(), offset)) {
return 0;
}
return offset;
}
// Find the dead breakpoint (see above) for the top wasm frame, if that frame
// is in the function of the given index.
int DeadBreakpoint(int func_index, base::Vector<const int> breakpoints,
Isolate* isolate) {
DebuggableStackFrameIterator it(isolate);
#if !V8_ENABLE_DRUMBRAKE
if (it.done() || !it.is_wasm()) return 0;
#else // !V8_ENABLE_DRUMBRAKE
// TODO(paolosev@microsoft.com) - Implement for Wasm interpreter.
if (it.done() || !it.is_wasm() || it.is_wasm_interpreter_entry()) {
return 0;
}
#endif // !V8_ENABLE_DRUMBRAKE
auto* wasm_frame = WasmFrame::cast(it.frame());
if (static_cast<int>(wasm_frame->function_index()) != func_index) return 0;
return DeadBreakpoint(wasm_frame, breakpoints);
}
WasmCode* RecompileLiftoffWithBreakpoints(int func_index,
base::Vector<const int> offsets,
int dead_breakpoint) {
mutex_.AssertHeld(); // Mutex is held externally.
DCHECK(!v8_flags.wasm_jitless);
ForDebugging for_debugging = offsets.size() == 1 && offsets[0] == 0
? kForStepping
: kWithBreakpoints;
// Check the cache first.
for (auto begin = cached_debugging_code_.begin(), it = begin,
end = cached_debugging_code_.end();
it != end; ++it) {
if (it->func_index == func_index &&
it->breakpoint_offsets.as_vector() == offsets &&
it->dead_breakpoint == dead_breakpoint) {
// Rotate the cache entry to the front (for LRU).
for (; it != begin; --it) std::iter_swap(it, it - 1);
if (for_debugging == kWithBreakpoints) {
// Re-install the code, in case it was replaced in the meantime.
native_module_->ReinstallDebugCode(it->code);
}
return it->code;
}
}
// Recompile the function with Liftoff, setting the new breakpoints.
// Not thread-safe. The caller is responsible for locking {mutex_}.
CompilationEnv env = CompilationEnv::ForModule(native_module_);
const WasmFunction* function = &env.module->functions[func_index];
base::Vector<const uint8_t> wire_bytes = native_module_->wire_bytes();
bool is_shared = env.module->type(function->sig_index).is_shared;
FunctionBody body{function->sig, function->code.offset(),
wire_bytes.begin() + function->code.offset(),
wire_bytes.begin() + function->code.end_offset(),
is_shared};
std::unique_ptr<DebugSideTable> debug_sidetable;
// Debug side tables for stepping are generated lazily.
bool generate_debug_sidetable = for_debugging == kWithBreakpoints;
// If lazy validation is on, we might need to lazily validate here.
if (V8_UNLIKELY(!env.module->function_was_validated(func_index))) {
WasmDetectedFeatures unused_detected_features;
Zone validation_zone(wasm::GetWasmEngine()->allocator(), ZONE_NAME);
DecodeResult validation_result =
ValidateFunctionBody(&validation_zone, env.enabled_features,
env.module, &unused_detected_features, body);
// Handling illegal modules here is tricky. As lazy validation is off by
// default anyway and this is for debugging only, we just crash for now.
CHECK_WITH_MSG(validation_result.ok(),
validation_result.error().message().c_str());
env.module->set_function_validated(func_index);
}
WasmCompilationResult result = ExecuteLiftoffCompilation(
&env, body,
LiftoffOptions{}
.set_func_index(func_index)
.set_for_debugging(for_debugging)
.set_breakpoints(offsets)
.set_dead_breakpoint(dead_breakpoint)
.set_debug_sidetable(generate_debug_sidetable ? &debug_sidetable
: nullptr));
// Liftoff compilation failure is a FATAL error. We rely on complete Liftoff
// support for debugging.
if (!result.succeeded()) FATAL("Liftoff compilation failed");
DCHECK_EQ(generate_debug_sidetable, debug_sidetable != nullptr);
DCHECK_NULL(result.assumptions);
WasmCode* new_code =
native_module_->PublishCode(native_module_->AddCompiledCode(result));
DCHECK(new_code->is_inspectable());
if (generate_debug_sidetable) {
base::MutexGuard lock(&debug_side_tables_mutex_);
DCHECK_EQ(0, debug_side_tables_.count(new_code));
debug_side_tables_.emplace(new_code, std::move(debug_sidetable));
}
// Insert new code into the cache. Insert before existing elements for LRU.
cached_debugging_code_.insert(
cached_debugging_code_.begin(),
CachedDebuggingCode{func_index, base::OwnedCopyOf(offsets),
dead_breakpoint, new_code});
// Increase the ref count (for the cache entry).
new_code->IncRef();
// Remove exceeding element.
if (cached_debugging_code_.size() > kMaxCachedDebuggingCode) {
// Put the code in the surrounding CodeRefScope to delay deletion until
// after the mutex is released.
WasmCodeRefScope::AddRef(cached_debugging_code_.back().code);
cached_debugging_code_.back().code->DecRefOnLiveCode();
cached_debugging_code_.pop_back();
}
DCHECK_GE(kMaxCachedDebuggingCode, cached_debugging_code_.size());
return new_code;
}
void SetBreakpoint(int func_index, int offset, Isolate* isolate) {
// TODO(paolosev@microsoft.com) - Add support for breakpoints in Wasm
// interpreter.
if (v8_flags.wasm_jitless) return;
// Put the code ref scope outside of the mutex, so we don't unnecessarily
// hold the mutex while freeing code.
WasmCodeRefScope wasm_code_ref_scope;
// Hold the mutex while modifying breakpoints, to ensure consistency when
// multiple isolates set/remove breakpoints at the same time.
base::MutexGuard guard(&mutex_);
// offset == 0 indicates flooding and should not happen here.
DCHECK_NE(0, offset);
// Get the set of previously set breakpoints, to check later whether a new
// breakpoint was actually added.
std::vector<int> all_breakpoints = FindAllBreakpoints(func_index);
auto& isolate_data = per_isolate_data_[isolate];
std::vector<int>& breakpoints =
isolate_data.breakpoints_per_function[func_index];
auto insertion_point =
std::lower_bound(breakpoints.begin(), breakpoints.end(), offset);
if (insertion_point != breakpoints.end() && *insertion_point == offset) {
// The breakpoint is already set for this isolate.
return;
}
breakpoints.insert(insertion_point, offset);
DCHECK(std::is_sorted(all_breakpoints.begin(), all_breakpoints.end()));
// Find the insertion position within {all_breakpoints}.
insertion_point = std::lower_bound(all_breakpoints.begin(),
all_breakpoints.end(), offset);
bool breakpoint_exists =
insertion_point != all_breakpoints.end() && *insertion_point == offset;
// If the breakpoint was already set before, then we can just reuse the old
// code. Otherwise, recompile it. In any case, rewrite this isolate's stack
// to make sure that it uses up-to-date code containing the breakpoint.
WasmCode* new_code;
if (breakpoint_exists) {
new_code = native_module_->GetCode(func_index);
} else {
all_breakpoints.insert(insertion_point, offset);
int dead_breakpoint =
DeadBreakpoint(func_index, base::VectorOf(all_breakpoints), isolate);
new_code = RecompileLiftoffWithBreakpoints(
func_index, base::VectorOf(all_breakpoints), dead_breakpoint);
}
UpdateReturnAddresses(isolate, new_code, isolate_data.stepping_frame);
}
std::vector<int> FindAllBreakpoints(int func_index) {
mutex_.AssertHeld(); // Mutex must be held externally.
std::set<int> breakpoints;
for (auto& data : per_isolate_data_) {
auto it = data.second.breakpoints_per_function.find(func_index);
if (it == data.second.breakpoints_per_function.end()) continue;
for (int offset : it->second) breakpoints.insert(offset);
}
return {breakpoints.begin(), breakpoints.end()};
}
void UpdateBreakpoints(int func_index, base::Vector<int> breakpoints,
Isolate* isolate, StackFrameId stepping_frame,
int dead_breakpoint) {
// TODO(paolosev@microsoft.com) - Add support for breakpoints in Wasm
// interpreter.
if (v8_flags.wasm_jitless) return;
mutex_.AssertHeld(); // Mutex is held externally.
WasmCode* new_code = RecompileLiftoffWithBreakpoints(
func_index, breakpoints, dead_breakpoint);
UpdateReturnAddresses(isolate, new_code, stepping_frame);
}
void FloodWithBreakpoints(WasmFrame* frame, ReturnLocation return_location) {
// TODO(paolosev@microsoft.com) - Add support for breakpoints in Wasm
// interpreter.
if (v8_flags.wasm_jitless) return;
// 0 is an invalid offset used to indicate flooding.
constexpr int kFloodingBreakpoints[] = {0};
DCHECK(frame->wasm_code()->is_liftoff());
// Generate an additional source position for the current byte offset.
base::MutexGuard guard(&mutex_);
WasmCode* new_code = RecompileLiftoffWithBreakpoints(
frame->function_index(), base::ArrayVector(kFloodingBreakpoints), 0);
UpdateReturnAddress(frame, new_code, return_location);
per_isolate_data_[frame->isolate()].stepping_frame = frame->id();
}
bool IsFrameBlackboxed(WasmFrame* frame) {
NativeModule* native_module = frame->native_module();
int func_index = frame->function_index();
WireBytesRef func_code =
native_module->module()->functions[func_index].code;
Isolate* isolate = frame->isolate();
DirectHandle<Script> script(Cast<Script>(frame->script()), isolate);
return isolate->debug()->IsFunctionBlackboxed(script, func_code.offset(),
func_code.end_offset());
}
bool PrepareStep(WasmFrame* frame) {
WasmCodeRefScope wasm_code_ref_scope;
wasm::WasmCode* code = frame->wasm_code();
if (!code->is_liftoff()) return false; // Cannot step in TurboFan code.
if (IsAtReturn(frame)) return false; // Will return after this step.
FloodWithBreakpoints(frame, kAfterBreakpoint);
return true;
}
void PrepareStepOutTo(WasmFrame* frame) {
WasmCodeRefScope wasm_code_ref_scope;
wasm::WasmCode* code = frame->wasm_code();
if (!code->is_liftoff()) return; // Cannot step out to TurboFan code.
FloodWithBreakpoints(frame, kAfterWasmCall);
}
void ClearStepping(WasmFrame* frame) {
// TODO(paolosev@microsoft.com) - Add support for breakpoints in Wasm
// interpreter.
if (v8_flags.wasm_jitless) return;
WasmCodeRefScope wasm_code_ref_scope;
base::MutexGuard guard(&mutex_);
auto* code = frame->wasm_code();
if (code->for_debugging() != kForStepping) return;
int func_index = code->index();
std::vector<int> breakpoints = FindAllBreakpoints(func_index);
int dead_breakpoint = DeadBreakpoint(frame, base::VectorOf(breakpoints));
WasmCode* new_code = RecompileLiftoffWithBreakpoints(
func_index, base::VectorOf(breakpoints), dead_breakpoint);
UpdateReturnAddress(frame, new_code, kAfterBreakpoint);
}
void ClearStepping(Isolate* isolate) {
base::MutexGuard guard(&mutex_);
auto it = per_isolate_data_.find(isolate);
if (it != per_isolate_data_.end()) it->second.stepping_frame = NO_ID;
}
bool IsStepping(WasmFrame* frame) {
Isolate* isolate = frame->isolate();
if (isolate->debug()->last_step_action() == StepInto) return true;
base::MutexGuard guard(&mutex_);
auto it = per_isolate_data_.find(isolate);
return it != per_isolate_data_.end() &&
it->second.stepping_frame == frame->id();
}
void RemoveBreakpoint(int func_index, int position, Isolate* isolate) {
// Put the code ref scope outside of the mutex, so we don't unnecessarily
// hold the mutex while freeing code.
WasmCodeRefScope wasm_code_ref_scope;
// Hold the mutex while modifying breakpoints, to ensure consistency when
// multiple isolates set/remove breakpoints at the same time.
base::MutexGuard guard(&mutex_);
const auto& function = native_module_->module()->functions[func_index];
int offset = position - function.code.offset();
auto& isolate_data = per_isolate_data_[isolate];
std::vector<int>& breakpoints =
isolate_data.breakpoints_per_function[func_index];
DCHECK_LT(0, offset);
auto insertion_point =
std::lower_bound(breakpoints.begin(), breakpoints.end(), offset);
if (insertion_point == breakpoints.end()) return;
if (*insertion_point != offset) return;
breakpoints.erase(insertion_point);
std::vector<int> remaining = FindAllBreakpoints(func_index);
// If the breakpoint is still set in another isolate, don't remove it.
DCHECK(std::is_sorted(remaining.begin(), remaining.end()));
if (std::binary_search(remaining.begin(), remaining.end(), offset)) return;
int dead_breakpoint =
DeadBreakpoint(func_index, base::VectorOf(remaining), isolate);
UpdateBreakpoints(func_index, base::VectorOf(remaining), isolate,
isolate_data.stepping_frame, dead_breakpoint);
}
void RemoveDebugSideTables(base::Vector<WasmCode* const> codes) {
base::MutexGuard guard(&debug_side_tables_mutex_);
for (auto* code : codes) {
debug_side_tables_.erase(code);
}
}
DebugSideTable* GetDebugSideTableIfExists(const WasmCode* code) const {
base::MutexGuard guard(&debug_side_tables_mutex_);
auto it = debug_side_tables_.find(code);
return it == debug_side_tables_.end() ? nullptr : it->second.get();
}
static bool HasRemovedBreakpoints(const std::vector<int>& removed,
const std::vector<int>& remaining) {
DCHECK(std::is_sorted(remaining.begin(), remaining.end()));
for (int offset : removed) {
// Return true if we removed a breakpoint which is not part of remaining.
if (!std::binary_search(remaining.begin(), remaining.end(), offset)) {
return true;
}
}
return false;
}
void RemoveIsolate(Isolate* isolate) {
// Put the code ref scope outside of the mutex, so we don't unnecessarily
// hold the mutex while freeing code.
WasmCodeRefScope wasm_code_ref_scope;
base::MutexGuard guard(&mutex_);
auto per_isolate_data_it = per_isolate_data_.find(isolate);
if (per_isolate_data_it == per_isolate_data_.end()) return;
std::unordered_map<int, std::vector<int>> removed_per_function =
std::move(per_isolate_data_it->second.breakpoints_per_function);
per_isolate_data_.erase(per_isolate_data_it);
for (auto& entry : removed_per_function) {
int func_index = entry.first;
std::vector<int>& removed = entry.second;
std::vector<int> remaining = FindAllBreakpoints(func_index);
if (HasRemovedBreakpoints(removed, remaining)) {
RecompileLiftoffWithBreakpoints(func_index, base::VectorOf(remaining),
0);
}
}
}
size_t EstimateCurrentMemoryConsumption() const {
UPDATE_WHEN_CLASS_CHANGES(DebugInfoImpl, 144);
UPDATE_WHEN_CLASS_CHANGES(CachedDebuggingCode, 40);
UPDATE_WHEN_CLASS_CHANGES(PerIsolateDebugData, 48);
size_t result = sizeof(DebugInfoImpl);
{
base::MutexGuard lock(&debug_side_tables_mutex_);
result += ContentSize(debug_side_tables_);
for (const auto& [code, table] : debug_side_tables_) {
result += table->EstimateCurrentMemoryConsumption();
}
}
{
base::MutexGuard lock(&mutex_);
result += ContentSize(cached_debugging_code_);
for (const CachedDebuggingCode& code : cached_debugging_code_) {
result += code.breakpoint_offsets.size() * sizeof(int);
}
result += ContentSize(per_isolate_data_);
for (const auto& [isolate, data] : per_isolate_data_) {
// Inlined handling of {PerIsolateDebugData}.
result += ContentSize(data.breakpoints_per_function);
for (const auto& [idx, breakpoints] : data.breakpoints_per_function) {
result += ContentSize(breakpoints);
}
}
}
if (v8_flags.trace_wasm_offheap_memory) {
PrintF("DebugInfo: %zu\n", result);
}
return result;
}
private:
struct FrameInspectionScope {
FrameInspectionScope(DebugInfoImpl* debug_info, Address pc,
Isolate* isolate)
: code(wasm::GetWasmCodeManager()->LookupCode(isolate, pc)),
pc_offset(static_cast<int>(pc - code->instruction_start())),
debug_side_table(code->is_inspectable()
? debug_info->GetDebugSideTable(code)
: nullptr),
debug_side_table_entry(debug_side_table
? debug_side_table->GetEntry(pc_offset)
: nullptr) {
DCHECK_IMPLIES(code->is_inspectable(), debug_side_table_entry != nullptr);
}
bool is_inspectable() const { return debug_side_table_entry; }
wasm::WasmCodeRefScope wasm_code_ref_scope;
wasm::WasmCode* code;
int pc_offset;
const DebugSideTable* debug_side_table;
const DebugSideTable::Entry* debug_side_table_entry;
};
const DebugSideTable* GetDebugSideTable(WasmCode* code) {
DCHECK(code->is_inspectable());
{
// Only hold the mutex temporarily. We can't hold it while generating the
// debug side table, because compilation takes the {NativeModule} lock.
base::MutexGuard guard(&debug_side_tables_mutex_);
auto it = debug_side_tables_.find(code);
if (it != debug_side_tables_.end()) return it->second.get();
}
// Otherwise create the debug side table now.
std::unique_ptr<DebugSideTable> debug_side_table =
GenerateLiftoffDebugSideTable(code);
DebugSideTable* ret = debug_side_table.get();
// Check cache again, maybe another thread concurrently generated a debug
// side table already.
{
base::MutexGuard guard(&debug_side_tables_mutex_);
auto& slot = debug_side_tables_[code];
if (slot != nullptr) return slot.get();
slot = std::move(debug_side_table);
}
// Print the code together with the debug table, if requested.
code->MaybePrint();
return ret;
}
// Get the value of a local (including parameters) or stack value. Stack
// values follow the locals in the same index space.
WasmValue GetValue(const DebugSideTable* debug_side_table,
const DebugSideTable::Entry* debug_side_table_entry,
int index, Address stack_frame_base,
Address debug_break_fp, Isolate* isolate) const {
const DebugSideTable::Entry::Value* value =
debug_side_table->FindValue(debug_side_table_entry, index);
if (value->is_constant()) {
DCHECK(value->type == kWasmI32 || value->type == kWasmI64);
return value->type == kWasmI32 ? WasmValue(value->i32_const)
: WasmValue(int64_t{value->i32_const});
}
if (value->is_register()) {
auto reg = LiftoffRegister::from_liftoff_code(value->reg_code);
auto gp_addr = [debug_break_fp](Register reg) {
return debug_break_fp +
WasmDebugBreakFrameConstants::GetPushedGpRegisterOffset(
reg.code());
};
if (reg.is_gp_pair()) {
DCHECK_EQ(kWasmI64, value->type);
uint32_t low_word = ReadUnalignedValue<uint32_t>(gp_addr(reg.low_gp()));
uint32_t high_word =
ReadUnalignedValue<uint32_t>(gp_addr(reg.high_gp()));
return WasmValue((uint64_t{high_word} << 32) | low_word);
}
if (reg.is_gp()) {
if (value->type == kWasmI32) {
return WasmValue(ReadUnalignedValue<uint32_t>(gp_addr(reg.gp())));
} else if (value->type == kWasmI64) {
return WasmValue(ReadUnalignedValue<uint64_t>(gp_addr(reg.gp())));
} else if (value->type.is_reference()) {
DirectHandle<Object> obj(
Tagged<Object>(ReadUnalignedValue<Address>(gp_addr(reg.gp()))),
isolate);
// TODO(jkummerow): Consider changing {value->type} to be a
// CanonicalValueType.
return WasmValue(obj, value->module->canonical_type(value->type));
} else {
UNREACHABLE();
}
}
DCHECK(reg.is_fp() || reg.is_fp_pair());
// ifdef here to workaround unreachable code for is_fp_pair.
#ifdef V8_TARGET_ARCH_ARM
int code = reg.is_fp_pair() ? reg.low_fp().code() : reg.fp().code();
#else
int code = reg.fp().code();
#endif
Address spilled_addr =
debug_break_fp +
WasmDebugBreakFrameConstants::GetPushedFpRegisterOffset(code);
if (value->type == kWasmF32) {
return WasmValue(ReadUnalignedValue<float>(spilled_addr));
} else if (value->type == kWasmF64) {
return WasmValue(ReadUnalignedValue<double>(spilled_addr));
} else if (value->type == kWasmS128) {
return WasmValue(Simd128(ReadUnalignedValue<int8x16>(spilled_addr)));
} else {
// All other cases should have been handled above.
UNREACHABLE();
}
}
// Otherwise load the value from the stack.
Address stack_address = stack_frame_base - value->stack_offset;
switch (value->type.kind()) {
case kI32:
return WasmValue(ReadUnalignedValue<int32_t>(stack_address));
case kI64:
return WasmValue(ReadUnalignedValue<int64_t>(stack_address));
case kF32:
return WasmValue(ReadUnalignedValue<float>(stack_address));
case kF64:
return WasmValue(ReadUnalignedValue<double>(stack_address));
case kS128:
return WasmValue(Simd128(ReadUnalignedValue<int8x16>(stack_address)));
case kRef:
case kRefNull: {
DirectHandle<Object> obj(
Tagged<Object>(ReadUnalignedValue<Address>(stack_address)),
isolate);
return WasmValue(obj, value->module->canonical_type(value->type));
}
case kI8:
case kI16:
case kF16:
case kVoid:
case kTop:
case kBottom:
UNREACHABLE();
}
}
// After installing a Liftoff code object with a different set of breakpoints,
// update return addresses on the stack so that execution resumes in the new
// code. The frame layout itself should be independent of breakpoints.
void UpdateReturnAddresses(Isolate* isolate, WasmCode* new_code,
StackFrameId stepping_frame) {
// The first return location is after the breakpoint, others are after wasm
// calls.
ReturnLocation return_location = kAfterBreakpoint;
for (DebuggableStackFrameIterator it(isolate); !it.done();
it.Advance(), return_location = kAfterWasmCall) {
// We still need the flooded function for stepping.
if (it.frame()->id() == stepping_frame) continue;
#if !V8_ENABLE_DRUMBRAKE
if (!it.is_wasm()) continue;
#else // !V8_ENABLE_DRUMBRAKE
// TODO(paolosev@microsoft.com) - Implement for Wasm interpreter.
if (!it.is_wasm() || it.is_wasm_interpreter_entry()) continue;
#endif // !V8_ENABLE_DRUMBRAKE
WasmFrame* frame = WasmFrame::cast(it.frame());
if (frame->native_module() != new_code->native_module()) continue;
if (frame->function_index() != new_code->index()) continue;
if (!frame->wasm_code()->is_liftoff()) continue;
UpdateReturnAddress(frame, new_code, return_location);
}
}
void UpdateReturnAddress(WasmFrame* frame, WasmCode* new_code,
ReturnLocation return_location) {
DCHECK(new_code->is_liftoff());
DCHECK_EQ(frame->function_index(), new_code->index());
DCHECK_EQ(frame->native_module(), new_code->native_module());
DCHECK(frame->wasm_code()->is_liftoff());
Address new_pc = FindNewPC(frame, new_code, frame->generated_code_offset(),
return_location);
#ifdef DEBUG
int old_position = frame->position();
#endif
#if V8_TARGET_ARCH_X64
if (frame->wasm_code()->for_debugging()) {
base::Memory<Address>(frame->fp() - kOSRTargetOffset) = new_pc;
}
#else
PointerAuthentication::ReplacePC(frame->pc_address(), new_pc,
kSystemPointerSize);
#endif
// The frame position should still be the same after OSR.
DCHECK_EQ(old_position, frame->position());
}
bool IsAtReturn(WasmFrame* frame) {
DisallowGarbageCollection no_gc;
int position = frame->position();
NativeModule* native_module = frame->native_module();
uint8_t opcode = native_module->wire_bytes()[position];
if (opcode == kExprReturn) return true;
// Another implicit return is at the last kExprEnd in the function body.
int func_index = frame->function_index();
WireBytesRef code = native_module->module()->functions[func_index].code;
return static_cast<size_t>(position) == code.end_offset() - 1;
}
// Isolate-specific data, for debugging modules that are shared by multiple
// isolates.
struct PerIsolateDebugData {
// Keeps track of the currently set breakpoints (by offset within that
// function).
std::unordered_map<int, std::vector<int>> breakpoints_per_function;
// Store the frame ID when stepping, to avoid overwriting that frame when
// setting or removing a breakpoint.
StackFrameId stepping_frame = NO_ID;
};
NativeModule* const native_module_;
mutable base::Mutex debug_side_tables_mutex_;
// DebugSideTable per code object, lazily initialized.
std::unordered_map<const WasmCode*, std::unique_ptr<DebugSideTable>>
debug_side_tables_;
// {mutex_} protects all fields below.
mutable base::Mutex mutex_;
// Cache a fixed number of WasmCode objects that were generated for debugging.
// This is useful especially in stepping, because stepping code is cleared on
// every pause and re-installed on the next step.
// This is a LRU cache (most recently used entries first).
static constexpr size_t kMaxCachedDebuggingCode = 3;
struct CachedDebuggingCode {
int func_index;
base::OwnedVector<const int> breakpoint_offsets;
int dead_breakpoint;
WasmCode* code;
};
std::vector<CachedDebuggingCode> cached_debugging_code_;
// Isolate-specific data.
std::unordered_map<Isolate*, PerIsolateDebugData> per_isolate_data_;
};
DebugInfo::DebugInfo(NativeModule* native_module)
: impl_(std::make_unique<DebugInfoImpl>(native_module)) {}
DebugInfo::~DebugInfo() = default;
int DebugInfo::GetNumLocals(Address pc, Isolate* isolate) {
return impl_->GetNumLocals(pc, isolate);
}
WasmValue DebugInfo::GetLocalValue(int local, Address pc, Address fp,
Address debug_break_fp, Isolate* isolate) {
return impl_->GetLocalValue(local, pc, fp, debug_break_fp, isolate);
}
int DebugInfo::GetStackDepth(Address pc, Isolate* isolate) {
return impl_->GetStackDepth(pc, isolate);
}
WasmValue DebugInfo::GetStackValue(int index, Address pc, Address fp,
Address debug_break_fp, Isolate* isolate) {
return impl_->GetStackValue(index, pc, fp, debug_break_fp, isolate);
}
const wasm::WasmFunction& DebugInfo::GetFunctionAtAddress(Address pc,
Isolate* isolate) {
return impl_->GetFunctionAtAddress(pc, isolate);
}
void DebugInfo::SetBreakpoint(int func_index, int offset,
Isolate* current_isolate) {
impl_->SetBreakpoint(func_index, offset, current_isolate);
}
bool DebugInfo::IsFrameBlackboxed(WasmFrame* frame) {
return impl_->IsFrameBlackboxed(frame);
}
bool DebugInfo::PrepareStep(WasmFrame* frame) {
return impl_->PrepareStep(frame);
}
void DebugInfo::PrepareStepOutTo(WasmFrame* frame) {
impl_->PrepareStepOutTo(frame);
}
void DebugInfo::ClearStepping(Isolate* isolate) {
impl_->ClearStepping(isolate);
}
void DebugInfo::ClearStepping(WasmFrame* frame) { impl_->ClearStepping(frame); }
bool DebugInfo::IsStepping(WasmFrame* frame) {
return impl_->IsStepping(frame);
}
void DebugInfo::RemoveBreakpoint(int func_index, int offset,
Isolate* current_isolate) {
impl_->RemoveBreakpoint(func_index, offset, current_isolate);
}
void DebugInfo::RemoveDebugSideTables(base::Vector<WasmCode* const> code) {
impl_->RemoveDebugSideTables(code);
}
DebugSideTable* DebugInfo::GetDebugSideTableIfExists(
const WasmCode* code) const {
return impl_->GetDebugSideTableIfExists(code);
}
void DebugInfo::RemoveIsolate(Isolate* isolate) {
return impl_->RemoveIsolate(isolate);
}
size_t DebugInfo::EstimateCurrentMemoryConsumption() const {
return impl_->EstimateCurrentMemoryConsumption();
}
} // namespace wasm
namespace {
// Return the next breakable position at or after {offset_in_func} in function
// {func_index}, or 0 if there is none.
// Note that 0 is never a breakable position in wasm, since the first uint8_t
// contains the locals count for the function.
int FindNextBreakablePosition(wasm::NativeModule* native_module, int func_index,
int offset_in_func) {
Zone zone{wasm::GetWasmEngine()->allocator(), ZONE_NAME};
wasm::BodyLocalDecls locals;
const uint8_t* module_start = native_module->wire_bytes().begin();
const wasm::WasmFunction& func =
native_module->module()->functions[func_index];
wasm::BytecodeIterator iterator(module_start + func.code.offset(),
module_start + func.code.end_offset(),
&locals, &zone);
DCHECK_LT(0, locals.encoded_size);
if (offset_in_func < 0) return 0;
for (; iterator.has_next(); iterator.next()) {
if (iterator.pc_offset() < static_cast<uint32_t>(offset_in_func)) continue;
if (!wasm::WasmOpcodes::IsBreakable(iterator.current())) continue;
return static_cast<int>(iterator.pc_offset());
}
return 0;
}
void SetBreakOnEntryFlag(Tagged<Script> script, bool enabled) {
if (script->break_on_entry() == enabled) return;
script->set_break_on_entry(enabled);
// Update the "break_on_entry" flag on all live instances.
i::Tagged<i::WeakArrayList> weak_instance_list =
script->wasm_weak_instance_list();
i::Isolate* isolate = Isolate::Current();
for (int i = 0; i < weak_instance_list->length(); ++i) {
if (weak_instance_list->Get(i).IsCleared()) continue;
i::Tagged<i::WasmInstanceObject> instance = i::Cast<i::WasmInstanceObject>(
weak_instance_list->Get(i).GetHeapObject());
instance->trusted_data(isolate)->set_break_on_entry(enabled);
}
}
} // namespace
// static
bool WasmScript::SetBreakPoint(DirectHandle<Script> script, int* position,
DirectHandle<BreakPoint> break_point) {
DCHECK_NE(kOnEntryBreakpointPosition, *position);
// Find the function for this breakpoint.
const wasm::WasmModule* module = script->wasm_native_module()->module();
int func_index = GetContainingWasmFunction(module, *position);
if (func_index < 0) return false;
const wasm::WasmFunction& func = module->functions[func_index];
int offset_in_func = *position - func.code.offset();
int breakable_offset = FindNextBreakablePosition(script->wasm_native_module(),
func_index, offset_in_func);
if (breakable_offset == 0) return false;
*position = func.code.offset() + breakable_offset;
return WasmScript::SetBreakPointForFunction(script, func_index,
breakable_offset, break_point);
}
// static
void WasmScript::SetInstrumentationBreakpoint(
DirectHandle<Script> script, DirectHandle<BreakPoint> break_point) {
// Special handling for on-entry breakpoints.
AddBreakpointToInfo(script, kOnEntryBreakpointPosition, break_point);
// Update the "break_on_entry" flag on all live instances.
SetBreakOnEntryFlag(*script, true);
}
// static
bool WasmScript::SetBreakPointOnFirstBreakableForFunction(
DirectHandle<Script> script, int func_index,
DirectHandle<BreakPoint> break_point) {
if (func_index < 0) return false;
int offset_in_func = 0;
int breakable_offset = FindNextBreakablePosition(script->wasm_native_module(),
func_index, offset_in_func);
if (breakable_offset == 0) return false;
return WasmScript::SetBreakPointForFunction(script, func_index,
breakable_offset, break_point);
}
// static
bool WasmScript::SetBreakPointForFunction(
DirectHandle<Script> script, int func_index, int offset,
DirectHandle<BreakPoint> break_point) {
Isolate* isolate = Isolate::Current();
DCHECK_LE(0, func_index);
DCHECK_NE(0, offset);
// Find the function for this breakpoint.
wasm::NativeModule* native_module = script->wasm_native_module();
const wasm::WasmModule* module = native_module->module();
const wasm::WasmFunction& func = module->functions[func_index];
// Insert new break point into {wasm_breakpoint_infos} of the script.
AddBreakpointToInfo(script, func.code.offset() + offset, break_point);