Files
blis/frame/include/bli_kernel_4m_macro_defs.h
Field G. Van Zee fde5f1fdec Added extensive support for configuration defaults.
Details:
- Standard names for reference kernels (levels-1v, -1f and 3) are now
  macro constants. Examples:
    BLIS_SAXPYV_KERNEL_REF
    BLIS_DDOTXF_KERNEL_REF
    BLIS_ZGEMM_UKERNEL_REF
- Developers no longer have to name all datatype instances of a kernel
  with a common base name; [sdcz] datatype flavors of each kernel or
  micro-kernel (level-1v, -1f, or 3) may now be named independently.
  This means you can now, if you wish, encode the datatype-specific
  register blocksizes in the name of the micro-kernel functions.
- Any datatype instances of any kernel (1v, 1f, or 3) that is left
  undefined in bli_kernel.h will default to the corresponding reference
  implementation. For example, if BLIS_DGEMM_UKERNEL is left undefined,
  it will be defined to be BLIS_DGEMM_UKERNEL_REF.
- Developers no longer need to name level-1v/-1f kernels with multiple
  datatype chars to match the number of types the kernel WOULD take in
  a mixed type environment, as in bli_dddaxpyv_opt(). Now, one char is
  sufficient, as in bli_daxpyv_opt().
- There is no longer a need to define an obj_t wrapper to go along with
  your level-1v/-1f kernels. The framework now prvides a _kernel()
  function which serves as the obj_t wrapper for whatever kernels are
  specified (or defaulted to) via bli_kernel.h
- Developers no longer need to prototype their kernels, and thus no
  longer need to include any prototyping headers from within
  bli_kernel.h. The framework now generates kernel prototypes, with the
  proper type signature, based on the kernel names defined (or defaulted
  to) via bli_kernel.h.
- If the complex datatype x (of [cz]) implementation of the gemm micro-
  kernel is left undefined by bli_kernel.h, but its same-precision real
  domain equivalent IS defined, BLIS will use a 4m-based implementation
  for the datatype x implementations of all level-3 operations, using
  only the real gemm micro-kernel.
2014-02-25 13:34:56 -06:00

417 lines
12 KiB
C

