source: icGREP/icgrep-devel/icgrep/grep_engine.cpp @ 5142

Last change on this file since 5142 was 5142, checked in by cameron, 3 years ago

ExternalFileBuffer?, SingleBlockBuffer? fixes

File size: 14.9 KB
Line 
1/*
2 *  Copyright (c) 2016 International Characters.
3 *  This software is licensed to the public under the Open Software License 3.0.
4 *  icgrep is a trademark of International Characters.
5 */
6
7#include <grep_engine.h>
8#include <IDISA/idisa_builder.h>
9#include <IDISA/idisa_target.h>
10#include <llvm/Support/CommandLine.h>
11#include <re/re_toolchain.h>
12#include <re/re_cc.h>
13
14#include <pablo/pablo_toolchain.h>
15#include <toolchain.h>
16#include <pablo/pablo_compiler.h>
17#include <kernels/pipeline.h>
18#include <llvm/IR/Function.h>
19#include <llvm/IR/Type.h>
20#include <llvm/IR/Module.h>
21#include <llvm/ExecutionEngine/MCJIT.h>
22#include <llvm/IRReader/IRReader.h>
23#include <llvm/Support/Debug.h>
24#include <llvm/IR/Verifier.h>
25#include <llvm/IR/TypeBuilder.h>
26#include <UCD/UnicodeNameData.h>
27
28
29#include <kernels/streamset.h>
30#include <kernels/scanmatchgen.h>
31#include <kernels/s2p_kernel.h>
32#include <kernels/cc_kernel.h>
33#include <kernels/pipeline.h>
34
35#include <pablo/function.h>
36#include <pablo/pablo_kernel.h>
37#include <pablo/pablo_toolchain.h>
38
39#include <llvm/IR/Intrinsics.h>
40#include "llvm/Support/SourceMgr.h"
41#include "llvm/IRReader/IRReader.h"
42#include "llvm/Linker/Linker.h"
43
44
45#include <fstream>
46#include <sstream>
47#include <iostream>
48#include <string>
49#include <stdint.h>
50
51#include <stdio.h>
52#include <stdlib.h>
53#include <unistd.h>
54#include <errno.h>
55#include <sys/types.h>
56#include <sys/stat.h>
57#include <stdexcept>
58#include <cctype>
59
60
61#include <llvm/Support/raw_os_ostream.h>
62
63// mmap system
64#include <boost/filesystem.hpp>
65#include <boost/iostreams/device/mapped_file.hpp>
66
67#include <fcntl.h>
68
69#include <kernels/kernel.h>
70
71static cl::OptionCategory bGrepOutputOptions("Output Options",
72                                             "These options control the output.");
73
74static cl::opt<bool> NormalizeLineBreaks("normalize-line-breaks", cl::desc("Normalize line breaks to std::endl."), cl::init(false),  cl::cat(bGrepOutputOptions));
75
76static cl::opt<bool> ShowFileNames("H", cl::desc("Show the file name with each matching line."), cl::cat(bGrepOutputOptions));
77static cl::alias ShowFileNamesLong("with-filename", cl::desc("Alias for -H"), cl::aliasopt(ShowFileNames));
78
79static cl::opt<bool> ShowLineNumbers("n", cl::desc("Show the line number with each matching line."), cl::cat(bGrepOutputOptions));
80static cl::alias ShowLineNumbersLong("line-number", cl::desc("Alias for -n"), cl::aliasopt(ShowLineNumbers));
81
82static cl::opt<bool> pipelineParallel("enable-pipeline-parallel", cl::desc("Enable multithreading with pipeline parallelism."), cl::cat(bGrepOutputOptions));
83
84
85bool isUTF_16 = false;
86
87void GrepEngine::doGrep(const std::string & fileName, const int fileIdx, bool CountOnly, std::vector<size_t> & total_CountOnly, bool UTF_16) {
88    boost::filesystem::path file(fileName);
89    if (exists(file)) {
90        if (is_directory(file)) {
91            return;
92        }
93    } else {
94        std::cerr << "Error: cannot open " << fileName << " for processing. Skipped.\n";
95        return;
96    }
97
98    const auto fileSize = file_size(file);
99    if (fileSize > 0) {
100        try {
101            boost::iostreams::mapped_file_source source(fileName, fileSize, 0);
102            char * fileBuffer = const_cast<char *>(source.data());
103            if (CountOnly) {
104                total_CountOnly[fileIdx] = mGrepFunction_CountOnly(fileBuffer, fileSize, fileIdx);
105            } else {
106                mGrepFunction(fileBuffer, fileSize, fileIdx);
107            }
108            source.close();
109        } catch (std::exception & e) {
110            throw std::runtime_error("Boost mmap error: " + fileName + ": " + e.what());
111        }
112    } else {
113        if (CountOnly) {
114            total_CountOnly[fileIdx] = mGrepFunction_CountOnly(nullptr, 0, fileIdx);
115        } else {
116            mGrepFunction(nullptr, 0, fileIdx);
117        }
118    }
119}
120
121using namespace parabix;
122
123void GrepEngine::grepCodeGen(std::string moduleName, re::RE * re_ast, bool CountOnly, bool UTF_16, bool isNameExpression) {
124    isUTF_16 = UTF_16; 
125    Module * M = new Module(moduleName, getGlobalContext());
126   
127    IDISA::IDISA_Builder * iBuilder = IDISA::GetIDISA_Builder(M);
128
129    const unsigned segmentSize = codegen::SegmentSize;
130    const unsigned bufferSegments = codegen::BufferSegments;
131
132    unsigned encodingBits = UTF_16 ? 16 : 8;
133
134    mIsNameExpression = isNameExpression;
135
136    Type * const int32ty = iBuilder->getInt32Ty();
137    Type * const size_ty = iBuilder->getSizeTy();
138    Type * const int8PtrTy = iBuilder->getInt8PtrTy();
139    Type * const voidTy = Type::getVoidTy(M->getContext());   
140    Type * const voidPtrTy = TypeBuilder<void *, false>::get(M->getContext());
141    Type * const inputType = PointerType::get(ArrayType::get(ArrayType::get(iBuilder->getBitBlockType(), (UTF_16 ? 16 : 8)), 1), 0);
142    Type * const resultTy = CountOnly ? size_ty : iBuilder->getVoidTy();
143    Function * const mainFn = cast<Function>(M->getOrInsertFunction("Main", resultTy, inputType, size_ty, size_ty, nullptr));
144    mainFn->setCallingConv(CallingConv::C);
145    iBuilder->SetInsertPoint(BasicBlock::Create(M->getContext(), "entry", mainFn, 0));
146    Function::arg_iterator args = mainFn->arg_begin();
147   
148    Value * const inputStream = &*(args++);
149    inputStream->setName("input");
150    Value * const fileSize = &*(args++);
151    fileSize->setName("fileSize");
152    Value * const fileIdx = &*(args++);
153    fileIdx->setName("fileIdx");
154       
155    ExternalFileBuffer ByteStream(iBuilder, StreamSetType(1, i8));
156    CircularBuffer BasisBits(iBuilder, StreamSetType(8, i1), segmentSize * bufferSegments);
157
158    kernel::s2pKernel  s2pk(iBuilder);
159    s2pk.generateKernel({&ByteStream}, {&BasisBits});
160   
161    re_ast = re::regular_expression_passes(re_ast);
162    pablo::PabloFunction * function = re::re2pablo_compiler(encodingBits, re_ast, CountOnly);
163    pablo_function_passes(function);
164
165    ByteStream.setStreamSetBuffer(inputStream, fileSize);
166    BasisBits.allocateBuffer();
167
168    Value * s2pInstance = s2pk.createInstance({});
169 
170    Type * pthreadTy = size_ty;
171    FunctionType * funVoidPtrVoidTy = FunctionType::get(voidTy, int8PtrTy, false);   
172   
173    Function * pthreadCreateFunc = cast<Function>(M->getOrInsertFunction("pthread_create",
174                                        int32ty, 
175                                        pthreadTy->getPointerTo(), 
176                                        voidPtrTy, 
177                                        static_cast<Type *>(funVoidPtrVoidTy)->getPointerTo(),
178                                        voidPtrTy, nullptr));
179    pthreadCreateFunc->setCallingConv(llvm::CallingConv::C);
180    Function * pthreadJoinFunc = cast<Function>(M->getOrInsertFunction("pthread_join", 
181                                        int32ty, 
182                                        pthreadTy, 
183                                        PointerType::get(int8PtrTy, 0), nullptr));
184    pthreadJoinFunc->setCallingConv(llvm::CallingConv::C);
185
186    Function * pthreadExitFunc = cast<Function>(M->getOrInsertFunction("pthread_exit", 
187                                        voidTy, 
188                                        voidPtrTy, nullptr));
189    pthreadExitFunc->addFnAttr(llvm::Attribute::NoReturn);
190    pthreadExitFunc->setCallingConv(llvm::CallingConv::C);
191
192    if (CountOnly) {
193        pablo::PabloKernel  icgrepK(iBuilder, "icgrep", function, {"matchedLineCount"});
194        icgrepK.generateKernel({&BasisBits}, {});       
195        Value * icgrepInstance = icgrepK.createInstance({});
196
197        if (pipelineParallel){
198            generatePipelineParallel(iBuilder, {&s2pk, &icgrepK}, {s2pInstance, icgrepInstance});
199        }
200        else{
201            generatePipelineLoop(iBuilder, {&s2pk, &icgrepK}, {s2pInstance, icgrepInstance}, fileSize);
202        }
203       
204        Value * matchCount = icgrepK.createGetAccumulatorCall(icgrepInstance, "matchedLineCount");
205        iBuilder->CreateRet(matchCount);
206
207    }
208    else {
209        CircularBuffer MatchResults(iBuilder, StreamSetType(2, i1), segmentSize * bufferSegments);
210        MatchResults.allocateBuffer();
211
212        pablo::PabloKernel  icgrepK(iBuilder, "icgrep", function, {});
213        icgrepK.generateKernel({&BasisBits},  {&MatchResults});
214        Value * icgrepInstance = icgrepK.createInstance({});
215
216        kernel::scanMatchKernel scanMatchK(iBuilder, mIsNameExpression);
217        scanMatchK.generateKernel({&MatchResults}, {});               
218        Value * scanMatchInstance = scanMatchK.createInstance({iBuilder->CreateBitCast(inputStream, int8PtrTy), fileSize, fileIdx});
219
220        if (pipelineParallel){
221            generatePipelineParallel(iBuilder, {&s2pk, &icgrepK, &scanMatchK}, {s2pInstance, icgrepInstance, scanMatchInstance});
222        }
223        else{
224            generatePipelineLoop(iBuilder, {&s2pk, &icgrepK, &scanMatchK}, {s2pInstance, icgrepInstance, scanMatchInstance}, fileSize);
225        }
226
227        iBuilder->CreateRetVoid();
228
229    }
230     
231    mEngine = JIT_to_ExecutionEngine(M);
232    ApplyObjectCache(mEngine);
233    icgrep_Linking(M, mEngine);
234
235#ifndef NDEBUG
236    verifyModule(*M, &dbgs());
237#endif
238
239    mEngine->finalizeObject();
240    delete iBuilder;
241   
242    if (CountOnly) {
243        mGrepFunction_CountOnly = reinterpret_cast<GrepFunctionType_CountOnly>(mEngine->getPointerToFunction(mainFn));
244    } else {
245        mGrepFunction = reinterpret_cast<GrepFunctionType>(mEngine->getPointerToFunction(mainFn));
246    }
247
248}
249
250re::CC *  GrepEngine::grepCodepoints() {
251
252    setParsedCodePointSet();
253    char * mFileBuffer = getUnicodeNameDataPtr();
254    size_t mFileSize = getUnicodeNameDataSize();
255
256    mGrepFunction(mFileBuffer, mFileSize, 0);
257
258    return getParsedCodePointSet();
259}
260
261GrepEngine::~GrepEngine() {
262    delete mEngine;
263}
264
265
266static int * total_count;
267static std::stringstream * resultStrs = nullptr;
268static std::vector<std::string> inputFiles;
269
270void initResult(std::vector<std::string> filenames){
271    const int n = filenames.size();
272    if (n > 1) {
273        ShowFileNames = true;
274    }
275    inputFiles = filenames;
276    resultStrs = new std::stringstream[n];
277    total_count = new int[n];
278    for (unsigned i = 0; i < inputFiles.size(); ++i){
279        total_count[i] = 0;
280    }
281   
282}
283
284extern "C" {
285    void wrapped_report_match(size_t lineNum, size_t line_start, size_t line_end, const char * buffer, size_t filesize, int fileIdx) {
286        int index = isUTF_16 ? 2 : 1;
287        int idx = fileIdx;
288         
289        if (ShowFileNames) {
290            resultStrs[idx] << inputFiles[idx] << ':';
291        }
292        if (ShowLineNumbers) {
293            resultStrs[idx] << lineNum << ":";
294        }
295       
296        if ((!isUTF_16 && buffer[line_start] == 0xA) && (line_start != line_end)) {
297            // The line "starts" on the LF of a CRLF.  Really the end of the last line.
298            line_start++;
299        }
300        if (((isUTF_16 && buffer[line_start] == 0x0) && buffer[line_start + 1] == 0xA) && (line_start != line_end)) {
301            // The line "starts" on the LF of a CRLF.  Really the end of the last line.
302            line_start += 2;
303        }
304        if (line_end == filesize) {
305            // The match position is at end-of-file.   We have a final unterminated line.
306            resultStrs[idx].write(&buffer[line_start * index], (line_end - line_start) * index);
307            if (NormalizeLineBreaks) {
308                resultStrs[idx] << '\n';  // terminate it
309            }
310            return;
311        }
312        unsigned char end_byte = (unsigned char)buffer[line_end]; 
313        unsigned char penult_byte = (unsigned char)(buffer[line_end - 1]);
314        if (NormalizeLineBreaks) {
315            if (end_byte == 0x85) {
316                // Line terminated with NEL, on the second byte.  Back up 1.
317                line_end--;
318            } else if (end_byte > 0xD) {
319                // Line terminated with PS or LS, on the third byte.  Back up 2.
320                isUTF_16 ? line_end-- : line_end -= 2;
321            }
322            resultStrs[idx].write(&buffer[line_start * index], (line_end - line_start) * index);
323            resultStrs[idx] << '\n';
324        }
325        else {   
326            if ((!isUTF_16 && end_byte == 0x0D) || (isUTF_16 && (end_byte == 0x0D && penult_byte == 0x0))) {
327                // Check for line_end on first byte of CRLF;  note that we don't
328                // want to access past the end of buffer.
329                if (line_end + 1 < filesize) {
330                    if (!isUTF_16 && buffer[line_end + 1] == 0x0A) {
331                        // Found CRLF; preserve both bytes.
332                        line_end++;
333                    }
334                    if (isUTF_16 && buffer[line_end + 1] == 0x0 && buffer[line_end + 2] == 0x0A) {
335                        // Found CRLF; preserve both bytes.
336                        line_end += 2;
337                    }
338                }
339            }
340            resultStrs[idx].write(&buffer[line_start * index], (line_end - line_start + 1) * index);
341        }
342    }
343}
344
345void PrintResult(bool CountOnly, std::vector<size_t> & total_CountOnly){
346    if(CountOnly){
347        if (!ShowFileNames) {
348            for (unsigned i = 0; i < inputFiles.size(); ++i){
349                std::cout << total_CountOnly[i] << std::endl;
350            }
351        }
352        else {
353            for (unsigned i = 0; i < inputFiles.size(); ++i){
354                std::cout << inputFiles[i] << ':' << total_CountOnly[i] << std::endl;
355            };
356        }
357        return;
358    }
359   
360    for (unsigned i = 0; i < inputFiles.size(); ++i){
361        std::cout << resultStrs[i].str();
362    }
363}
364
365re::CC * parsedCodePointSet;
366
367extern "C" {
368    void insert_codepoints(size_t lineNum, size_t line_start, size_t line_end, const char * buffer) {
369        re::codepoint_t c = 0;
370        ssize_t line_pos = line_start;
371        while (isxdigit(buffer[line_pos])) {
372            if (isdigit(buffer[line_pos])) {
373                c = (c << 4) | (buffer[line_pos] - '0');
374            }
375            else {
376                c = (c << 4) | (tolower(buffer[line_pos]) - 'a' + 10);
377            }
378            line_pos++;
379        }
380        assert(((line_pos - line_start) >= 4) && ((line_pos - line_start) <= 6)); // UCD format 4 to 6 hex digits.       
381        parsedCodePointSet->insert(c);
382    }
383}
384
385void setParsedCodePointSet(){
386    parsedCodePointSet = re::makeCC();
387}
388
389re::CC * getParsedCodePointSet(){
390    return parsedCodePointSet;
391}
392
393
394void icgrep_Linking(Module * m, ExecutionEngine * e) {
395    Module::FunctionListType & fns = m->getFunctionList();
396    for (Module::FunctionListType::iterator it = fns.begin(), it_end = fns.end(); it != it_end; ++it) {
397        std::string fnName = it->getName().str();
398        if (fnName == "s2p_block") continue;
399        if (fnName == "process_block") continue;
400        if (fnName == "process_block_initialize_carries") continue;
401       
402        if (fnName == "wrapped_report_match") {
403            e->addGlobalMapping(cast<GlobalValue>(it), (void *)&wrapped_report_match);
404        }
405        if (fnName == "insert_codepoints") {
406            e->addGlobalMapping(cast<GlobalValue>(it), (void *)&insert_codepoints);
407        }
408#ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
409        else {
410            const UCD::ExternalProperty & ep = UCD::resolveExternalProperty(fnName);
411            e->addGlobalMapping(cast<GlobalValue>(it), std::get<0>(ep));
412        }
413#endif
414    }
415}
416
Note: See TracBrowser for help on using the repository browser.