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

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

refine PabloKernel? signature based on CountOnly? parameter

File size: 13.2 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 <utf_encoding.h>
17#include <pablo/pablo_compiler.h>
18#include <kernels/pipeline.h>
19#include <llvm/IR/Function.h>
20#include <llvm/IR/Type.h>
21#include <llvm/IR/Module.h>
22#include <llvm/ExecutionEngine/MCJIT.h>
23#include <llvm/IRReader/IRReader.h>
24#include <llvm/Support/Debug.h>
25#include <llvm/IR/Verifier.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
81
82bool isUTF_16 = false;
83
84void GrepEngine::doGrep(const std::string & fileName, const int fileIdx, bool CountOnly, std::vector<size_t> & total_CountOnly, bool UTF_16) {
85    boost::filesystem::path file(fileName);
86    if (exists(file)) {
87        if (is_directory(file)) {
88            return;
89        }
90    } else {
91        std::cerr << "Error: cannot open " << fileName << " for processing. Skipped.\n";
92        return;
93    }
94
95    const auto fileSize = file_size(file);
96    if (fileSize > 0) {
97        try {
98            boost::iostreams::mapped_file_source source(fileName, fileSize, 0);
99            char * fileBuffer = const_cast<char *>(source.data());
100            if (CountOnly) {
101                total_CountOnly[fileIdx] = mGrepFunction_CountOnly(fileBuffer, fileSize, fileIdx);
102            } else {
103                mGrepFunction(fileBuffer, fileSize, fileIdx);
104            }
105            source.close();
106        } catch (std::exception & e) {
107            throw std::runtime_error("Boost mmap error: " + fileName + ": " + e.what());
108        }
109    } else {
110        if (CountOnly) {
111            total_CountOnly[fileIdx] = mGrepFunction_CountOnly(nullptr, 0, fileIdx);
112        } else {
113            mGrepFunction(nullptr, 0, fileIdx);
114        }
115    }
116}
117
118using namespace parabix;
119
120void GrepEngine::grepCodeGen(std::string moduleName, re::RE * re_ast, bool CountOnly, bool UTF_16, bool isNameExpression) {
121    isUTF_16 = UTF_16; 
122    Module * M = new Module(moduleName, getGlobalContext());
123   
124    IDISA::IDISA_Builder * iBuilder = IDISA::GetIDISA_Builder(M);
125
126    const unsigned segmentSize = codegen::SegmentSize;
127
128    Encoding::Type type;
129    type = UTF_16 ? Encoding::Type::UTF_16 : Encoding::Type::UTF_8;
130    unsigned bits;
131    bits = UTF_16 ? 16 : 8;
132
133    Encoding encoding(type, bits);
134    mIsNameExpression = isNameExpression;
135
136    Type * const size_ty = iBuilder->getSizeTy();
137    Type * const int8PtrTy = iBuilder->getInt8PtrTy();
138    Type * const inputType = PointerType::get(ArrayType::get(ArrayType::get(iBuilder->getBitBlockType(), (UTF_16 ? 16 : 8)), 1), 0);
139    Type * const resultTy = CountOnly ? size_ty : iBuilder->getVoidTy();
140    Function * const mainFn = cast<Function>(M->getOrInsertFunction("Main", resultTy, inputType, size_ty, size_ty, nullptr));
141    mainFn->setCallingConv(CallingConv::C);
142    iBuilder->SetInsertPoint(BasicBlock::Create(M->getContext(), "entry", mainFn, 0));
143    Function::arg_iterator args = mainFn->arg_begin();
144   
145    Value * const inputStream = &*(args++);
146    inputStream->setName("input");
147    Value * const fileSize = &*(args++);
148    fileSize->setName("fileSize");
149    Value * const fileIdx = &*(args++);
150    fileIdx->setName("fileIdx");
151
152       
153    ExternalUnboundedBuffer ByteStream(iBuilder, StreamSetType(1, i8));
154    CircularBuffer BasisBits(iBuilder, StreamSetType(8, i1), segmentSize);
155
156    kernel::s2pKernel  s2pk(iBuilder);
157    s2pk.generateKernel({&ByteStream}, {&BasisBits});
158
159    re_ast = re::regular_expression_passes(encoding, re_ast);   
160    pablo::PabloFunction * function = re::re2pablo_compiler(encoding, re_ast, CountOnly);
161    pablo_function_passes(function);
162   
163    if (CountOnly) {
164        pablo::PabloKernel  icgrepK(iBuilder, "icgrep", function, {"matchedLineCount"});
165        icgrepK.generateKernel({&BasisBits}, {});
166
167        ByteStream.setStreamSetBuffer(inputStream);
168        BasisBits.allocateBuffer();
169       
170        Value * s2pInstance = s2pk.createInstance({});
171        Value * icgrepInstance = icgrepK.createInstance({});
172       
173        generatePipelineLoop(iBuilder, {&s2pk, &icgrepK}, {s2pInstance, icgrepInstance}, fileSize);
174        Value * matchCount = icgrepK.createGetAccumulatorCall(icgrepInstance, "matchedLineCount");
175        iBuilder->CreateRet(matchCount);
176    }
177    else {
178        CircularBuffer MatchResults(iBuilder, StreamSetType(2, i1), segmentSize);
179        pablo::PabloKernel  icgrepK(iBuilder, "icgrep", function, {});
180        icgrepK.generateKernel({&BasisBits},  {&MatchResults});
181
182        ByteStream.setStreamSetBuffer(inputStream);
183        BasisBits.allocateBuffer();
184        MatchResults.allocateBuffer();
185       
186        Value * s2pInstance = s2pk.createInstance({});
187        Value * icgrepInstance = icgrepK.createInstance({});
188        kernel::scanMatchKernel scanMatchK(iBuilder, mIsNameExpression);
189        scanMatchK.generateKernel({&MatchResults}, {});
190               
191        Value * scanMatchInstance = scanMatchK.createInstance({iBuilder->CreateBitCast(inputStream, int8PtrTy), fileSize, fileIdx});
192       
193        generatePipelineLoop(iBuilder, {&s2pk, &icgrepK, &scanMatchK}, {s2pInstance, icgrepInstance, scanMatchInstance}, fileSize);
194        iBuilder->CreateRetVoid();
195    }
196   
197    mEngine = JIT_to_ExecutionEngine(M);
198    ApplyObjectCache(mEngine);
199    icgrep_Linking(M, mEngine);
200
201#ifndef NDEBUG
202    verifyModule(*M, &dbgs());
203#endif
204
205    mEngine->finalizeObject();
206    delete iBuilder;
207   
208    if (CountOnly) {
209        mGrepFunction_CountOnly = reinterpret_cast<GrepFunctionType_CountOnly>(mEngine->getPointerToFunction(mainFn));
210    } else {
211        mGrepFunction = reinterpret_cast<GrepFunctionType>(mEngine->getPointerToFunction(mainFn));
212    }
213
214}
215
216
217
218re::CC *  GrepEngine::grepCodepoints() {
219
220    setParsedCodePointSet();
221    char * mFileBuffer = getUnicodeNameDataPtr();
222    size_t mFileSize = getUnicodeNameDataSize();
223
224    mGrepFunction(mFileBuffer, mFileSize, 0);
225
226    return getParsedCodePointSet();
227}
228
229GrepEngine::~GrepEngine() {
230    delete mEngine;
231}
232
233
234static int * total_count;
235static std::stringstream * resultStrs = nullptr;
236static std::vector<std::string> inputFiles;
237
238void initResult(std::vector<std::string> filenames){
239    const int n = filenames.size();
240    if (n > 1) {
241        ShowFileNames = true;
242    }
243    inputFiles = filenames;
244    resultStrs = new std::stringstream[n];
245    total_count = new int[n];
246    for (unsigned i = 0; i < inputFiles.size(); ++i){
247        total_count[i] = 0;
248    }
249   
250}
251
252extern "C" {
253    void wrapped_report_match(size_t lineNum, size_t line_start, size_t line_end, const char * buffer, size_t filesize, int fileIdx) {
254        int index = isUTF_16 ? 2 : 1;
255        int idx = fileIdx;
256         
257        if (ShowFileNames) {
258            resultStrs[idx] << inputFiles[idx] << ':';
259        }
260        if (ShowLineNumbers) {
261            resultStrs[idx] << lineNum << ":";
262        }
263       
264        if ((!isUTF_16 && buffer[line_start] == 0xA) && (line_start != line_end)) {
265            // The line "starts" on the LF of a CRLF.  Really the end of the last line.
266            line_start++;
267        }
268        if (((isUTF_16 && buffer[line_start] == 0x0) && buffer[line_start + 1] == 0xA) && (line_start != line_end)) {
269            // The line "starts" on the LF of a CRLF.  Really the end of the last line.
270            line_start += 2;
271        }
272        if (line_end == filesize) {
273            // The match position is at end-of-file.   We have a final unterminated line.
274            resultStrs[idx].write(&buffer[line_start * index], (line_end - line_start) * index);
275            if (NormalizeLineBreaks) {
276                resultStrs[idx] << '\n';  // terminate it
277            }
278            return;
279        }
280        unsigned char end_byte = (unsigned char)buffer[line_end]; 
281        unsigned char penult_byte = (unsigned char)(buffer[line_end - 1]);
282        if (NormalizeLineBreaks) {
283            if (end_byte == 0x85) {
284                // Line terminated with NEL, on the second byte.  Back up 1.
285                line_end--;
286            } else if (end_byte > 0xD) {
287                // Line terminated with PS or LS, on the third byte.  Back up 2.
288                isUTF_16 ? line_end-- : line_end -= 2;
289            }
290            resultStrs[idx].write(&buffer[line_start * index], (line_end - line_start) * index);
291            resultStrs[idx] << '\n';
292        }
293        else {   
294            if ((!isUTF_16 && end_byte == 0x0D) || (isUTF_16 && (end_byte == 0x0D && penult_byte == 0x0))) {
295                // Check for line_end on first byte of CRLF;  note that we don't
296                // want to access past the end of buffer.
297                if (line_end + 1 < filesize) {
298                    if (!isUTF_16 && buffer[line_end + 1] == 0x0A) {
299                        // Found CRLF; preserve both bytes.
300                        line_end++;
301                    }
302                    if (isUTF_16 && buffer[line_end + 1] == 0x0 && buffer[line_end + 2] == 0x0A) {
303                        // Found CRLF; preserve both bytes.
304                        line_end += 2;
305                    }
306                }
307            }
308            resultStrs[idx].write(&buffer[line_start * index], (line_end - line_start + 1) * index);
309        }
310    }
311}
312
313void PrintResult(bool CountOnly, std::vector<size_t> & total_CountOnly){
314    if(CountOnly){
315        if (!ShowFileNames) {
316            for (unsigned i = 0; i < inputFiles.size(); ++i){
317                std::cout << total_CountOnly[i] << std::endl;
318            }
319        }
320        else {
321            for (unsigned i = 0; i < inputFiles.size(); ++i){
322                std::cout << inputFiles[i] << ':' << total_CountOnly[i] << std::endl;
323            };
324        }
325        return;
326    }
327   
328    for (unsigned i = 0; i < inputFiles.size(); ++i){
329        std::cout << resultStrs[i].str();
330    }
331}
332
333re::CC * parsedCodePointSet;
334
335extern "C" {
336    void insert_codepoints(size_t lineNum, size_t line_start, size_t line_end, const char * buffer) {
337        re::codepoint_t c = 0;
338        ssize_t line_pos = line_start;
339        while (isxdigit(buffer[line_pos])) {
340            if (isdigit(buffer[line_pos])) {
341                c = (c << 4) | (buffer[line_pos] - '0');
342            }
343            else {
344                c = (c << 4) | (tolower(buffer[line_pos]) - 'a' + 10);
345            }
346            line_pos++;
347        }
348        assert(((line_pos - line_start) >= 4) && ((line_pos - line_start) <= 6)); // UCD format 4 to 6 hex digits.       
349        parsedCodePointSet->insert(c);
350    }
351}
352
353void setParsedCodePointSet(){
354    parsedCodePointSet = re::makeCC();
355}
356
357re::CC * getParsedCodePointSet(){
358    return parsedCodePointSet;
359}
360
361
362
363
364void icgrep_Linking(Module * m, ExecutionEngine * e) {
365    Module::FunctionListType & fns = m->getFunctionList();
366    for (Module::FunctionListType::iterator it = fns.begin(), it_end = fns.end(); it != it_end; ++it) {
367        std::string fnName = it->getName().str();
368        if (fnName == "s2p_block") continue;
369        if (fnName == "process_block") continue;
370        if (fnName == "process_block_initialize_carries") continue;
371       
372        if (fnName == "wrapped_report_match") {
373            e->addGlobalMapping(cast<GlobalValue>(it), (void *)&wrapped_report_match);
374        }
375        if (fnName == "insert_codepoints") {
376            e->addGlobalMapping(cast<GlobalValue>(it), (void *)&insert_codepoints);
377        }
378#ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
379        else {
380            const UCD::ExternalProperty & ep = UCD::resolveExternalProperty(fnName);
381            e->addGlobalMapping(cast<GlobalValue>(it), std::get<0>(ep));
382        }
383#endif
384    }
385}
386
Note: See TracBrowser for help on using the repository browser.