1 /******************************************************************************
3 * Copyright (c) 2020 Intel.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 *******************************************************************************/
20 * @brief xRAN BFP compression/decompression for C-plane with 32T32R
22 * @file xran_bfp_cplane32.cpp
23 * @ingroup group_source_xran
24 * @author Intel Corporation
27 #include "xran_compression.hpp"
28 #include "xran_bfp_utils.hpp"
29 #include "xran_bfp_byte_packing_utils.hpp"
32 #include <immintrin.h>
35 namespace BFP_CPlane_32_SNC
37 /// Namespace constants
38 const int k_numDataElements = 64; /// 16 IQ pairs
39 const int k_numRegsPerBlock = 2; /// Number of AVX512 registers per compression block (input)
42 maxAbsOneBlock(const __m512i* inData)
44 /// Vertical maxAbs on all registers
45 __m512i maxAbsReg = __m512i();
46 #pragma unroll(k_numRegsPerBlock)
47 for (int n = 0; n < k_numRegsPerBlock; ++n)
49 const auto thisRegAbs = _mm512_abs_epi16(inData[n]);
50 maxAbsReg = _mm512_max_epi16(thisRegAbs, maxAbsReg);
52 /// Horizontal max across remaining register
53 return BlockFloatCompander::horizontalMax1x32(maxAbsReg);
56 /// Compute exponent value for a set of 16 RB from the maximum absolute value
58 computeExponent_16RB(const BlockFloatCompander::ExpandedData& dataIn, const __m512i totShiftBits)
60 __m512i maxAbs = __m512i();
61 const __m512i* dataInAddr = reinterpret_cast<const __m512i*>(dataIn.dataExpanded);
63 for (int n = 0; n < 16; ++n)
65 ((uint32_t*)&maxAbs)[n] = maxAbsOneBlock(dataInAddr + n * k_numRegsPerBlock);
67 /// Calculate exponent
68 return BlockFloatCompander::expLzCnt(maxAbs, totShiftBits);
71 /// Compute exponent value for a set of 4 RB from the maximum absolute value
73 computeExponent_4RB(const BlockFloatCompander::ExpandedData& dataIn, const __m512i totShiftBits)
75 __m512i maxAbs = __m512i();
76 const __m512i* dataInAddr = reinterpret_cast<const __m512i*>(dataIn.dataExpanded);
78 for (int n = 0; n < 4; ++n)
80 ((uint32_t*)&maxAbs)[n] = maxAbsOneBlock(dataInAddr + n * k_numRegsPerBlock);
82 /// Calculate exponent
83 return BlockFloatCompander::expLzCnt(maxAbs, totShiftBits);
86 /// Compute exponent value for 1 RB from the maximum absolute value
88 computeExponent_1RB(const BlockFloatCompander::ExpandedData& dataIn, const __m512i totShiftBits)
90 __m512i maxAbs = __m512i();
91 const __m512i* dataInAddr = reinterpret_cast<const __m512i*>(dataIn.dataExpanded);
92 ((uint32_t*)&maxAbs)[0] = maxAbsOneBlock(dataInAddr);
93 /// Calculate exponent
94 const auto exps = BlockFloatCompander::expLzCnt(maxAbs, totShiftBits);
95 return ((uint8_t*)&exps)[0];
100 /// Apply compression to one compression block
101 template<BlockFloatCompander::PackFunction networkBytePack>
103 applyCompressionN_1RB(const __m512i* dataIn, uint8_t* outBlockAddr,
104 const int iqWidth, const uint8_t thisExp, const int totNumBytesPerReg, const uint64_t rbWriteMask)
106 /// Store exponent first
107 *outBlockAddr = thisExp;
108 #pragma unroll(k_numRegsPerBlock)
109 for (int n = 0; n < k_numRegsPerBlock; ++n)
111 /// Apply the exponent shift
112 const auto compData = _mm512_srai_epi16(dataIn[n], thisExp);
113 /// Pack compressed data network byte order
114 const auto compDataBytePacked = networkBytePack(compData);
115 /// Store compressed data
116 _mm512_mask_storeu_epi8(outBlockAddr + 1 + n * totNumBytesPerReg, rbWriteMask, compDataBytePacked);
120 /// Derive and apply 9, 10, or 12bit compression to 16 compression blocks
121 template<BlockFloatCompander::PackFunction networkBytePack>
123 compressN_16RB(const BlockFloatCompander::ExpandedData& dataIn, BlockFloatCompander::CompressedData* dataOut,
124 const __m512i totShiftBits, const int totNumBytesPerBlock, const int totNumBytesPerReg, const uint64_t rbWriteMask)
126 const auto exponents = computeExponent_16RB(dataIn, totShiftBits);
127 const __m512i* dataInAddr = reinterpret_cast<const __m512i*>(dataIn.dataExpanded);
129 for (int n = 0; n < 16; ++n)
131 applyCompressionN_1RB<networkBytePack>(dataInAddr + n * k_numRegsPerBlock, dataOut->dataCompressed + n * totNumBytesPerBlock, dataIn.iqWidth, ((uint8_t*)&exponents)[n * 4], totNumBytesPerReg, rbWriteMask);
135 /// Derive and apply 9, 10, or 12bit compression to 4 compression blocks
136 template<BlockFloatCompander::PackFunction networkBytePack>
138 compressN_4RB(const BlockFloatCompander::ExpandedData& dataIn, BlockFloatCompander::CompressedData* dataOut,
139 const __m512i totShiftBits, const int totNumBytesPerBlock, const int totNumBytesPerReg, const uint64_t rbWriteMask)
141 const auto exponents = computeExponent_4RB(dataIn, totShiftBits);
142 const __m512i* dataInAddr = reinterpret_cast<const __m512i*>(dataIn.dataExpanded);
144 for (int n = 0; n < 4; ++n)
146 applyCompressionN_1RB<networkBytePack>(dataInAddr + n * k_numRegsPerBlock, dataOut->dataCompressed + n * totNumBytesPerBlock, dataIn.iqWidth, ((uint8_t*)&exponents)[n * 4], totNumBytesPerReg, rbWriteMask);
150 /// Derive and apply 9, 10, or 12bit compression to 1 RB
151 template<BlockFloatCompander::PackFunction networkBytePack>
153 compressN_1RB(const BlockFloatCompander::ExpandedData& dataIn, BlockFloatCompander::CompressedData* dataOut,
154 const __m512i totShiftBits, const int totNumBytesPerBlock, const int totNumBytesPerReg, const uint64_t rbWriteMask)
156 const auto thisExponent = computeExponent_1RB(dataIn, totShiftBits);
157 const __m512i* dataInAddr = reinterpret_cast<const __m512i*>(dataIn.dataExpanded);
158 applyCompressionN_1RB<networkBytePack>(dataInAddr, dataOut->dataCompressed, dataIn.iqWidth, thisExponent, totNumBytesPerReg, rbWriteMask);
161 /// Calls compression function specific to the number of blocks to be executed. For 9, 10, or 12bit iqWidth.
162 template<BlockFloatCompander::PackFunction networkBytePack>
164 compressByAllocN(const BlockFloatCompander::ExpandedData& dataIn, BlockFloatCompander::CompressedData* dataOut,
165 const __m512i totShiftBits, const int totNumBytesPerBlock, const int totNumBytesPerReg, const uint64_t rbWriteMask)
167 switch (dataIn.numBlocks)
170 compressN_16RB<networkBytePack>(dataIn, dataOut, totShiftBits, totNumBytesPerBlock, totNumBytesPerReg, rbWriteMask);
174 compressN_4RB<networkBytePack>(dataIn, dataOut, totShiftBits, totNumBytesPerBlock, totNumBytesPerReg, rbWriteMask);
178 compressN_1RB<networkBytePack>(dataIn, dataOut, totShiftBits, totNumBytesPerBlock, totNumBytesPerReg, rbWriteMask);
185 /// Apply 8b compression to 1 compression block.
187 applyCompression8_1RB(const __m512i* dataIn, uint8_t* outBlockAddr, const uint8_t thisExp)
189 /// Store exponent first
190 *outBlockAddr = thisExp;
191 constexpr uint32_t k_writeMask = 0xFFFFFFFF;
192 __m256i* regOutAddr = reinterpret_cast<__m256i*>(outBlockAddr + 1);
193 #pragma unroll(k_numRegsPerBlock)
194 for (int n = 0; n < k_numRegsPerBlock; ++n)
196 /// Apply the exponent shift
197 const auto compData = _mm512_srai_epi16(dataIn[n], thisExp);
198 /// Truncate to 8bit and store
199 _mm256_mask_storeu_epi8(regOutAddr + n, k_writeMask, _mm512_cvtepi16_epi8(compData));
203 /// Derive and apply 8b compression to 16 compression blocks
205 compress8_16RB(const BlockFloatCompander::ExpandedData& dataIn, BlockFloatCompander::CompressedData* dataOut, const __m512i totShiftBits)
207 const __m512i exponents = computeExponent_16RB(dataIn, totShiftBits);
208 const __m512i* dataInAddr = reinterpret_cast<const __m512i*>(dataIn.dataExpanded);
210 for (int n = 0; n < 16; ++n)
212 applyCompression8_1RB(dataInAddr + n * k_numRegsPerBlock, dataOut->dataCompressed + n * (k_numDataElements + 1), ((uint8_t*)&exponents)[n * 4]);
216 /// Derive and apply 8b compression to 4 compression blocks
218 compress8_4RB(const BlockFloatCompander::ExpandedData& dataIn, BlockFloatCompander::CompressedData* dataOut, const __m512i totShiftBits)
220 const __m512i exponents = computeExponent_4RB(dataIn, totShiftBits);
221 const __m512i* dataInAddr = reinterpret_cast<const __m512i*>(dataIn.dataExpanded);
223 for (int n = 0; n < 4; ++n)
225 applyCompression8_1RB(dataInAddr + n * k_numRegsPerBlock, dataOut->dataCompressed + n * (k_numDataElements + 1), ((uint8_t*)&exponents)[n * 4]);
229 /// Derive and apply 8b compression to 1 compression block
231 compress8_1RB(const BlockFloatCompander::ExpandedData& dataIn, BlockFloatCompander::CompressedData* dataOut, const __m512i totShiftBits)
233 const auto thisExponent = computeExponent_1RB(dataIn, totShiftBits);
234 const __m512i* dataInAddr = reinterpret_cast<const __m512i*>(dataIn.dataExpanded);
235 applyCompression8_1RB(dataInAddr, dataOut->dataCompressed, thisExponent);
238 /// Calls compression function specific to the number of RB to be executed. For 8 bit iqWidth.
240 compressByAlloc8(const BlockFloatCompander::ExpandedData& dataIn, BlockFloatCompander::CompressedData* dataOut, const __m512i totShiftBits)
242 switch (dataIn.numBlocks)
245 compress8_16RB(dataIn, dataOut, totShiftBits);
249 compress8_4RB(dataIn, dataOut, totShiftBits);
253 compress8_1RB(dataIn, dataOut, totShiftBits);
260 /// Expand 1 compression block
261 template<BlockFloatCompander::UnpackFunction networkByteUnpack>
263 applyExpansionN_1RB(const uint8_t* expAddr, __m512i* dataOutAddr, const int maxExpShift, const int totNumBytesPerReg)
265 static constexpr uint8_t k_WriteMask = 0xFF;
266 const auto thisExpShift = maxExpShift - *expAddr;
267 #pragma unroll(k_numRegsPerBlock)
268 for (int n = 0; n < k_numRegsPerBlock; ++n)
270 const auto thisInRegAddr = expAddr + 1 + n * totNumBytesPerReg;
271 /// Unpack network order packed data
272 const auto inDataUnpacked = networkByteUnpack(thisInRegAddr);
273 /// Apply exponent scaling (by appropriate arithmetic shift right)
274 const auto expandedData = _mm512_srai_epi16(inDataUnpacked, thisExpShift);
275 /// Write expanded data to output
276 _mm512_mask_storeu_epi64(dataOutAddr + n, k_WriteMask, expandedData);
280 /// Calls expansion function specific to the number of blocks to be executed. For 9, 10, or 12bit iqWidth.
281 template<BlockFloatCompander::UnpackFunction networkByteUnpack>
283 expandByAllocN(const BlockFloatCompander::CompressedData& dataIn, BlockFloatCompander::ExpandedData* dataOut,
284 const int totNumBytesPerBlock, const int totNumBytesPerReg, const int maxExpShift)
286 __m512i* dataOutAddr = reinterpret_cast<__m512i*>(dataOut->dataExpanded);
287 switch (dataIn.numBlocks)
291 for (int n = 0; n < 16; ++n)
293 applyExpansionN_1RB<networkByteUnpack>(dataIn.dataCompressed + n * totNumBytesPerBlock, dataOutAddr + n * k_numRegsPerBlock, maxExpShift, totNumBytesPerReg);
299 for (int n = 0; n < 4; ++n)
301 applyExpansionN_1RB<networkByteUnpack>(dataIn.dataCompressed + n * totNumBytesPerBlock, dataOutAddr + n * k_numRegsPerBlock, maxExpShift, totNumBytesPerReg);
306 applyExpansionN_1RB<networkByteUnpack>(dataIn.dataCompressed, dataOutAddr, maxExpShift, totNumBytesPerReg);
312 /// Apply expansion to 1 compression block
314 applyExpansion8_1RB(const uint8_t* expAddr, __m512i* dataOutAddr)
316 const __m256i* rawDataIn = reinterpret_cast<const __m256i*>(expAddr + 1);
317 static constexpr uint8_t k_WriteMask = 0xFF;
318 #pragma unroll(k_numRegsPerBlock)
319 for (int n = 0; n < k_numRegsPerBlock; ++n)
321 const auto compData16 = _mm512_cvtepi8_epi16(rawDataIn[n]);
322 const auto expData = _mm512_slli_epi16(compData16, *expAddr);
323 _mm512_mask_storeu_epi64(dataOutAddr + n, k_WriteMask, expData);
327 /// Calls expansion function specific to the number of RB to be executed. For 8 bit iqWidth.
329 expandByAlloc8(const BlockFloatCompander::CompressedData& dataIn, BlockFloatCompander::ExpandedData* dataOut)
331 __m512i* dataOutAddr = reinterpret_cast<__m512i*>(dataOut->dataExpanded);
332 switch (dataIn.numBlocks)
336 for (int n = 0; n < 16; ++n)
338 applyExpansion8_1RB(dataIn.dataCompressed + n * (k_numDataElements + 1), dataOutAddr + n * k_numRegsPerBlock);
344 for (int n = 0; n < 4; ++n)
346 applyExpansion8_1RB(dataIn.dataCompressed + n * (k_numDataElements + 1), dataOutAddr + n * k_numRegsPerBlock);
351 applyExpansion8_1RB(dataIn.dataCompressed, dataOutAddr);
358 /// Main kernel function for 32 antenna C-plane compression.
359 /// Starts by determining iqWidth specific parameters and functions.
361 BlockFloatCompander::BFPCompressCtrlPlane32AvxSnc(const ExpandedData& dataIn, CompressedData* dataOut)
363 /// Compensation for extra zeros in 32b leading zero count when computing exponent
364 const auto totShiftBits8 = _mm512_set1_epi32(25);
365 const auto totShiftBits9 = _mm512_set1_epi32(24);
366 const auto totShiftBits10 = _mm512_set1_epi32(23);
367 const auto totShiftBits12 = _mm512_set1_epi32(21);
369 /// Total number of data bytes per compression block is (iqWidth * numElements / 8) + 1
370 const auto totNumBytesPerBlock = ((BFP_CPlane_32_SNC::k_numDataElements * dataIn.iqWidth) >> 3) + 1;
371 /// Total number of compressed bytes to handle per register is 32 * iqWidth / 8
372 const auto totNumBytesPerReg = dataIn.iqWidth << 2;
374 /// Compressed data write mask for each iqWidth option
375 constexpr uint64_t rbWriteMask9 = 0x0000000FFFFFFFFF;
376 constexpr uint64_t rbWriteMask10 = 0x000000FFFFFFFFFF;
377 constexpr uint64_t rbWriteMask12 = 0x0000FFFFFFFFFFFF;
379 switch (dataIn.iqWidth)
382 BFP_CPlane_32_SNC::compressByAlloc8(dataIn, dataOut, totShiftBits8);
386 BFP_CPlane_32_SNC::compressByAllocN<BlockFloatCompander::networkBytePack9bSnc>(dataIn, dataOut, totShiftBits9, totNumBytesPerBlock, totNumBytesPerReg, rbWriteMask9);
390 BFP_CPlane_32_SNC::compressByAllocN<BlockFloatCompander::networkBytePack10bSnc>(dataIn, dataOut, totShiftBits10, totNumBytesPerBlock, totNumBytesPerReg, rbWriteMask10);
394 BFP_CPlane_32_SNC::compressByAllocN<BlockFloatCompander::networkBytePack12bSnc>(dataIn, dataOut, totShiftBits12, totNumBytesPerBlock, totNumBytesPerReg, rbWriteMask12);
400 /// Main kernel function for 32 antenna C-plane expansion.
401 /// Starts by determining iqWidth specific parameters and functions.
403 BlockFloatCompander::BFPExpandCtrlPlane32AvxSnc(const CompressedData& dataIn, ExpandedData* dataOut)
405 constexpr int k_maxExpShift9 = 7;
406 constexpr int k_maxExpShift10 = 6;
407 constexpr int k_maxExpShift12 = 4;
409 /// Total number of data bytes per compression block is (iqWidth * numElements / 8) + 1
410 const auto totNumBytesPerBlock = ((BFP_CPlane_32_SNC::k_numDataElements * dataIn.iqWidth) >> 3) + 1;
411 /// Total number of compressed bytes to handle per register is 32 * iqWidth / 8
412 const auto totNumBytesPerReg = dataIn.iqWidth << 2;
414 switch (dataIn.iqWidth)
417 BFP_CPlane_32_SNC::expandByAlloc8(dataIn, dataOut);
421 BFP_CPlane_32_SNC::expandByAllocN<BlockFloatCompander::networkByteUnpack9bSnc>(dataIn, dataOut, totNumBytesPerBlock, totNumBytesPerReg, k_maxExpShift9);
425 BFP_CPlane_32_SNC::expandByAllocN<BlockFloatCompander::networkByteUnpack10bSnc>(dataIn, dataOut, totNumBytesPerBlock, totNumBytesPerReg, k_maxExpShift10);
429 BFP_CPlane_32_SNC::expandByAllocN<BlockFloatCompander::networkByteUnpack12bSnc>(dataIn, dataOut, totNumBytesPerBlock, totNumBytesPerReg, k_maxExpShift12);