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

Last change on this file since 5139 was 5139, checked in by lindanl, 3 years ago

change getInt64Ty to getSizeTy.

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