Files
blis/frame/base/bli_error.c
Field G. Van Zee 9804adfd40 Added option to disable pack buffer memory pools.
Details:
- Added a new configure option, --[en|dis]able-packbuf-pools, which will
  enable or disable the use of internal memory pools for managing buffers
  used for packing. When disabled, the function specified by the cpp
  macro BLIS_MALLOC_POOL is called whenever a packing buffer is needed
  (and BLIS_FREE_POOL is called when the buffer is ready to be released,
  usually at the end of a loop). When enabled, which was the status quo
  prior to this commit, a memory pool data structure is created and
  managed to provide threads with packing buffers. The memory pool
  minimizes calls to bli_malloc_pool() (i.e., the wrapper that calls
  BLIS_MALLOC_POOL), but does so through a somewhat more complex
  mechanism that may incur additional overhead in some (but not all)
  situations. The new option defaults to --enable-packbuf-pools.
- Removed the reinitialization of the memory pools from the level-3
  front-ends and replaced it with automatic reinitialization within the
  pool API's implementation. This required an extra argument to
  bli_pool_checkout_block() in the form of a requested size, but hides
  the complexity entirely from BLIS. And since bli_pool_checkout_block()
  is only ever called within a critical section, this change fixes a
  potential race condition in which threads using contexts with different
  cache blocksizes--most likely a heterogeneous environment--can check
  out pool blocks that are too small for the submatrices it wishes to
  pack. Thanks to Nisanth Padinharepatt for reporting this potential
  issue.
- Removed several functions in light of the relocation of pool reinit,
  including bli_membrk_reinit_pools(), bli_memsys_reinit(),
  bli_pool_reinit_if(), and bli_check_requested_block_size_for_pool().
- Updated the testsuite to print whether the memory pools are enabled or
  disabled.
2017-12-21 19:22:57 -06:00

