#![cfg(all(feature = "simd-avx2", target_arch = "x86_64"))]
use core::arch::x86_64::*;
use crate::error::{QuantError, QuantResult};
use crate::simd::avx2::util::{f16_to_f32, hsum_f32_avx};
use crate::traits::QuantKernel;
use crate::types::QuantTensor;
pub const BLOCK_SIZE: usize = 256;
pub const BLOCK_BYTES: usize = 110;
#[allow(non_camel_case_types)]
pub struct Q3_KAvx2;
fn decode_scales(scales_raw: &[u8]) -> [f32; 16] {
let mut sc = [0u32; 16];
for j in 0..4 {
sc[j] = (scales_raw[j] & 0x3F) as u32;
}
for j in 0..4 {
sc[4 + j] = (scales_raw[4 + j] & 0x3F) as u32;
}
for j in 0..4 {
let lo = (scales_raw[8 + j] & 0x0F) as u32;
let hi = ((scales_raw[j] >> 6) & 0x03) as u32;
sc[8 + j] = lo | (hi << 4);
}
for j in 0..4 {
let lo = ((scales_raw[8 + j] >> 4) & 0x0F) as u32;
let hi = ((scales_raw[4 + j] >> 6) & 0x03) as u32;
sc[12 + j] = lo | (hi << 4);
}
let mut result = [0.0f32; 16];
for i in 0..16 {
result[i] = (sc[i] as i32 - 32) as f32;
}
result
}
#[target_feature(enable = "avx2")]
#[inline]
unsafe fn extract_2bit_16(raw: __m128i, shift: u32, mask: __m128i) -> __m128i {
let shifted = match shift {
0 => raw,
2 => _mm_srli_epi16::<2>(raw),
4 => _mm_srli_epi16::<4>(raw),
_ => _mm_srli_epi16::<6>(raw),
};
_mm_and_si128(shifted, mask)
}
#[target_feature(enable = "avx2")]
#[inline]
unsafe fn hmask_correction_16(hmask_half: __m128i, m_vec: __m128i) -> __m128i {
let masked = _mm_and_si128(hmask_half, m_vec);
let is_zero = _mm_cmpeq_epi8(masked, _mm_setzero_si128());
_mm_and_si128(is_zero, _mm_set1_epi8(4))
}
impl QuantKernel for Q3_KAvx2 {
fn dequant_block(&self, block: &[u8], output: &mut [f32]) -> QuantResult<()> {
if block.len() < BLOCK_BYTES {
return Err(QuantError::BufferTooSmall {
needed: BLOCK_BYTES,
available: block.len(),
});
}
if output.len() < BLOCK_SIZE {
return Err(QuantError::BufferTooSmall {
needed: BLOCK_SIZE,
available: output.len(),
});
}
unsafe { dequant_block_avx2(block, output) }
Ok(())
}
fn gemv(
&self,
quant_matrix: &QuantTensor,
input: &[f32],
output: &mut [f32],
) -> QuantResult<()> {
let n_rows = quant_matrix.shape[0];
let n_cols = if quant_matrix.shape.len() > 1 {
quant_matrix.shape[1]
} else {
quant_matrix.n_elements() / n_rows
};
if input.len() < n_cols {
return Err(QuantError::DimensionMismatch {
expected: n_cols,
got: input.len(),
});
}
if output.len() < n_rows {
return Err(QuantError::DimensionMismatch {
expected: n_rows,
got: output.len(),
});
}
let blocks_per_row = n_cols.div_ceil(BLOCK_SIZE);
let row_bytes = blocks_per_row * BLOCK_BYTES;
for (row, out) in output.iter_mut().enumerate().take(n_rows) {
let row_start = row * row_bytes;
*out = unsafe {
gemv_row_avx2(
&quant_matrix.data[row_start..row_start + row_bytes],
input,
blocks_per_row,
n_cols,
)
};
}
Ok(())
}
fn gemm(
&self,
quant_matrix: &QuantTensor,
input: &[f32],
output: &mut [f32],
m: usize,
n: usize,
k: usize,
) -> QuantResult<()> {
for row in 0..m {
let input_row = &input[row * k..(row + 1) * k];
let output_row = &mut output[row * n..(row + 1) * n];
self.gemv(quant_matrix, input_row, output_row)?;
}
Ok(())
}
fn block_size(&self) -> usize {
BLOCK_SIZE
}
fn block_bytes(&self) -> usize {
BLOCK_BYTES
}
fn name(&self) -> &'static str {
"Q3_K"
}
}
#[target_feature(enable = "avx2,fma")]
unsafe fn dequant_block_avx2(block: &[u8], output: &mut [f32]) {
let hmask = &block[0..32];
let qs = &block[32..96];
let scales_raw = &block[96..108];
let d = f16_to_f32(&block[108..]);
let sc = decode_scales(scales_raw);
let hmask_lo = _mm_loadu_si128(hmask.as_ptr() as *const __m128i);
let hmask_hi = _mm_loadu_si128(hmask.as_ptr().add(16) as *const __m128i);
let mask_2bit = _mm_set1_epi8(0x03);
let mut is = 0usize;
let mut out_off = 0usize;
for group in 0..2usize {
let qs_base = group * 32;
let raw_a = _mm_loadu_si128(qs.as_ptr().add(qs_base) as *const __m128i);
let raw_b = _mm_loadu_si128(qs.as_ptr().add(qs_base + 16) as *const __m128i);
for shift_idx in 0..4u32 {
let shift = shift_idx * 2;
let bit_pos = (group as u32) * 4 + shift_idx;
let m: u8 = 1u8 << bit_pos;
let m_vec = _mm_set1_epi8(m as i8);
{
let dl = d * sc[is];
is += 1;
let vdl = _mm256_set1_ps(dl);
let q_bytes = extract_2bit_16(raw_a, shift, mask_2bit);
let correction = hmask_correction_16(hmask_lo, m_vec);
let q_i32 = _mm256_cvtepu8_epi32(q_bytes);
let c_i32 = _mm256_cvtepu8_epi32(correction);
let val_i32 = _mm256_sub_epi32(q_i32, c_i32);
let val_f32 = _mm256_cvtepi32_ps(val_i32);
let w0 = _mm256_mul_ps(vdl, val_f32);
let q_bytes_hi8 = _mm_srli_si128(q_bytes, 8);
let correction_hi8 = _mm_srli_si128(correction, 8);
let q_i32_2 = _mm256_cvtepu8_epi32(q_bytes_hi8);
let c_i32_2 = _mm256_cvtepu8_epi32(correction_hi8);
let val_i32_2 = _mm256_sub_epi32(q_i32_2, c_i32_2);
let val_f32_2 = _mm256_cvtepi32_ps(val_i32_2);
let w1 = _mm256_mul_ps(vdl, val_f32_2);
let ptr = output.as_mut_ptr().add(out_off);
_mm256_storeu_ps(ptr, w0);
_mm256_storeu_ps(ptr.add(8), w1);
out_off += 16;
}
{
let dl = d * sc[is];
is += 1;
let vdl = _mm256_set1_ps(dl);
let q_bytes = extract_2bit_16(raw_b, shift, mask_2bit);
let correction = hmask_correction_16(hmask_hi, m_vec);
let q_i32 = _mm256_cvtepu8_epi32(q_bytes);
let c_i32 = _mm256_cvtepu8_epi32(correction);
let val_i32 = _mm256_sub_epi32(q_i32, c_i32);
let val_f32 = _mm256_cvtepi32_ps(val_i32);
let w2 = _mm256_mul_ps(vdl, val_f32);
let q_bytes_hi8 = _mm_srli_si128(q_bytes, 8);
let correction_hi8 = _mm_srli_si128(correction, 8);
let q_i32_2 = _mm256_cvtepu8_epi32(q_bytes_hi8);
let c_i32_2 = _mm256_cvtepu8_epi32(correction_hi8);
let val_i32_2 = _mm256_sub_epi32(q_i32_2, c_i32_2);
let val_f32_2 = _mm256_cvtepi32_ps(val_i32_2);
let w3 = _mm256_mul_ps(vdl, val_f32_2);
let ptr = output.as_mut_ptr().add(out_off);
_mm256_storeu_ps(ptr, w2);
_mm256_storeu_ps(ptr.add(8), w3);
out_off += 16;
}
}
}
}
#[target_feature(enable = "avx2,fma")]
unsafe fn gemv_row_avx2(
row_data: &[u8],
input: &[f32],
blocks_per_row: usize,
n_cols: usize,
) -> f32 {
let mut row_sum = 0.0f32;
for blk in 0..blocks_per_row {
let block_offset = blk * BLOCK_BYTES;
let block = &row_data[block_offset..block_offset + BLOCK_BYTES];
let input_offset = blk * BLOCK_SIZE;
let remaining = n_cols.saturating_sub(input_offset);
let hmask = &block[0..32];
let qs = &block[32..96];
let scales_raw = &block[96..108];
let d = f16_to_f32(&block[108..]);
let sc = decode_scales(scales_raw);
if remaining >= BLOCK_SIZE {
let hmask_lo = _mm_loadu_si128(hmask.as_ptr() as *const __m128i);
let hmask_hi = _mm_loadu_si128(hmask.as_ptr().add(16) as *const __m128i);
let mask_2bit = _mm_set1_epi8(0x03);
let mut block_acc = _mm256_setzero_ps();
let mut is = 0usize;
let mut w_off = input_offset;
for group in 0..2usize {
let qs_base = group * 32;
let raw_a = _mm_loadu_si128(qs.as_ptr().add(qs_base) as *const __m128i);
let raw_b = _mm_loadu_si128(qs.as_ptr().add(qs_base + 16) as *const __m128i);
for shift_idx in 0..4u32 {
let shift = shift_idx * 2;
let bit_pos = (group as u32) * 4 + shift_idx;
let m: u8 = 1u8 << bit_pos;
let m_vec = _mm_set1_epi8(m as i8);
{
let dl = d * sc[is];
is += 1;
let vdl = _mm256_set1_ps(dl);
let q_bytes = extract_2bit_16(raw_a, shift, mask_2bit);
let correction = hmask_correction_16(hmask_lo, m_vec);
let inp_ptr = input.as_ptr().add(w_off);
let q_i32 = _mm256_cvtepu8_epi32(q_bytes);
let c_i32 = _mm256_cvtepu8_epi32(correction);
let val_f32 = _mm256_cvtepi32_ps(_mm256_sub_epi32(q_i32, c_i32));
let w0 = _mm256_mul_ps(vdl, val_f32);
let i0 = _mm256_loadu_ps(inp_ptr);
block_acc = _mm256_fmadd_ps(w0, i0, block_acc);
let q_hi8 = _mm_srli_si128(q_bytes, 8);
let c_hi8 = _mm_srli_si128(correction, 8);
let q_i32_2 = _mm256_cvtepu8_epi32(q_hi8);
let c_i32_2 = _mm256_cvtepu8_epi32(c_hi8);
let val_f32_2 = _mm256_cvtepi32_ps(_mm256_sub_epi32(q_i32_2, c_i32_2));
let w1 = _mm256_mul_ps(vdl, val_f32_2);
let i1 = _mm256_loadu_ps(inp_ptr.add(8));
block_acc = _mm256_fmadd_ps(w1, i1, block_acc);
w_off += 16;
}
{
let dl = d * sc[is];
is += 1;
let vdl = _mm256_set1_ps(dl);
let q_bytes = extract_2bit_16(raw_b, shift, mask_2bit);
let correction = hmask_correction_16(hmask_hi, m_vec);
let inp_ptr = input.as_ptr().add(w_off);
let q_i32 = _mm256_cvtepu8_epi32(q_bytes);
let c_i32 = _mm256_cvtepu8_epi32(correction);
let val_f32 = _mm256_cvtepi32_ps(_mm256_sub_epi32(q_i32, c_i32));
let w2 = _mm256_mul_ps(vdl, val_f32);
let i2 = _mm256_loadu_ps(inp_ptr);
block_acc = _mm256_fmadd_ps(w2, i2, block_acc);
let q_hi8 = _mm_srli_si128(q_bytes, 8);
let c_hi8 = _mm_srli_si128(correction, 8);
let q_i32_2 = _mm256_cvtepu8_epi32(q_hi8);
let c_i32_2 = _mm256_cvtepu8_epi32(c_hi8);
let val_f32_2 = _mm256_cvtepi32_ps(_mm256_sub_epi32(q_i32_2, c_i32_2));
let w3 = _mm256_mul_ps(vdl, val_f32_2);
let i3 = _mm256_loadu_ps(inp_ptr.add(8));
block_acc = _mm256_fmadd_ps(w3, i3, block_acc);
w_off += 16;
}
}
}
row_sum += hsum_f32_avx(block_acc);
} else if remaining > 0 {
let mut partial_sum = 0.0f32;
let mut is = 0usize;
let mut in_off = input_offset;
let mut m_bit: u8 = 1;
for group in 0..2usize {
let qs_base = group * 32;
for shift in (0u32..8).step_by(2) {
for n in 0..2usize {
let dl = d * sc[is];
is += 1;
for l in 0..16 {
let idx = in_off + l;
if idx < n_cols {
let qs_idx = qs_base + n * 16 + l;
let q_lo = ((*qs.get_unchecked(qs_idx) >> shift) & 3) as i32;
let subtract = if *hmask.get_unchecked(n * 16 + l) & m_bit != 0 {
0
} else {
4
};
partial_sum += dl * (q_lo - subtract) as f32 * input[idx];
}
}
in_off += 16;
}
m_bit = m_bit.wrapping_shl(1);
}
}
row_sum += partial_sum;
}
}
row_sum
}
#[cfg(all(test, target_arch = "x86_64", feature = "simd-avx2"))]
mod tests {
use super::*;
use crate::reference::q3_k::Q3KRef;
fn make_q3k_block(d: f32, scales: &[u8; 12], hmask: &[u8; 32], qs: &[u8; 64]) -> Vec<u8> {
let mut block = Vec::with_capacity(BLOCK_BYTES);
block.extend_from_slice(hmask);
block.extend_from_slice(qs);
block.extend_from_slice(scales);
block.extend_from_slice(&half::f16::from_f32(d).to_bits().to_le_bytes());
block
}
fn make_tensor(block: Vec<u8>, n_cols: usize) -> QuantTensor {
QuantTensor::new(block, vec![1, n_cols], oxillama_gguf::GgufTensorType::Q3K)
}
#[test]
fn test_dequant_matches_reference_zeros() {
if !std::arch::is_x86_feature_detected!("avx2") {
return;
}
let block = make_q3k_block(0.0, &[0; 12], &[0; 32], &[0; 64]);
let mut out_avx2 = vec![0.0f32; 256];
let mut out_ref = vec![0.0f32; 256];
Q3_KAvx2
.dequant_block(&block, &mut out_avx2)
.expect("avx2 dequant");
Q3KRef
.dequant_block(&block, &mut out_ref)
.expect("ref dequant");
for (i, (&a, &r)) in out_avx2.iter().zip(out_ref.iter()).enumerate() {
assert!(
(a - r).abs() < 1e-5,
"dequant mismatch [zeros] at index {i}: avx2={a}, ref={r}"
);
}
}
#[test]
fn test_dequant_matches_reference_hmask_all_set() {
if !std::arch::is_x86_feature_detected!("avx2") {
return;
}
let hmask = [0xFFu8; 32];
let qs = [0x00u8; 64];
let mut scales = [0u8; 12];
scales[..8].fill(0x21);
let block = make_q3k_block(1.0, &scales, &hmask, &qs);
let mut out_avx2 = vec![99.0f32; 256];
let mut out_ref = vec![99.0f32; 256];
Q3_KAvx2
.dequant_block(&block, &mut out_avx2)
.expect("avx2 dequant");
Q3KRef
.dequant_block(&block, &mut out_ref)
.expect("ref dequant");
for (i, (&a, &r)) in out_avx2.iter().zip(out_ref.iter()).enumerate() {
assert!(
(a - r).abs() < 1e-3,
"dequant mismatch [hmask_set] at index {i}: avx2={a}, ref={r}"
);
}
}
#[test]
fn test_dequant_matches_reference_hmask_all_clear() {
if !std::arch::is_x86_feature_detected!("avx2") {
return;
}
let hmask = [0x00u8; 32];
let qs = [0x00u8; 64];
let scales: [u8; 12] = [
0xA1, 0xA1, 0xA1, 0xA1, 0xA1, 0xA1, 0xA1, 0xA1, 0x11, 0x11, 0x11, 0x11,
];
let block = make_q3k_block(1.0, &scales, &hmask, &qs);
let mut out_avx2 = vec![0.0f32; 256];
let mut out_ref = vec![0.0f32; 256];
Q3_KAvx2
.dequant_block(&block, &mut out_avx2)
.expect("avx2 dequant");
Q3KRef
.dequant_block(&block, &mut out_ref)
.expect("ref dequant");
for (i, (&a, &r)) in out_avx2.iter().zip(out_ref.iter()).enumerate() {
assert!(
(a - r).abs() < 1e-3,
"dequant mismatch [hmask_clear] at index {i}: avx2={a}, ref={r}"
);
}
}
#[test]
fn test_dequant_matches_reference_varied() {
if !std::arch::is_x86_feature_detected!("avx2") {
return;
}
let mut scales = [0u8; 12];
for (i, s) in scales.iter_mut().enumerate() {
*s = ((i * 17 + 3) & 0x3F) as u8;
}
let mut hmask = [0u8; 32];
for (i, h) in hmask.iter_mut().enumerate() {
*h = ((i * 13 + 7) & 0xFF) as u8;
}
let mut qs = [0u8; 64];
for (i, q) in qs.iter_mut().enumerate() {
*q = ((i * 5 + 11) & 0xFF) as u8;
}
let block = make_q3k_block(0.5, &scales, &hmask, &qs);
let mut out_avx2 = vec![0.0f32; 256];
let mut out_ref = vec![0.0f32; 256];
Q3_KAvx2
.dequant_block(&block, &mut out_avx2)
.expect("avx2 dequant");
Q3KRef
.dequant_block(&block, &mut out_ref)
.expect("ref dequant");
for (i, (&a, &r)) in out_avx2.iter().zip(out_ref.iter()).enumerate() {
assert!(
(a - r).abs() < 1e-3,
"dequant mismatch [varied] at index {i}: avx2={a}, ref={r}"
);
}
}
#[test]
fn test_gemv_matches_reference() {
if !std::arch::is_x86_feature_detected!("avx2") {
return;
}
let mut scales = [0u8; 12];
for (i, s) in scales.iter_mut().enumerate() {
*s = ((i * 17 + 3) & 0x3F) as u8;
}
let mut hmask = [0u8; 32];
for (i, h) in hmask.iter_mut().enumerate() {
*h = ((i * 13 + 7) & 0xFF) as u8;
}
let mut qs = [0u8; 64];
for (i, q) in qs.iter_mut().enumerate() {
*q = ((i * 5 + 11) & 0xFF) as u8;
}
let block = make_q3k_block(0.5, &scales, &hmask, &qs);
let tensor_avx2 = make_tensor(block.clone(), 256);
let tensor_ref = make_tensor(block, 256);
let input: Vec<f32> = (0..256).map(|i| (i as f32) * 0.01 - 1.28).collect();
let mut out_avx2 = vec![0.0f32; 1];
let mut out_ref = vec![0.0f32; 1];
Q3_KAvx2
.gemv(&tensor_avx2, &input, &mut out_avx2)
.expect("avx2 gemv");
Q3KRef
.gemv(&tensor_ref, &input, &mut out_ref)
.expect("ref gemv");
assert!(
(out_avx2[0] - out_ref[0]).abs() < 0.1,
"gemv mismatch: avx2={}, ref={}",
out_avx2[0],
out_ref[0]
);
}
#[test]
fn test_gemv_partial_block() {
if !std::arch::is_x86_feature_detected!("avx2") {
return;
}
let hmask = [0xAAu8; 32]; let qs = [0x55u8; 64];
let mut scales = [0u8; 12];
scales[..8].fill(0x21);
let block = make_q3k_block(1.0, &scales, &hmask, &qs);
let tensor_avx2 = make_tensor(block.clone(), 200);
let tensor_ref = make_tensor(block, 200);
let input = vec![1.0f32; 200];
let mut out_avx2 = vec![0.0f32; 1];
let mut out_ref = vec![0.0f32; 1];
Q3_KAvx2
.gemv(&tensor_avx2, &input, &mut out_avx2)
.expect("avx2 gemv partial");
Q3KRef
.gemv(&tensor_ref, &input, &mut out_ref)
.expect("ref gemv partial");
assert!(
(out_avx2[0] - out_ref[0]).abs() < 0.1,
"partial gemv mismatch: avx2={}, ref={}",
out_avx2[0],
out_ref[0]
);
}
#[test]
fn test_gemv_alternating_hmask() {
if !std::arch::is_x86_feature_detected!("avx2") {
return;
}
let mut scales = [0u8; 12];
for (i, s) in scales.iter_mut().enumerate() {
*s = ((i * 11 + 5) & 0x3F) as u8;
}
let mut hmask = [0u8; 32];
for (i, h) in hmask.iter_mut().enumerate() {
*h = if i % 2 == 0 { 0xAA } else { 0x55 };
}
let mut qs = [0u8; 64];
for (i, q) in qs.iter_mut().enumerate() {
*q = ((i * 7 + 3) & 0xFF) as u8;
}
let block = make_q3k_block(0.75, &scales, &hmask, &qs);
let tensor_avx2 = make_tensor(block.clone(), 256);
let tensor_ref = make_tensor(block, 256);
let input: Vec<f32> = (0..256).map(|i| (i as f32 * 0.005) - 0.64).collect();
let mut out_avx2 = vec![0.0f32; 1];
let mut out_ref = vec![0.0f32; 1];
Q3_KAvx2
.gemv(&tensor_avx2, &input, &mut out_avx2)
.expect("avx2 gemv alternating");
Q3KRef
.gemv(&tensor_ref, &input, &mut out_ref)
.expect("ref gemv alternating");
assert!(
(out_avx2[0] - out_ref[0]).abs() < 0.1,
"alternating gemv mismatch: avx2={}, ref={}",
out_avx2[0],
out_ref[0]
);
}
#[test]
fn test_buffer_too_small_block() {
let block = vec![0u8; 10]; let mut output = vec![0.0f32; 256];
assert!(Q3_KAvx2.dequant_block(&block, &mut output).is_err());
}
#[test]
fn test_buffer_too_small_output() {
let block = vec![0u8; BLOCK_BYTES];
let mut output = vec![0.0f32; 10]; assert!(Q3_KAvx2.dequant_block(&block, &mut output).is_err());
}
}