release/src/router/mysql/storage/ndb/include/portlib/NdbMem.h

   1 /* Copyright (c) 2003-2005, 2007 MySQL AB
   2
   3    This program is free software; you can redistribute it and/or modify
   4    it under the terms of the GNU General Public License as published by
   5    the Free Software Foundation; version 2 of the License.
   6
   7    This program is distributed in the hope that it will be useful,
   8    but WITHOUT ANY WARRANTY; without even the implied warranty of
   9    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10    GNU General Public License for more details.
  11
  12    You should have received a copy of the GNU General Public License
  13    along with this program; if not, write to the Free Software
  14    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA */
  15
  16 #ifndef NDB_MEM_H
  17 #define NDB_MEM_H
  18
  19 #include <ndb_global.h>
  20
  21 #ifdef  __cplusplus
  22 extern "C" {
  23 #endif
  24
  25
  26 /**
  27  * NdbMem_Create
  28  * Create and initalise internal data structures for Ndb
  29  */
  30 void NdbMem_Create(void);
  31
  32
  33 /**
  34  * NdbMem_Destroy
  35  * Destroy all memory allocated by NdbMem
  36  */
  37 void NdbMem_Destroy(void);
  38
  39 /**
  40  * NdbMem_Allocate
  41  * Allocate size of memory
  42  * @parameter size - size in bytes of memory to allocate
  43  * @returns - pointer to memory if succesful otherwise NULL
  44  */
  45 void* NdbMem_Allocate(size_t size);
  46
  47 /**
  48  * NdbMem_AllocateAlign
  49  * Allocate size of memory
  50  * @parameter size - size in bytes of memory to allocate
  51  * @paramter alignment - byte boundary to align the data at
  52  * @returns - pointer to memory if succesful otherwise NULL
  53  */
  54 void* NdbMem_AllocateAlign(size_t size, size_t alignment);
  55
  56
  57 /**
  58  * NdbMem_Free
  59  *  Free the memory that ptr points to
  60  *  @parameter ptr - pointer to the memory to free
  61  */
  62 void NdbMem_Free(void* ptr);
  63
  64 /**
  65  * NdbMem_MemLockAll
  66  *   Locks virtual memory in main memory
  67  */
  68 int NdbMem_MemLockAll(int);
  69
  70 /**
  71  * NdbMem_MemUnlockAll
  72  *   Unlocks virtual memory
  73  */
  74 int NdbMem_MemUnlockAll(void);
  75
  76 #ifdef  __cplusplus
  77 }
  78 #endif
  79
  80 #endif