245 lines
10 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.
*/
#include "blis.h"
void bli_error_init( void )
{
bli_error_init_msgs();
}
void bli_error_finalize( void )
{
}
// -----------------------------------------------------------------------------
// Internal array to hold error strings.
static char bli_error_string[BLIS_MAX_NUM_ERR_MSGS][BLIS_MAX_ERR_MSG_LENGTH];
void bli_error_init_msgs( void )
{
sprintf( bli_error_string_for_code(BLIS_INVALID_ERROR_CHECKING_LEVEL),
"Invalid error checking level." );
sprintf( bli_error_string_for_code(BLIS_UNDEFINED_ERROR_CODE),
"Undefined error code." );
sprintf( bli_error_string_for_code(BLIS_NULL_POINTER),
"Encountered unexpected null pointer." );
sprintf( bli_error_string_for_code(BLIS_NOT_YET_IMPLEMENTED),
"Requested functionality not yet implemented." );
sprintf( bli_error_string_for_code(BLIS_INVALID_SIDE),
"Invalid side parameter value." );
sprintf( bli_error_string_for_code(BLIS_INVALID_UPLO),
"Invalid uplo_t parameter value." );
sprintf( bli_error_string_for_code(BLIS_INVALID_TRANS),
"Invalid trans_t parameter value." );
sprintf( bli_error_string_for_code(BLIS_INVALID_CONJ),
"Invalid conj_t parameter value." );
sprintf( bli_error_string_for_code(BLIS_INVALID_DIAG),
"Invalid diag_t parameter value." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_NONUNIT_DIAG),
"Expected object with non-unit diagonal." );
sprintf( bli_error_string_for_code(BLIS_INVALID_DATATYPE),
"Invalid datatype value." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_FLOATING_POINT_DATATYPE),
"Expected floating-point datatype value." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_NONINTEGER_DATATYPE),
"Expected non-integer datatype value." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_NONCONSTANT_DATATYPE),
"Expected non-constant datatype value." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_REAL_DATATYPE),
"Expected real datatype value." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_INTEGER_DATATYPE),
"Expected integer datatype value." );
sprintf( bli_error_string_for_code(BLIS_INCONSISTENT_DATATYPES),
"Expected consistent datatypes (equal, or one being constant)." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_REAL_PROJ_OF),
"Expected second datatype to be real projection of first." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_REAL_VALUED_OBJECT),
"Expected real-valued object (ie: if complex, imaginary component equals zero)." );
sprintf( bli_error_string_for_code(BLIS_NONCONFORMAL_DIMENSIONS),
"Encountered non-conformal dimensions between objects." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_SCALAR_OBJECT),
"Expected scalar object." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_VECTOR_OBJECT),
"Expected vector object." );
sprintf( bli_error_string_for_code(BLIS_UNEQUAL_VECTOR_LENGTHS),
"Encountered unequal vector lengths." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_SQUARE_OBJECT),
"Expected square object." );
sprintf( bli_error_string_for_code(BLIS_UNEXPECTED_OBJECT_LENGTH),
"Unexpected object length." );
sprintf( bli_error_string_for_code(BLIS_UNEXPECTED_OBJECT_WIDTH),
"Unexpected object width." );
sprintf( bli_error_string_for_code(BLIS_UNEXPECTED_VECTOR_DIM),
"Unexpected vector dimension." );
sprintf( bli_error_string_for_code(BLIS_UNEXPECTED_DIAG_OFFSET),
"Unexpected object diagonal offset." );
sprintf( bli_error_string_for_code(BLIS_NEGATIVE_DIMENSION),
"Encountered negative dimension." );
sprintf( bli_error_string_for_code(BLIS_INVALID_ROW_STRIDE),
"Encountered invalid row stride relative to n dimension." );
sprintf( bli_error_string_for_code(BLIS_INVALID_COL_STRIDE),
"Encountered invalid col stride relative to m dimension." );
sprintf( bli_error_string_for_code(BLIS_INVALID_DIM_STRIDE_COMBINATION),
"Encountered invalid stride/dimension combination." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_GENERAL_OBJECT),
"Expected general object." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_HERMITIAN_OBJECT),
"Expected Hermitian object." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_SYMMETRIC_OBJECT),
"Expected symmetric object." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_TRIANGULAR_OBJECT),
"Expected triangular object." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_UPPER_OR_LOWER_OBJECT),
"Expected upper or lower triangular object." );
sprintf( bli_error_string_for_code(BLIS_INVALID_3x1_SUBPART),
"Encountered invalid 3x1 (vertical) subpartition label." );
sprintf( bli_error_string_for_code(BLIS_INVALID_1x3_SUBPART),
"Encountered invalid 1x3 (horizontal) subpartition label." );
sprintf( bli_error_string_for_code(BLIS_INVALID_3x3_SUBPART),
"Encountered invalid 3x3 (diagonal) subpartition label." );
sprintf( bli_error_string_for_code(BLIS_UNEXPECTED_NULL_CONTROL_TREE),
"Encountered unexpected null control tree node." );
sprintf( bli_error_string_for_code(BLIS_PACK_SCHEMA_NOT_SUPPORTED_FOR_UNPACK),
"Pack schema not yet supported/implemented for use with unpacking." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_NONNULL_OBJECT_BUFFER),
"Encountered object with non-zero dimensions containing null buffer." );
sprintf( bli_error_string_for_code(BLIS_INVALID_PACKBUF),
"Invalid packbuf_t value." );
sprintf( bli_error_string_for_code(BLIS_EXHAUSTED_CONTIG_MEMORY_POOL),
"Attempted to allocate more memory from contiguous pool than is available." );
sprintf( bli_error_string_for_code(BLIS_INSUFFICIENT_STACK_BUF_SIZE),
"Configured maximum stack buffer size is insufficient for register blocksizes currently in use." );
sprintf( bli_error_string_for_code(BLIS_ALIGNMENT_NOT_POWER_OF_TWO),
"Encountered memory alignment value that is either zero or not a power of two." );
sprintf( bli_error_string_for_code(BLIS_ALIGNMENT_NOT_MULT_OF_PTR_SIZE),
"Encountered memory alignment value that is not a multiple of sizeof(void*)." );
sprintf( bli_error_string_for_code(BLIS_EXPECTED_OBJECT_ALIAS),
"Expected object to be alias." );
sprintf( bli_error_string_for_code(BLIS_INVALID_ARCH_ID),
"Invalid architecture id value." );
sprintf( bli_error_string_for_code(BLIS_MC_DEF_NONMULTIPLE_OF_MR),
"Default MC is non-multiple of MR for one or more datatypes." );
sprintf( bli_error_string_for_code(BLIS_MC_DEF_NONMULTIPLE_OF_MR),
"Maximum MC is non-multiple of MR for one or more datatypes." );
sprintf( bli_error_string_for_code(BLIS_NC_DEF_NONMULTIPLE_OF_NR),
"Default NC is non-multiple of NR for one or more datatypes." );
sprintf( bli_error_string_for_code(BLIS_NC_DEF_NONMULTIPLE_OF_NR),
"Maximum NC is non-multiple of NR for one or more datatypes." );
sprintf( bli_error_string_for_code(BLIS_KC_DEF_NONMULTIPLE_OF_KR),
"Default KC is non-multiple of KR for one or more datatypes." );
sprintf( bli_error_string_for_code(BLIS_KC_DEF_NONMULTIPLE_OF_KR),
"Maximum KC is non-multiple of KR for one or more datatypes." );
}
void bli_print_msg( char* str, char* file, guint_t line )
{
fprintf( stderr, "\n" );
fprintf( stderr, "libblis: %s (line %lu):\n", file, ( long unsigned int )line );
fprintf( stderr, "libblis: %s\n", str );
fflush( stderr );
}
void bli_abort( void )
{
fprintf( stderr, "libblis: Aborting.\n" );
//raise( SIGABRT );
abort();
}
// -----------------------------------------------------------------------------
#ifdef BLIS_ENABLE_PTHREADS
static pthread_mutex_t err_mutex = PTHREAD_MUTEX_INITIALIZER;
#endif
// Current error checking level.
static errlev_t bli_err_chk_level = BLIS_FULL_ERROR_CHECKING;
errlev_t bli_error_checking_level( void )
{
return bli_err_chk_level;
}
void bli_error_checking_level_set( errlev_t new_level )
{
err_t e_val;
e_val = bli_check_valid_error_level( new_level );
bli_check_error_code( e_val );
#ifdef BLIS_ENABLE_OPENMP
_Pragma( "omp critical (err)" )
#endif
#ifdef BLIS_ENABLE_PTHREADS
pthread_mutex_lock( &err_mutex );
#endif
// BEGIN CRITICAL SECTION
{
bli_err_chk_level = new_level;
}
// END CRITICAL SECTION
#ifdef BLIS_ENABLE_PTHREADS
pthread_mutex_unlock( &err_mutex );
#endif
}
bool_t bli_error_checking_is_enabled( void )
{
return bli_error_checking_level() != BLIS_NO_ERROR_CHECKING;
}
char* bli_error_string_for_code( gint_t code )
{
return bli_error_string[-code];
}