/* SPDX-License-Identifier: LGPL-2.1-only OR BSD-3-Clause */
/******************************************************************************
 *
 * This file is provided under a dual license.  When you use or
 * distribute this software, you may choose to be licensed under
 * version 2.1 of the GNU Lesser General Public License
 * ("LGPLv2.1 License") or BSD License.
 *
 * LGPLv2.1 License
 *
 * Copyright(C) 2019 MediaTek Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2.1 of the GNU Lesser General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html for more
 * details.
 *
 * BSD LICENSE
 *
 * Copyright(C) 2019 MediaTek 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 of the copyright holder 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.
 *
 *****************************************************************************/

/*-----------------------------------------------------------------------------
 * $RCSfile: x_lkg_tst.h,v $
 * $Revision: #1 $
 * $Date: 2015/05/29 $
 * $Author: brianpc.huang $
 * $CCRevision: /main/DTV_X_HQ_int/1 $
 * $SWAuthor: Justin Deng $
 * $MD5HEX: 028afa0cf4cf478ceee1815e4b6eb6e4 $
 *
 * Description:
 *         This header file contains leakage test common macros, defines, 
 *         typedefs, and enums.
 *---------------------------------------------------------------------------*/
 
#ifndef _X_LKG_TST_H_
#define _X_LKG_TST_H_

/*----------------------------------------------------------------------------*/
/*! @addtogroup groupMW_EVCTX
 *  @{
 */
/*----------------------------------------------------------------------------*/

/*----------------------------------------------------------------------------*/
/*! @brief  the wrapper of API x_mem_alloc

 *  @param  [in] z_size          		- size of object to be allocated
 *  @param  [in] ps_file_name           	- file in which ps_func_name is.
 *  @param  [in] ui4_line_num          	- line number at which ps_func_name is.
 *  @param  [in] ps_func_name           - caller function.
 *  
 *  @note   

 *  @see
 *  @return		VOID*
 *  @retval		The pointer to the allocated object if success, NULL if error
 */
/*----------------------------------------------------------------------------*/

VOID * x_lt_mem_alloc_details (SIZE_T       z_size,
                               const CHAR*  ps_file_name,
                               const UINT32 ui4_line_num,
                               const CHAR*  ps_func_name);

#define x_lt_mem_alloc(size)    \
        x_lt_mem_alloc_details(size, __FILE__, __LINE__, __func__)

/*----------------------------------------------------------------------------*/
/*! @brief  the wrapper of API x_lt_mem_free

 *  @param  [in] pv_mem_block         - pointer to the object which is about to be freed.
 *  
 *  @note   

 *  @see
 */
/*----------------------------------------------------------------------------*/

VOID x_lt_mem_free (VOID *  pv_mem_block);

/*----------------------------------------------------------------------------*/
/*! @brief  function to test whether if memory is leaking.

 *  
 *  @note   

 *  @see
 *  @return		BOOL
 *  @retval		TRUE	- memory leak.
 *				FALSE	- no leakage happens.
 */
/*----------------------------------------------------------------------------*/

BOOL x_lt_is_leaking( VOID );

/*----------------------------------------------------------------------------*/
/*! @brief  get the leaked memory size if any.

 *  
 *  @note   

 *  @see
 *  @return		SIZE_T
 *  @retval		size of leaked memory is returned.
 */
/*----------------------------------------------------------------------------*/

SIZE_T  x_lt_get_leak_size( VOID );

/*----------------------------------------------------------------------------*/
/*! @brief  dump the leaked memory address and size if any. This is for debugging usage.
 *  
 *  @note   
  *  @see
  */
/*----------------------------------------------------------------------------*/

VOID x_lt_dump_leaking_mem( VOID );

/*----------------------------------------------------------------------------*/
/*! @brief   init the semaphore handle of leakage memory test module.

 *  
 *  @note   

 *  @see
 *    @return		INT32
 *    @retval		EVCTXR_OK   - Success
 */
/*----------------------------------------------------------------------------*/

INT32 x_lt_init( VOID );

/*---------------------------------------------------------------------------*/
/*! @brief   delete the semaphore handle of leakage memory  test module.
 *  
 *  @note   

 *  @see
  */
/*----------------------------------------------------------------------------*/

VOID x_lt_exit( VOID );

#endif  /* _X_LKG_TST_H_ */

/*----------------------------------------------------------------------------*/
/*! @} */                                             /* end of groupMW_EVCTX */
/*----------------------------------------------------------------------------*/

