aboutsummaryrefslogtreecommitdiff
path: root/include/cps/RuntimeCheck.h
blob: 51a07aa7bf9037fec82b6ae3a5d39dcf599f51ba (plain)
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

#pragma once
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include <cstdint>
#include <string>

namespace cps {

class RuntimeCheck {
    llvm::Module &TheModule;
    llvm::LLVMContext &TheContext;
    llvm::IRBuilder<> &Builder;

    llvm::FunctionCallee PrintfFunc;
    llvm::FunctionCallee ExitFunc;
    llvm::Value *DivZeroMsg;
    llvm::Value *OutOfBoundsMsg;
    llvm::Value *EnumRangeMsg;
    llvm::Value *NullDerefMsg;
    llvm::Value *ArrayArgBoundsMsg;

    void setupExternalFunctions();
    void emitErrorAndExit(llvm::Value *Condition, llvm::Value *Msg, int Line);

public:
    RuntimeCheck(llvm::Module &M, llvm::LLVMContext &C, llvm::IRBuilder<> &B);

    void emitDivZeroCheck(llvm::Value *Divisor, int Line);
    void emitIndexCheck(llvm::Value *Index, llvm::Value *Lower, llvm::Value *Upper, int Line);

    // Enum +/- INTEGER results must stay inside the enum's value range.
    void emitEnumRangeCheck(llvm::Value *Ordinal, uint64_t ValueCount,
                            const std::string &TypeName, int Line);

    // Dereferencing an unset (null) pointer dies instead of segfaulting.
    void emitNullDerefCheck(llvm::Value *Ptr, int Line);

    // A bounded array parameter is a contract: the argument's runtime bounds
    // must equal the declared ones.
    void emitArrayArgBoundsCheck(llvm::Value *ActualLower, llvm::Value *ActualUpper,
                                 int64_t DeclaredLower, int64_t DeclaredUpper, int Line);

    // Runtime-computed variant: FmtArgs are the printf varargs after Msg
    // (e.g. {i32 line, ptr filename}). Needed when the failure site is inside
    // a synthesized helper function, where the line number is an argument
    // rather than a compile-time constant.
    void emitErrorAndExit(llvm::Value *Condition, llvm::Value *Msg,
                          llvm::ArrayRef<llvm::Value *> FmtArgs);
};

}