blis/frame/base/bli_init.c

/*

   BLIS
   An object-based framework for developing high-performance BLAS-like
   libraries.

   Copyright (C) 2014, The University of Texas at Austin
   Copyright (C) 2018 - 2024, Advanced Micro Devices, Inc. All rights reserved.

   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(s) of the copyright holder(s) 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"

// Make thread settings local to each thread calling BLIS routines.
// (The definition resides in bli_rntm.c.)
extern BLIS_THREAD_LOCAL rntm_t tl_rntm;

// Thread local variable to handle initialization of tl_rntm from global_rntm.
BLIS_THREAD_LOCAL bool initialize_tl_rntm = TRUE;

// -----------------------------------------------------------------------------

void bli_init( void )
{
	bli_init_once();
}

void bli_finalize( void )
{
	bli_thread_finalize_tl();
	bli_finalize_once();
}

// -----------------------------------------------------------------------------

void bli_init_auto( void )
{
	bli_init_once();
}

void bli_finalize_auto( void )
{
	// The _auto() functions are used when initializing the BLAS compatibility
	// layer. It would not make much sense to automatically initialize and
	// finalize for every BLAS routine call; therefore, we remain initialized
	// unless and until the application explicitly calls bli_finalize().
}

// -----------------------------------------------------------------------------


// A pthread_once_t variable is a pthread structure used in pthread_once().
// pthread_once() is guaranteed to execute exactly once among all threads that
// pass in this control object (until/unless the variable is reset).
static bli_pthread_once_t once_init     = BLIS_PTHREAD_ONCE_INIT;
static bli_pthread_once_t once_finalize = BLIS_PTHREAD_ONCE_INIT;

void bli_init_once( void )
{
	// Initialize all global data structures
	bli_pthread_once( &once_init, bli_init_apis );

	// Initialize tl_rntm as a copy of global_rntm
	// Need to do this once per application thread
	if (initialize_tl_rntm)
	{
		bli_thread_init_tl();
		initialize_tl_rntm = FALSE;
	}

	// On every call each application thread must
	// reset info_value to 0
	gint_t info_value = 0;
	bli_rntm_set_info_value_only( info_value, &tl_rntm );

}

void bli_finalize_once( void )
{
	bli_pthread_once( &once_finalize, bli_finalize_apis );
}

// -----------------------------------------------------------------------------

void bli_init_apis( void )
{
	/* Initialize DTL Library with trace level set by the user */
	AOCL_DTL_INITIALIZE(AOCL_DTL_TRACE_LEVEL);
	// Initialize various sub-APIs.
	bli_gks_init();
	bli_ind_init();
	bli_thread_init();
	bli_pack_init();
	bli_memsys_init();

	// Reset the control variable that will allow finalization.
	// NOTE: We must initialize a fresh pthread_once_t object and THEN copy the
	// contents to the static control variable because some implementations of
	// pthreads define pthread_once_t as a struct and BLIS_PTHREAD_ONCE_INIT as
	// a struct initializer expression (i.e. { ... }), which cannot be used in
	// post-declaration struct assignment in strict C99.
	const bli_pthread_once_t once_new = BLIS_PTHREAD_ONCE_INIT;
	once_finalize = once_new;
}

void bli_finalize_apis( void )
{
	// Finalize various sub-APIs.
	bli_memsys_finalize();
	bli_pack_finalize();
	bli_thread_finalize();
	bli_ind_finalize();
	bli_gks_finalize();
	AOCL_DTL_UNINITIALIZE();

	// Reset the control variable that will allow (re-)initialization.
	// NOTE: We must initialize a fresh pthread_once_t object and THEN copy the
	// contents to the static control variable because some implementations of
	// pthreads define pthread_once_t as a struct and BLIS_PTHREAD_ONCE_INIT as
	// a struct initializer expression (i.e. { ... }), which cannot be used in
	// post-declaration struct assignment in strict C99.
	const bli_pthread_once_t once_new = BLIS_PTHREAD_ONCE_INIT;
	once_init = once_new;
}