aboutsummaryrefslogtreecommitdiff
path: root/include/cps/RuntimeCheck.h
blob: d2ee1ea3d10a981bc2111c75739f0c752d5bf6d2 (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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

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

namespace cps {

class ExceptionHandler;

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

    llvm::FunctionCallee FprintfFunc;
    llvm::FunctionCallee StderrFunc;   // Windows: __acrt_iob_func(2)
    llvm::GlobalVariable *StderrVar;   // elsewhere: the C library's stderr
    ExceptionHandler &Exceptions;
    bool LibraryMode = false;
    llvm::GlobalVariable *UserLine;
    llvm::Value *DivZeroMsg;
    llvm::Value *OutOfBoundsMsg;
    llvm::Value *EnumRangeMsg;
    llvm::Value *NullDerefMsg;
    llvm::Value *ArrayArgBoundsMsg;

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

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

    void setLibraryMode(bool Enabled) { LibraryMode = Enabled; }
    llvm::Value *lineValue(int Line);
    void setUserLine(int Line);

    // Format a runtime diagnostic (printf-style) and write it to stderr.
    void emitStderr(llvm::Value *Msg, llvm::ArrayRef<llvm::Value *> FmtArgs = {});

    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 throws 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);

    // Print the diagnostic to stderr, then throw an anonymous exception on failure.
    // 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 emitCheck(llvm::Value *Condition, llvm::Value *Msg,
                   llvm::ArrayRef<llvm::Value *> FmtArgs);
};

}