cpukit/libdebugger/rtems-debugger-block.h

0001 /*
0002  * Copyright (c) 2016 Chris Johns <chrisj@rtems.org>.
0003  * All rights reserved.
0004  *
0005  * Redistribution and use in source and binary forms, with or without
0006  * modification, are permitted provided that the following conditions
0007  * are met:
0008  * 1. Redistributions of source code must retain the above copyright
0009  *    notice, this list of conditions and the following disclaimer.
0010  * 2. Redistributions in binary form must reproduce the above copyright
0011  *    notice, this list of conditions and the following disclaimer in the
0012  *    documentation and/or other materials provided with the distribution.
0013  *
0014  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
0015  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0016  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0017  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
0018  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
0019  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
0020  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
0021  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
0022  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
0023  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
0024  * SUCH DAMAGE.
0025  */
0026
0027 /*
0028  * Debugger for RTEMS.
0029  */
0030
0031 #ifndef _RTEMS_DEBUGGER_BLOCK_h
0032 #define _RTEMS_DEBUGGER_BLOCK_h
0033
0034 #include <rtems/rtems-debugger.h>
0035
0036 #ifdef __cplusplus
0037 extern "C" {
0038 #endif /* __cplusplus */
0039
0040 /**
0041  * DB server block manages a block of re-sizable memory. The block only
0042  * grows. As more threads enter the system the block becomes the peak and then
0043  * sits at that level.
0044  */
0045 typedef struct rtems_debugger_block
0046 {
0047   void*  block;  /**< The block of memory. */
0048   size_t step;   /**< The step size the block is increased by. */
0049   size_t size;   /**< The size of the elements in the block. */
0050   size_t count;  /**< The number of elements in the block. */
0051   size_t level;  /**< The usage level in the block. */
0052 } rtems_debugger_block;
0053
0054 /**
0055  * Create a block.
0056  */
0057 extern int rtems_debugger_block_create(rtems_debugger_block* block,
0058                        size_t                step,
0059                        size_t                size);
0060
0061 /**
0062  * Destroy a block.
0063  */
0064 extern int rtems_debugger_block_destroy(rtems_debugger_block* block);
0065
0066 /**
0067  * Resize a block.
0068  */
0069 extern int rtems_debugger_block_resize(rtems_debugger_block* block);
0070
0071 #ifdef __cplusplus
0072 }
0073 #endif /* __cplusplus */
0074
0075
0076 #endif