/*
BLIS
An object-based framework for developing high-performance BLAS-like
libraries.
Copyright (C) 2014, The University of Texas
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
- Neither the name of The University of Texas nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef BLIS_KERNEL_4M_MACRO_DEFS_H
#define BLIS_KERNEL_4M_MACRO_DEFS_H
// -- Construct 4m kernel function names ---------------------------------------
//
// Level-3 4m
//
// gemm4m micro-kernels
#ifndef BLIS_CGEMM4M_UKERNEL
#define BLIS_CGEMM4M_UKERNEL BLIS_CGEMM4M_UKERNEL_REF
#endif
#ifndef BLIS_ZGEMM4M_UKERNEL
#define BLIS_ZGEMM4M_UKERNEL BLIS_ZGEMM4M_UKERNEL_REF
#endif
// gemmtrsm4m_l micro-kernels
#ifndef BLIS_CGEMMTRSM4M_L_UKERNEL
#define BLIS_CGEMMTRSM4M_L_UKERNEL BLIS_CGEMMTRSM4M_L_UKERNEL_REF
#endif
#ifndef BLIS_ZGEMMTRSM4M_L_UKERNEL
#define BLIS_ZGEMMTRSM4M_L_UKERNEL BLIS_ZGEMMTRSM4M_L_UKERNEL_REF
#endif
// gemmtrsm4m_u micro-kernels
#ifndef BLIS_CGEMMTRSM4M_U_UKERNEL
#define BLIS_CGEMMTRSM4M_U_UKERNEL BLIS_CGEMMTRSM4M_U_UKERNEL_REF
#endif
#ifndef BLIS_ZGEMMTRSM4M_U_UKERNEL
#define BLIS_ZGEMMTRSM4M_U_UKERNEL BLIS_ZGEMMTRSM4M_U_UKERNEL_REF
#endif
// trsm4m_l micro-kernels
#ifndef BLIS_CTRSM4M_L_UKERNEL
#define BLIS_CTRSM4M_L_UKERNEL BLIS_CTRSM4M_L_UKERNEL_REF
#endif
#ifndef BLIS_ZTRSM4M_L_UKERNEL
#define BLIS_ZTRSM4M_L_UKERNEL BLIS_ZTRSM4M_L_UKERNEL_REF
#endif
// trsm4m_u micro-kernels
#ifndef BLIS_CTRSM4M_U_UKERNEL
#define BLIS_CTRSM4M_U_UKERNEL BLIS_CTRSM4M_U_UKERNEL_REF
#endif
#ifndef BLIS_ZTRSM4M_U_UKERNEL
#define BLIS_ZTRSM4M_U_UKERNEL BLIS_ZTRSM4M_U_UKERNEL_REF
#endif
//
// Level-1m
//
// packm_2xk_ri kernels
#ifndef BLIS_SPACKM_2XK_RI_KERNEL
#define BLIS_SPACKM_2XK_RI_KERNEL BLIS_SPACKM_2XK_RI_KERNEL_REF
#endif
#ifndef BLIS_DPACKM_2XK_RI_KERNEL
#define BLIS_DPACKM_2XK_RI_KERNEL BLIS_DPACKM_2XK_RI_KERNEL_REF
#endif
#ifndef BLIS_CPACKM_2XK_RI_KERNEL
#define BLIS_CPACKM_2XK_RI_KERNEL BLIS_CPACKM_2XK_RI_KERNEL_REF
#endif
#ifndef BLIS_ZPACKM_2XK_RI_KERNEL
#define BLIS_ZPACKM_2XK_RI_KERNEL BLIS_ZPACKM_2XK_RI_KERNEL_REF
#endif
// packm_4xk_ri kernels
#ifndef BLIS_SPACKM_4XK_RI_KERNEL
#define BLIS_SPACKM_4XK_RI_KERNEL BLIS_SPACKM_4XK_RI_KERNEL_REF
#endif
#ifndef BLIS_DPACKM_4XK_RI_KERNEL
#define BLIS_DPACKM_4XK_RI_KERNEL BLIS_DPACKM_4XK_RI_KERNEL_REF
#endif
#ifndef BLIS_CPACKM_4XK_RI_KERNEL
#define BLIS_CPACKM_4XK_RI_KERNEL BLIS_CPACKM_4XK_RI_KERNEL_REF
#endif
#ifndef BLIS_ZPACKM_4XK_RI_KERNEL
#define BLIS_ZPACKM_4XK_RI_KERNEL BLIS_ZPACKM_4XK_RI_KERNEL_REF
#endif
// packm_6xk_ri kernels
#ifndef BLIS_SPACKM_6XK_RI_KERNEL
#define BLIS_SPACKM_6XK_RI_KERNEL BLIS_SPACKM_6XK_RI_KERNEL_REF
#endif
#ifndef BLIS_DPACKM_6XK_RI_KERNEL
#define BLIS_DPACKM_6XK_RI_KERNEL BLIS_DPACKM_6XK_RI_KERNEL_REF
#endif
#ifndef BLIS_CPACKM_6XK_RI_KERNEL
#define BLIS_CPACKM_6XK_RI_KERNEL BLIS_CPACKM_6XK_RI_KERNEL_REF
#endif
#ifndef BLIS_ZPACKM_6XK_RI_KERNEL
#define BLIS_ZPACKM_6XK_RI_KERNEL BLIS_ZPACKM_6XK_RI_KERNEL_REF
#endif
// packm_8xk_ri kernels
#ifndef BLIS_SPACKM_8XK_RI_KERNEL
#define BLIS_SPACKM_8XK_RI_KERNEL BLIS_SPACKM_8XK_RI_KERNEL_REF
#endif
#ifndef BLIS_DPACKM_8XK_RI_KERNEL
#define BLIS_DPACKM_8XK_RI_KERNEL BLIS_DPACKM_8XK_RI_KERNEL_REF
#endif
#ifndef BLIS_CPACKM_8XK_RI_KERNEL
#define BLIS_CPACKM_8XK_RI_KERNEL BLIS_CPACKM_8XK_RI_KERNEL_REF
#endif
#ifndef BLIS_ZPACKM_8XK_RI_KERNEL
#define BLIS_ZPACKM_8XK_RI_KERNEL BLIS_ZPACKM_8XK_RI_KERNEL_REF
#endif
// packm_10xk_ri kernels
#ifndef BLIS_SPACKM_10XK_RI_KERNEL
#define BLIS_SPACKM_10XK_RI_KERNEL BLIS_SPACKM_10XK_RI_KERNEL_REF
#endif
#ifndef BLIS_DPACKM_10XK_RI_KERNEL
#define BLIS_DPACKM_10XK_RI_KERNEL BLIS_DPACKM_10XK_RI_KERNEL_REF
#endif
#ifndef BLIS_CPACKM_10XK_RI_KERNEL
#define BLIS_CPACKM_10XK_RI_KERNEL BLIS_CPACKM_10XK_RI_KERNEL_REF
#endif
#ifndef BLIS_ZPACKM_10XK_RI_KERNEL
#define BLIS_ZPACKM_10XK_RI_KERNEL BLIS_ZPACKM_10XK_RI_KERNEL_REF
#endif
// packm_12xk_ri kernels
#ifndef BLIS_SPACKM_12XK_RI_KERNEL
#define BLIS_SPACKM_12XK_RI_KERNEL BLIS_SPACKM_12XK_RI_KERNEL_REF
#endif
#ifndef BLIS_DPACKM_12XK_RI_KERNEL
#define BLIS_DPACKM_12XK_RI_KERNEL BLIS_DPACKM_12XK_RI_KERNEL_REF
#endif
#ifndef BLIS_CPACKM_12XK_RI_KERNEL
#define BLIS_CPACKM_12XK_RI_KERNEL BLIS_CPACKM_12XK_RI_KERNEL_REF
#endif
#ifndef BLIS_ZPACKM_12XK_RI_KERNEL
#define BLIS_ZPACKM_12XK_RI_KERNEL BLIS_ZPACKM_12XK_RI_KERNEL_REF
#endif
// packm_14xk_ri kernels
#ifndef BLIS_SPACKM_14XK_RI_KERNEL
#define BLIS_SPACKM_14XK_RI_KERNEL BLIS_SPACKM_14XK_RI_KERNEL_REF
#endif
#ifndef BLIS_DPACKM_14XK_RI_KERNEL
#define BLIS_DPACKM_14XK_RI_KERNEL BLIS_DPACKM_14XK_RI_KERNEL_REF
#endif
#ifndef BLIS_CPACKM_14XK_RI_KERNEL
#define BLIS_CPACKM_14XK_RI_KERNEL BLIS_CPACKM_14XK_RI_KERNEL_REF
#endif
#ifndef BLIS_ZPACKM_14XK_RI_KERNEL
#define BLIS_ZPACKM_14XK_RI_KERNEL BLIS_ZPACKM_14XK_RI_KERNEL_REF
#endif
// packm_16xk_ri kernels
#ifndef BLIS_SPACKM_16XK_RI_KERNEL
#define BLIS_SPACKM_16XK_RI_KERNEL BLIS_SPACKM_16XK_RI_KERNEL_REF
#endif
#ifndef BLIS_DPACKM_16XK_RI_KERNEL
#define BLIS_DPACKM_16XK_RI_KERNEL BLIS_DPACKM_16XK_RI_KERNEL_REF
#endif
#ifndef BLIS_CPACKM_16XK_RI_KERNEL
#define BLIS_CPACKM_16XK_RI_KERNEL BLIS_CPACKM_16XK_RI_KERNEL_REF
#endif
#ifndef BLIS_ZPACKM_16XK_RI_KERNEL
#define BLIS_ZPACKM_16XK_RI_KERNEL BLIS_ZPACKM_16XK_RI_KERNEL_REF
#endif
// -- Define default 4m-specific blocksize macros ------------------------------
// Define complex 4m register blocksizes in terms of blocksizes used for
// real kernels.
// 4m register blocksizes
#define BLIS_DEFAULT_4M_MR_C BLIS_DEFAULT_MR_S
#define BLIS_DEFAULT_4M_KR_C BLIS_DEFAULT_KR_S
#define BLIS_DEFAULT_4M_NR_C BLIS_DEFAULT_NR_S
#define BLIS_DEFAULT_4M_MR_Z BLIS_DEFAULT_MR_D
#define BLIS_DEFAULT_4M_KR_Z BLIS_DEFAULT_KR_D
#define BLIS_DEFAULT_4M_NR_Z BLIS_DEFAULT_NR_D
// 4m register blocksize extensions
#define BLIS_EXTEND_4M_MR_C BLIS_EXTEND_MR_S
#define BLIS_EXTEND_4M_KR_C 0
#define BLIS_EXTEND_4M_NR_C BLIS_EXTEND_NR_S
#define BLIS_EXTEND_4M_MR_Z BLIS_EXTEND_MR_D
#define BLIS_EXTEND_4M_KR_Z 0
#define BLIS_EXTEND_4M_NR_Z BLIS_EXTEND_NR_D
// Define complex 4m cache blocksizes in terms of blocksizes used for
// real operations (if they have not yet already been defined).
// 4m cache blocksizes
#ifndef BLIS_DEFAULT_4M_MC_C
#define BLIS_DEFAULT_4M_MC_C ((BLIS_DEFAULT_MC_S)/1)
#endif
#ifndef BLIS_DEFAULT_4M_KC_C
#define BLIS_DEFAULT_4M_KC_C ((BLIS_DEFAULT_KC_S)/2)
#endif
#ifndef BLIS_DEFAULT_4M_NC_C
#define BLIS_DEFAULT_4M_NC_C ((BLIS_DEFAULT_NC_S)/1)
#endif
#ifndef BLIS_DEFAULT_4M_MC_Z
#define BLIS_DEFAULT_4M_MC_Z ((BLIS_DEFAULT_MC_D)/1)
#endif
#ifndef BLIS_DEFAULT_4M_KC_Z
#define BLIS_DEFAULT_4M_KC_Z ((BLIS_DEFAULT_KC_D)/2)
#endif
#ifndef BLIS_DEFAULT_4M_NC_Z
#define BLIS_DEFAULT_4M_NC_Z ((BLIS_DEFAULT_NC_D)/1)
#endif
// 4m cache blocksize extensions
#ifndef BLIS_EXTEND_4M_MC_C
#define BLIS_EXTEND_4M_MC_C 0
#endif
#ifndef BLIS_EXTEND_4M_KC_C
#define BLIS_EXTEND_4M_KC_C 0
#endif
#ifndef BLIS_EXTEND_4M_NC_C
#define BLIS_EXTEND_4M_NC_C 0
#endif
#ifndef BLIS_EXTEND_4M_MC_Z
#define BLIS_EXTEND_4M_MC_Z 0
#endif
#ifndef BLIS_EXTEND_4M_KC_Z
#define BLIS_EXTEND_4M_KC_Z 0
#endif
#ifndef BLIS_EXTEND_4M_NC_Z
#define BLIS_EXTEND_4M_NC_Z 0
#endif
// -- Kernel blocksize checks --------------------------------------------------
// Verify that cache blocksizes are whole multiples of register blocksizes.
// Specifically, verify that:
// - MC is a whole multiple of MR *AND* NR.
// - NC is a whole multiple of NR *AND* MR.
// - KC is a whole multiple of KR *AND* both MR, NR.
// These constraints are enforced because it makes it easier to handle diagonals
// in the macro-kernel implementations.
//
// MC must be a whole multiple of MR and NR.
//
#if ( \
( BLIS_DEFAULT_4M_MC_C % BLIS_DEFAULT_4M_MR_C != 0 ) || \
( BLIS_DEFAULT_4M_MC_Z % BLIS_DEFAULT_4M_MR_Z != 0 ) \
)
#error "MC (4m) must be multiple of MR for all datatypes."
#endif
#if ( \
( BLIS_DEFAULT_4M_MC_C % BLIS_DEFAULT_4M_NR_C != 0 ) || \
( BLIS_DEFAULT_4M_MC_Z % BLIS_DEFAULT_4M_NR_Z != 0 ) \
)
#error "MC (4m) must be multiple of NR for all datatypes."
#endif
//
// NC must be a whole multiple of NR and MR.
//
#if ( \
( BLIS_DEFAULT_4M_NC_C % BLIS_DEFAULT_4M_NR_C != 0 ) || \
( BLIS_DEFAULT_4M_NC_Z % BLIS_DEFAULT_4M_NR_Z != 0 ) \
)
#error "NC (4m) must be multiple of NR for all datatypes."
#endif
#if ( \
( BLIS_DEFAULT_4M_NC_C % BLIS_DEFAULT_4M_MR_C != 0 ) || \
( BLIS_DEFAULT_4M_NC_Z % BLIS_DEFAULT_4M_MR_Z != 0 ) \
)
#error "NC (4m) must be multiple of MR for all datatypes."
#endif
//
// KC must be a whole multiple of KR, MR, and NR.
//
#if ( \
( BLIS_DEFAULT_4M_KC_C % BLIS_DEFAULT_4M_KR_C != 0 ) || \
( BLIS_DEFAULT_4M_KC_Z % BLIS_DEFAULT_4M_KR_Z != 0 ) \
)
#error "KC (4m) must be multiple of KR for all datatypes."
#endif
#if ( \
( BLIS_DEFAULT_4M_KC_C % BLIS_DEFAULT_4M_MR_C != 0 ) || \
( BLIS_DEFAULT_4M_KC_Z % BLIS_DEFAULT_4M_MR_Z != 0 ) \
)
#error "KC (4m) must be multiple of MR for all datatypes."
#endif
#if ( \
( BLIS_DEFAULT_4M_KC_C % BLIS_DEFAULT_4M_NR_C != 0 ) || \
( BLIS_DEFAULT_4M_KC_Z % BLIS_DEFAULT_4M_NR_Z != 0 ) \
)
#error "KC (4m) must be multiple of NR for all datatypes."
#endif
// -- Compute extended blocksizes ----------------------------------------------
//
// Compute maximum cache blocksizes.
//
#define BLIS_MAXIMUM_4M_MC_C ( BLIS_DEFAULT_4M_MC_C + BLIS_EXTEND_4M_MC_C )
#define BLIS_MAXIMUM_4M_KC_C ( BLIS_DEFAULT_4M_KC_C + BLIS_EXTEND_4M_KC_C )
#define BLIS_MAXIMUM_4M_NC_C ( BLIS_DEFAULT_4M_NC_C + BLIS_EXTEND_4M_NC_C )
#define BLIS_MAXIMUM_4M_MC_Z ( BLIS_DEFAULT_4M_MC_Z + BLIS_EXTEND_4M_MC_Z )
#define BLIS_MAXIMUM_4M_KC_Z ( BLIS_DEFAULT_4M_KC_Z + BLIS_EXTEND_4M_KC_Z )
#define BLIS_MAXIMUM_4M_NC_Z ( BLIS_DEFAULT_4M_NC_Z + BLIS_EXTEND_4M_NC_Z )
//
// Compute leading dimension blocksizes used when packing micro-panels.
//
#define BLIS_PACKDIM_4M_MR_C ( BLIS_DEFAULT_4M_MR_C + BLIS_EXTEND_4M_MR_C )
#define BLIS_PACKDIM_4M_KR_C ( BLIS_DEFAULT_4M_KR_C + BLIS_EXTEND_4M_KR_C )
#define BLIS_PACKDIM_4M_NR_C ( BLIS_DEFAULT_4M_NR_C + BLIS_EXTEND_4M_NR_C )
#define BLIS_PACKDIM_4M_MR_Z ( BLIS_DEFAULT_4M_MR_Z + BLIS_EXTEND_4M_MR_Z )
#define BLIS_PACKDIM_4M_KR_Z ( BLIS_DEFAULT_4M_KR_Z + BLIS_EXTEND_4M_KR_Z )
#define BLIS_PACKDIM_4M_NR_Z ( BLIS_DEFAULT_4M_NR_Z + BLIS_EXTEND_4M_NR_Z )
#endif