Files
blis/frame/base/bli_pba.h
Field G. Van Zee 3a6f41afb8 Renamed membrk files/vars/functions to pba.
Details:
- Renamed the files, variables, and functions relating to the packing
  block allocator from its legacy name (membrk) to its current name
  (pba). This more clearly contrasts the packing block allocator with
  the small block allocator (sba).
- Fixed a typo in bli_pack_set_pack_b(), defined in bli_pack.c, that
  caused the function to erroneously change the value of the pack_a
  field of the global rntm_t instead of the pack_b field. (Apparently
  nobody has used this API yet.)
- Comment updates.
2021-03-27 17:22:14 -05:00

188 lines
4.3 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_MEMBRK_H
#define BLIS_MEMBRK_H
// Packing block allocator (formerly memory broker)
/*
typedef struct pba_s
{
pool_t pools[3];
bli_pthread_mutex_t mutex;
// These fields are used for general-purpose allocation.
siz_t align_size;
malloc_ft malloc_fp;
free_ft free_fp;
} pba_t;
*/
// pba init
//BLIS_INLINE void bli_pba_init_mutex( pba_t* pba )
//{
// bli_pthread_mutex_init( &(pba->mutex), NULL );
//}
//BLIS_INLINE void bli_pba_finalize_mutex( pba_t* pba )
//{
// bli_pthread_mutex_destroy( &(pba->mutex) );
//}
// pba query
BLIS_INLINE pool_t* bli_pba_pool( dim_t pool_index, pba_t* pba )
{
return &(pba->pools[ pool_index ]);
}
BLIS_INLINE siz_t bli_pba_align_size( pba_t* pba )
{
return pba->align_size;
}
BLIS_INLINE malloc_ft bli_pba_malloc_fp( pba_t* pba )
{
return pba->malloc_fp;
}
BLIS_INLINE free_ft bli_pba_free_fp( pba_t* pba )
{
return pba->free_fp;
}
// pba modification
BLIS_INLINE void bli_pba_set_align_size( siz_t align_size, pba_t* pba )
{
pba->align_size = align_size;
}
BLIS_INLINE void bli_pba_set_malloc_fp( malloc_ft malloc_fp, pba_t* pba )
{
pba->malloc_fp = malloc_fp;
}
BLIS_INLINE void bli_pba_set_free_fp( free_ft free_fp, pba_t* pba )
{
pba->free_fp = free_fp;
}
// pba action
BLIS_INLINE void bli_pba_lock( pba_t* pba )
{
bli_pthread_mutex_lock( &(pba->mutex) );
}
BLIS_INLINE void bli_pba_unlock( pba_t* pba )
{
bli_pthread_mutex_unlock( &(pba->mutex) );
}
// -----------------------------------------------------------------------------
pba_t* bli_pba_query( void );
void bli_pba_init
(
cntx_t* cntx
);
void bli_pba_finalize
(
void
);
void bli_pba_acquire_m
(
rntm_t* rntm,
siz_t req_size,
packbuf_t buf_type,
mem_t* mem
);
void bli_pba_release
(
rntm_t* rntm,
mem_t* mem
);
void bli_pba_rntm_set_pba
(
rntm_t* rntm
);
siz_t bli_pba_pool_size
(
pba_t* pba,
packbuf_t buf_type
);
// ----------------------------------------------------------------------------
void bli_pba_init_pools
(
cntx_t* cntx,
pba_t* pba
);
void bli_pba_finalize_pools
(
pba_t* pba
);
void bli_pba_compute_pool_block_sizes
(
siz_t* bs_a,
siz_t* bs_b,
siz_t* bs_c,
cntx_t* cntx
);
void bli_pba_compute_pool_block_sizes_dt
(
num_t dt,
siz_t* bs_a,
siz_t* bs_b,
siz_t* bs_c,
cntx_t* cntx
);
#endif