/*

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

   Copyright (C) 2014, The University of Texas at Austin
   Copyright (C) 2018 - 2019, Advanced Micro Devices, Inc.

   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"


void bli_l3_cntl_create_if
     (
             opid_t   family,
             pack_t   schema_a,
             pack_t   schema_b,
       const obj_t*   a,
       const obj_t*   b,
       const obj_t*   c,
             pool_t*  pool,
       const cntl_t*  cntl_orig,
             cntl_t** cntl_use
     )
{
	// If the control tree pointer is NULL, we construct a default
	// tree as a function of the operation family.
	if ( cntl_orig == NULL )
	{
		if ( family == BLIS_GEMM ||
		     family == BLIS_GEMMT ||
		     family == BLIS_TRMM )
		{
			*cntl_use = bli_gemm_cntl_create
			(
			  pool,
			  family,
			  schema_a,
			  schema_b,
			  bli_obj_ker_fn( c )
			);
		}
		else // if ( family == BLIS_TRSM )
		{
			side_t side;

			// NOTE: We no longer ever use right-sided trsm, and therefore this
			// function will only ever get called with side = BLIS_LEFT, which
			// means that in the future, we can remove the a, b, and c operands
			// from the function signature. (This assumes that the call to
			// bli_obj_ker_fn( c ) is replaced in some future reorganization
			// that moves the .ker_fn argument from obj_t to, say, the rntm_t.)
			if ( bli_obj_is_triangular( a ) ) side = BLIS_LEFT;
			else                              side = BLIS_RIGHT;

			*cntl_use = bli_trsm_cntl_create
			(
			  pool,
			  side,
			  schema_a,
			  schema_b,
			  bli_obj_ker_fn( c )
			);
		}
	}
	else
	{
		// If the user provided a control tree, create a copy and use it
		// instead (so that threads can use its local tree as a place to
		// cache things like pack mem_t entries).
		*cntl_use = bli_cntl_copy( pool, cntl_orig );

		// Recursively set the family fields of the newly copied control tree
		// nodes.
		bli_cntl_mark_family( family, *cntl_use );
	}
}

void bli_l3_cntl_free
     (
       pool_t* pool,
       cntl_t* cntl_use
     )
{
	// NOTE: We don't actually need to call separate _cntl_free() functions
	// for gemm and trsm; it is merely an unnecessary mirroring of behavior
	// from the _create() side (which must call different functions based
	// on the family).

	opid_t family = bli_cntl_family( cntl_use );

	if ( family == BLIS_GEMM ||
	     family == BLIS_GEMMT ||
	     family == BLIS_TRMM )
	{
		bli_gemm_cntl_free( pool, cntl_use );
	}
	else // if ( family == BLIS_TRSM )
	{
		bli_trsm_cntl_free( pool, cntl_use );
	}
}