* Updated header: Added 2006. Changed address of FSF. Changed email
[cacao.git] / src / vm / suck.h
1 /* src/vm/suck.h - functions to read LE ordered types from a buffer
2
3    Copyright (C) 1996-2005, 2006 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    Contact: cacao@cacaojvm.org
26
27    Authors: Christian Thalinger
28
29    Changes:
30
31    $Id: suck.h 4357 2006-01-22 23:33:38Z twisti $
32
33 */
34
35
36 #ifndef _SUCK_H
37 #define _SUCK_H
38
39 #include "config.h"
40 #include "vm/types.h"
41
42 #include "vm/class.h"
43 #include "vm/hashtable.h"
44 #include "vm/loader.h"
45
46
47 /* list_classpath_entry *******************************************************/
48
49 enum {
50         CLASSPATH_PATH,
51         CLASSPATH_ARCHIVE
52 };
53
54 typedef struct list_classpath_entry list_classpath_entry;
55
56 struct list_classpath_entry {
57 #if defined(USE_THREADS)
58         /* Required for monitor locking on zip/jar files. */
59         java_objectheader  header;
60 #endif                            
61         s4                 type;
62         char              *path;
63         s4                 pathlen;
64 #if defined(ENABLE_ZLIB)
65         hashtable         *htclasses;
66 #endif
67         listnode           linkage;
68 };
69
70
71 /* macros to read LE and BE types from a buffer ********************************
72
73    BE macros are for Java class file loading.
74    LE macros are for ZIP file loading.
75
76 *******************************************************************************/
77
78 /* LE macros (for ZIP files ) *************************************************/
79
80 #if defined(__I386__) || defined(__X86_64__)
81
82 /* we can optimize the LE access on little endian machines without alignment */
83
84 #define SUCK_LE_U1(p)    *((u1 *) (p))
85 #define SUCK_LE_U2(p)    *((u2 *) (p))
86 #define SUCK_LE_U4(p)    *((u4 *) (p))
87
88 #if U8_AVAILABLE == 1
89 #define SUCK_LE_U8(p)    *((u8 *) (p))
90 #endif
91
92 #else /* defined(__I386__) || defined(__X86_64__) */
93
94 #define SUCK_LE_U1(p) \
95       ((u1) (p)[0])
96
97 #define SUCK_LE_U2(p) \
98     ((((u2) (p)[1]) << 8) + \
99       ((u2) (p)[0]))
100
101 #define SUCK_LE_U4(p) \
102     ((((u4) (p)[3]) << 24) + \
103      (((u4) (p)[2]) << 16) + \
104      (((u4) (p)[1]) << 8) + \
105       ((u4) (p)[0]))
106
107 #if U8_AVAILABLE == 1
108 #define SUCK_LE_U8(p) \
109     ((((u8) (p)[7]) << 56) + \
110      (((u8) (p)[6]) << 48) + \
111      (((u8) (p)[5]) << 40) + \
112      (((u8) (p)[4]) << 32) + \
113      (((u8) (p)[3]) << 24) + \
114      (((u8) (p)[2]) << 16) + \
115      (((u8) (p)[1]) << 8) + \
116       ((u8) (p)[0]))
117 #endif
118
119 #endif /* defined(__I386__) || defined(__X86_64__) */
120
121
122 /* BE macros (for Java class files ) ******************************************/
123
124 #define SUCK_BE_U1(p) \
125       ((u1) (p)[0])
126
127 #define SUCK_BE_U2(p) \
128     ((((u2) (p)[0]) << 8) + \
129       ((u2) (p)[1]))
130
131 #define SUCK_BE_U4(p) \
132     ((((u4) (p)[0]) << 24) + \
133      (((u4) (p)[1]) << 16) + \
134      (((u4) (p)[2]) << 8) + \
135       ((u4) (p)[3]))
136
137 #if U8_AVAILABLE == 1
138 #define SUCK_BE_U8(p) \
139     ((((u8) (p)[0]) << 56) + \
140      (((u8) (p)[1]) << 48) + \
141      (((u8) (p)[2]) << 40) + \
142      (((u8) (p)[3]) << 32) + \
143      (((u8) (p)[4]) << 24) + \
144      (((u8) (p)[5]) << 16) + \
145      (((u8) (p)[6]) << 8) + \
146       ((u8) (p)[7]))
147 #endif
148
149
150 /* signed suck defines ********************************************************/
151
152 #define suck_s1(a)    (s1) suck_u1((a))
153 #define suck_s2(a)    (s2) suck_u2((a))
154 #define suck_s4(a)    (s4) suck_u4((a))
155 #define suck_s8(a)    (s8) suck_u8((a))
156
157
158 /* export variables ***********************************************************/
159
160 extern char *bootclasspath;
161 extern char *classpath;
162
163 extern list *list_classpath_entries;
164
165
166 /* function prototypes ********************************************************/
167
168 bool suck_init(void);
169
170 void suck_add(char *classpath);
171 void suck_add_from_property(char *key);
172
173 bool suck_check_classbuffer_size(classbuffer *cb, s4 len);
174
175 u1 suck_u1(classbuffer *cb);
176 u2 suck_u2(classbuffer *cb);
177 u4 suck_u4(classbuffer *cb);
178 u8 suck_u8(classbuffer *cb);
179
180 float suck_float(classbuffer *cb);
181 double suck_double(classbuffer *cb);
182
183 void suck_nbytes(u1 *buffer, classbuffer *cb, s4 len);
184 void suck_skip_nbytes(classbuffer *cb, s4 len);
185
186 classbuffer *suck_start(classinfo *c);
187
188 void suck_stop(classbuffer *cb);
189
190 #endif /* _SUCK_H */
191
192 /*
193  * These are local overrides for various environment variables in Emacs.
194  * Please do not remove this and leave it at the end of the file, where
195  * Emacs will automagically detect them.
196  * ---------------------------------------------------------------------
197  * Local variables:
198  * mode: c
199  * indent-tabs-mode: t
200  * c-basic-offset: 4
201  * tab-width: 4
202  * End:
203  */