Files
blis/frame/base/bli_mem.h
Field G. Van Zee 00e14cb6d8 Replaced use of bool_t type with C99 bool.
Details:
- Textually replaced nearly all non-comment instances of bool_t with the
  C99 bool type. A few remaining instances, such as those in the files
  bli_herk_x_ker_var2.c, bli_trmm_xx_ker_var2.c, and
  bli_trsm_xx_ker_var2.c, were promoted to dim_t since they were being
  used not for boolean purposes but to index into an array.
- This commit constitutes the third phase of a transition toward using
  C99's bool instead of bool_t, which was raised in issue #420. The first
  phase, which cleaned up various typecasts in preparation for using
  bool as the basis for bool_t (instead of gint_t), was implemented by
  commit a69a4d7. The second phase, which redefined the bool_t typedef
  in terms of bool (from gint_t), was implemented by commit 2c554c2.
2020-07-29 14:24:34 -05:00

157 lines
3.9 KiB
C

/*
BLIS
An object-based framework for developing high-performance BLAS-like
libraries.
Copyright (C) 2014, The University of Texas at Austin
Copyright (C) 2016, Hewlett Packard Enterprise Development LP
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.
*/
#ifndef BLIS_MEM_H
#define BLIS_MEM_H
// mem_t object type (defined in bli_type_defs.h)
/*
typedef struct mem_s
{
pblk_t pblk;
packbuf_t buf_type;
pool_t* pool;
siz_t size;
} mem_t;
typedef struct
{
void* buf;
siz_t block_size;
} pblk_t;
*/
//
// -- mem_t query --------------------------------------------------------------
//
BLIS_INLINE pblk_t* bli_mem_pblk( mem_t* mem )
{
return &(mem->pblk);
}
BLIS_INLINE void* bli_mem_buffer( mem_t* mem )
{
return bli_pblk_buf( bli_mem_pblk( mem ) );
}
BLIS_INLINE packbuf_t bli_mem_buf_type( mem_t* mem )
{
return mem->buf_type;
}
BLIS_INLINE pool_t* bli_mem_pool( mem_t* mem )
{
return mem->pool;
}
BLIS_INLINE siz_t bli_mem_size( mem_t* mem )
{
return mem->size;
}
BLIS_INLINE bool bli_mem_is_alloc( mem_t* mem )
{
return ( bool )
( bli_mem_buffer( mem ) != NULL );
}
BLIS_INLINE bool bli_mem_is_unalloc( mem_t* mem )
{
return ( bool )
( bli_mem_buffer( mem ) == NULL );
}
//
// -- mem_t modification -------------------------------------------------------
//
BLIS_INLINE void bli_mem_set_pblk( pblk_t* pblk, mem_t* mem )
{
mem->pblk = *pblk;
}
BLIS_INLINE void bli_mem_set_buffer( void* buf, mem_t* mem )
{
bli_pblk_set_buf( buf, &(mem->pblk) );
}
BLIS_INLINE void bli_mem_set_buf_type( packbuf_t buf_type, mem_t* mem )
{
mem->buf_type = buf_type;
}
BLIS_INLINE void bli_mem_set_pool( pool_t* pool, mem_t* mem )
{
mem->pool = pool;
}
BLIS_INLINE void bli_mem_set_size( siz_t size, mem_t* mem )
{
mem->size = size;
}
//
// -- mem_t initialization -----------------------------------------------------
//
// NOTE: This initializer macro must be updated whenever fields are added or
// removed from the mem_t type definition. An alternative to the initializer is
// calling bli_mem_clear() at runtime.
#define BLIS_MEM_INITIALIZER \
{ \
.pblk = BLIS_PBLK_INITIALIZER, \
.buf_type = -1, \
.pool = NULL, \
.size = 0, \
} \
BLIS_INLINE void bli_mem_clear( mem_t* mem )
{
bli_mem_set_buffer( NULL, mem );
bli_mem_set_buf_type( ( packbuf_t )-1, mem );
bli_mem_set_pool( NULL, mem );
bli_mem_set_size( 0, mem );
}
#endif