mirror of
https://github.com/amd/blis.git
synced 2026-05-11 01:30:00 +00:00
Details: - Reworked the build system around a configuration registry file, named config_registry', that identifies valid configuration targets, their constituent sub-configurations, and the kernel sets that are needed by those sub-configurations. The build system now facilitates the building of a single library that can contains kernels and cache/register blocksizes for multiple configurations (microarchitectures). Reference kernels are also built on a per-configuration basis. - Updated the Makefile to use new variables set by configure via the config.mk.in template, such as CONFIG_LIST, KERNEL_LIST, and KCONFIG_MAP, in determining which sub-configurations (CONFIG_LIST) and kernel sets (KERNEL_LIST) are included in the library, and which make_defs.mk files' CFLAGS (KCONFIG_MAP) are used when compiling kernels. - Reorganized 'kernels' directory into a "flat" structure. Renamed kernel functions into a standard format that includes the kernel set name (e.g. 'haswell'). Created a "bli_kernels_<kernelset>.h" file in each kernels sub-directory. These files exist to provide prototypes for the kernels present in those directories. - Reorganized reference kernels into a top-level 'ref_kernels' directory. This directory includes a new source file, bli_cntx_ref.c (compiled on a per-configuration basis), that defines the code needed to initialize a reference context and a context for induced methods for the microarchitecture in question. - Rewrote make_defs.mk files in each configuration so that the compiler variables (e.g. CFLAGS) are "stored" (renamed) on a per-configuration basis. - Modified bli_config.h.in template so that bli_config.h is generated with #defines for the config (family) name, the sub-configurations that are associated with the family, and the kernel sets needed by those sub-configurations. - Deprecated all kernel-related information in bli_kernel.h and transferred what remains to new header files named "bli_arch_<configname>.h", which are conditionally #included from a new header bli_arch.h. These files are still needed to set library-wide parameters such as custom malloc()/free() functions or SIMD alignment values. - Added bli_cntx_init_<configname>.c files to each configuration directory. The files contain a function, named the same as the file, that initializes a "native" context for a particular configuration (microarchitecture). The idea is that optimized kernels, if available, will be initialized into these contexts. Other fields will retain pointers to reference functions, which will be compiled on a per-configuration basis. These bli_cntx_init_*() functions will be called during the initialization of the global kernel structure. They are thought of as initializing for "native" execution, but they also form the basis for contexts that use induced methods. These functions are prototyped, along with their _ref() and _ind() brethren, by prototype-generating macros in bli_arch.h. - Added a new typedef enum in bli_type_defs.h to define an arch_t, which identifies the various sub-configurations. - Redesigned the global kernel structure (gks) around a 2D array of cntx_t structures (pointers to cntx_t, actually). The first dimension is indexed over arch_t and the inner dimension is the ind_t (induced method) for each microarchitecture. When a microarchitecture (configuration) is "registered" at init-time, the inner array for that configuration in the 2D array is initialized (and allocated, if it hasn't been already). The cntx_t slot for BLIS_NAT is initialized immediately and those for other induced method types are initialized and cached on-demand, as needed. At cntx_t registration, we also store function pointers to cntx_init functions that will initialize (a) "reference" contexts and (b) contexts for use with induced methods. We don't cache the full contexts for reference contexts since they are rarely needed. The functions that initialize these two kinds of contexts are generated automatically for each targeted sub-configuration from cpp-templatized code at compile-time. Induced method contexts that need "stage" adjustments can still obtain them via functions in bli_cntx_ind_stage.c. - Added new functions and functionality to bli_cntx.c, such as for setting the level-1f, level-1v, and packm kernels, and for converting a native context into one for executing an induced method. - Moved the checking of register/cache blocksize consistency from being cpp macros in bli_kernel_macro_defs.h to being runtime checks defined in bli_check.c and called from bli_gks_register_cntx() at the time that the global kernel structure's internal context is initialized for a given microarchitecture/configuration. - Deprecated all of the old per-operation bli_*_cntx.c files and removed the previous operation-level cntx_t_init()/_finalize() invocations. Instead, we now query the gks for a suitable context, usually via bli_gks_query_cntx(). - Deprecated support for the 3m2 and 3m3 induced methods. (They required hackery that I was no longer willing to support.) - Consolidated the 1e and 1r packm kernels for any given register blocksize into a single kernel that will branch on the schema and support packing to both formats. - Added the cntx_t* argument to all packm kernel signatures. - Deprecated the local function pointer array in all bli_packm_cxk*.c files and instead obtain the packm kernel from the cntx_t. - Added bli_calloc_intl(), which serves as the calloc-equivalent to to bli_malloc_intl(). Useful when we wish to allocate and initialize to zero/NULL. - Converted existing cpp macro functions defined in bli_blksz.h, bli_func.h, bli_cntx.h into static functions.
157 lines
5.4 KiB
C
157 lines
5.4 KiB
C
/*
|
|
|
|
BLIS
|
|
An object-based framework for developing high-performance BLAS-like
|
|
libraries.
|
|
|
|
Copyright (C) 2014, The University of Texas at Austin
|
|
|
|
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 at Austin 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_MACRO_DEFS_H
|
|
#define BLIS_KERNEL_MACRO_DEFS_H
|
|
|
|
|
|
// -- Define default threading parameters --------------------------------------
|
|
|
|
#ifndef BLIS_DEFAULT_M_THREAD_RATIO
|
|
#define BLIS_DEFAULT_M_THREAD_RATIO 2
|
|
#endif
|
|
|
|
#ifndef BLIS_DEFAULT_N_THREAD_RATIO
|
|
#define BLIS_DEFAULT_N_THREAD_RATIO 1
|
|
#endif
|
|
|
|
#ifndef BLIS_DEFAULT_MR_THREAD_MAX
|
|
#define BLIS_DEFAULT_MR_THREAD_MAX 1
|
|
#endif
|
|
|
|
#ifndef BLIS_DEFAULT_NR_THREAD_MAX
|
|
#define BLIS_DEFAULT_NR_THREAD_MAX 4
|
|
#endif
|
|
|
|
|
|
// -- Memory allocation --------------------------------------------------------
|
|
|
|
// Memory allocation functions. These macros define the three types of
|
|
// malloc()-style functions, and their free() counterparts: one for each
|
|
// type of memory to be allocated.
|
|
// NOTE: ANY ALTERNATIVE TO malloc()/free() USED FOR ANY OF THE FOLLOWING
|
|
// THREE PAIRS OF MACROS MUST USE THE SAME FUNCTION PROTOTYPE AS malloc()
|
|
// and free():
|
|
//
|
|
// void* malloc( size_t size );
|
|
// void free( void* p );
|
|
//
|
|
|
|
// This allocation function is called to allocate memory for blocks within
|
|
// BLIS's internal memory pools.
|
|
#ifndef BLIS_MALLOC_POOL
|
|
#define BLIS_MALLOC_POOL malloc
|
|
#endif
|
|
|
|
#ifndef BLIS_FREE_POOL
|
|
#define BLIS_FREE_POOL free
|
|
#endif
|
|
|
|
// This allocation function is called to allocate memory for internally-
|
|
// used objects and structures, such as control tree nodes.
|
|
#ifndef BLIS_MALLOC_INTL
|
|
#define BLIS_MALLOC_INTL malloc
|
|
#endif
|
|
|
|
#ifndef BLIS_FREE_INTL
|
|
#define BLIS_FREE_INTL free
|
|
#endif
|
|
|
|
// This allocation function is called to allocate memory for objects
|
|
// created by user-level API functions, such as bli_obj_create().
|
|
#ifndef BLIS_MALLOC_USER
|
|
#define BLIS_MALLOC_USER malloc
|
|
#endif
|
|
|
|
#ifndef BLIS_FREE_USER
|
|
#define BLIS_FREE_USER free
|
|
#endif
|
|
|
|
// -- Other system-related definitions -----------------------------------------
|
|
|
|
// Size of a virtual memory page. This is used to align blocks within the
|
|
// memory pools.
|
|
#ifndef BLIS_PAGE_SIZE
|
|
#define BLIS_PAGE_SIZE 4096
|
|
#endif
|
|
|
|
// Number of named SIMD vector registers available for use.
|
|
#ifndef BLIS_SIMD_NUM_REGISTERS
|
|
#define BLIS_SIMD_NUM_REGISTERS 16
|
|
#endif
|
|
|
|
// Size (in bytes) of each SIMD vector.
|
|
#ifndef BLIS_SIMD_SIZE
|
|
#define BLIS_SIMD_SIZE 32
|
|
#endif
|
|
|
|
// Alignment size (in bytes) needed by the instruction set for aligned
|
|
// SIMD/vector instructions.
|
|
#ifndef BLIS_SIMD_ALIGN_SIZE
|
|
#define BLIS_SIMD_ALIGN_SIZE BLIS_SIMD_SIZE
|
|
#endif
|
|
|
|
// The maximum size in bytes of local stack buffers within macro-kernel
|
|
// functions. These buffers are usually used to store a temporary copy
|
|
// of a single microtile. The reason we multiply by 2 is to handle induced
|
|
// methods, where we use real domain register blocksizes in units of
|
|
// complex elements. Specifically, the macro-kernels will need this larger
|
|
// micro-tile footprint, even though the virtual micro-kernels will only
|
|
// ever be writing to half (real or imaginary part) at a time.
|
|
#ifndef BLIS_STACK_BUF_MAX_SIZE
|
|
#define BLIS_STACK_BUF_MAX_SIZE ( BLIS_SIMD_NUM_REGISTERS * \
|
|
BLIS_SIMD_SIZE * 2 )
|
|
#endif
|
|
|
|
// Alignment size used to align local stack buffers within macro-kernel
|
|
// functions.
|
|
#define BLIS_STACK_BUF_ALIGN_SIZE BLIS_SIMD_ALIGN_SIZE
|
|
|
|
// Alignment size used when allocating memory via BLIS_MALLOC_USER.
|
|
// To disable heap alignment, set this to 1.
|
|
#define BLIS_HEAP_ADDR_ALIGN_SIZE BLIS_SIMD_ALIGN_SIZE
|
|
|
|
// Alignment size used when sizing leading dimensions of memory allocated
|
|
// via BLIS_MALLOC_USER.
|
|
#define BLIS_HEAP_STRIDE_ALIGN_SIZE BLIS_SIMD_ALIGN_SIZE
|
|
|
|
// Alignment size used when allocating blocks to the internal memory
|
|
// pool, via BLIS_MALLOC_POOL.
|
|
#define BLIS_POOL_ADDR_ALIGN_SIZE BLIS_PAGE_SIZE
|
|
|
|
|
|
|
|
#endif
|
|
|