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

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

Some clean ups of encoding info for ccc restructuring.

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 int64ty = iBuilder->getInt64Ty();
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    ExternalUnboundedBuffer 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);
166    BasisBits.allocateBuffer();
167
168    Value * producerPtr = ByteStream.getProducerPosPtr(ByteStream.getStreamSetStructPtr());
169    iBuilder->CreateAlignedStore(fileSize, producerPtr, 8)->setOrdering(Release);
170
171    Value * s2pInstance = s2pk.createInstance({});
172 
173    Type * pthreadTy = int64ty; //Pthread Type for 64-bit machine.
174    FunctionType * funVoidPtrVoidTy = FunctionType::get(voidTy, int8PtrTy, false);   
175   
176    Function * pthreadCreateFunc = cast<Function>(M->getOrInsertFunction("pthread_create",
177                                        int32ty, 
178                                        pthreadTy->getPointerTo(), 
179                                        voidPtrTy, 
180                                        static_cast<Type *>(funVoidPtrVoidTy)->getPointerTo(),
181                                        voidPtrTy, nullptr));
182    pthreadCreateFunc->setCallingConv(llvm::CallingConv::C);
183    Function * pthreadJoinFunc = cast<Function>(M->getOrInsertFunction("pthread_join", 
184                                        int32ty, 
185                                        pthreadTy, 
186                                        PointerType::get(int8PtrTy, 0), nullptr));
187    pthreadJoinFunc->setCallingConv(llvm::CallingConv::C);
188
189    Function * pthreadExitFunc = cast<Function>(M->getOrInsertFunction("pthread_exit", 
190                                        voidTy, 
191                                        voidPtrTy, nullptr));
192    pthreadExitFunc->addFnAttr(llvm::Attribute::NoReturn);
193    pthreadExitFunc->setCallingConv(llvm::CallingConv::C);
194
195    if (CountOnly) {
196        pablo::PabloKernel  icgrepK(iBuilder, "icgrep", function, {"matchedLineCount"});
197        icgrepK.generateKernel({&BasisBits}, {});       
198        Value * icgrepInstance = icgrepK.createInstance({});
199
200        if (pipelineParallel){
201            generatePipelineParallel(iBuilder, {&s2pk, &icgrepK}, {s2pInstance, icgrepInstance});
202        }
203        else{
204            generatePipelineLoop(iBuilder, {&s2pk, &icgrepK}, {s2pInstance, icgrepInstance}, fileSize);
205        }
206       
207        Value * matchCount = icgrepK.createGetAccumulatorCall(icgrepInstance, "matchedLineCount");
208        iBuilder->CreateRet(matchCount);
209
210    }
211    else {
212        CircularBuffer MatchResults(iBuilder, StreamSetType(2, i1), segmentSize * bufferSegments);
213        MatchResults.allocateBuffer();
214
215        pablo::PabloKernel  icgrepK(iBuilder, "icgrep", function, {});
216        icgrepK.generateKernel({&BasisBits},  {&MatchResults});
217        Value * icgrepInstance = icgrepK.createInstance({});
218
219        kernel::scanMatchKernel scanMatchK(iBuilder, mIsNameExpression);
220        scanMatchK.generateKernel({&MatchResults}, {});               
221        Value * scanMatchInstance = scanMatchK.createInstance({iBuilder->CreateBitCast(inputStream, int8PtrTy), fileSize, fileIdx});
222
223        if (pipelineParallel){
224            generatePipelineParallel(iBuilder, {&s2pk, &icgrepK, &scanMatchK}, {s2pInstance, icgrepInstance, scanMatchInstance});
225        }
226        else{
227            generatePipelineLoop(iBuilder, {&s2pk, &icgrepK, &scanMatchK}, {s2pInstance, icgrepInstance, scanMatchInstance}, fileSize);
228        }
229
230        iBuilder->CreateRetVoid();
231
232    }
233     
234    mEngine = JIT_to_ExecutionEngine(M);
235    ApplyObjectCache(mEngine);
236    icgrep_Linking(M, mEngine);
237
238#ifndef NDEBUG
239    verifyModule(*M, &dbgs());
240#endif
241
242    mEngine->finalizeObject();
243    delete iBuilder;
244   
245    if (CountOnly) {
246        mGrepFunction_CountOnly = reinterpret_cast<GrepFunctionType_CountOnly>(mEngine->getPointerToFunction(mainFn));
247    } else {
248        mGrepFunction = reinterpret_cast<GrepFunctionType>(mEngine->getPointerToFunction(mainFn));
249    }
250
251}
252
253re::CC *  GrepEngine::grepCodepoints() {
254
255    setParsedCodePointSet();
256    char * mFileBuffer = getUnicodeNameDataPtr();
257    size_t mFileSize = getUnicodeNameDataSize();
258
259    mGrepFunction(mFileBuffer, mFileSize, 0);
260
261    return getParsedCodePointSet();
262}
263
264GrepEngine::~GrepEngine() {
265    delete mEngine;
266}
267
268
269static int * total_count;
270static std::stringstream * resultStrs = nullptr;
271static std::vector<std::string> inputFiles;
272
273void initResult(std::vector<std::string> filenames){
274    const int n = filenames.size();
275    if (n > 1) {
276        ShowFileNames = true;
277    }
278    inputFiles = filenames;
279    resultStrs = new std::stringstream[n];
280    total_count = new int[n];
281    for (unsigned i = 0; i < inputFiles.size(); ++i){
282        total_count[i] = 0;
283    }
284   
285}
286
287extern "C" {
288    void wrapped_report_match(size_t lineNum, size_t line_start, size_t line_end, const char * buffer, size_t filesize, int fileIdx) {
289        int index = isUTF_16 ? 2 : 1;
290        int idx = fileIdx;
291         
292        if (ShowFileNames) {
293            resultStrs[idx] << inputFiles[idx] << ':';
294        }
295        if (ShowLineNumbers) {
296            resultStrs[idx] << lineNum << ":";
297        }
298       
299        if ((!isUTF_16 && buffer[line_start] == 0xA) && (line_start != line_end)) {
300            // The line "starts" on the LF of a CRLF.  Really the end of the last line.
301            line_start++;
302        }
303        if (((isUTF_16 && buffer[line_start] == 0x0) && buffer[line_start + 1] == 0xA) && (line_start != line_end)) {
304            // The line "starts" on the LF of a CRLF.  Really the end of the last line.
305            line_start += 2;
306        }
307        if (line_end == filesize) {
308            // The match position is at end-of-file.   We have a final unterminated line.
309            resultStrs[idx].write(&buffer[line_start * index], (line_end - line_start) * index);
310            if (NormalizeLineBreaks) {
311                resultStrs[idx] << '\n';  // terminate it
312            }
313            return;
314        }
315        unsigned char end_byte = (unsigned char)buffer[line_end]; 
316        unsigned char penult_byte = (unsigned char)(buffer[line_end - 1]);
317        if (NormalizeLineBreaks) {
318            if (end_byte == 0x85) {
319                // Line terminated with NEL, on the second byte.  Back up 1.
320                line_end--;
321            } else if (end_byte > 0xD) {
322                // Line terminated with PS or LS, on the third byte.  Back up 2.
323                isUTF_16 ? line_end-- : line_end -= 2;
324            }
325            resultStrs[idx].write(&buffer[line_start * index], (line_end - line_start) * index);
326            resultStrs[idx] << '\n';
327        }
328        else {   
329            if ((!isUTF_16 && end_byte == 0x0D) || (isUTF_16 && (end_byte == 0x0D && penult_byte == 0x0))) {
330                // Check for line_end on first byte of CRLF;  note that we don't
331                // want to access past the end of buffer.
332                if (line_end + 1 < filesize) {
333                    if (!isUTF_16 && buffer[line_end + 1] == 0x0A) {
334                        // Found CRLF; preserve both bytes.
335                        line_end++;
336                    }
337                    if (isUTF_16 && buffer[line_end + 1] == 0x0 && buffer[line_end + 2] == 0x0A) {
338                        // Found CRLF; preserve both bytes.
339                        line_end += 2;
340                    }
341                }
342            }
343            resultStrs[idx].write(&buffer[line_start * index], (line_end - line_start + 1) * index);
344        }
345    }
346}
347
348void PrintResult(bool CountOnly, std::vector<size_t> & total_CountOnly){
349    if(CountOnly){
350        if (!ShowFileNames) {
351            for (unsigned i = 0; i < inputFiles.size(); ++i){
352                std::cout << total_CountOnly[i] << std::endl;
353            }
354        }
355        else {
356            for (unsigned i = 0; i < inputFiles.size(); ++i){
357                std::cout << inputFiles[i] << ':' << total_CountOnly[i] << std::endl;
358            };
359        }
360        return;
361    }
362   
363    for (unsigned i = 0; i < inputFiles.size(); ++i){
364        std::cout << resultStrs[i].str();
365    }
366}
367
368re::CC * parsedCodePointSet;
369
370extern "C" {
371    void insert_codepoints(size_t lineNum, size_t line_start, size_t line_end, const char * buffer) {
372        re::codepoint_t c = 0;
373        ssize_t line_pos = line_start;
374        while (isxdigit(buffer[line_pos])) {
375            if (isdigit(buffer[line_pos])) {
376                c = (c << 4) | (buffer[line_pos] - '0');
377            }
378            else {
379                c = (c << 4) | (tolower(buffer[line_pos]) - 'a' + 10);
380            }
381            line_pos++;
382        }
383        assert(((line_pos - line_start) >= 4) && ((line_pos - line_start) <= 6)); // UCD format 4 to 6 hex digits.       
384        parsedCodePointSet->insert(c);
385    }
386}
387
388void setParsedCodePointSet(){
389    parsedCodePointSet = re::makeCC();
390}
391
392re::CC * getParsedCodePointSet(){
393    return parsedCodePointSet;
394}
395
396
397void icgrep_Linking(Module * m, ExecutionEngine * e) {
398    Module::FunctionListType & fns = m->getFunctionList();
399    for (Module::FunctionListType::iterator it = fns.begin(), it_end = fns.end(); it != it_end; ++it) {
400        std::string fnName = it->getName().str();
401        if (fnName == "s2p_block") continue;
402        if (fnName == "process_block") continue;
403        if (fnName == "process_block_initialize_carries") continue;
404       
405        if (fnName == "wrapped_report_match") {
406            e->addGlobalMapping(cast<GlobalValue>(it), (void *)&wrapped_report_match);
407        }
408        if (fnName == "insert_codepoints") {
409            e->addGlobalMapping(cast<GlobalValue>(it), (void *)&insert_codepoints);
410        }
411#ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
412        else {
413            const UCD::ExternalProperty & ep = UCD::resolveExternalProperty(fnName);
414            e->addGlobalMapping(cast<GlobalValue>(it), std::get<0>(ep));
415        }
416#endif
417    }
418}
419
Note: See TracBrowser for help on using the repository browser.