source: icGREP/icgrep-devel/icgrep/kernels/radix64.cpp @ 5678

Last change on this file since 5678 was 5599, checked in by cameron, 2 years ago

Bug fixes for multiblock kernel/radix64

File size: 17.5 KB
RevLine 
[5216]1/*
2 *  Copyright (c) 2016 International Characters.
3 *  This software is licensed to the public under the Open Software License 3.0.
4 */
[5232]5#include "radix64.h"
[5267]6#include <kernels/streamset.h>
[5436]7#include <kernels/kernel_builder.h>
[5216]8
9using namespace llvm;
10
[5260]11namespace kernel {
12
[5216]13// This kernel produces an expanded input stream by duplicating every third byte.
14// It is implemented using SIMD shufflevector operations.  With 16-byte registers,
15// a single shufflevector operation produces 16 bytes of output data from the
16// 12 bytes of input data.   With 32-byte registers, 32 bytes of output data are
17// produced from 24 bytes of input data.
18//
19// Using aligned SIMD loads, an inner loop processes three registers full of input
[5307]20// data (i.e., three BytePacks) to produce four registers full of output.   This is
[5216]21// a 3 step process.
22// Step 1:  Load input_pack0, apply the shuffle operation to produce output_pack0.
23//          At this point 3/4 of the data in input_pack0 has been processed.
24// Step 2:  Load input_pack1, apply a shuffle operation to use the remaining
25//          1/4 of input_pack0 and 1/2 of input_pack1 to produce output_pack1.
26//          At this point 1/2 of the data in input_pack1 has been processed.
27// Step 3:  Load input_pack2, apply a shuffle operation to use the remaining 1/2
28//          of input_pack1 and 1/4 of input_pack2 to produce output_pack2.
29//          Then apply a further shuffle opertaion to use the remaining 3/4 of
30//          input_pack2 to produce output_pack3.
31
[5508]32// The MultiBlockLogic is based on a natural stride taking 3 packs at a time.
33// In this case, the output produced is exactly 4 packs or 4 blocks, with no pending
34// data maintained in the kernel state.
[5216]35//
[5508]36// When processing the final partial stride of data, the kernel performs full
37// triple-pack processing for each full or partial triple-pack remaining,
38// relying on the MultiBlockKernel builder to only copy the correct number
39// of bytes to the actual output stream.
[5216]40
[5507]41void expand3_4Kernel::generateMultiBlockLogic(const std::unique_ptr<KernelBuilder> & iBuilder) {
[5286]42
43    BasicBlock * expand2_3entry = iBuilder->GetInsertBlock();
[5440]44    BasicBlock * expand_3_4_loop = iBuilder->CreateBasicBlock("expand_3_4_loop");
45    BasicBlock * expand3_4_exit = iBuilder->CreateBasicBlock("expand3_4_exit");
[5216]46   
47    // Determine the require shufflevector constants.
[5508]48    const unsigned PACK_SIZE = iBuilder->getBitBlockWidth()/8;
[5216]49   
50    // Construct a list of indexes in  the form
51    // 0, 1, 2, 2, 3, 4, 5, 5, 6, 7, 8, 8, ...
52    unsigned sourceByteIndex = 0;
53    unsigned expand3_4_index[PACK_SIZE];
54    for (unsigned i = 0; i < PACK_SIZE; i++) {
55        expand3_4_index[i] = sourceByteIndex;
56        if (i % 4 != 2) sourceByteIndex++;
57    }
58    unsigned const expand3_4_offset[4] = {PACK_SIZE, 3*PACK_SIZE/4, PACK_SIZE/2, PACK_SIZE/4};
59    Value * expand_3_4_shuffle[4];
60    for (unsigned j = 0; j < 4; j++) {
61        std::vector<Constant *> Idxs;
62        for (unsigned i = 0; i < PACK_SIZE; i++) {
63            Idxs.push_back(ConstantInt::get(iBuilder->getInt32Ty(), expand3_4_offset[j] + expand3_4_index[i]));
64        }
65        expand_3_4_shuffle[j] = ConstantVector::get(Idxs);
[5232]66    }
[5325]67
[5277]68    Constant * triplePackSize = iBuilder->getSize(3 * PACK_SIZE); // 3 packs per loop.
[5260]69    UndefValue * undefPack = UndefValue::get(iBuilder->fwVectorType(8));
[5216]70   
71    const unsigned packAlign = iBuilder->getBitBlockWidth()/8;
[5276]72
[5507]73    Function::arg_iterator args = mCurrentMethod->arg_begin();
[5216]74   
[5507]75    /* self = */ args++;
76    Value * itemsToDo = &*(args++);
77    Value * sourceStream = &*(args++);
78    Value * expandedStream = &*(args);
79
[5508]80    // The main loop processes 3 packs of data at a time.
[5594]81    // The initial pack offsets may be nonzero.
[5599]82    sourceStream = iBuilder->CreatePointerCast(sourceStream, iBuilder->getInt8PtrTy());
83    expandedStream = iBuilder->CreatePointerCast(expandedStream, iBuilder->getInt8PtrTy());
[5594]84    Value * offset = iBuilder->CreateURem(iBuilder->getProcessedItemCount("sourceStream"), iBuilder->getSize(iBuilder->getBitBlockWidth()));
[5599]85    Value * sourcePackPtr = iBuilder->CreatePointerCast(iBuilder->CreateGEP(sourceStream, offset), iBuilder->getBitBlockType()->getPointerTo());
[5594]86    offset = iBuilder->CreateURem(iBuilder->getProducedItemCount("expand34Stream"), iBuilder->getSize(iBuilder->getBitBlockWidth()));
[5599]87    Value * outputPackPtr = iBuilder->CreatePointerCast(iBuilder->CreateGEP(expandedStream, offset), iBuilder->getBitBlockType()->getPointerTo());
[5508]88    iBuilder->CreateCondBr(iBuilder->CreateICmpSGT(itemsToDo, iBuilder->getSize(0)), expand_3_4_loop, expand3_4_exit);
89   
[5216]90    iBuilder->SetInsertPoint(expand_3_4_loop);
91    PHINode * loopInput_ptr = iBuilder->CreatePHI(sourcePackPtr->getType(), 2);
92    PHINode * loopOutput_ptr = iBuilder->CreatePHI(outputPackPtr->getType(), 2);
93    PHINode * loopItemsRemain = iBuilder->CreatePHI(iBuilder->getSizeTy(), 2);
[5232]94
[5216]95    loopInput_ptr->addIncoming(sourcePackPtr, expand2_3entry);
96    loopOutput_ptr->addIncoming(outputPackPtr, expand2_3entry);
[5508]97    loopItemsRemain->addIncoming(itemsToDo, expand2_3entry);
[5232]98
[5507]99
[5216]100    // Step 1 of the main loop.
101    Value * pack0 = iBuilder->fwCast(8, iBuilder->CreateAlignedLoad(loopInput_ptr, packAlign));
102    Value * expand0 = iBuilder->bitCast(iBuilder->CreateShuffleVector(undefPack, pack0, expand_3_4_shuffle[0]));
[5297]103    iBuilder->CreateBlockAlignedStore(expand0, loopOutput_ptr);
[5216]104    // Step 2 of the main loop.
[5240]105    Value * inPack1_ptr = iBuilder->CreateGEP(loopInput_ptr, iBuilder->getInt32(1));
106    Value * outPack1_ptr = iBuilder->CreateGEP(loopOutput_ptr, iBuilder->getInt32(1));
[5216]107    Value * pack1 = iBuilder->fwCast(8, iBuilder->CreateAlignedLoad(inPack1_ptr, packAlign));
108    Value * expand1 = iBuilder->bitCast(iBuilder->CreateShuffleVector(pack0, pack1, expand_3_4_shuffle[1]));
[5297]109    iBuilder->CreateBlockAlignedStore(expand1, outPack1_ptr);
[5216]110    // Step 3 of the main loop.
[5240]111    Value * inPack2_ptr = iBuilder->CreateGEP(loopInput_ptr, iBuilder->getInt32(2));
112    Value * outPack2_ptr = iBuilder->CreateGEP(loopOutput_ptr, iBuilder->getInt32(2));
[5216]113    Value * pack2 = iBuilder->fwCast(8, iBuilder->CreateAlignedLoad(inPack2_ptr, packAlign));
114    Value * expand2 = iBuilder->bitCast(iBuilder->CreateShuffleVector(pack1, pack2, expand_3_4_shuffle[2]));
[5297]115    iBuilder->CreateBlockAlignedStore(expand2, outPack2_ptr);
[5240]116    Value * outPack3_ptr = iBuilder->CreateGEP(loopOutput_ptr, iBuilder->getInt32(3));
[5216]117    Value * expand3 = iBuilder->bitCast(iBuilder->CreateShuffleVector(pack2, undefPack, expand_3_4_shuffle[3]));
[5297]118    iBuilder->CreateBlockAlignedStore(expand3, outPack3_ptr);
[5232]119
[5240]120    Value * loopNextInputPack = iBuilder->CreateGEP(loopInput_ptr, iBuilder->getInt32(3));
[5277]121    Value * remainingItems = iBuilder->CreateSub(loopItemsRemain, triplePackSize);
[5232]122
123    Value * loopNextOutputPack;
[5240]124    loopNextOutputPack = iBuilder->CreateGEP(loopOutput_ptr, iBuilder->getInt32(4));
[5232]125
[5216]126    loopInput_ptr->addIncoming(loopNextInputPack, expand_3_4_loop);
127    loopOutput_ptr->addIncoming(loopNextOutputPack, expand_3_4_loop);
128    loopItemsRemain->addIncoming(remainingItems, expand_3_4_loop);
[5232]129
[5508]130    Value * continueLoop = iBuilder->CreateICmpSGT(remainingItems, iBuilder->getSize(0));
131    iBuilder->CreateCondBr(continueLoop, expand_3_4_loop, expand3_4_exit);
[5277]132   
[5216]133    iBuilder->SetInsertPoint(expand3_4_exit);
[5507]134    }
[5216]135
136
[5219]137// Radix 64 determination, converting 3 bytes to 4 6-bit values.
138//
[5232]139//  00000000|zyxwvuts|rqpmnlkj|hgfedcba    Original
140//           zy                            bits to move 6 positions right
141//             xwvuts                      bits to move 8 positions left
142//                    rqpm                 bits to move 4 positions right
143//                        nlkj             bits to move 10 positions left
144//                             hqfedc      bits to move 2 positions right
145//                                   ba    bits to move 12 positions left
146//    xwvuts|  nlkjzy|  barqpm|  hgfedc    Target
[5440]147inline Value * radix64Kernel::processPackData(const std::unique_ptr<KernelBuilder> & iBuilder, llvm::Value * bytepack) const {
[5297]148
[5232]149    Value * step_right_6 = iBuilder->simd_fill(32, ConstantInt::get(iBuilder->getInt32Ty(), 0x00C00000));
[5297]150    Value * right_6_result = iBuilder->simd_srli(32, iBuilder->simd_and(bytepack, step_right_6), 6);
151
[5232]152    Value * step_left_8 = iBuilder->simd_fill(32, ConstantInt::get(iBuilder->getInt32Ty(), 0x003F0000));
[5297]153    Value * left_8_result = iBuilder->simd_slli(32, iBuilder->simd_and(bytepack, step_left_8), 8);
154    Value * mid = iBuilder->simd_or(right_6_result, left_8_result);
155
[5232]156    Value * step_right_4 = iBuilder->simd_fill(32, ConstantInt::get(iBuilder->getInt32Ty(), 0x0000F000));
[5297]157    Value * right_4_result = iBuilder->simd_srli(32, iBuilder->simd_and(bytepack, step_right_4), 4);
158    mid = iBuilder->simd_or(mid, right_4_result);
159
[5232]160    Value * step_left_10 = iBuilder->simd_fill(32, ConstantInt::get(iBuilder->getInt32Ty(), 0x00000F00));
[5297]161    Value * left_10_result = iBuilder->simd_slli(32, iBuilder->simd_and(bytepack, step_left_10), 10);
162    mid = iBuilder->simd_or(mid, left_10_result);
163
[5232]164    Value * step_right_2 = iBuilder->simd_fill(32, ConstantInt::get(iBuilder->getInt32Ty(), 0x000000FC));
[5297]165    Value * right_2_result = iBuilder->simd_srli(32, iBuilder->simd_and(bytepack, step_right_2), 2);
166    mid = iBuilder->simd_or(mid, right_2_result);
167
[5232]168    Value * step_left_12 = iBuilder->simd_fill(32, ConstantInt::get(iBuilder->getInt32Ty(), 0x00000003));
[5288]169    Value * left_12_result = iBuilder->simd_slli(32, iBuilder->simd_and(bytepack, step_left_12), 12);
[5297]170    mid = iBuilder->simd_or(mid, left_12_result);
[5288]171
[5297]172    return iBuilder->bitCast(mid);
[5288]173}
174
[5440]175void radix64Kernel::generateDoBlockMethod(const std::unique_ptr<KernelBuilder> & iBuilder) {
[5219]176    for (unsigned i = 0; i < 8; i++) {
[5440]177        Value * bytepack = iBuilder->loadInputStreamPack("expandedStream", iBuilder->getInt32(0), iBuilder->getInt32(i));
178        Value * radix64pack = processPackData(iBuilder, bytepack);
179        iBuilder->storeOutputStreamPack("radix64stream", iBuilder->getInt32(0), iBuilder->getInt32(i), radix64pack);
[5219]180    }
181}
182
[5440]183void radix64Kernel::generateFinalBlockMethod(const std::unique_ptr<KernelBuilder> & iBuilder, Value * remainingBytes) {
[5285]184
185    BasicBlock * entry = iBuilder->GetInsertBlock();
[5440]186    BasicBlock * radix64_loop = iBuilder->CreateBasicBlock("radix64_loop");
187    BasicBlock * fbExit = iBuilder->CreateBasicBlock("fbExit");
[5325]188   
[5232]189    const unsigned PACK_SIZE = iBuilder->getStride()/8;
[5246]190    Constant * packSize = iBuilder->getSize(PACK_SIZE);
[5232]191
192    // Enter the loop only if there is at least one byte remaining to process.
[5234]193    iBuilder->CreateCondBr(iBuilder->CreateICmpEQ(remainingBytes, iBuilder->getSize(0)), fbExit, radix64_loop);
[5232]194
195    iBuilder->SetInsertPoint(radix64_loop);
196    PHINode * idx = iBuilder->CreatePHI(iBuilder->getInt32Ty(), 2);
197    PHINode * loopRemain = iBuilder->CreatePHI(iBuilder->getSizeTy(), 2);
[5285]198    idx->addIncoming(ConstantInt::getNullValue(iBuilder->getInt32Ty()), entry);
199    loopRemain->addIncoming(remainingBytes, entry);
[5232]200
[5440]201    Value * bytepack = iBuilder->loadInputStreamPack("expandedStream", iBuilder->getInt32(0), idx);
202    Value * radix64pack = processPackData(iBuilder, bytepack);
203    iBuilder->storeOutputStreamPack("radix64stream", iBuilder->getInt32(0), idx, radix64pack);
[5232]204
205    Value* nextIdx = iBuilder->CreateAdd(idx, ConstantInt::get(iBuilder->getInt32Ty(), 1));
206    idx->addIncoming(nextIdx, radix64_loop);
207    Value* remainAfterLoop = iBuilder->CreateSub(loopRemain, packSize);
208    loopRemain->addIncoming(remainAfterLoop, radix64_loop);
209
[5291]210    Value* continueLoop = iBuilder->CreateICmpSGT(remainAfterLoop, iBuilder->getSize(0));
[5288]211
[5325]212    iBuilder->CreateCondBr(continueLoop, radix64_loop, fbExit);
[5232]213
214    iBuilder->SetInsertPoint(fbExit);
215}
216
[5440]217inline llvm::Value* base64Kernel::processPackData(const std::unique_ptr<KernelBuilder> & iBuilder, llvm::Value* bytepack) const {
[5288]218    Value * mask_gt_25 = iBuilder->simd_ugt(8, bytepack, iBuilder->simd_fill(8, iBuilder->getInt8(25)));
219    Value * mask_gt_51 = iBuilder->simd_ugt(8, bytepack, iBuilder->simd_fill(8, iBuilder->getInt8(51)));
220    Value * mask_eq_62 = iBuilder->simd_eq(8, bytepack, iBuilder->simd_fill(8, iBuilder->getInt8(62)));
221    Value * mask_eq_63 = iBuilder->simd_eq(8, bytepack, iBuilder->simd_fill(8, iBuilder->getInt8(63)));
222    // Strategy:
223    // 1. add ord('A') = 65 to all radix64 values, this sets the correct values for entries 0 to 25.
224    // 2. add ord('a') - ord('A') - (26 - 0) = 6 to all values >25, this sets the correct values for entries 0 to 51
225    // 3. subtract ord('a') - ord('0') + (52 - 26) = 75 to all values > 51, this sets the correct values for entries 0 to 61
226    // 4. subtract ord('0') - ord('+') + (62 - 52) = 15 for all values = 62
227    // 4. add ord('/') - ord('0') - (63 - 52) = 3 for all values = 63
228    Value * t0_25 = iBuilder->simd_add(8, bytepack, iBuilder->simd_fill(8, iBuilder->getInt8('A')));
229    Value * t0_51 = iBuilder->simd_add(8, t0_25, iBuilder->simd_and(mask_gt_25, iBuilder->simd_fill(8, iBuilder->getInt8(6))));
230    Value * t0_61 = iBuilder->simd_sub(8, t0_51, iBuilder->simd_and(mask_gt_51, iBuilder->simd_fill(8, iBuilder->getInt8(75))));
231    Value * t0_62 = iBuilder->simd_sub(8, t0_61, iBuilder->simd_and(mask_eq_62, iBuilder->simd_fill(8, iBuilder->getInt8(15))));
[5317]232    return iBuilder->bitCast(iBuilder->simd_sub(8, t0_62, iBuilder->simd_and(mask_eq_63, iBuilder->simd_fill(8, iBuilder->getInt8(12)))));
[5288]233}
234
[5440]235void base64Kernel::generateDoBlockMethod(const std::unique_ptr<KernelBuilder> & iBuilder) {
[5219]236    for (unsigned i = 0; i < 8; i++) {
[5440]237        Value * bytepack = iBuilder->loadInputStreamPack("radix64stream", iBuilder->getInt32(0), iBuilder->getInt32(i));
238        Value * base64pack = processPackData(iBuilder, bytepack);
239        iBuilder->storeOutputStreamPack("base64stream", iBuilder->getInt32(0), iBuilder->getInt32(i), base64pack);
[5219]240    }
241}
242
243// Special processing for the base 64 format.   The output must always contain a multiple
244// of 4 bytes.   When the number of radix 64 values is not a multiple of 4
245// number of radix 64 values
[5440]246void base64Kernel::generateFinalBlockMethod(const std::unique_ptr<KernelBuilder> & iBuilder, Value * remainingBytes) {
[5285]247
248    BasicBlock * entry = iBuilder->GetInsertBlock();
[5440]249    BasicBlock * base64_loop = iBuilder->CreateBasicBlock("base64_loop");
250    BasicBlock * loopExit = iBuilder->CreateBasicBlock("loopExit");
251    BasicBlock * doPadding = iBuilder->CreateBasicBlock("doPadding");
252    BasicBlock * doPadding2 = iBuilder->CreateBasicBlock("doPadding2");
253    BasicBlock * fbExit = iBuilder->CreateBasicBlock("fbExit");
[5285]254
[5246]255    Value * remainMod4 = iBuilder->CreateAnd(remainingBytes, iBuilder->getSize(3));
256    Value * padBytes = iBuilder->CreateSub(iBuilder->getSize(4), remainMod4);
257    padBytes = iBuilder->CreateAnd(padBytes, iBuilder->getSize(3));
[5219]258
[5234]259    Constant * packSize = iBuilder->getSize(iBuilder->getStride() / 8);
[5260]260
[5219]261    // Enter the loop only if there is at least one byte remaining to process.
[5234]262    iBuilder->CreateCondBr(iBuilder->CreateICmpEQ(remainingBytes, iBuilder->getSize(0)), fbExit, base64_loop);
[5285]263
[5219]264    iBuilder->SetInsertPoint(base64_loop);
265    PHINode * idx = iBuilder->CreatePHI(iBuilder->getInt32Ty(), 2);
266    PHINode * loopRemain = iBuilder->CreatePHI(iBuilder->getSizeTy(), 2);
[5285]267    idx->addIncoming(ConstantInt::getNullValue(iBuilder->getInt32Ty()), entry);
268    loopRemain->addIncoming(remainingBytes, entry);
[5440]269    Value * bytepack = iBuilder->loadInputStreamPack("radix64stream", iBuilder->getInt32(0), idx);
270    Value * base64pack = processPackData(iBuilder, bytepack);
271    iBuilder->storeOutputStreamPack("base64stream", iBuilder->getInt32(0), idx, base64pack);
[5219]272    idx->addIncoming(iBuilder->CreateAdd(idx, ConstantInt::get(iBuilder->getInt32Ty(), 1)), base64_loop);
[5232]273    Value* remainAfterLoop = iBuilder->CreateSub(loopRemain, packSize);
274    loopRemain->addIncoming(remainAfterLoop, base64_loop);
275
[5290]276    Value* continueLoop = iBuilder->CreateICmpSGT(remainAfterLoop, iBuilder->getSize(0));
[5232]277    iBuilder->CreateCondBr(continueLoop, base64_loop, loopExit);
278
[5219]279    iBuilder->SetInsertPoint(loopExit);
[5234]280    iBuilder->CreateCondBr(iBuilder->CreateICmpEQ(padBytes, iBuilder->getSize(0)), fbExit, doPadding);
[5260]281
[5219]282    iBuilder->SetInsertPoint(doPadding);
[5440]283    Value * i8output_ptr = iBuilder->getOutputStreamBlockPtr("base64stream", iBuilder->getInt32(0));
[5307]284    i8output_ptr = iBuilder->CreatePointerCast(i8output_ptr, iBuilder->getInt8PtrTy());
[5240]285    iBuilder->CreateStore(ConstantInt::get(iBuilder->getInt8Ty(), '='), iBuilder->CreateGEP(i8output_ptr, remainingBytes));
[5234]286    iBuilder->CreateCondBr(iBuilder->CreateICmpEQ(remainMod4, iBuilder->getSize(3)), fbExit, doPadding2);
[5219]287    iBuilder->SetInsertPoint(doPadding2);
[5234]288    Value * finalPadPos = iBuilder->CreateAdd(remainingBytes, iBuilder->getSize(1));
[5240]289    iBuilder->CreateStore(ConstantInt::get(iBuilder->getInt8Ty(), '='), iBuilder->CreateGEP(i8output_ptr, finalPadPos));
[5219]290    iBuilder->CreateBr(fbExit);
291    iBuilder->SetInsertPoint(fbExit);
292}
[5232]293
[5436]294expand3_4Kernel::expand3_4Kernel(const std::unique_ptr<kernel::KernelBuilder> & iBuilder)
[5507]295: MultiBlockKernel("expand3_4",
[5297]296            {Binding{iBuilder->getStreamSetTy(1, 8), "sourceStream"}},
[5507]297            {Binding{iBuilder->getStreamSetTy(1, 8), "expand34Stream", FixedRatio(4,3)}},
[5297]298            {}, {}, {}) {
[5508]299    setKernelStride(3 * iBuilder->getBitBlockWidth()/8);
[5232]300}
[5283]301
[5436]302radix64Kernel::radix64Kernel(const std::unique_ptr<kernel::KernelBuilder> & iBuilder)
[5435]303: BlockOrientedKernel("radix64",
[5297]304            {Binding{iBuilder->getStreamSetTy(1, 8), "expandedStream"}},
305            {Binding{iBuilder->getStreamSetTy(1, 8), "radix64stream"}},
306            {}, {}, {}) {
[5283]307}
308
[5436]309base64Kernel::base64Kernel(const std::unique_ptr<kernel::KernelBuilder> & iBuilder)
[5435]310: BlockOrientedKernel("base64",
[5297]311            {Binding{iBuilder->getStreamSetTy(1, 8), "radix64stream"}},
[5328]312            {Binding{iBuilder->getStreamSetTy(1, 8), "base64stream", RoundUpToMultiple(4)}},
[5297]313            {}, {}, {}) {
[5283]314}
315
316}
Note: See TracBrowser for help on using the repository browser.