source: icGREP/icgrep-devel/icgrep/u8u16.cpp @ 5063

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

Include codegen options in -help

File size: 13.4 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 <string>
8#include <iostream>
9#include <fstream>
10#include <sstream>
11
12#include <llvm/IR/Function.h>
13#include <llvm/IR/Module.h>
14#include <llvm/ExecutionEngine/ExecutionEngine.h>
15#include <llvm/ExecutionEngine/MCJIT.h>
16#include <llvm/IRReader/IRReader.h>
17#include <llvm/IR/Verifier.h>
18#include <llvm/Support/Debug.h>
19
20#include <llvm/Support/CommandLine.h>
21
22#include <toolchain.h>
23#include <re/re_cc.h>
24#include <cc/cc_compiler.h>
25#include <pablo/pablo_toolchain.h>
26#include <pablo/function.h>
27#include <IDISA/idisa_builder.h>
28#include <IDISA/idisa_target.h>
29#include <kernels/u8u16_pipeline.h>
30
31#include <utf_encoding.h>
32
33// mmap system
34#include <boost/filesystem.hpp>
35#include <boost/iostreams/device/mapped_file.hpp>
36using namespace boost::iostreams;
37using namespace boost::filesystem;
38
39#include <fcntl.h>
40static cl::OptionCategory u8u16Options("u8u16 Options",
41                                            "Transcoding control options.");
42
43static cl::list<std::string> inputFiles(cl::Positional, cl::desc("<input file ...>"), cl::OneOrMore, cl::cat(u8u16Options));
44
45//
46//
47//
48namespace pablo {
49
50PabloFunction * u8u16_pablo(const Encoding encoding) {
51    //  input: 8 basis bit streams
52    //  output: 16 u8-indexed streams, + delmask stream + error stream
53    PabloFunction * function = PabloFunction::Create("u8u16", 8, 18);
54    cc::CC_Compiler ccc(*function, encoding);
55   
56    PabloBuilder pBuilder(ccc.getBuilder().getPabloBlock(), ccc.getBuilder());
57    const std::vector<Var *> u8_bits = ccc.getBasisBits();
58    // Outputs
59    Assign * u16_hi[8];
60    Assign * u16_lo[8];
61    Assign * delmask;
62    Assign * error_mask;
63   
64    // The logic for processing non-ASCII bytes is to be embedded within an if-hierarchy.
65    PabloAST * nonASCII = ccc.compileCC(re::makeCC(0x80, 0xFF));
66   
67    // Builder for the if statement handling all non-ASCII logic
68    PabloBuilder nAb = PabloBuilder::Create(pBuilder);
69    // Bits 3 through 7 of a 2-byte prefix are data bits, needed to
70    // produce the UTF-16 code unit data ...,
71    PabloAST * bit3a1 = nAb.createAdvance(u8_bits[3], 1);
72    PabloAST * bit4a1 = nAb.createAdvance(u8_bits[4], 1);
73    PabloAST * bit5a1 = nAb.createAdvance(u8_bits[5], 1);
74    PabloAST * bit6a1 = nAb.createAdvance(u8_bits[6], 1);
75    PabloAST * bit7a1 = nAb.createAdvance(u8_bits[7], 1);
76   
77    // Entry condition for 3 or 4 byte sequences: we have a prefix byte in the range 0xE0-0xFF.
78    PabloAST * pfx34 = ccc.compileCC(re::makeCC(0xE0, 0xFF), nAb);
79    // Builder for the if statement handling all logic for 3- and 4-byte sequences.
80    PabloBuilder p34b = PabloBuilder::Create(nAb);
81    // Bits 4 through 7 of a 3-byte prefix are data bits.  They must be moved
82    // to the final position of the 3-byte sequence.
83    PabloAST * bit2a1 = p34b.createAdvance(u8_bits[2], 1);
84    PabloAST * bit4a2 = p34b.createAdvance(bit4a1, 1);
85    PabloAST * bit5a2 = p34b.createAdvance(bit5a1, 1);
86    PabloAST * bit6a2 = p34b.createAdvance(bit6a1, 1);
87    PabloAST * bit7a2 = p34b.createAdvance(bit7a1, 1);
88    //
89    // Logic for 4-byte UTF-8 sequences
90    //
91    // Entry condition  or 4 byte sequences: we have a prefix byte in the range 0xF0-0xFF.
92    PabloAST * pfx4 = ccc.compileCC(re::makeCC(0xF0, 0xFF), p34b);
93    // Builder for the if statement handling all logic for 4-byte sequences only.
94    PabloBuilder p4b = PabloBuilder::Create(p34b);
95    // Illegal 4-byte sequences
96    PabloAST * F0 = ccc.compileCC(re::makeCC(0xF0), p4b);
97    PabloAST * F4 = ccc.compileCC(re::makeCC(0xF4), p4b);
98    PabloAST * F0_err = p4b.createAnd(p4b.createAdvance(F0, 1), ccc.compileCC(re::makeCC(0x80, 0x8F), p4b));
99    PabloAST * F4_err = p4b.createAnd(p4b.createAdvance(F4, 1), ccc.compileCC(re::makeCC(0x90, 0xBF), p4b));
100    PabloAST * F5_FF = ccc.compileCC(re::makeCC(0xF5, 0xFF), p4b);
101    Assign * FX_err = p4b.createAssign("FX_err", p4b.createOr(F5_FF, p4b.createOr(F0_err, F4_err)));
102    //
103    // 4-byte prefixes have a scope that extends over the next 3 bytes.
104    Assign * u8scope42 = p4b.createAssign("u8scope42", p4b.createAdvance(pfx4, 1));
105    Assign * u8scope43 = p4b.createAssign("u8scope43", p4b.createAdvance(u8scope42, 1));
106    Assign * u8scope44 = p4b.createAssign("u8scope44", p4b.createAdvance(u8scope43, 1));
107    //
108   
109    //  From the 4-byte sequence 11110abc 10defghi 10jklmno 10pqrstu,
110    //  we must calculate the value abcde - 1 to produce the bit values
111    //  for u16_hi6, hi7, lo0, lo1 at the scope43 position.
112    Assign * s43_lo1 = p4b.createAssign("scope43_lo1", p4b.createAnd(u8scope43, p4b.createNot(bit3a1)));           // e - 1
113    Assign * s43_lo0 = p4b.createAssign("scope43_lo0", p4b.createAnd(u8scope43, p4b.createXor(bit2a1, s43_lo1)));  // d - borrow
114    PabloAST * brw1 = p4b.createAnd(s43_lo1, p4b.createNot(bit2a1));
115    Assign * s43_hi7 = p4b.createAssign("scope43_hi7", p4b.createAnd(u8scope43, p4b.createXor(bit7a2, brw1)));     // c - borrow
116    PabloAST * brw2 = p4b.createAnd(brw1, p4b.createNot(bit7a2));
117    Assign * s43_hi6 = p4b.createAssign("scope43_hi6", p4b.createAnd(u8scope43, p4b.createXor(bit6a2, brw2)));     // b - borrow
118    //
119    Assign * s43_lo2 = p4b.createAssign("scope43_lo2", p4b.createAnd(u8scope43, bit4a1));
120    Assign * s43_lo3 = p4b.createAssign("scope43_lo3", p4b.createAnd(u8scope43, bit5a1));
121    Assign * s43_lo4 = p4b.createAssign("scope43_lo4", p4b.createAnd(u8scope43, bit6a1));
122    Assign * s43_lo5 = p4b.createAssign("scope43_lo5", p4b.createAnd(u8scope43, bit7a1));
123    Assign * s43_lo6 = p4b.createAssign("scope43_lo6", p4b.createAnd(u8scope43, u8_bits[2]));
124    Assign * s43_lo7 = p4b.createAssign("scope43_lo7", p4b.createAnd(u8scope43, u8_bits[3]));
125    //
126    //
127    p34b.createIf(pfx4,
128                  {FX_err, u8scope42, u8scope43, u8scope44, s43_hi6, s43_hi7,
129                   s43_lo0, s43_lo1, s43_lo2, s43_lo3, s43_lo4, s43_lo5, s43_lo6, s43_lo7},
130                   p4b);
131    //
132    // Combined logic for 3 and 4 byte sequences
133    //
134    PabloAST * pfx3 = ccc.compileCC(re::makeCC(0xE0, 0xEF), p34b);
135    Assign * u8scope32 = p34b.createAssign("u8scope32", p34b.createAdvance(pfx3, 1));
136    Assign * u8scope33 = p34b.createAssign("u8scope33", p34b.createAdvance(u8scope32, 1));
137
138    // Illegal 3-byte sequences
139    PabloAST * E0 = ccc.compileCC(re::makeCC(0xE0), p34b);
140    PabloAST * ED = ccc.compileCC(re::makeCC(0xED), p34b);
141    PabloAST * E0_err = p34b.createAnd(p34b.createAdvance(E0, 1), ccc.compileCC(re::makeCC(0x80, 0x9F), p34b));
142    PabloAST * ED_err = p34b.createAnd(p34b.createAdvance(ED, 1), ccc.compileCC(re::makeCC(0xA0, 0xBF), p34b));
143    Assign * EX_FX_err = p34b.createAssign("EX_FX_err", p34b.createOr(p34b.createOr(E0_err, ED_err), FX_err));
144    // Two surrogate UTF-16 units are computed at the 3rd and 4th positions of 4-byte sequences.
145    PabloAST * surrogate = p34b.createOr(u8scope43, u8scope44);
146   
147    Assign * p34del = p34b.createAssign("p34del", p34b.createOr(u8scope32, u8scope42));
148
149
150    // The high 5 bits of the UTF-16 code unit are only nonzero for 3 and 4-byte
151    // UTF-8 sequences.
152    u16_hi[0] = p34b.createAssign("u16_hi0", p34b.createOr(p34b.createAnd(u8scope33, bit4a2), surrogate));
153    u16_hi[1] = p34b.createAssign("u16_hi1", p34b.createOr(p34b.createAnd(u8scope33, bit5a2), surrogate));
154    u16_hi[2] = p34b.createAssign("u16_hi2", p34b.createAnd(u8scope33, bit6a2));
155    u16_hi[3] = p34b.createAssign("u16_hi3", p34b.createOr(p34b.createAnd(u8scope33, bit7a2), surrogate));
156    u16_hi[4] = p34b.createAssign("u16_hi4", p34b.createOr(p34b.createAnd(u8scope33, bit2a1), surrogate));
157   
158    //
159    nAb.createIf(pfx34, 
160                 {u8scope33, EX_FX_err, p34del, 
161                  u16_hi[0], u16_hi[1], u16_hi[2], u16_hi[3], u16_hi[4], u8scope44, s43_hi6, s43_hi7,
162                  s43_lo0, s43_lo1, s43_lo2, s43_lo3, s43_lo4, s43_lo5, s43_lo6, s43_lo7},
163                 p34b);
164    //
165    // Combined logic for 2, 3 and 4 byte sequences
166    //
167    PabloAST * pfx2 = ccc.compileCC(re::makeCC(0xC0, 0xDF), nAb);
168    PabloAST * u8scope22 = nAb.createAdvance(pfx2, 1);
169    Assign * u8lastscope = nAb.createAssign("u8lastscope", nAb.createOr(u8scope22, nAb.createOr(u8scope33, u8scope44)));
170    PabloAST * u8anyscope = nAb.createOr(u8lastscope, p34del);
171
172    PabloAST * C0_C1_err = ccc.compileCC(re::makeCC(0xC0, 0xC1), nAb);
173    PabloAST * scope_suffix_mismatch = nAb.createXor(u8anyscope, ccc.compileCC(re::makeCC(0x80, 0xBF), nAb));
174    error_mask = nAb.createAssign("errormask", nAb.createOr(scope_suffix_mismatch, nAb.createOr(C0_C1_err, EX_FX_err)));
175    delmask = nAb.createAssign("delmask", nAb.createOr(p34del, ccc.compileCC(re::makeCC(0xC0, 0xFF), nAb)));
176   
177    // The low 3 bits of the high byte of the UTF-16 code unit as well as the high bit of the
178    // low byte are only nonzero for 2, 3 and 4 byte sequences.
179    u16_hi[5] = nAb.createAssign("u16_hi5", nAb.createOr(nAb.createAnd(u8lastscope, bit3a1), u8scope44));
180    u16_hi[6] = nAb.createAssign("u16_hi6", nAb.createOr(nAb.createAnd(u8lastscope, bit4a1), s43_hi6));
181    u16_hi[7] = nAb.createAssign("u16_hi7", nAb.createOr(nAb.createAnd(u8lastscope, bit5a1), s43_hi7));
182    u16_lo[0] = nAb.createAssign("u16_lo0", nAb.createOr(nAb.createAnd(u8lastscope, bit6a1), s43_lo0));
183    Assign * p234_lo1 = nAb.createAssign("p234_lo1", nAb.createOr(nAb.createAnd(u8lastscope, bit7a1), s43_lo1));
184
185    pBuilder.createIf(nonASCII, 
186                      {error_mask, delmask, u8lastscope,
187                       u16_hi[0], u16_hi[1], u16_hi[2], u16_hi[3], u16_hi[4], u16_hi[5], u16_hi[6], u16_hi[7],
188                       u16_lo[0], p234_lo1, s43_lo2, s43_lo3, s43_lo4, s43_lo5, s43_lo6, s43_lo7},
189                      nAb);
190    //
191    //
192    PabloAST * ASCII = ccc.compileCC(re::makeCC(0x0, 0x7F));
193    PabloAST * last_byte = pBuilder.createOr(ASCII, u8lastscope);
194    u16_lo[1] = pBuilder.createAssign("u16_lo1", pBuilder.createOr(pBuilder.createAnd(ASCII, u8_bits[1]), p234_lo1));
195    u16_lo[2] = pBuilder.createAssign("u16_lo2", pBuilder.createOr(pBuilder.createAnd(last_byte, u8_bits[2]), s43_lo2));
196    u16_lo[3] = pBuilder.createAssign("u16_lo3", pBuilder.createOr(pBuilder.createAnd(last_byte, u8_bits[3]), s43_lo3));
197    u16_lo[4] = pBuilder.createAssign("u16_lo4", pBuilder.createOr(pBuilder.createAnd(last_byte, u8_bits[4]), s43_lo4));
198    u16_lo[5] = pBuilder.createAssign("u16_lo5", pBuilder.createOr(pBuilder.createAnd(last_byte, u8_bits[5]), s43_lo5));
199    u16_lo[6] = pBuilder.createAssign("u16_lo6", pBuilder.createOr(pBuilder.createAnd(last_byte, u8_bits[6]), s43_lo6));
200    u16_lo[7] = pBuilder.createAssign("u16_lo7", pBuilder.createOr(pBuilder.createAnd(last_byte, u8_bits[7]), s43_lo7));
201   
202    for (unsigned i = 0; i < 8; i++) {
203        function->setResult(i, pBuilder.createAssign("u16_hi" + std::to_string(i), u16_hi[i]));
204        function->setResult(i+8, pBuilder.createAssign("u16_lo" + std::to_string(i), u16_lo[i]));
205    }
206    function->setResult(16, pBuilder.createAssign("delbits", delmask));
207    function->setResult(17, pBuilder.createAssign("errors", error_mask));
208
209    return function;
210}
211}
212
213
214typedef void (*u8u16FunctionType)(char * byte_data, size_t filesize);
215
216static ExecutionEngine * u8u16Engine = nullptr;
217
218u8u16FunctionType u8u16CodeGen(void) {
219                           
220    Module * M = new Module("u8u16", getGlobalContext());
221   
222    IDISA::IDISA_Builder * idb = IDISA::GetIDISA_Builder(M);
223
224    kernel::PipelineBuilder pipelineBuilder(M, idb);
225
226    Encoding encoding(Encoding::Type::UTF_8, 8);
227   
228    pablo::PabloFunction * function = pablo::u8u16_pablo(encoding);
229   
230
231    pipelineBuilder.CreateKernels(function);
232
233    llvm::Function * main_IR = pipelineBuilder.ExecuteKernels();
234   
235    verifyModule(*M, &dbgs());
236    //std::cerr << "ExecuteKernels(); done\n";
237    u8u16Engine = JIT_to_ExecutionEngine(M);
238   
239    u8u16Engine->finalizeObject();
240    //std::cerr << "finalizeObject(); done\n";
241
242    delete idb;
243    return reinterpret_cast<u8u16FunctionType>(u8u16Engine->getPointerToFunction(main_IR));
244}
245
246void u8u16(u8u16FunctionType fn_ptr, const std::string & fileName) {
247    std::string mFileName = fileName;
248    size_t mFileSize;
249    char * mFileBuffer;
250   
251    const path file(mFileName);
252    if (exists(file)) {
253        if (is_directory(file)) {
254            return;
255        }
256    } else {
257        std::cerr << "Error: cannot open " << mFileName << " for processing. Skipped.\n";
258        return;
259    }
260   
261    mFileSize = file_size(file);
262    mapped_file_source mFile;
263    if (mFileSize == 0) {
264        mFileBuffer = nullptr;
265    }
266    else {
267        try {
268            mFile.open(mFileName);
269        } catch (std::exception &e) {
270            std::cerr << "Error: Boost mmap of " << mFileName << ": " << e.what() << std::endl;
271            return;
272        }
273        mFileBuffer = const_cast<char *>(mFile.data());
274    }
275    //std::cerr << "mFileSize =" << mFileSize << "\n";
276    //std::cerr << "fn_ptr =" << std::hex << reinterpret_cast<intptr_t>(fn_ptr) << "\n";
277
278    fn_ptr(mFileBuffer, mFileSize);
279
280    mFile.close();
281   
282}
283
284
285int main(int argc, char *argv[]) {
286    cl::HideUnrelatedOptions(ArrayRef<const cl::OptionCategory *>{&u8u16Options, pablo::pablo_toolchain_flags(), codegen::codegen_flags()});
287    cl::ParseCommandLineOptions(argc, argv);
288
289    u8u16FunctionType fn_ptr = u8u16CodeGen();
290
291    for (unsigned i = 0; i != inputFiles.size(); ++i) {
292        u8u16(fn_ptr, inputFiles[i]);
293    }
294
295    delete u8u16Engine;
296
297    return 0;
298}
299
300                       
Note: See TracBrowser for help on using the repository browser.