/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017,
* 2018, 2019
* Jonathan Schleifer <js@heap.zone>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#include "config.h"
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#import "OFBlock.h"
#import "OFAllocFailedException.h"
#import "OFInitializationFailedException.h"
#if defined(OF_OBJFW_RUNTIME)
# import "runtime/private.h"
#endif
#ifdef OF_HAVE_ATOMIC_OPS
# import "atomic.h"
#endif
#ifdef OF_HAVE_THREADS
# import "mutex.h"
#endif
typedef struct of_block_byref_t of_block_byref_t;
struct of_block_byref_t {
Class isa;
of_block_byref_t *forwarding;
int flags;
int size;
void (*byref_keep)(void *dest, void *src);
void (*byref_dispose)(void *);
};
enum {
OF_BLOCK_HAS_COPY_DISPOSE = (1 << 25),
OF_BLOCK_HAS_CTOR = (1 << 26),
OF_BLOCK_IS_GLOBAL = (1 << 28),
OF_BLOCK_HAS_STRET = (1 << 29),
OF_BLOCK_HAS_SIGNATURE = (1 << 30)
};
#define OF_BLOCK_REFCOUNT_MASK 0xFFFF
enum {
OF_BLOCK_FIELD_IS_OBJECT = 3,
OF_BLOCK_FIELD_IS_BLOCK = 7,
OF_BLOCK_FIELD_IS_BYREF = 8,
OF_BLOCK_FIELD_IS_WEAK = 16,
OF_BLOCK_BYREF_CALLER = 128
};
@protocol RetainRelease
- (instancetype)retain;
- (void)release;
@end
#ifdef OF_OBJFW_RUNTIME
/* Begin of ObjC module */
static struct objc_class _NSConcreteStackBlock_metaclass = {
Nil, Nil, "OFStackBlock", 8, OBJC_CLASS_INFO_METACLASS,
sizeof(_NSConcreteStackBlock_metaclass), NULL, NULL
};
struct objc_class _NSConcreteStackBlock = {
&_NSConcreteStackBlock_metaclass, (Class)(void *)"OFBlock",
"OFStackBlock", 8, OBJC_CLASS_INFO_CLASS, sizeof(of_block_literal_t),
NULL, NULL
};
static struct objc_class _NSConcreteGlobalBlock_metaclass = {
Nil, Nil, "OFGlobalBlock", 8, OBJC_CLASS_INFO_METACLASS,
sizeof(_NSConcreteGlobalBlock_metaclass), NULL, NULL
};
struct objc_class _NSConcreteGlobalBlock = {
&_NSConcreteGlobalBlock_metaclass, (Class)(void *)"OFBlock",
"OFGlobalBlock", 8, OBJC_CLASS_INFO_CLASS, sizeof(of_block_literal_t),
NULL, NULL
};
static struct objc_class _NSConcreteMallocBlock_metaclass = {
Nil, Nil, "OFMallocBlock", 8, OBJC_CLASS_INFO_METACLASS,
sizeof(_NSConcreteMallocBlock_metaclass), NULL, NULL
};
struct objc_class _NSConcreteMallocBlock = {
&_NSConcreteMallocBlock_metaclass, (Class)(void *)"OFBlock",
"OFMallocBlock", 8, OBJC_CLASS_INFO_CLASS, sizeof(of_block_literal_t),
NULL, NULL
};
static struct {
unsigned long unknown;
struct objc_selector *selectorRefs;
uint16_t classDefsCount, categoryDefsCount;
void *defs[4];
} symtab = {
0, NULL, 3, 0,
{
&_NSConcreteStackBlock, &_NSConcreteGlobalBlock,
&_NSConcreteMallocBlock, NULL
}
};
static struct objc_module module = {
8, sizeof(module), NULL, (struct objc_symtab *)&symtab
};
OF_CONSTRUCTOR()
{
__objc_exec_class(&module);
}
/* End of ObjC module */
#elif defined(OF_APPLE_RUNTIME)
extern Class objc_initializeClassPair(Class, const char *, Class, Class);
struct class {
struct class *isa, *superclass;
const char *name;
long version, info, instanceSize;
struct ivar_list *iVars;
struct method_list **methodList;
struct cache *cache;
struct protocol_list *protocols;
const char *iVarLayout;
struct class_ext *ext;
};
struct class _NSConcreteStackBlock;
struct class _NSConcreteGlobalBlock;
struct class _NSConcreteMallocBlock;
# if defined(__OBJC2__) && !defined(OF_POWERPC64)
struct class _NSConcreteStackBlock_metaclass;
struct class _NSConcreteGlobalBlock_metaclass;
struct class _NSConcreteMallocBlock_metaclass;
# endif
#endif
static struct {
Class isa;
} alloc_failed_exception;
#ifndef OF_HAVE_ATOMIC_OPS
# define NUM_SPINLOCKS 8 /* needs to be a power of 2 */
# define SPINLOCK_HASH(p) ((uintptr_t)p >> 4) & (NUM_SPINLOCKS - 1)
static of_spinlock_t blockSpinlocks[NUM_SPINLOCKS];
static of_spinlock_t byrefSpinlocks[NUM_SPINLOCKS];
#endif
void *
_Block_copy(const void *block_)
{
of_block_literal_t *block = (of_block_literal_t *)block_;
if ([(id)block isMemberOfClass: (Class)&_NSConcreteStackBlock]) {
of_block_literal_t *copy;
if ((copy = malloc(block->descriptor->size)) == NULL) {
alloc_failed_exception.isa =
[OFAllocFailedException class];
@throw (OFAllocFailedException *)
&alloc_failed_exception;
}
memcpy(copy, block, block->descriptor->size);
object_setClass((id)copy, (Class)&_NSConcreteMallocBlock);
copy->flags++;
if (block->flags & OF_BLOCK_HAS_COPY_DISPOSE)
block->descriptor->copy_helper(copy, block);
return copy;
}
if ([(id)block isMemberOfClass: (Class)&_NSConcreteMallocBlock]) {
#ifdef OF_HAVE_ATOMIC_OPS
of_atomic_int_inc(&block->flags);
#else
unsigned hash = SPINLOCK_HASH(block);
OF_ENSURE(of_spinlock_lock(&blockSpinlocks[hash]));
block->flags++;
OF_ENSURE(of_spinlock_unlock(&blockSpinlocks[hash]));
#endif
}
return block;
}
void
_Block_release(const void *block_)
{
of_block_literal_t *block = (of_block_literal_t *)block_;
if (object_getClass((id)block) != (Class)&_NSConcreteMallocBlock)
return;
#ifdef OF_HAVE_ATOMIC_OPS
if ((of_atomic_int_dec(&block->flags) & OF_BLOCK_REFCOUNT_MASK) == 0) {
if (block->flags & OF_BLOCK_HAS_COPY_DISPOSE)
block->descriptor->dispose_helper(block);
free(block);
}
#else
unsigned hash = SPINLOCK_HASH(block);
OF_ENSURE(of_spinlock_lock(&blockSpinlocks[hash]));
if ((--block->flags & OF_BLOCK_REFCOUNT_MASK) == 0) {
OF_ENSURE(of_spinlock_unlock(&blockSpinlocks[hash]));
if (block->flags & OF_BLOCK_HAS_COPY_DISPOSE)
block->descriptor->dispose_helper(block);
free(block);
return;
}
OF_ENSURE(of_spinlock_unlock(&blockSpinlocks[hash]));
#endif
}
void
_Block_object_assign(void *dst_, const void *src_, const int flags_)
{
int flags = flags_ & (OF_BLOCK_FIELD_IS_BLOCK |
OF_BLOCK_FIELD_IS_OBJECT | OF_BLOCK_FIELD_IS_BYREF);
if (src_ == NULL)
return;
switch (flags) {
case OF_BLOCK_FIELD_IS_BLOCK:
*(of_block_literal_t **)dst_ = _Block_copy(src_);
break;
case OF_BLOCK_FIELD_IS_OBJECT:
if (!(flags_ & OF_BLOCK_BYREF_CALLER))
*(id *)dst_ = [(id)src_ retain];
break;
case OF_BLOCK_FIELD_IS_BYREF:;
of_block_byref_t *src = (of_block_byref_t *)src_;
of_block_byref_t **dst = (of_block_byref_t **)dst_;
src = src->forwarding;
if ((src->flags & OF_BLOCK_REFCOUNT_MASK) == 0) {
if ((*dst = malloc(src->size)) == NULL) {
alloc_failed_exception.isa =
[OFAllocFailedException class];
@throw (OFAllocFailedException *)
&alloc_failed_exception;
}
memcpy(*dst, src, src->size);
(*dst)->flags =
((*dst)->flags & ~OF_BLOCK_REFCOUNT_MASK) | 1;
(*dst)->forwarding = *dst;
if (src->flags & OF_BLOCK_HAS_COPY_DISPOSE)
src->byref_keep(*dst, src);
#ifdef OF_HAVE_ATOMIC_OPS
if (!of_atomic_ptr_cmpswap((void **)&src->forwarding,
src, *dst)) {
src->byref_dispose(*dst);
free(*dst);
*dst = src->forwarding;
}
#else
unsigned hash = SPINLOCK_HASH(src);
OF_ENSURE(of_spinlock_lock(&byrefSpinlocks[hash]));
if (src->forwarding == src)
src->forwarding = *dst;
else {
src->byref_dispose(*dst);
free(*dst);
*dst = src->forwarding;
}
OF_ENSURE(of_spinlock_unlock(&byrefSpinlocks[hash]));
#endif
} else
*dst = src;
#ifdef OF_HAVE_ATOMIC_OPS
of_atomic_int_inc(&(*dst)->flags);
#else
unsigned hash = SPINLOCK_HASH(*dst);
OF_ENSURE(of_spinlock_lock(&byrefSpinlocks[hash]));
(*dst)->flags++;
OF_ENSURE(of_spinlock_unlock(&byrefSpinlocks[hash]));
#endif
break;
}
}
void
_Block_object_dispose(const void *object_, const int flags_)
{
const int flags = flags_ & (OF_BLOCK_FIELD_IS_BLOCK |
OF_BLOCK_FIELD_IS_OBJECT | OF_BLOCK_FIELD_IS_BYREF);
if (object_ == NULL)
return;
switch (flags) {
case OF_BLOCK_FIELD_IS_BLOCK:
_Block_release(object_);
break;
case OF_BLOCK_FIELD_IS_OBJECT:
if (!(flags_ & OF_BLOCK_BYREF_CALLER))
[(id)object_ release];
break;
case OF_BLOCK_FIELD_IS_BYREF:;
of_block_byref_t *object = (of_block_byref_t *)object_;
object = object->forwarding;
#ifdef OF_HAVE_ATOMIC_OPS
if ((of_atomic_int_dec(&object->flags) &
OF_BLOCK_REFCOUNT_MASK) == 0) {
if (object->flags & OF_BLOCK_HAS_COPY_DISPOSE)
object->byref_dispose(object);
free(object);
}
#else
unsigned hash = SPINLOCK_HASH(object);
OF_ENSURE(of_spinlock_lock(&byrefSpinlocks[hash]));
if ((--object->flags & OF_BLOCK_REFCOUNT_MASK) == 0) {
OF_ENSURE(of_spinlock_unlock(&byrefSpinlocks[hash]));
if (object->flags & OF_BLOCK_HAS_COPY_DISPOSE)
object->byref_dispose(object);
free(object);
}
OF_ENSURE(of_spinlock_unlock(&byrefSpinlocks[hash]));
#endif
break;
}
}
@implementation OFBlock
+ (void)load
{
#ifndef OF_HAVE_ATOMIC_OPS
for (size_t i = 0; i < NUM_SPINLOCKS; i++)
if (!of_spinlock_new(&blockSpinlocks[i]) ||
!of_spinlock_new(&byrefSpinlocks[i]))
@throw [OFInitializationFailedException
exceptionWithClass: self];
#endif
#ifdef OF_APPLE_RUNTIME
Class tmp;
# if defined(__OBJC2__) && !defined(OF_POWERPC64)
tmp = objc_initializeClassPair(self, "OFStackBlock",
(Class)&_NSConcreteStackBlock,
(Class)&_NSConcreteStackBlock_metaclass);
if (tmp == Nil)
@throw [OFInitializationFailedException
exceptionWithClass: self];
objc_registerClassPair(tmp);
tmp = objc_initializeClassPair(self, "OFGlobalBlock",
(Class)&_NSConcreteGlobalBlock,
(Class)&_NSConcreteGlobalBlock_metaclass);
if (tmp == Nil)
@throw [OFInitializationFailedException
exceptionWithClass: self];
objc_registerClassPair(tmp);
tmp = objc_initializeClassPair([OFBlock class], "OFMallocBlock",
(Class)&_NSConcreteMallocBlock,
(Class)&_NSConcreteMallocBlock_metaclass);
if (tmp == Nil)
@throw [OFInitializationFailedException
exceptionWithClass: self];
objc_registerClassPair(tmp);
# else
/*
* There is no objc_initializeClassPair in 10.5.
* However, objc_allocateClassPair does not register the new class with
* the subclass in the ObjC1 runtime like the ObjC2 runtime does, so
* this workaround should be fine.
*/
if ((tmp = objc_allocateClassPair(self, "OFStackBlock", 0)) == NULL)
@throw [OFInitializationFailedException
exceptionWithClass: self];
memcpy(&_NSConcreteStackBlock, tmp, sizeof(_NSConcreteStackBlock));
free(tmp);
objc_registerClassPair((Class)&_NSConcreteStackBlock);
if ((tmp = objc_allocateClassPair(self, "OFGlobalBlock", 0)) == NULL)
@throw [OFInitializationFailedException
exceptionWithClass: self];
memcpy(&_NSConcreteGlobalBlock, tmp, sizeof(_NSConcreteGlobalBlock));
free(tmp);
objc_registerClassPair((Class)&_NSConcreteGlobalBlock);
if ((tmp = objc_allocateClassPair(self, "OFMallocBlock", 0)) == NULL)
@throw [OFInitializationFailedException
exceptionWithClass: self];
memcpy(&_NSConcreteMallocBlock, tmp, sizeof(_NSConcreteMallocBlock));
free(tmp);
objc_registerClassPair((Class)&_NSConcreteMallocBlock);
# endif
#endif
}
+ (instancetype)alloc
{
OF_UNRECOGNIZED_SELECTOR
}
- (instancetype)init
{
OF_INVALID_INIT_METHOD
}
- (void *)allocMemoryWithSize: (size_t)size
{
OF_UNRECOGNIZED_SELECTOR
}
- (void *)allocMemoryWithSize: (size_t)size
count: (size_t)count
{
OF_UNRECOGNIZED_SELECTOR
}
- (void *)resizeMemory: (void *)ptr
size: (size_t)size
{
OF_UNRECOGNIZED_SELECTOR
}
- (void *)resizeMemory: (void *)ptr
size: (size_t)size
count: (size_t)count
{
OF_UNRECOGNIZED_SELECTOR
}
- (void)freeMemory: (void *)ptr
{
OF_UNRECOGNIZED_SELECTOR
}
- (instancetype)retain
{
if ([self isMemberOfClass: (Class)&_NSConcreteMallocBlock])
return Block_copy(self);
return self;
}
- (id)copy
{
return Block_copy(self);
}
- (instancetype)autorelease
{
if ([self isMemberOfClass: (Class)&_NSConcreteMallocBlock])
return [super autorelease];
return self;
}
- (unsigned int)retainCount
{
if ([self isMemberOfClass: (Class)&_NSConcreteMallocBlock])
return ((of_block_literal_t *)self)->flags &
OF_BLOCK_REFCOUNT_MASK;
return OF_RETAIN_COUNT_MAX;
}
- (void)release
{
if ([self isMemberOfClass: (Class)&_NSConcreteMallocBlock])
Block_release(self);
}
- (void)dealloc
{
OF_DEALLOC_UNSUPPORTED
}
@end