summaryrefslogtreecommitdiff
path: root/plugins/warp/api/warpcore.h
blob: c1762ae62cf03ed08ce87c5f53d0cba5d2a344eb (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
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
#pragma once

#ifndef BN_TYPE_PARSER
#ifdef __cplusplus
#include <cstdint>
#include <cstddef>
#include <cstdlib>
#else
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#include <stdlib.h>
#endif
#endif

#ifdef __GNUC__
    #ifdef WARP_LIBRARY
        #define WARP_FFI_API __attribute__((visibility("default")))
    #else  // WARP_LIBRARY
        #define WARP_FFI_API
    #endif  // WARP_LIBRARY
#else       // __GNUC__
    #ifdef _MSC_VER
        #ifndef DEMO_EDITION
            #ifdef WARP_LIBRARY
                #define WARP_FFI_API __declspec(dllexport)
            #else  // WARP_LIBRARY
                #define WARP_FFI_API __declspec(dllimport)
            #endif  // WARP_LIBRARY
        #else
            #define WARP_FFI_API
        #endif
    #else  // _MSC_VER
        #define WARP_FFI_API
    #endif  // _MSC_VER
#endif      // __GNUC__C

#ifdef __cplusplus
extern "C"
{
#endif

    typedef struct BNArchitecture BNArchitecture;
    typedef struct BNBinaryView BNBinaryView;
    typedef struct BNPlatform BNPlatform;
    typedef struct BNBasicBlock BNBasicBlock;
    typedef struct BNLowLevelILFunction BNLowLevelILFunction;
    typedef struct BNFunction BNFunction;
    typedef struct BNSymbol BNSymbol;
    typedef struct BNType BNType;
    typedef struct BNDataBuffer BNDataBuffer;
    typedef struct BNProject BNProject;
    typedef struct BNProjectFile BNProjectFile;

    struct BNWARPUUID
    {
        uint8_t uuid[16];
    };

    struct BNWARPFunctionComment
    {
        char* text;
        int64_t offset;
    };

    char* BNWARPUUIDGetString(const BNWARPUUID* uuid);
    bool BNWARPUUIDFromString(const char* str, BNWARPUUID* uuid);
    bool BNWARPUUIDEqual(const BNWARPUUID* a, const BNWARPUUID* b);
    void BNWARPFreeUUIDList(BNWARPUUID* uuids, size_t count);

    typedef BNWARPUUID BNWARPSource;
    typedef BNWARPUUID BNWARPBasicBlockGUID;
    typedef BNWARPUUID BNWARPConstraintGUID;
    typedef BNWARPUUID BNWARPFunctionGUID;
    typedef BNWARPUUID BNWARPTypeGUID;

    typedef struct BNWARPProcessor BNWARPProcessor;
    typedef struct BNWARPFile BNWARPFile;
    typedef struct BNWARPChunk BNWARPChunk;
    typedef struct BNWARPTarget BNWARPTarget;
    typedef struct BNWARPContainer BNWARPContainer;
    typedef struct BNWARPFunction BNWARPFunction;
    typedef struct BNWARPType BNWARPType;
    typedef struct BNWARPConstraint BNWARPConstraint;
    typedef struct BNWARPContainerSearchQuery BNWARPContainerSearchQuery;
    typedef struct BNWARPContainerSearchItem BNWARPContainerSearchItem;

    typedef enum BNWARPProcessorIncludedData : uint8_t
    {
        WARPProcessorIncludedDataSymbols = 0,
        WARPProcessorIncludedDataSignatures = 1,
        WARPProcessorIncludedDataTypes = 2,
        WARPProcessorIncludedDataAll = 3,
    } BNWARPProcessorIncludedData;

    typedef enum BNWARPProcessorIncludedFunctions : uint8_t
    {
        WARPProcessorIncludedFunctionsSelected = 0,
        WARPProcessorIncludedFunctionsAnnotated = 1,
        WARPProcessorIncludedFunctionsAll = 2,
    } BNWARPProcessorIncludedFunctions;

    typedef enum BNWARPContainerSearchItemKind
    {
        WARPContainerSearchItemKindSource = 0,
        WARPContainerSearchItemKindFunction = 1,
        WARPContainerSearchItemKindType = 2,
        WARPContainerSearchItemKindSymbol = 3,
    } BNWARPContainerSearchItemKind;

    struct BNWARPContainerSearchResponse
    {
        size_t count;
        BNWARPContainerSearchItem** items;
        size_t offset;
        size_t total;
    };

    struct BNWARPConstraint
    {
        BNWARPConstraintGUID guid;
        int64_t offset;
    };
    
    struct BNWARPProcessorState
    {
        bool cancelled;
        size_t unprocessedFilesCount;
        size_t processedFilesCount;
        char** analyzingFiles;
        size_t analyzingFilesCount;
        char** processingFiles;
        size_t processingFilesCount;
    };

    WARP_FFI_API BNWARPProcessor* BNWARPNewProcessor(BNWARPProcessorIncludedData includedData, BNWARPProcessorIncludedFunctions includedFunctions, size_t workerCount);
    WARP_FFI_API void BNWARPProcessorAddPath(BNWARPProcessor* processor, const char* path);
    WARP_FFI_API void BNWARPProcessorAddProject(BNWARPProcessor* processor, BNProject* project);
    WARP_FFI_API void BNWARPProcessorAddProjectFile(BNWARPProcessor* processor, BNProjectFile* projectFile);
    WARP_FFI_API void BNWARPProcessorAddBinaryView(BNWARPProcessor* processor, BNBinaryView* view);
    WARP_FFI_API BNWARPFile* BNWARPProcessorStart(BNWARPProcessor* processor);
    WARP_FFI_API void BNWARPProcessorCancel(BNWARPProcessor* processor);
    WARP_FFI_API BNWARPProcessorState BNWARPProcessorGetState(BNWARPProcessor* processor);
    WARP_FFI_API void BNWARPFreeProcessor(BNWARPProcessor* processor);
    WARP_FFI_API void BNWARPFreeProcessorState(BNWARPProcessorState processorState);

    WARP_FFI_API void BNWARPRunMatcher(BNBinaryView* view);

    WARP_FFI_API bool BNWARPGetBasicBlockGUID(BNBasicBlock* basicBlock, BNWARPBasicBlockGUID* result);
    WARP_FFI_API bool BNWARPGetAnalysisFunctionGUID(BNFunction* analysisFunction, BNWARPFunctionGUID* result);
    WARP_FFI_API bool BNWARPIsLiftedInstructionVariant(BNLowLevelILFunction* liftedFunction, size_t idx);
    WARP_FFI_API bool BNWARPIsLiftedInstructionBlacklisted(BNLowLevelILFunction* liftedFunction, size_t idx);
    WARP_FFI_API bool BNWARPIsLowLevelInstructionComputedVariant(BNLowLevelILFunction* llilFunction, size_t idx);

    WARP_FFI_API BNWARPFunction* BNWARPGetFunction(BNFunction* analysisFunction);
    WARP_FFI_API BNWARPFunction* BNWARPGetMatchedFunction(BNFunction* analysisFunction);
    WARP_FFI_API BNWARPContainer** BNWARPGetContainers(size_t* count);
    WARP_FFI_API BNWARPContainer* BNWARPAddContainer(const char* name);

    WARP_FFI_API char* BNWARPContainerGetName(BNWARPContainer* container);

    WARP_FFI_API BNWARPSource* BNWARPContainerGetSources(BNWARPContainer* container, size_t* count);
    WARP_FFI_API bool BNWARPContainerAddSource(BNWARPContainer* container, const char* sourcePath, BNWARPSource* result);
    WARP_FFI_API bool BNWARPContainerCommitSource(BNWARPContainer* container, const BNWARPSource* source);
    WARP_FFI_API bool BNWARPContainerIsSourceUncommitted(BNWARPContainer* container, const BNWARPSource* source);
    WARP_FFI_API bool BNWARPContainerIsSourceWritable(BNWARPContainer* container, const BNWARPSource* source);
    WARP_FFI_API char* BNWARPContainerGetSourcePath(BNWARPContainer* container, const BNWARPSource* source);

    WARP_FFI_API bool BNWARPContainerAddFunctions(BNWARPContainer* container, const BNWARPTarget* target, const BNWARPSource* source, BNWARPFunction** functions, size_t count);
    WARP_FFI_API bool BNWARPContainerAddTypes(BNWARPContainer* container, const BNWARPSource* source, BNWARPType** types, size_t count);

    WARP_FFI_API bool BNWARPContainerRemoveFunctions(BNWARPContainer* container, const BNWARPTarget* target, const BNWARPSource* source, BNWARPFunction** functions, size_t count);
    WARP_FFI_API bool BNWARPContainerRemoveTypes(BNWARPContainer* container, const BNWARPSource* source, BNWARPTypeGUID* types, size_t count);

    WARP_FFI_API void BNWARPContainerFetchFunctions(BNWARPContainer* container, BNWARPTarget* target, const char** sourceTags, size_t sourceTagCount, const BNWARPFunctionGUID* guids, size_t count, const BNWARPConstraintGUID* constraints, size_t constraintCount);

    WARP_FFI_API BNWARPSource* BNWARPContainerGetSourcesWithFunctionGUID(BNWARPContainer* container, const BNWARPTarget* target, const BNWARPFunctionGUID* guid, size_t* count);
    WARP_FFI_API BNWARPSource* BNWARPContainerGetSourcesWithTypeGUID(BNWARPContainer* container, const BNWARPTypeGUID* guid, size_t* count);
    WARP_FFI_API BNWARPFunction** BNWARPContainerGetFunctionsWithGUID(BNWARPContainer* container, const BNWARPTarget* target, const BNWARPSource* source, const BNWARPFunctionGUID* guid, size_t* count);
    WARP_FFI_API BNWARPType* BNWARPContainerGetTypeWithGUID(BNWARPContainer* container, const BNWARPSource* source, const BNWARPTypeGUID* guid);
    WARP_FFI_API BNWARPTypeGUID* BNWARPContainerGetTypeGUIDsWithName(BNWARPContainer* container, const BNWARPSource* source, const char* name, size_t* count);

    WARP_FFI_API BNWARPContainer* BNWARPNewContainerReference(BNWARPContainer* container);
    WARP_FFI_API void BNWARPFreeContainerReference(BNWARPContainer* container);
    WARP_FFI_API void BNWARPFreeContainerList(BNWARPContainer** containers, size_t count);

    WARP_FFI_API BNWARPContainerSearchQuery* BNWARPNewContainerSearchQuery(const char* query, const size_t* offset, const size_t* limit, const BNWARPSource* source, const char** sourceTags, size_t sourceTagCount);

    WARP_FFI_API BNWARPContainerSearchResponse* BNWARPContainerSearch(BNWARPContainer* container, const BNWARPContainerSearchQuery* query);

    WARP_FFI_API BNWARPContainerSearchItemKind BNWARPContainerSearchItemGetKind(BNWARPContainerSearchItem* item);
    WARP_FFI_API BNWARPSource BNWARPContainerSearchItemGetSource(BNWARPContainerSearchItem* item);
    WARP_FFI_API BNWARPType* BNWARPContainerSearchItemGetType(BNWARPContainerSearchItem* item);
    WARP_FFI_API char* BNWARPContainerSearchItemGetName(BNWARPContainerSearchItem* item);
    WARP_FFI_API BNWARPFunction* BNWARPContainerSearchItemGetFunction(BNWARPContainerSearchItem* item);

    WARP_FFI_API BNWARPContainerSearchQuery* BNWARPNewContainerSearchQueryReference(BNWARPContainerSearchQuery* query);
    WARP_FFI_API void BNWARPFreeContainerSearchQueryReference(BNWARPContainerSearchQuery* query);

    WARP_FFI_API BNWARPContainerSearchItem* BNWARPNewContainerSearchItemReference(BNWARPContainerSearchItem* item);
    WARP_FFI_API void BNWARPFreeContainerSearchItemReference(BNWARPContainerSearchItem* item);
    WARP_FFI_API void BNWARPFreeContainerSearchItemList(BNWARPContainerSearchItem** items, size_t count);

    WARP_FFI_API void BNWARPFreeContainerSearchResponse(BNWARPContainerSearchResponse* response);

    WARP_FFI_API void BNWARPFunctionApply(BNWARPFunction* function, BNFunction* analysisFunction);
    WARP_FFI_API BNWARPFunctionGUID BNWARPFunctionGetGUID(BNWARPFunction* function);
    WARP_FFI_API BNSymbol* BNWARPFunctionGetSymbol(BNWARPFunction* function, BNFunction* analysisFunction);
    WARP_FFI_API char* BNWARPFunctionGetSymbolName(BNWARPFunction* function);
    WARP_FFI_API BNWARPType* BNWARPFunctionGetType(BNWARPFunction* function);
    WARP_FFI_API BNWARPConstraint* BNWARPFunctionGetConstraints(BNWARPFunction* function, size_t* count);
    WARP_FFI_API BNWARPFunctionComment* BNWARPFunctionGetComments(BNWARPFunction* function, size_t* count);
    WARP_FFI_API bool BNWARPFunctionsEqual(BNWARPFunction* functionA, BNWARPFunction* functionB);

    WARP_FFI_API void BNWARPFreeFunctionCommentList(BNWARPFunctionComment* comments, size_t count);
    WARP_FFI_API void BNWARPFreeConstraintList(BNWARPConstraint* constraints, size_t count);

    WARP_FFI_API BNWARPFunction* BNWARPNewFunctionReference(BNWARPFunction* function);
    WARP_FFI_API void BNWARPFreeFunctionReference(BNWARPFunction* function);
    WARP_FFI_API void BNWARPFreeFunctionList(BNWARPFunction** functions, size_t count);

    WARP_FFI_API BNWARPType* BNWARPGetType(BNType* analysisType, uint8_t confidence);
    WARP_FFI_API char* BNWARPTypeGetName(BNWARPType* ty);
    WARP_FFI_API uint8_t BNWARPTypeGetConfidence(BNWARPType* ty);
    WARP_FFI_API BNType* BNWARPTypeGetAnalysisType(BNArchitecture* arch, BNWARPType* ty);

    WARP_FFI_API BNWARPType* BNWARPNewTypeReference(BNWARPType* ty);
    WARP_FFI_API void BNWARPFreeTypeReference(BNWARPType* ty);

    WARP_FFI_API BNWARPTarget* BNWARPGetTarget(BNPlatform* platform);

    WARP_FFI_API BNWARPTarget* BNWARPNewTargetReference(BNWARPTarget* target);
    WARP_FFI_API void BNWARPFreeTargetReference(BNWARPTarget* target);

    WARP_FFI_API BNWARPFile* BNWARPNewFileFromPath(const char* path);

    WARP_FFI_API BNWARPChunk** BNWARPFileGetChunks(BNWARPFile* file, size_t* count);
    WARP_FFI_API BNDataBuffer* BNWARPFileToDataBuffer(BNWARPFile* file);
    
    WARP_FFI_API BNWARPTarget* BNWARPChunkGetTarget(BNWARPChunk* chunk);
    WARP_FFI_API BNWARPFunction** BNWARPChunkGetFunctions(BNWARPChunk* chunk, size_t* count);
    WARP_FFI_API BNWARPType** BNWARPChunkGetTypes(BNWARPChunk* chunk, size_t* count);

    WARP_FFI_API BNWARPFile* BNWARPNewFileReference(BNWARPFile* file);
    WARP_FFI_API void BNWARPFreeFileReference(BNWARPFile* file);

    WARP_FFI_API BNWARPChunk* BNWARPNewChunkReference(BNWARPChunk* chunk);
    WARP_FFI_API void BNWARPFreeChunkReference(BNWARPChunk* chunk);

    WARP_FFI_API void BNWARPFreeChunkList(BNWARPChunk** chunks, size_t count);
    WARP_FFI_API void BNWARPFreeTypeList(BNWARPType** types, size_t count);

#ifdef __cplusplus
}
#endif