forked from S2E/s2e-old
-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathS2EExecutor.cpp
2580 lines (2080 loc) · 82.3 KB
/
S2EExecutor.cpp
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
/*
* S2E Selective Symbolic Execution Framework
*
* Copyright (c) 2010, Dependable Systems Laboratory, EPFL
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Dependable Systems Laboratory, EPFL nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE DEPENDABLE SYSTEMS LABORATORY, EPFL BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Currently maintained by:
* Volodymyr Kuznetsov ([email protected])
* Vitaly Chipounov ([email protected])
*
* Revision List:
* v1.0 - Initial Release - Vitaly Chipounov, Vova Kuznetsov
*
* All contributors listed in S2E-AUTHORS.
*
*/
extern "C" {
#include <qemu-common.h>
#include <cpu-all.h>
#include <tcg.h>
#include <tcg-llvm.h>
#include <exec-all.h>
#include <ioport.h>
#include <sysemu.h>
#include <cpus.h>
extern struct CPUX86State *env;
void QEMU_NORETURN raise_exception(int exception_index);
void QEMU_NORETURN raise_exception_err(int exception_index, int error_code);
extern const uint8_t parity_table[256];
extern const uint8_t rclw_table[32];
extern const uint8_t rclb_table[32];
void do_interrupt_all(int intno, int is_int, int error_code,
target_ulong next_eip, int is_hw);
void s2e_do_interrupt_all(int intno, int is_int, int error_code,
target_ulong next_eip, int is_hw);
uint64_t helper_set_cc_op_eflags(void);
}
#ifndef __APPLE__
#include <malloc.h>
#endif
#include "S2EExecutor.h"
#include <s2e/s2e_config.h>
#include <s2e/S2E.h>
#include <s2e/S2EExecutionState.h>
#include <s2e/Utils.h>
#include <s2e/Plugins/CorePlugin.h>
#include <s2e/S2EDeviceState.h>
#include <s2e/SelectRemovalPass.h>
#include <s2e/S2EStatsTracker.h>
//XXX: Remove this from executor
#include <s2e/Plugins/ModuleExecutionDetector.h>
#include <s2e/s2e_qemu.h>
#include <llvm/Module.h>
#include <llvm/Function.h>
#include <llvm/DerivedTypes.h>
#include <llvm/Instructions.h>
#include <llvm/Constants.h>
#include <llvm/PassManager.h>
#include <llvm/DataLayout.h>
#include <llvm/ExecutionEngine/ExecutionEngine.h>
#include <llvm/ExecutionEngine/GenericValue.h>
#include <llvm/Support/DynamicLibrary.h>
#include <llvm/Support/Process.h>
#include <llvm/Support/CommandLine.h>
#include <klee/PTree.h>
#include <klee/Memory.h>
#include <klee/Searcher.h>
#include <klee/ExternalDispatcher.h>
#include <klee/UserSearcher.h>
#include <klee/CoreStats.h>
#include <klee/TimerStatIncrementer.h>
#include <klee/Solver.h>
#include <llvm/Support/TimeValue.h>
#include <vector>
#include <sstream>
#ifdef WIN32
#include <windows.h>
#else
#include <sys/mman.h>
#endif
#include <tr1/functional>
//#define S2E_DEBUG_MEMORY
//#define S2E_DEBUG_INSTRUCTIONS
//#define S2E_TRACE_EFLAGS
//#define FORCE_CONCRETIZATION
using namespace std;
using namespace llvm;
using namespace klee;
extern "C" {
// XXX
//void* g_s2e_exec_ret_addr = 0;
}
namespace {
uint64_t hash64(uint64_t val, uint64_t initial = 14695981039346656037ULL) {
const char* __first = (const char*) &val;
for (unsigned int i = 0; i < sizeof(uint64_t); ++i) {
initial ^= static_cast<uint64_t>(*__first++);
initial *= static_cast<uint64_t>(1099511628211ULL);
}
return initial;
}
}
namespace {
cl::opt<bool>
UseSelectCleaner("use-select-cleaner",
cl::desc("Remove Select statements from LLVM code"),
cl::init(false));
cl::opt<bool>
StateSharedMemory("state-shared-memory",
cl::desc("Allow unimportant memory regions (like video RAM) to be shared between states"),
cl::init(false));
cl::opt<bool>
FlushTBsOnStateSwitch("flush-tbs-on-state-switch",
cl::desc("Flush translation blocks when switching states -"
" disabling leads to faster but possibly incorrect execution"),
cl::init(true));
cl::opt<bool>
KeepLLVMFunctions("keep-llvm-functions",
cl::desc("Never delete generated LLVM functions"),
cl::init(false));
//The default is true for two reasons:
//1. Symbolic addresses are very expensive to handle
//2. There is lazy forking which will eventually enumerate
//all possible addresses.
//Overall, we have more path explosion, but at least execution
//does not get stuck in various places.
cl::opt<bool>
ForkOnSymbolicAddress("fork-on-symbolic-address",
cl::desc("Fork on each memory access with symbolic address"),
cl::init(true));
cl::opt<bool>
ConcretizeIoAddress("concretize-io-address",
cl::desc("Concretize symbolic I/O addresses"),
cl::init(true));
//XXX: Works for MMIO only, add support for port I/O
cl::opt<bool>
ConcretizeIoWrites("concretize-io-writes",
cl::desc("Concretize symbolic I/O writes"),
cl::init(true));
cl::opt<bool>
S2EDebugInstructions("print-llvm-instructions",
cl::desc("Traces all LLVM instructions sent to KLEE"), cl::init(false));
cl::opt<bool>
VerboseFork("verbose-fork-info",
cl::desc("Print detailed information on forks"), cl::init(false));
cl::opt<bool>
VerboseStateSwitching("verbose-state-switching",
cl::desc("Print detailed information on state switches"), cl::init(false));
cl::opt<bool>
VerboseTbFinalize("verbose-tb-finalize",
cl::desc("Print detailed information when finalizing a partially-completed TB"), cl::init(false));
cl::opt<bool>
UseFastHelpers("use-fast-helpers",
cl::desc("Replaces LLVM bitcode with fast symbolic-aware equivalent native helpers"), cl::init(false));
cl::opt<unsigned>
ClockSlowDown("clock-slow-down",
cl::desc("Slow down factor when interpreting LLVM code"), cl::init(101));
cl::opt<unsigned>
ClockSlowDownFastHelpers("clock-slow-down-fast-helpers",
cl::desc("Slow down factor when interpreting LLVM code and using fast helpers"), cl::init(11));
}
//The logs may be flooded with messages when switching execution mode.
//This option allows disabling printing mode switches.
cl::opt<bool>
PrintModeSwitch("print-mode-switch",
cl::desc("Print message when switching from symbolic to concrete and vice versa"),
cl::init(false));
cl::opt<bool>
PrintForkingStatus("print-forking-status",
cl::desc("Print message when enabling/disabling forking."),
cl::init(false));
cl::opt<bool>
VerboseStateDeletion("verbose-state-deletion",
cl::desc("Print detailed information on state deletion"), cl::init(false));
//Concolic mode is the default because it works better than symbex.
cl::opt<bool>
ConcolicMode("use-concolic-execution",
cl::desc("Concolic execution mode"), cl::init(true));
// Disable fork and use make_concolic to use Concolic Taint
cl::opt<bool>
ConcolicTaint("use-concolic-taint",
cl::desc("Single Concolic Taint"), cl::init(false));
cl::opt<bool>
DebugConstraints("debug-constraints",
cl::desc("Check that added constraints are satisfiable"), cl::init(false));
extern cl::opt<bool> UseExprSimplifier;
extern "C" {
int g_s2e_fork_on_symbolic_address = 0;
int g_s2e_concretize_io_addresses = 1;
int g_s2e_concretize_io_writes = 1;
void s2e_print_instructions(int v);
void s2e_print_instructions(int v) {
S2EDebugInstructions = v;
}
}
namespace s2e {
/* Global array to hold tb function arguments */
volatile void* tb_function_args[3];
/* External dispatcher to convert QEMU s2e_longjmp's into C++ exceptions */
class S2EExternalDispatcher: public klee::ExternalDispatcher
{
protected:
virtual bool runProtectedCall(llvm::Function *f, uint64_t *args);
public:
S2EExternalDispatcher(ExecutionEngine* engine):
ExternalDispatcher(engine) {}
void removeFunction(llvm::Function *f);
};
extern "C" {
// FIXME: This is not reentrant.
static s2e_jmp_buf s2e_escapeCallJmpBuf;
static s2e_jmp_buf s2e_cpuExitJmpBuf;
#ifdef _WIN32
static void s2e_ext_sigsegv_handler(int signal)
{
}
#else
static void s2e_ext_sigsegv_handler(int signal, siginfo_t *info, void *context) {
s2e_longjmp(s2e_escapeCallJmpBuf, 1);
}
#endif
}
bool S2EExternalDispatcher::runProtectedCall(Function *f, uint64_t *args) {
#ifndef _WIN32
struct sigaction segvAction, segvActionOld;
#endif
bool res;
if (!f)
return false;
gTheArgsP = args;
#ifdef _WIN32
signal(SIGSEGV, s2e_ext_sigsegv_handler);
#else
segvAction.sa_handler = 0;
memset(&segvAction.sa_mask, 0, sizeof(segvAction.sa_mask));
segvAction.sa_flags = SA_SIGINFO;
segvAction.sa_sigaction = s2e_ext_sigsegv_handler;
sigaction(SIGSEGV, &segvAction, &segvActionOld);
#endif
memcpy(s2e_cpuExitJmpBuf, env->jmp_env, sizeof(env->jmp_env));
if(s2e_setjmp(env->jmp_env)) {
memcpy(env->jmp_env, s2e_cpuExitJmpBuf, sizeof(env->jmp_env));
throw CpuExitException();
} else {
if (s2e_setjmp(s2e_escapeCallJmpBuf)) {
res = false;
} else {
std::vector<GenericValue> gvArgs;
executionEngine->runFunction(f, gvArgs);
res = true;
}
}
memcpy(env->jmp_env, s2e_cpuExitJmpBuf, sizeof(env->jmp_env));
#ifdef _WIN32
#warning Implement more robust signal handling on windows
signal(SIGSEGV, SIG_IGN);
#else
sigaction(SIGSEGV, &segvActionOld, 0);
#endif
return res;
}
/**
* Remove all mappings between calls to external functions
* and the actual external call stub generated by KLEE.
* Also remove the machine code for the stub and the stub itself.
* This is used whenever S2E deletes a translation block and its LLVM
* representation. Failing to do so would leave stale references to
* machine code in KLEE's external dispatcher.
*/
void S2EExternalDispatcher::removeFunction(llvm::Function *f) {
dispatchers_ty::iterator it, itn;
it = dispatchers.begin();
while (it != dispatchers.end()) {
if ((*it).first->getParent()->getParent() == f) {
llvm::Function *dispatcher = (*it).second;
executionEngine->freeMachineCodeForFunction(dispatcher);
dispatcher->eraseFromParent();
itn = it;
++itn;
dispatchers.erase(it);
it = itn;
} else {
++it;
}
}
}
S2EHandler::S2EHandler(S2E* s2e)
: m_s2e(s2e)
{
}
llvm::raw_ostream &S2EHandler::getInfoStream() const
{
return m_s2e->getInfoStream();
}
std::string S2EHandler::getOutputFilename(const std::string &fileName)
{
return m_s2e->getOutputFilename(fileName);
}
llvm::raw_ostream *S2EHandler::openOutputFile(const std::string &fileName)
{
return m_s2e->openOutputFile(fileName);
}
/* klee-related function */
void S2EHandler::incPathsExplored()
{
m_pathsExplored++;
}
/* klee-related function */
void S2EHandler::processTestCase(const klee::ExecutionState &state,
const char *err, const char *suffix)
{
//XXX: This stuff is not used anymore
//Use onTestCaseGeneration event instead.
}
void S2EExecutor::handlerTraceMemoryAccess(Executor* executor,
ExecutionState* state,
klee::KInstruction* target,
std::vector<klee::ref<klee::Expr> > &args)
{
assert(dynamic_cast<S2EExecutor*>(executor));
S2EExecutor* s2eExecutor = static_cast<S2EExecutor*>(executor);
if(!s2eExecutor->m_s2e->getCorePlugin()->onDataMemoryAccess.empty()) {
assert(dynamic_cast<S2EExecutionState*>(state));
S2EExecutionState* s2eState = static_cast<S2EExecutionState*>(state);
assert(args.size() == 6);
Expr::Width width = cast<klee::ConstantExpr>(args[3])->getZExtValue();
bool isWrite = cast<klee::ConstantExpr>(args[4])->getZExtValue();
bool isIO = cast<klee::ConstantExpr>(args[5])->getZExtValue();
ref<Expr> value = klee::ExtractExpr::create(args[2], 0, width);
s2eExecutor->m_s2e->getCorePlugin()->onDataMemoryAccess.emit(
s2eState, args[0], args[1], value, isWrite, isIO);
}
}
void S2EExecutor::handlerTraceInstruction(klee::Executor* executor,
klee::ExecutionState* state,
klee::KInstruction* target,
std::vector<klee::ref<klee::Expr> > &args)
{
S2EExecutionState* s2eState = static_cast<S2EExecutionState*>(state);
g_s2e->getDebugStream()
<< "pc=" << hexval(s2eState->getPc())
<< " EAX: " << s2eState->readCpuRegister(offsetof(CPUX86State, regs[R_EAX]), klee::Expr::Int32)
<< " ECX: " << s2eState->readCpuRegister(offsetof(CPUX86State, regs[R_ECX]), klee::Expr::Int32)
<< " CCSRC: " << s2eState->readCpuRegister(offsetof(CPUX86State, cc_src), klee::Expr::Int32)
<< " CCDST: " << s2eState->readCpuRegister(offsetof(CPUX86State, cc_dst), klee::Expr::Int32)
<< " CCOP: " << s2eState->readCpuRegister(offsetof(CPUX86State, cc_op), klee::Expr::Int32) << '\n';
}
void S2EExecutor::handlerOnTlbMiss(Executor* executor,
ExecutionState* state,
klee::KInstruction* target,
std::vector<klee::ref<klee::Expr> > &args)
{
assert(dynamic_cast<S2EExecutor*>(executor));
assert(args.size() == 4);
S2EExecutionState* s2eState = static_cast<S2EExecutionState*>(state);
ref<Expr> addr = args[2];
bool isWrite = cast<klee::ConstantExpr>(args[3])->getZExtValue();
if(!isa<klee::ConstantExpr>(addr)) {
/*
g_s2e->getWarningsStream()
<< "Warning: s2e_on_tlb_miss does not support symbolic addresses"
<< '\n';
*/
return;
}
uint64_t constAddress;
constAddress = cast<klee::ConstantExpr>(addr)->getZExtValue(64);
s2e_on_tlb_miss(g_s2e, s2eState, constAddress, isWrite);
}
void S2EExecutor::handlerTracePortAccess(Executor* executor,
ExecutionState* state,
klee::KInstruction* target,
std::vector<klee::ref<klee::Expr> > &args)
{
assert(dynamic_cast<S2EExecutor*>(executor));
S2EExecutor* s2eExecutor = static_cast<S2EExecutor*>(executor);
if(!s2eExecutor->m_s2e->getCorePlugin()->onPortAccess.empty()) {
assert(dynamic_cast<S2EExecutionState*>(state));
S2EExecutionState* s2eState = static_cast<S2EExecutionState*>(state);
assert(args.size() == 4);
Expr::Width width = cast<klee::ConstantExpr>(args[2])->getZExtValue();
bool isWrite = cast<klee::ConstantExpr>(args[3])->getZExtValue();
ref<Expr> value = klee::ExtractExpr::create(args[1], 0, width);
s2eExecutor->m_s2e->getCorePlugin()->onPortAccess.emit(
s2eState, args[0], value, isWrite);
}
}
void S2EExecutor::handleForkAndConcretize(Executor* executor,
ExecutionState* state,
klee::KInstruction* target,
std::vector< ref<Expr> > &args)
{
S2EExecutor* s2eExecutor = static_cast<S2EExecutor*>(executor);
assert(args.size() == 3);
ref<Expr> address = args[0];
address = state->constraints.simplifyExpr(address);
if (UseExprSimplifier) {
address = s2eExecutor->simplifyExpr(*state, address);
}
if(isa<klee::ConstantExpr>(address)) {
s2eExecutor->bindLocal(target, *state, address);
return;
}
klee::ref<klee::Expr> concreteAddress;
if (ConcolicMode) {
concreteAddress = state->concolics.evaluate(address);
assert(dyn_cast<klee::ConstantExpr>(concreteAddress) && "Could not evaluate address");
} else {
//Not in concolic mode, will have to invoke the constraint solver
//to compute a concrete value
klee::ref<klee::ConstantExpr> value;
bool success = s2eExecutor->getSolver()->getValue(
Query(state->constraints, address), value);
if (!success) {
s2eExecutor->terminateStateEarly(*state, "Could not compute a concrete value for a symbolic address");
assert(false && "Can't get here");
}
concreteAddress = value;
}
klee::ref<klee::Expr> condition = EqExpr::create(concreteAddress, address);
if (!state->forkDisabled) {
//XXX: may create deep paths!
StatePair sp = executor->fork(*state, condition, true);
//The condition is always true in the current state
//(i.e., expr == concreteAddress holds).
assert(sp.first == state);
//It may happen that the simplifier figures out that
//the condition is always true, in which case, no fork is needed.
//TODO: find a test case for that
if (sp.second) {
//Will have to reexecute handleForkAndConcretize in the speculative state
sp.second->pc = sp.second->prevPC;
}
} else {
state->addConstraint(condition);
}
s2eExecutor->bindLocal(target, *state, concreteAddress);
}
void S2EExecutor::handleMakeSymbolic(Executor* executor,
ExecutionState* state,
klee::KInstruction* target,
std::vector< ref<Expr> > &args)
{
S2EExecutionState* s2eState = static_cast<S2EExecutionState*>(state);
s2eState->makeSymbolic(args, false);
}
void S2EExecutor::handleGetValue(klee::Executor* executor,
klee::ExecutionState* state,
klee::KInstruction* target,
std::vector<klee::ref<klee::Expr> > &args) {
S2EExecutionState* s2eState = static_cast<S2EExecutionState*>(state);
assert(args.size() == 3 &&
"Expected three args to tcg_llvm_get_value: addr, size, add_constraint");
// KLEE address of variable
ref<klee::ConstantExpr> kleeAddress = cast<klee::ConstantExpr>(args[0]);
// Size in bytes
uint64_t sizeInBytes = cast<klee::ConstantExpr>(args[1])->getZExtValue();
// Add a constraint permanently?
bool add_constraint = cast<klee::ConstantExpr>(args[2])->getZExtValue();
// Read the value and concretize it.
// The value will be stored at kleeAddress
std::vector<ref<Expr> > result;
s2eState->kleeReadMemory(kleeAddress, sizeInBytes, NULL, false, true, add_constraint);
}
S2EExecutor::S2EExecutor(S2E* s2e, TCGLLVMContext *tcgLLVMContext,
const InterpreterOptions &opts,
InterpreterHandler *ie)
: Executor(opts, ie, tcgLLVMContext->getExecutionEngine()),
m_s2e(s2e), m_tcgLLVMContext(tcgLLVMContext),
m_executeAlwaysKlee(false), m_forkProcTerminateCurrentState(false),
m_inLoadBalancing(false), yieldedState(NULL)
{
delete externalDispatcher;
externalDispatcher = new S2EExternalDispatcher(
tcgLLVMContext->getExecutionEngine());
LLVMContext& ctx = m_tcgLLVMContext->getLLVMContext();
// XXX: this will not work without creating JIT
// XXX: how to get data layout without without ExecutionEngine ?
m_tcgLLVMContext->getModule()->setDataLayout(
m_tcgLLVMContext->getExecutionEngine()
->getDataLayout()->getStringRepresentation());
/* Define globally accessible functions */
#define __DEFINE_EXT_FUNCTION(name) \
llvm::sys::DynamicLibrary::AddSymbol(#name, (void*) name);
#define __DEFINE_EXT_VARIABLE(name) \
llvm::sys::DynamicLibrary::AddSymbol(#name, (void*) &name);
//__DEFINE_EXT_FUNCTION(raise_exception)
//__DEFINE_EXT_FUNCTION(raise_exception_err)
helper_register_symbols();
__DEFINE_EXT_VARIABLE(g_s2e_concretize_io_addresses)
__DEFINE_EXT_VARIABLE(g_s2e_concretize_io_writes)
__DEFINE_EXT_VARIABLE(g_s2e_fork_on_symbolic_address)
__DEFINE_EXT_VARIABLE(g_s2e_enable_mmio_checks)
__DEFINE_EXT_FUNCTION(fprintf)
__DEFINE_EXT_FUNCTION(sprintf)
__DEFINE_EXT_FUNCTION(fputc)
__DEFINE_EXT_FUNCTION(fwrite)
__DEFINE_EXT_VARIABLE(io_mem_ram)
__DEFINE_EXT_VARIABLE(io_mem_rom)
__DEFINE_EXT_VARIABLE(io_mem_unassigned)
__DEFINE_EXT_VARIABLE(io_mem_notdirty)
__DEFINE_EXT_FUNCTION(cpu_io_recompile)
__DEFINE_EXT_FUNCTION(cpu_x86_handle_mmu_fault)
__DEFINE_EXT_FUNCTION(cpu_x86_update_cr0)
__DEFINE_EXT_FUNCTION(cpu_x86_update_cr3)
__DEFINE_EXT_FUNCTION(cpu_x86_update_cr4)
__DEFINE_EXT_FUNCTION(cpu_x86_cpuid)
__DEFINE_EXT_FUNCTION(cpu_get_apic_base)
__DEFINE_EXT_FUNCTION(cpu_set_apic_base)
__DEFINE_EXT_FUNCTION(cpu_get_apic_tpr)
__DEFINE_EXT_FUNCTION(cpu_set_apic_tpr)
__DEFINE_EXT_FUNCTION(cpu_smm_update)
__DEFINE_EXT_FUNCTION(cpu_outb)
__DEFINE_EXT_FUNCTION(cpu_outw)
__DEFINE_EXT_FUNCTION(cpu_outl)
__DEFINE_EXT_FUNCTION(cpu_inb)
__DEFINE_EXT_FUNCTION(cpu_inw)
__DEFINE_EXT_FUNCTION(cpu_inl)
__DEFINE_EXT_FUNCTION(cpu_restore_state)
__DEFINE_EXT_FUNCTION(cpu_abort)
__DEFINE_EXT_FUNCTION(cpu_loop_exit)
__DEFINE_EXT_FUNCTION(cpu_get_tsc)
__DEFINE_EXT_FUNCTION(tb_find_pc)
__DEFINE_EXT_FUNCTION(qemu_system_reset_request)
__DEFINE_EXT_FUNCTION(hw_breakpoint_insert)
__DEFINE_EXT_FUNCTION(hw_breakpoint_remove)
__DEFINE_EXT_FUNCTION(check_hw_breakpoints)
__DEFINE_EXT_FUNCTION(tlb_flush_page)
__DEFINE_EXT_FUNCTION(tlb_flush)
__DEFINE_EXT_FUNCTION(io_readb_mmu)
__DEFINE_EXT_FUNCTION(io_readw_mmu)
__DEFINE_EXT_FUNCTION(io_readl_mmu)
__DEFINE_EXT_FUNCTION(io_readq_mmu)
__DEFINE_EXT_FUNCTION(io_writeb_mmu)
__DEFINE_EXT_FUNCTION(io_writew_mmu)
__DEFINE_EXT_FUNCTION(io_writel_mmu)
__DEFINE_EXT_FUNCTION(io_writeq_mmu)
__DEFINE_EXT_FUNCTION(iotlb_to_region)
__DEFINE_EXT_FUNCTION(s2e_ensure_symbolic)
//__DEFINE_EXT_FUNCTION(s2e_on_tlb_miss)
__DEFINE_EXT_FUNCTION(s2e_on_page_fault)
__DEFINE_EXT_FUNCTION(s2e_is_port_symbolic)
__DEFINE_EXT_FUNCTION(s2e_is_mmio_symbolic_b)
__DEFINE_EXT_FUNCTION(s2e_is_mmio_symbolic_w)
__DEFINE_EXT_FUNCTION(s2e_is_mmio_symbolic_l)
__DEFINE_EXT_FUNCTION(s2e_is_mmio_symbolic_q)
__DEFINE_EXT_FUNCTION(s2e_on_privilege_change);
__DEFINE_EXT_FUNCTION(s2e_on_page_fault);
__DEFINE_EXT_FUNCTION(s2e_ismemfunc)
__DEFINE_EXT_FUNCTION(s2e_notdirty_mem_write)
__DEFINE_EXT_FUNCTION(cpu_io_recompile)
__DEFINE_EXT_FUNCTION(can_do_io)
__DEFINE_EXT_FUNCTION(ldub_phys)
__DEFINE_EXT_FUNCTION(stb_phys)
__DEFINE_EXT_FUNCTION(lduw_phys)
__DEFINE_EXT_FUNCTION(stw_phys)
__DEFINE_EXT_FUNCTION(ldl_phys)
__DEFINE_EXT_FUNCTION(stl_phys)
__DEFINE_EXT_FUNCTION(ldq_phys)
__DEFINE_EXT_FUNCTION(stq_phys)
#if 0
//Implementing these functions prevents special function handler
//from being called...
if (execute_llvm) {
__DEFINE_EXT_FUNCTION(tcg_llvm_fork_and_concretize)
__DEFINE_EXT_FUNCTION(tcg_llvm_trace_memory_access)
__DEFINE_EXT_FUNCTION(tcg_llvm_trace_port_access)
}
#endif
if(UseSelectCleaner) {
m_tcgLLVMContext->getFunctionPassManager()->add(new SelectRemovalPass());
m_tcgLLVMContext->getFunctionPassManager()->doInitialization();
}
ModuleOptions MOpts = ModuleOptions(vector<string>(),
/* Optimize= */ true, /* CheckDivZero= */ false);
/* Set module for the executor */
/**
* When execute_llvm is true, all code is translated to LLVM, then JITed to x86.
* This is basically a debug mode that allows reusing all S2E's plugin infrastructure
* while testing the LLVM backend.
* Symolic execution IS NOT SUPPORTED when running in LLVM mode!
*/
if (!execute_llvm) {
char* filename = qemu_find_file(QEMU_FILE_TYPE_LIB, "op_helper.bc");
assert(filename);
MOpts = ModuleOptions(vector<string>(1, filename),
/* Optimize= */ true, /* CheckDivZero= */ false,
m_tcgLLVMContext->getFunctionPassManager());
g_free(filename);
}
/* This catches obvious LLVM misconfigurations */
Module *M = m_tcgLLVMContext->getModule();
DataLayout TD(M);
assert(M->getPointerSize() == Module::Pointer64 && "Something is broken in your LLVM build: LLVM thinks pointers are 32-bits!");
s2e->getDebugStream() << "Current data layout: " << m_tcgLLVMContext->getModule()->getDataLayout() << '\n';
s2e->getDebugStream() << "Current target triple: " << m_tcgLLVMContext->getModule()->getTargetTriple() << '\n';
setModule(m_tcgLLVMContext->getModule(), MOpts, false);
if (UseFastHelpers) {
disableConcreteLLVMHelpers();
}
/* Add dummy TB function declaration */
PointerType* tbFunctionArgTy =
PointerType::get(IntegerType::get(ctx, 64), 0);
FunctionType* tbFunctionTy = FunctionType::get(
IntegerType::get(ctx, TCG_TARGET_REG_BITS),
ArrayRef<Type*>(vector<Type*>(1, PointerType::get(
IntegerType::get(ctx, 64), 0))),
false);
Function* tbFunction = Function::Create(
tbFunctionTy, Function::PrivateLinkage, "s2e_dummyTbFunction",
m_tcgLLVMContext->getModule());
/* Create dummy main function containing just two instructions:
a call to TB function and ret */
Function* dummyMain = Function::Create(
FunctionType::get(Type::getVoidTy(ctx), false),
Function::PrivateLinkage, "s2e_dummyMainFunction",
m_tcgLLVMContext->getModule());
BasicBlock* dummyMainBB = BasicBlock::Create(ctx, "entry", dummyMain);
vector<Value*> tbFunctionArgs(1, ConstantPointerNull::get(tbFunctionArgTy));
CallInst::Create(tbFunction, ArrayRef<Value*>(tbFunctionArgs),
"tbFunctionCall", dummyMainBB);
ReturnInst::Create(m_tcgLLVMContext->getLLVMContext(), dummyMainBB);
kmodule->updateModuleWithFunction(dummyMain);
m_dummyMain = kmodule->functionMap[dummyMain];
if (!execute_llvm) {
Function* function;
function = kmodule->module->getFunction("tcg_llvm_trace_memory_access");
assert(function);
addSpecialFunctionHandler(function, handlerTraceMemoryAccess);
function = kmodule->module->getFunction("tcg_llvm_trace_port_access");
assert(function);
addSpecialFunctionHandler(function, handlerTracePortAccess);
function = kmodule->module->getFunction("s2e_on_tlb_miss");
assert(function);
addSpecialFunctionHandler(function, handlerOnTlbMiss);
function = kmodule->module->getFunction("tcg_llvm_fork_and_concretize");
assert(function);
addSpecialFunctionHandler(function, handleForkAndConcretize);
function = kmodule->module->getFunction("tcg_llvm_make_symbolic");
assert(function);
addSpecialFunctionHandler(function, handleMakeSymbolic);
function = kmodule->module->getFunction("tcg_llvm_get_value");
assert(function);
addSpecialFunctionHandler(function, handleGetValue);
FunctionType *traceInstTy = FunctionType::get(Type::getVoidTy(M->getContext()), false);
function = dynamic_cast<Function*>(kmodule->module->getOrInsertFunction("tcg_llvm_trace_instruction", traceInstTy));
assert(function);
addSpecialFunctionHandler(function, handlerTraceInstruction);
if (UseFastHelpers) {
replaceExternalFunctionsWithSpecialHandlers();
}
m_tcgLLVMContext->initializeHelpers();
}
initializeStatistics();
searcher = constructUserSearcher(*this);
m_forceConcretizations = false;
g_s2e_fork_on_symbolic_address = ForkOnSymbolicAddress;
g_s2e_concretize_io_addresses = ConcretizeIoAddress;
g_s2e_concretize_io_writes = ConcretizeIoWrites;
concolicMode = ConcolicMode;
concolicTaint = ConcolicTaint;
if (UseFastHelpers) {
if (!ForkOnSymbolicAddress) {
s2e->getWarningsStream()
<< UseFastHelpers.ArgStr << " can only be used if "
<< ForkOnSymbolicAddress.ArgStr << " is enabled\n";
exit(-1);
}
}
}
void S2EExecutor::initializeStatistics()
{
if(StatsTracker::useStatistics()) {
statsTracker =
new S2EStatsTracker(*this,
interpreterHandler->getOutputFilename("assembly.ll"),
userSearcherRequiresMD2U());
statsTracker->writeHeaders();
}
}
void S2EExecutor::flushTb() {
tb_flush(env); // release references to TB functions
}
S2EExecutor::~S2EExecutor()
{
if(statsTracker)
statsTracker->done();
}
S2EExecutionState* S2EExecutor::createInitialState()
{
assert(!processTree);
/* Create initial execution state */
S2EExecutionState *state =
new S2EExecutionState(m_dummyMain);
state->m_runningConcrete = true;
state->m_active = true;
if(pathWriter)
state->pathOS = pathWriter->open();
if(symPathWriter)
state->symPathOS = symPathWriter->open();
if(statsTracker)
statsTracker->framePushed(*state, 0);
states.insert(state);
searcher->update(0, states, std::set<ExecutionState*>());
processTree = new PTree(state);
state->ptreeNode = processTree->root;
/* Externally accessible global vars */
/* XXX move away */
addExternalObject(*state, &tcg_llvm_runtime,
sizeof(tcg_llvm_runtime), false,
/* isUserSpecified = */ true,
/* isSharedConcrete = */ true,
/* isValueIgnored = */ true);
addExternalObject(*state, (void*) tb_function_args,
sizeof(tb_function_args), false,
/* isUserSpecified = */ true,
/* isSharedConcrete = */ true,
/* isValueIgnored = */ true);
#define __DEFINE_EXT_OBJECT_RO(name) \
predefinedSymbols.insert(std::make_pair(#name, (void*) &name)); \
addExternalObject(*state, (void*) &name, sizeof(name), \
true, true, true)->setName(#name);
#define __DEFINE_EXT_OBJECT_RO_SYMB(name) \
predefinedSymbols.insert(std::make_pair(#name, (void*) &name)); \
addExternalObject(*state, (void*) &name, sizeof(name), \
true, true, false)->setName(#name);
__DEFINE_EXT_OBJECT_RO(env)
__DEFINE_EXT_OBJECT_RO(g_s2e)
__DEFINE_EXT_OBJECT_RO(g_s2e_state)
//__DEFINE_EXT_OBJECT_RO(g_s2e_exec_ret_addr)
__DEFINE_EXT_OBJECT_RO(io_mem_read)
__DEFINE_EXT_OBJECT_RO(io_mem_write)
//__DEFINE_EXT_OBJECT_RO(io_mem_opaque)
__DEFINE_EXT_OBJECT_RO(use_icount)
__DEFINE_EXT_OBJECT_RO(cpu_single_env)
__DEFINE_EXT_OBJECT_RO(loglevel)
__DEFINE_EXT_OBJECT_RO(logfile)
__DEFINE_EXT_OBJECT_RO_SYMB(parity_table)
__DEFINE_EXT_OBJECT_RO_SYMB(rclw_table)
__DEFINE_EXT_OBJECT_RO_SYMB(rclb_table)
m_s2e->getMessagesStream(state)
<< "Created initial state" << '\n';
return state;
}
void S2EExecutor::initializeExecution(S2EExecutionState* state,
bool executeAlwaysKlee)
{
#if 0
typedef std::pair<uint64_t, uint64_t> _UnusedMemoryRegion;
foreach(_UnusedMemoryRegion p, m_unusedMemoryRegions) {
/* XXX */
/* XXX : use qemu_virtual* */
#ifdef WIN32
VirtualFree((void*) p.first, p.second, MEM_FREE);
#else
munmap((void*) p.first, p.second);
#endif
}
#endif
m_executeAlwaysKlee = executeAlwaysKlee;
initializeGlobals(*state);
bindModuleConstants();
initTimers();
initializeStateSwitchTimer();
}
void S2EExecutor::registerCpu(S2EExecutionState *initialState,
CPUX86State *cpuEnv)
{
std::cout << std::hex
<< "Adding CPU (addr = " << std::hex << cpuEnv
<< ", size = 0x" << sizeof(*cpuEnv) << ")"