ObjFW
private.h
1 /*
2  * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
3  *
4  * All rights reserved.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License version 3.0 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
13  * version 3.0 for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * version 3.0 along with this program. If not, see
17  * <https://www.gnu.org/licenses/>.
18  */
19 
20 #include "config.h"
21 
22 #import "macros.h"
23 
24 #if !defined(__has_feature) || !__has_feature(nullability)
25 # ifndef _Nonnull
26 # define _Nonnull
27 # endif
28 # ifndef _Nullable
29 # define _Nullable
30 # endif
31 #endif
32 
33 typedef uint32_t (*_Nonnull objc_hashtable_hash_func)(const void *_Nonnull key);
34 typedef bool (*_Nonnull objc_hashtable_equal_func)(const void *_Nonnull key1,
35  const void *_Nonnull key2);
36 
37 struct objc_class {
38  Class _Nonnull isa;
39  Class _Nullable superclass;
40  const char *_Nonnull name;
41  unsigned long version;
42  unsigned long info;
43  long instanceSize;
44  struct objc_ivar_list *_Nullable ivars;
45  struct objc_method_list *_Nullable methodList;
46  struct objc_dtable *_Nullable dTable;
47  Class _Nullable *_Nullable subclassList;
48  void *_Nullable siblingClass;
49  struct objc_protocol_list *_Nullable protocols;
50  void *_Nullable GCObjectType;
51  unsigned long ABIVersion;
52  int32_t *_Nonnull *_Nullable ivarOffsets;
53  struct objc_property_list *_Nullable propertyList;
54 };
55 
56 enum objc_class_info {
57  OBJC_CLASS_INFO_CLASS = 0x001,
58  OBJC_CLASS_INFO_METACLASS = 0x002,
59  OBJC_CLASS_INFO_NEW_ABI = 0x010,
60  OBJC_CLASS_INFO_SETUP = 0x100,
61  OBJC_CLASS_INFO_LOADED = 0x200,
62  OBJC_CLASS_INFO_DTABLE = 0x400,
63  OBJC_CLASS_INFO_INITIALIZED = 0x800
64 };
65 
66 struct objc_object {
67  Class _Nonnull isa;
68 };
69 
70 struct objc_selector {
71  uintptr_t UID;
72  const char *_Nullable typeEncoding;
73 };
74 
75 struct objc_method {
76  struct objc_selector selector;
77  IMP _Nonnull implementation;
78 };
79 
80 struct objc_method_list {
81  struct objc_method_list *_Nullable next;
82  unsigned int count;
83  struct objc_method methods[1];
84 };
85 
86 struct objc_category {
87  const char *_Nonnull categoryName;
88  const char *_Nonnull className;
89  struct objc_method_list *_Nullable instanceMethods;
90  struct objc_method_list *_Nullable classMethods;
91  struct objc_protocol_list *_Nullable protocols;
92 };
93 
94 struct objc_ivar {
95  const char *_Nonnull name;
96  const char *_Nonnull typeEncoding;
97  unsigned int offset;
98 };
99 
100 struct objc_ivar_list {
101  unsigned int count;
102  struct objc_ivar ivars[1];
103 };
104 
105 struct objc_method_description {
106  const char *_Nonnull name;
107  const char *_Nonnull typeEncoding;
108 };
109 
110 struct objc_method_description_list {
111  int count;
112  struct objc_method_description list[1];
113 };
114 
115 struct objc_protocol_list {
116  struct objc_protocol_list *_Nullable next;
117  long count;
118  Protocol *__unsafe_unretained _Nonnull list[1];
119 };
120 
121 #if __has_attribute(__objc_root_class__)
122 __attribute__((__objc_root_class__))
123 #endif
124 @interface Protocol
125 {
126 @public
127  Class _Nonnull isa;
128  const char *_Nonnull name;
129  struct objc_protocol_list *_Nullable protocolList;
130  struct objc_method_description_list *_Nullable instanceMethods;
131  struct objc_method_description_list *_Nullable classMethods;
132 }
133 @end
134 
135 enum objc_property_attributes {
136  OBJC_PROPERTY_READONLY = 0x01,
137  OBJC_PROPERTY_GETTER = 0x02,
138  OBJC_PROPERTY_ASSIGN = 0x04,
139  OBJC_PROPERTY_READWRITE = 0x08,
140  OBJC_PROPERTY_RETAIN = 0x10,
141  OBJC_PROPERTY_COPY = 0x20,
142  OBJC_PROPERTY_NONATOMIC = 0x40,
143  OBJC_PROPERTY_SETTER = 0x80
144 };
145 
146 enum objc_property_extended_attributes {
147  OBJC_PROPERTY_SYNTHESIZED = 0x1,
148  OBJC_PROPERTY_DYNAMIC = 0x2,
149  OBJC_PROPERTY_PROTOCOL = 0x3,
150  OBJC_PROPERTY_ATOMIC = 0x4,
151  OBJC_PROPERTY_WEAK = 0x8,
152  OBJC_PROPERTY_STRONG = 0x10,
153  OBJC_PROPERTY_UNSAFE_UNRETAINED = 0x20
154 };
155 
156 struct objc_property {
157  const char *_Nonnull name;
158  unsigned char attributes, extendedAttributes;
159  struct {
160  const char *_Nullable name;
161  const char *_Nullable typeEncoding;
162  } getter, setter;
163 };
164 
165 struct objc_property_list {
166  unsigned int count;
167  struct objc_property_list *_Nullable next;
168  struct objc_property properties[1];
169 };
170 
171 struct objc_static_instances {
172  const char *_Nonnull className;
173  id _Nullable instances[1];
174 };
175 
176 struct objc_symtab {
177  unsigned long unknown;
178  struct objc_selector *_Nullable selectorRefs;
179  uint16_t classDefsCount;
180  uint16_t categoryDefsCount;
181  void *_Nonnull defs[1];
182 };
183 
184 struct objc_module {
185  unsigned long version; /* 9 = non-fragile */
186  unsigned long size;
187  const char *_Nullable name;
188  struct objc_symtab *_Nonnull symtab;
189 };
190 
191 struct objc_hashtable_bucket {
192  const void *_Nonnull key, *_Nonnull object;
193  uint32_t hash;
194 };
195 
196 struct objc_hashtable {
197  objc_hashtable_hash_func hash;
198  objc_hashtable_equal_func equal;
199  uint32_t count, size;
200  struct objc_hashtable_bucket *_Nonnull *_Nullable data;
201 };
202 
203 struct objc_sparsearray {
204  struct objc_sparsearray_data {
205  void *_Nullable next[256];
206  } *_Nonnull data;
207  uint8_t levels;
208 };
209 
210 struct objc_dtable {
211  struct objc_dtable_level2 {
212 #ifdef OF_SELUID24
213  struct objc_dtable_level3 {
214  IMP _Nullable buckets[256];
215  } *_Nonnull buckets[256];
216 #else
217  IMP _Nullable buckets[256];
218 #endif
219  } *_Nonnull buckets[256];
220 };
221 
222 extern void objc_registerAllCategories(struct objc_symtab *_Nonnull);
223 extern struct objc_category *_Nullable *_Nullable
224  objc_categoriesForClass(Class _Nonnull);
225 extern void objc_unregisterAllCategories(void);
226 extern void objc_initializeClass(Class _Nonnull);
227 extern void objc_updateDTable(Class _Nonnull);
228 extern void objc_registerAllClasses(struct objc_symtab *_Nonnull);
229 extern Class _Nullable objc_classnameToClass(const char *_Nonnull, bool);
230 extern void objc_unregisterClass(Class _Nonnull);
231 extern void objc_unregisterAllClasses(void);
232 extern uint32_t objc_string_hash(const void *_Nonnull);
233 extern bool objc_string_equal(const void *_Nonnull, const void *_Nonnull);
234 extern struct objc_hashtable *_Nonnull objc_hashtable_new(
235  objc_hashtable_hash_func, objc_hashtable_equal_func, uint32_t);
236 extern struct objc_hashtable_bucket objc_deletedBucket;
237 extern void objc_hashtable_set(struct objc_hashtable *_Nonnull,
238  const void *_Nonnull, const void *_Nonnull);
239 extern void *_Nullable objc_hashtable_get(struct objc_hashtable *_Nonnull,
240  const void *_Nonnull);
241 extern void objc_hashtable_delete(struct objc_hashtable *_Nonnull,
242  const void *_Nonnull);
243 extern void objc_hashtable_free(struct objc_hashtable *_Nonnull);
244 extern void objc_registerSelector(struct objc_selector *_Nonnull);
245 extern void objc_registerAllSelectors(struct objc_symtab *_Nonnull);
246 extern void objc_unregisterAllSelectors(void);
247 extern struct objc_sparsearray *_Nonnull objc_sparsearray_new(uint8_t);
248 extern void *_Nullable objc_sparsearray_get(struct objc_sparsearray *_Nonnull,
249  uintptr_t);
250 extern void objc_sparsearray_set(struct objc_sparsearray *_Nonnull, uintptr_t,
251  void *_Nullable);
252 extern void objc_sparsearray_free(struct objc_sparsearray *_Nonnull);
253 extern struct objc_dtable *_Nonnull objc_dtable_new(void);
254 extern void objc_dtable_copy(struct objc_dtable *_Nonnull,
255  struct objc_dtable *_Nonnull);
256 extern void objc_dtable_set(struct objc_dtable *_Nonnull, uint32_t,
257  IMP _Nullable);
258 extern void objc_dtable_free(struct objc_dtable *_Nonnull);
259 extern void objc_dtable_cleanup(void);
260 extern void objc_initStaticInstances(struct objc_symtab *_Nonnull);
261 extern void objc_forgetPendingStaticInstances(void);
262 extern void objc_zeroWeakReferences(id _Nonnull);
263 extern Class _Nullable object_getTaggedPointerClass(id _Nonnull);
264 #ifdef OF_HAVE_THREADS
265 extern void objc_globalMutex_lock(void);
266 extern void objc_globalMutex_unlock(void);
267 extern void objc_globalMutex_free(void);
268 #else
269 # define objc_globalMutex_lock()
270 # define objc_globalMutex_unlock()
271 # define objc_globalMutex_free()
272 #endif
273 extern char *_Nullable objc_strdup(const char *_Nonnull string);
274 
275 static inline IMP _Nullable
276 objc_dtable_get(const struct objc_dtable *_Nonnull dtable, uint32_t idx)
277 {
278 #ifdef OF_SELUID24
279  uint8_t i = idx >> 16;
280  uint8_t j = idx >> 8;
281  uint8_t k = idx;
282 
283  return dtable->buckets[i]->buckets[j]->buckets[k];
284 #else
285  uint8_t i = idx >> 8;
286  uint8_t j = idx;
287 
288  return dtable->buckets[i]->buckets[j];
289 #endif
290 }
291 
292 extern void OF_NO_RETURN_FUNC objc_error(const char *_Nonnull title,
293  const char *_Nonnull format, ...);
294 #define OBJC_ERROR(...) \
295  objc_error("ObjFWRT @ " __FILE__ ":" OF_STRINGIFY(__LINE__), \
296  __VA_ARGS__)
297 
298 #if defined(OF_ELF)
299 # if defined(OF_AMD64) || defined(OF_X86) || \
300  defined(OF_POWERPC64) || defined(OF_POWERPC) || \
301  defined(OF_ARM64) || defined(OF_ARM) || \
302  defined(OF_MIPS64_N64) || defined(OF_MIPS) || \
303  defined(OF_SPARC64) || defined(OF_SPARC)
304 # define OF_ASM_LOOKUP
305 # endif
306 #elif defined(OF_MACH_O)
307 # if defined(OF_AMD64)
308 # define OF_ASM_LOOKUP
309 # endif
310 #elif defined(OF_WINDOWS)
311 # if defined(OF_AMD64) || defined(OF_X86)
312 # define OF_ASM_LOOKUP
313 # endif
314 #endif
315 
316 @interface DummyObject
317 {
318  Class _Nonnull isa;
319 }
320 
321 @property (readonly, nonatomic) bool allowsWeakReference;
322 
323 + (void)initialize;
324 + (bool)resolveClassMethod: (nonnull SEL)selector;
325 + (bool)resolveInstanceMethod: (nonnull SEL)selector;
326 - (nonnull id)retain;
327 - (void)release;
328 - (nonnull id)autorelease;
329 - (nonnull id)copy;
330 - (nonnull id)mutableCopy;
331 - (bool)retainWeakReference;
332 @end
id(* IMP)(id object, SEL selector,...)
A method implementation.
Definition: ObjFWRT.h:146
const struct objc_protocol * Protocol
A protocol.
Definition: ObjFWRT.h:117
A pointer to a class.
Definition: private.h:37
A pointer to any object.
Definition: private.h:66