85277dc93179ddc7d90a035086c1dfe348a21d84
[cacao.git] / src / native / localref.h
1 /* src/native/localref.h - Management of local reference tables
2
3    Copyright (C) 1996-2005, 2006, 2007 R. Grafl, A. Krall, C. Kruegel,
4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
6    J. Wenninger, Institut f. Computersprachen - TU Wien
7
8    This file is part of CACAO.
9
10    This program is free software; you can redistribute it and/or
11    modify it under the terms of the GNU General Public License as
12    published by the Free Software Foundation; either version 2, or (at
13    your option) any later version.
14
15    This program is distributed in the hope that it will be useful, but
16    WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18    General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23    02110-1301, USA.
24
25    $Id: localref.h 8364 2007-08-20 19:52:00Z michi $
26
27 */
28
29
30 #ifndef _LOCALREF_H
31 #define _LOCALREF_H
32
33 /* forward typedefs ***********************************************************/
34
35 typedef struct localref_table localref_table;
36
37 #include "config.h"
38 #include "vm/types.h"
39
40 #include "vm/global.h"
41
42
43 /* localref_table **************************************************************
44
45    ATTENTION: keep this structure a multiple of 8-bytes!!! This is
46    essential for the native stub on 64-bit architectures.
47
48 *******************************************************************************/
49
50 #define LOCALREFTABLE_CAPACITY    16
51
52 struct localref_table {
53         s4                 capacity;        /* table size                         */
54         s4                 used;            /* currently used references          */
55         s4                 localframes;     /* number of current frames           */
56         s4                 PADDING;         /* 8-byte padding                     */
57         localref_table    *prev;            /* link to prev table (LocalFrame)    */
58         java_object_t     *refs[LOCALREFTABLE_CAPACITY]; /* references            */
59 };
60
61
62 #if defined(ENABLE_THREADS)
63 #define LOCALREFTABLE    (THREADOBJECT->_localref_table)
64 #else
65 extern localref_table *_no_threads_localref_table;
66
67 #define LOCALREFTABLE    (_no_threads_localref_table)
68 #endif
69
70
71 /* function prototypes ********************************************************/
72
73 bool localref_table_init(void);
74 bool localref_table_destroy(void);
75 void localref_table_add(localref_table *lrt);
76 void localref_table_remove();
77
78 bool localref_frame_push(int32_t capacity);
79 void localref_frame_pop_all(void);
80
81 java_handle_t *localref_add(java_object_t *o);
82 void           localref_del(java_handle_t *h);
83
84 #if !defined(NDEBUG)
85 void localref_dump(void);
86 #endif
87
88
89 #endif /* _LOCALREF_H */
90
91
92 /*
93  * These are local overrides for various environment variables in Emacs.
94  * Please do not remove this and leave it at the end of the file, where
95  * Emacs will automagically detect them.
96  * ---------------------------------------------------------------------
97  * Local variables:
98  * mode: c
99  * indent-tabs-mode: t
100  * c-basic-offset: 4
101  * tab-width: 4
102  * End:
103  */