src/st-memory.h

   1 /*
   2  * st-virtual-space.h
   3  *
   4  * Copyright (C) 2008 Vincent Geddes
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23 */
  24
  25 #ifndef __ST_MEMORY__
  26 #define __ST_MEMORY__
  27
  28 #include <st-types.h>
  29 #include <st-utils.h>
  30 #include <ptr_array.h>
  31
  32 /* threshold is 8 Mb or 16 Mb depending on whether system is 32 or 64 bits */
  33 #define ST_COLLECTION_THRESHOLD (sizeof (st_oop) * 2 * 1024 * 1024)
  34
  35 #define RESERVED_SIZE        (1000 * 1024 * 1024)
  36 #define INITIAL_COMMIT_SIZE  (64 * 1024 * 1024)
  37
  38 typedef struct
  39 {
  40     struct cell *table;
  41     st_uint  alloc;
  42     st_uint  size;
  43     st_uint  deleted;
  44
  45     st_uint current_hash;
  46
  47 } identity_ht;
  48
  49 struct cell
  50 {
  51     st_oop  object;
  52     st_uint hash;
  53 };
  54
  55 typedef struct st_heap
  56 {
  57     st_uchar *start; /* start of reserved address space */
  58     st_uchar *p;     /* end of committed address space (`start' to `p' is thus writeable memory) */
  59     st_uchar *end;   /* end of reserved address space */
  60
  61 } st_heap;
  62
  63 typedef struct st_memory
  64 {
  65     st_heap   *heap;
  66
  67     st_oop    *start, *end;
  68     st_oop    *p;
  69
  70     st_oop    *mark_stack;
  71
  72     st_uchar  *mark_bits;
  73     st_uchar  *alloc_bits;
  74     st_uint    bits_size; /* in bytes */
  75
  76     st_oop   **offsets;
  77     st_uint    offsets_size; /* in bytes */
  78
  79     ptr_array  roots;
  80     st_uint    counter;
  81
  82     /* free context pool */
  83     st_oop     free_context_large;
  84     st_oop     free_context;
  85
  86     /* statistics */
  87     struct timespec total_pause_time;     /* total accumulated pause time */
  88     st_ulong bytes_allocated;             /* current number of allocated bytes */
  89     st_ulong bytes_collected;             /* number of bytes collected in last compaction */
  90
  91     identity_ht *ht;
  92
  93 } st_memory;
  94
  95 st_memory *st_memory_new             (void);
  96 void       st_memory_destroy         (void);
  97 void       st_memory_add_root        (st_oop object);
  98 void       st_memory_remove_root     (st_oop object);
  99 st_oop     st_memory_allocate        (st_uint size);
 100
 101 st_oop     st_memory_allocate_context (bool large);
 102 void       st_memory_recycle_context  (st_oop context);
 103
 104 bool       st_memory_compaction_occurred (void);
 105 st_oop     st_memory_remap_reference    (st_oop reference);
 106
 107 st_heap  *st_heap_new       (st_uint reserved_size);
 108 bool      st_heap_grow      (st_heap *heap, st_uint grow_size);
 109 bool      st_heap_shrink    (st_heap *heap, st_uint shrink_size);
 110 void      st_heap_destroy   (st_heap *heap);
 111
 112 st_uint      st_identity_ht_hash (identity_ht *ht, st_oop object);
 113 identity_ht *st_identity_ht_new (void);
 114 void         st_identity_ht_remove (identity_ht *ht, st_oop object);
 115 void         st_identity_ht_rehash_object (identity_ht *ht, st_oop old, st_oop new);
 116
 117 #endif /* __ST_MEMORY__ */