动手实现 NSInvocation（下）

#Original (English)

Source: https://www.mikeash.com/pyblog/friday-qa-2013-03-22-lets-build-nsinvocation-part-ii.html

Last time on Friday Q&A, I began the reimplementation of parts of NSInvocation as MAInvocation. In that article, I discussed the basic theory, the architecture calling conventions, and presented the assembly language glue code needed for the implementation. Today, I present the Objective-C part of MAInvocation.

RecapMAInvocation is my reimplementation of a large chunk of NSInvocation. For simplicity, it doesn’t support floating point arguments or return values, and it also doesn’t support struct arguments. It only supports the x86-64 architecture. The code is on GitHub here:

https://github.com/mikeash/MAInvocation

The first six parameters to a function are passed in six registers: rdi, rsi, rdx, rcx, r8, and r9. Subsequent parameters, if any, are passed on the stack. Return values are returned in rax. For the special case of a two-element struct, the second element is returned in rdx. Larger structs are returned by having the caller allocate memory, and then a pointer to that memory is implicitly passed in as the first parameter in rdi, with all explicit parameters bumped down. These are called stret calls in the Objective-C world.

Assembly language glue is used to translate between values held in a struct and actual function calls. The struct holds all of the registers in question, plus a pointer to stack arguments, plus some additional data:

1
    struct RawArguments
2
    {
3
        void *fptr;
4

5
        uint64_t rdi;
6
        uint64_t rsi;
7
        uint64_t rdx;
8
        uint64_t rcx;
9
        uint64_t r8;
10
        uint64_t r9;
11

12
        uint64_t stackArgsCount;
13
        uint64_t *stackArgs;
14

15
        uint64_t rax_ret;
16
        uint64_t rdx_ret;
17

18
        uint64_t isStretCall;
19
    };

The MAInvocationCall function is written in assembly, and was explored in the previous article. It has this prototype:

1
    void MAInvocationCall(struct RawArguments *);

Objective-C code can fill out a struct RawArguments with a function pointer and the appropriate register values, then call this function. It will make the function call, and on return, the two return value register fields in the struct will be filled out with whatever the function returned.

There are also two forwarding handlers:

1
    void MAInvocationForward(void);
2
    void MAInvocationForwardStret(void);

These are designed to be invoked by an arbitrary Objective-C method call. They both create a new struct RawArguments, fill out the argument registers and stack arguments pointer, and then invoke a C function called MAInvocationForwardC. When that returns, the handlers pass the rax_ret and rdx_ret values back to the caller. The only difference between these two handlers is whether they set the isStretCall to 0 or 1.

The stage is now set for the Objective-C implementation of MAInvocation.

InterfaceThe interface to MAInvocation is the same as NSInvocation:

1
    @interface MAInvocation : NSObject
2

3
    + (MAInvocation *)invocationWithMethodSignature:(NSMethodSignature *)sig;
4

5
    - (NSMethodSignature *)methodSignature;
6

7
    - (void)retainArguments;
8
    - (BOOL)argumentsRetained;
9

10
    - (id)target;
11
    - (void)setTarget:(id)target;
12

13
    - (SEL)selector;
14
    - (void)setSelector:(SEL)selector;
15

16
    - (void)getReturnValue:(void *)retLoc;
17
    - (void)setReturnValue:(void *)retLoc;
18

19
    - (void)getArgument:(void *)argumentLocation atIndex:(NSInteger)idx;
20
    - (void)setArgument:(void *)argumentLocation atIndex:(NSInteger)idx;
21

22
    - (void)invoke;
23
    - (void)invokeWithTarget:(id)target;
24

25
    @end

Instance VariablesThe method signature is central to an invocation object. The method signature describes how many parameters the method takes, as well as what the types are. This is critical information to be able to figure out how to deal with method parameters and return types. This is why the only way to create an MAInvocation is with an NSMethodSignature, and that signature is stored in an instance variable:

1
    @implementation MAInvocation {
2
        NSMethodSignature *_sig;

The invocation keeps a local struct RawArguments. This struct is manipulated directly when setting or getting arguments and return values. When the invocation is invoked, a pointer to the instance variable can be passed directly to the assembly language glue:

1
        struct RawArguments _raw;

Invocations can retain their arguments. This sends retain to all object arguments, and it also copies C string arguments. Whether arguments are currently retained needs to be tracked, so that they can be properly freed, and so that newly-set arguments can be retained, so there’s a flag for that:

1
        BOOL _argumentsRetained;

Finally, there needs to be a buffer to store the return value for stret calls:

1
        void *_stretBuffer;
2
    }

InitializationThe factory method just calls an init method:

1
    + (NSInvocation *)invocationWithMethodSignature: (NSMethodSignature *)sig
2
    {
3
        return [[[self alloc] initWithMethodSignature: sig] autorelease];
4
    }

The init method saves the method signature:

1
    - (id)initWithMethodSignature: (NSMethodSignature *)sig
2
    {
3
        if((self = [super init]))
4
        {
5
            _sig = [sig retain];

It then populates the isStretCall of the struct RawArguments by examining the method signature to determine whether it fits the requirements for a stret call. This is done by calling another method. The code for that method is rather involved, and will come later:

1
            _raw.isStretCall = [self isStretReturn];

Next, the stack arguments are set up. The first thing to do here is to get the total number of arguments from the method signature:

1
            NSUInteger argsCount = [sig numberOfArguments];

Note that this count includes the two implicit arguments, self and _cmd, so this number is exactly equal to the number of function arguments being passed.

If it’s a stret call, then there’s effectively one more argument, because of the implicit pointer for the return value passed in rdi:

1
            if(_raw.isStretCall)
2
                argsCount++;

If there are more than six arguments (potentially including the implicit stret parameter), then there are stack arguments. stackArgsCount is set to the number of remaining arguments, and memory is allocated so that stackArgs can hold them:

1
            if(argsCount > 6)
2
            {
3
                _raw.stackArgsCount = argsCount - 6;
4
                _raw.stackArgs = calloc(argsCount - 6, sizeof(*_raw.stackArgs));
5
            }
6
        }
7
        return self;
8
    }

Wrapper MethodsThere are a few methods in the API that are simply small wrappers around other methods. I’ll cover them here before we get to the real meat.

The target method just gets the value of the first argument in a slightly more convenient way. The method is just a small wrapper around the getArgument:atIndex: method:

1
    - (id)target
2
    {
3
        id target;
4
        [self getArgument: &target atIndex: 0];
5
        return target;
6
    }

The setTarget: method is an even simpler wrapper around the setArgument:atIndex: method:

1
    - (void)setTarget: (id)target
2
    {
3
        [self setArgument: &target atIndex: 0];
4
    }

The selector and setSelector: methods are virtually identical, but manipulate the second argument:

1
    - (SEL)selector
2
    {
3
        SEL sel;
4
        [self getArgument: &sel atIndex: 1];
5
        return sel;
6
    }
7

8
    - (void)setSelector: (SEL)selector
9
    {
10
        [self setArgument: &selector atIndex: 1];
11
    }

Finally, the invoke method calls invokeWithTarget:, passing [self target]:

1
    - (void)invoke
2
    {
3
        [self invokeWithTarget: [self target]];
4
    }

Getting ArgumentsIn order to get an argument out of the invocation, the code first needs to know where an argument is stored. This small wrapper method handles that:

1
    - (uint64_t *)argumentPointerAtIndex: (NSInteger)idx
2
    {
3
        uint64_t *ptr = NULL;
4
        if(idx == 0)
5
            ptr = &_raw.rdi;
6
        if(idx == 1)
7
            ptr = &_raw.rsi;
8
        if(idx == 2)
9
            ptr = &_raw.rdx;
10
        if(idx == 3)
11
            ptr = &_raw.rcx;
12
        if(idx == 4)
13
            ptr = &_raw.r8;
14
        if(idx == 5)
15
            ptr = &_raw.r9;
16
        if(idx >= 6)
17
            ptr = _raw.stackArgs + idx - 6;
18
        return ptr;
19
    }

This method takes a raw argument index, which is to say that it’s already been adjusted to take into account whether or not this is a stret call. It then maps that index onto the appropriate register or stack slot.

It’s also handy to be able to get the size of a particular argument, so it can copy the right number of bytes for arguments that are smaller than 8 bytes. This method wraps the Foundation function NSGetSizeAndAlignment, which takes an Objective-C type string and returns the size (and alignment!) of the type in question:

1
    - (NSUInteger)sizeOfType: (const char *)type
2
    {
3
        NSUInteger size;
4
        NSGetSizeAndAlignment(type, &size, NULL);
5
        return size;
6
    }

Another small wrapper around this method provides the size of a given argument:

1
    - (NSUInteger)sizeAtIndex: (NSInteger)idx
2
    {
3
        return [self sizeOfType: [_sig getArgumentTypeAtIndex: idx]];
4
    }

To actually fetch an argument, the method first adjusts the requested index to take into account the possible stret return:

1
    - (void)getArgument: (void *)argumentLocation atIndex: (NSInteger)idx
2
    {
3
        NSInteger rawArgumentIndex = idx;
4
        if(_raw.isStretCall)
5
            rawArgumentIndex++;

Next, it grabs the pointer from the above method, and checks it for sanity:

1
        uint64_t *src = [self argumentPointerAtIndex: rawArgumentIndex];
2
        assert(src);

Then it grabs the argument size and copies the appropriate number of bytes out of the argument location:

1
        NSUInteger size = [self sizeAtIndex: idx];
2
        memcpy(argumentLocation, src, size);
3
    }

Getting and Setting Return ValuesTo get and set the return value, the value’s size is needed. This is easy to obtain by just getting the size of the return type obtained from the method signature:

1
    - (NSUInteger)returnValueSize
2
    {
3
        return [self sizeOfType: [_sig methodReturnType]];
4
    }

It’s also necessary to get a pointer to the location where the return value is stored. If the invocation is for a stret call, then it returns _stretBuffer. If the buffer isn’t allocated yet, it allocates it:

1
    - (void *)returnValuePtr
2
    {
3
        if(_raw.isStretCall)
4
        {
5
            if(_stretBuffer == NULL)
6
                _stretBuffer = calloc(1, [self returnValueSize]);
7
            return _stretBuffer;
8
        }

For regular calls, it just returns the address of the rax_ret field in the raw arguments struct:

1
        else
2
        {
3
            return &_raw.rax_ret;
4
        }
5
    }

This takes care of the case where the return value uses both return registers. Since they’re contiguous in the struct, copying a sufficiently large value into this address will write to both register fields in the struct.

With these methods available, writing the methods to get and set the return value is easy. All they have to do is call memcpy with the computed size and pointer:

1
    - (void)getReturnValue: (void *)retLoc
2
    {
3
        NSUInteger size = [self returnValueSize];
4
        memcpy(retLoc, [self returnValuePtr], size);
5
    }
6

7
    - (void)setReturnValue: (void *)retLoc
8
    {
9
        NSUInteger size = [self returnValueSize];
10
        memcpy([self returnValuePtr], retLoc, size);
11
    }

Type ClassificationDetermining whether a method’s return type requires a stret call requires classifying that type according to the x86-64 calling conventions. The NSInvocation API allows for retaining the arguments to the invocation, which also requires classifying the argument types, so that all of the object types can be found.

The different classifications get put into an enum which combines the relevant parts of the x86-64 ABI with the distinctions necessary for retaining arguments. This boils down to objects, blocks, C strings, other integer types (including non-object pointers), a struct containing two integers, an empty struct, any other struct, and any other type not already covered:

1
    enum TypeClassification
2
    {
3
        TypeObject,
4
        TypeBlock,
5
        TypeCString,
6
        TypeInteger,
7
        TypeTwoIntegers,
8
        TypeEmptyStruct,
9
        TypeStruct,
10
        TypeOther
11
    };

The classification process itself consists of two mutually-recursive methods: one that classifies arbitrary types, and one specialized to classify struct types.

The general method starts by creating the type strings for ‘id’, blocks, and C strings by using the @encode directive:

1
    - (enum TypeClassification)classifyType: (const char *)type
2
    {
3
        const char *idType = @encode(id);
4
        const char *blockType = @encode(void (^)(void));
5
        const char *charPtrType = @encode(char *);

Note that all blocks have the same type string when it comes to @encode, so the choice of block type here is completely arbitrary.

With these in hand, it compares type against them, and returns the appropriate enum value if there’s a match:

1
        if(strcmp(type, idType) == 0)
2
            return TypeObject;
3
        if(strcmp(type, blockType) == 0)
4
            return TypeBlock;
5
        if(strcmp(type, charPtrType) == 0)
6
            return TypeCString;

Next, it checks integer types. This crazy bit of code constructs a C string that contains every the character for every integer type, plus function pointers (which is just ?), plus any other pointer (which all start with ^):

1
        char intTypes[] = { @encode(signed char)[0], @encode(unsigned char)[0], @encode(short)[0], @encode(unsigned short)[0], @encode(int)[0], @encode(unsigned int)[0], @encode(long)[0], @encode(unsigned long)[0], @encode(long long)[0], @encode(unsigned long long)[0], '?', '^', 0 };

With that C string in hand, the strchr function can be used to check the first character in type aganist all of these characters. If there’s a match, then the type is an integer type:

1
        if(strchr(intTypes, type[0]))
2
            return TypeInteger;

struct types begin with the { character. If the type string starts with that character, then call into the struct classifier:

1
        if(type[0] == '{')
2
            return [self classifyStructType: type];

If nothing matches, then return the “other” type:

1
        return TypeOther;
2
    }

The struct classifier uses a helper method that takes the type string for the struct and enumerates over all of its contents. It tracks the struct’s classification at each point, and updates it with each new element in the struct. It starts out with an empty struct:

1
    - (enum TypeClassification)classifyStructType: (const char *)type
2
    {
3
        __block enum TypeClassification structClassification = TypeEmptyStruct;

Then it enumerates and classifies each type within:

1
        [self enumerateStructElementTypes: type block: ^(const char *type) {
2
            enum TypeClassification elementClassification = [self classifyType: type];

If the current classification is an empty struct, then the new classification is the same as the element classification. A struct with one element is classified the same as the element it contains:

1
            if(structClassification == TypeEmptyStruct)
2
                structClassification = elementClassification;

If the current classification is an integer type and the element classification is also an integer type, then the struct gets the special classification of a struct containing two integers:

1
            else if([self isIntegerClass: structClassification] && [self isIntegerClass: elementClassification])
2
                structClassification = TypeTwoIntegers;

In any other circumstance (struct contains more than two elements, struct contains floating-point elements, etc.) the classification is just a generic struct:

1
            else
2
                structClassification = TypeStruct;
3
        }];
4
        return structClassification;
5
    }

The method to enumerate over a struct type string’s elements is short. A struct type string consists of the struct’s name, the = symbol, and then each element’s type concatenated together, all contained within a pair of {}. For example, NSRange would look like:

1
    {NSRange=LL}

The first thing the method does is find the = and start scanning just beyond it:

1
    - (void)enumerateStructElementTypes: (const char *)type block: (void (^)(const char *type))block
2
    {
3
        const char *equals = strchr(type, '=');
4
        const char *cursor = equals + 1;

Then it enumerates over each type contained within, taking advantage of NSGetSizeAndAlignment to move the cursor to the end of each type encountered, even if the type contains more than one character. It does this until it encounters a closing brace:

1
        while(*cursor != '}')
2
        {
3
            block(cursor);
4
            cursor = NSGetSizeAndAlignment(cursor, NULL, NULL);
5
        }
6
    }

There’s also a short helper method that determines whether a particular type classification is considered an integer. This just checks to see if the classification is an object, block, C string, or an actual integer or other pointer:

1
    - (BOOL)isIntegerClass: (enum TypeClassification)classification
2
    {
3
        return classification == TypeObject || classification == TypeBlock || classification == TypeCString || classification == TypeInteger;
4
    }

This finishes the type classification system. This is somewhat rudimentary compared to the full complexity of the x86-64 spec, but it’s enough for MAInvocation’s needs. With type classification available, we can finally implement the isStretReturn method used in the initializer:

1
    - (BOOL)isStretReturn
2
    {
3
        return [self classifyType: [_sig methodReturnType]] == TypeStruct;
4
    }

Setting ArgumentsWith type classification in place, it’s finally time to implement setting arguments. The basic form of setArgument:atIndex: is nearly identical to getArgument:atIndex:, but the need to support retained arguments makes everything far more complicated.

It’s possible to create an NSInvocation, set it up, and then keep it around for a while. In order for the NSInvocation to remain valid, it needs to be able to do proper memory management on the arguments it contains. In a nod to flexibility, this is optional. A freshly-made NSInvocation doesn’t do any memory management on its arguments, but it can be enabled by sending it a retainArguments message.

MAInvocation mimics this functionality. When it receives retainArguments it performs the following operations on its arguments:

1
    1. Block arguments are copied.
2
    2. Non-block object arguments are retained.
3
    3. C string arguments are copied.
4
    4. All others are left alone.

In addition to doing this for retainArguments, the setArgument:atIndex: method needs to do this for each newly set argument as well. This is what makes it so much more complex than getArgument:atIndex:.

The method starts off by computing the raw argument index:

1
    - (void)setArgument: (void *)argumentLocation atIndex: (NSInteger)idx
2
    {
3
        NSInteger rawArgumentIndex = idx;
4
        if(_raw.isStretCall)
5
            rawArgumentIndex++;

Next, it gets the argument pointer at that index:

1
        uint64_t *dest = [self argumentPointerAtIndex: rawArgumentIndex];
2
        assert(dest);

Then it classifies the argument at this index:

1
        enum TypeClassification c = [self classifyArgumentAtIndex: idx];

If arguments are retained, it will then check the classification of the arguments to see if it’s a block, a non-block object, or a C string. If it is, then it directly sets dest to the value found at argumentLocation using the appropriate retain or copy semantics. If argument is of a different type, or if arguments aren’t retained, it does a simple memcpy.

The first case is for plain objects. This just does a fairly standard retain/release combination, with a bunch of casting to treat both pointers as object pointers. The release is done at the end using the old variable to avoid problems where releasing the old value invalidates the new one:

1
        if(_argumentsRetained && c == TypeObject)
2
        {
3
            id old = *(id *)dest;
4
            *(id *)dest = [*(id *)argumentLocation retain];
5
            [old release];
6
        }

Blocks get the same treatment, except they get a copy rather than a retain:

1
        else if(_argumentsRetained && c == TypeBlock)
2
        {
3
            id old = *(id *)dest;
4
            *(id *)dest = [*(id *)argumentLocation copy];
5
            [old release];
6
        }

C strings are similar, but use strdup and free:

1
        else if(_argumentsRetained && c == TypeCString)
2
        {
3
            char *old = *(char **)dest;
4

5
            char *cstr = *(char **)argumentLocation;
6
            if(cstr != NULL)
7
                cstr = strdup(cstr);
8
            *(char **)dest = cstr;
9

10
            free(old);
11
        }

In all other cases, the appropriate number of bytes is copied over using memcpy:

1
        else
2
        {
3
            NSUInteger size = [self sizeAtIndex: idx];
4
            memcpy(dest, argumentLocation, size);
5
        }
6
    }

The classifyArgumentAtIndex: is a small wrapper around classifyType: that retrieves the argument type from the method signature and classifies it:

1
    - (enum TypeClassification)classifyArgumentAtIndex: (NSUInteger)idx
2
    {
3
        return [self classifyType: [_sig getArgumentTypeAtIndex: idx]];
4
    }

Retaining ArgumentsIn addition to retaining each argument as it arrives in setArgument:atIndex:, MAInvocation also needs to retain all existing arguments in the retainArguments method. Only the first call does anything, so the first thing that method does is check to see if arguments are already retained, and bail out if so:

1
    - (void)retainArguments
2
    {
3
        if(_argumentsRetained)
4
            return;

Next, it iterates over all retainable arguments, using a helper method. This method invokes a block for each retainable argument that passes in the argument index as well as the argument’s value. There are three value arguments in the block, and only one is set for any given call.

1
        [self iterateRetainableArguments: ^(NSUInteger idx, id obj, id block, char *cstr) {

If it’s an object argument, then that argument is retained:

1
            if(obj)
2
            {
3
                [obj retain];
4
            }

If it’s a block argument, the block is copied, and the new value set as the argument value. Note that _argumentsRetained has not yet been set to YES, so setArgument:atIndex: won’t try to do its own memory management, avoiding any conflict between the two:

1
            else if(block)
2
            {
3
                block = [block copy];
4
                [self setArgument: &block atIndex: idx];
5
            }

If it’s a C string argument, it uses strdup:

1
            else if(cstr)
2
            {
3
                if(cstr != NULL)
4
                    cstr = strdup(cstr);
5
                [self setArgument: &cstr atIndex: idx];
6
            }
7
        }];

Finally, it sets _argumentsRetained:

1
        _argumentsRetained = YES;
2
    }

The iterateRetainableArguments: method uses the type classification system to figure out what each argument is, then calls getArgument:atIndex: to fetch the value. It first iterates over each argument and classifies it:

1
    - (void)iterateRetainableArguments: (void (^)(NSUInteger idx, id obj, id block, char *cstr))block
2
    {
3
        for(NSUInteger i = 0; i < [_sig numberOfArguments]; i++)
4
        {
5
            enum TypeClassification c = [self classifyArgumentAtIndex: i];

Objects and blocks are both handled by the same branch. It first retrieves the argument into a local id variable:

1
            if(c == TypeObject || c == TypeBlock)
2
            {
3
                id arg;
4
                [self getArgument: &arg atIndex: i];

It then moves arg into one of two other local variables depending on whether the type is a block or a plain object:

1
                id o = c == TypeObject ? arg : nil;
2
                id b = c == TypeBlock ? arg : nil;

At this point, o contains the argument value if it’s a plain argument, and b contains the argument value if it’s a block. The iteration block can then be called with these values:

1
                block(i, o, b, NULL);
2
            }

C strings are similar, but less complex, because there’s only one possible type here:

1
            else if(c == TypeCString)
2
            {
3
                char *arg;
4
                [self getArgument: &arg atIndex: i];
5

6
                block(i, nil, nil, arg);
7
            }
8
        }
9
    }

While we’re at it, here’s a quick getter method for argumentsRetained:

1
    - (BOOL)argumentsRetained
2
    {
3
        return _argumentsRetained;
4
    }

DeallocThe hardest part of dealloc is freeing the retained arguments. The iterateRetainableArguments: method takes care of most of the work:

1
    - (void)dealloc
2
    {
3
        if(_argumentsRetained)
4
        {
5
            [self iterateRetainableArguments: ^(NSUInteger idx, id obj, id block, char *cstr) {
6
                [obj release];
7
                [block release];
8
                free(cstr);
9
            }];
10
        }

With that taken care of, all that remains is freeing the method signature, the stackArgs pointer, and calling super:

1
        [_sig release];
2
        free(_raw.stackArgs);
3

4
        [super dealloc];
5
    }

InvocationThe code so far has kept the struct RawArguments almost completely up to date. Implementing invokeWithTarget: is simply a matter of filling out the last details, then making a call to the MAInvocationCall assembly glue function. The method starts out by setting the target value:

1
    - (void)invokeWithTarget: (id)target
2
    {
3
        [self setTarget: target];

It then uses methodForSelector: to get the function pointer for the invocation’s selector and places that into the fptr field. This is what the glue code will call:

1
        _raw.fptr = [target methodForSelector: [self selector]];

If this is a stret call, then rdi needs to be set up to point to space that can hold the return value:

1
        if(_raw.isStretCall)
2
            _raw.rdi = (uint64_t)[self returnValuePtr];

Finally, call the assembly glue:

1
        MAInvocationCall(&_raw);
2
    }

With all of the register fields and the stack arguments pointer set up, and the function pointer field set to the target IMP, the assembly glue is able to make the call. Upon return, the assembly glue copies rax and rdx into the return value fields of the struct RawArguments. This means that the return value is already set when the assembly glue returns, and will be available from getReturnValue: without any additional action in the Objective-C code.

ForwardingThe last major piece of MAInvocation is the MAInvocationForwardC function. The assembly language forwarding glue intercepts unknown message calls. It then constructs a struct RawArguments on the stack from the function call, and then calls through to MAInvocationForwardC, passing it a pointer to the struct RawArguments. The remainder of the logic is implemented in Objective-C:

1
    void MAInvocationForwardC(struct RawArguments *r)
2
    {

The first order of business is to get the object that the message was sent to, and the selector being sent. For a stret call, the object is in rsi and the selector is in rdx. For a normal call, the object is in rdi and the selector is in rsi:

1
        id obj;
2
        SEL sel;
3

4
        if(r->isStretCall)
5
        {
6
            obj = (id)r->rsi;
7
            sel = (SEL)r->rdx;
8
        }
9
        else
10
        {
11
            obj = (id)r->rdi;
12
            sel = (SEL)r->rsi;
13
        }

A method signature is critical to creating an invocation object. With the object and selector available, a simple call to methodSignatureForSelector: obtains that:

1
        NSMethodSignature *sig = [obj methodSignatureForSelector: sel];

With the method signature in hand, the forwarding function can now create an MAInvocation:

1
        MAInvocation *inv = [[MAInvocation alloc] initWithMethodSignature: sig];

The next order of business is to copy all of the pertinent information from r into the invocation’s_raw` instance variable. First come the registers:

1
        inv->_raw.rdi = r->rdi;
2
        inv->_raw.rsi = r->rsi;
3
        inv->_raw.rdx = r->rdx;
4
        inv->_raw.rcx = r->rcx;
5
        inv->_raw.r8 = r->r8;
6
        inv->_raw.r9 = r->r9;

After that, stack arguments are copied. Although r always contains 0 for stackArgsCount, the invocation has now computed the number of actual stack arguments, so its _raw variable can be consulted to get the count:

1
        memcpy(inv->_raw.stackArgs, r->stackArgs, inv->_raw.stackArgsCount * sizeof(uint64_t));

The invocation is now fully constructed and filled out. The object is sent forwardInvocation: with the newly constructed invocation.

1
        [obj forwardInvocation: (id)inv];

After that call returns, the return value from the invocation needs to be copied back into r. The assembly glue will then pass the value back to the caller. It first copies the two return value registers over:

1
        r->rax_ret = inv->_raw.rax_ret;
2
        r->rdx_ret = inv->_raw.rdx_ret;

If it’s a stret call and the invocation actually has a buffer to hold the return value, the value in the invocation’s return value buffer is copied into the memory pointed to by r->rdi, which is where the caller specified that it wanted the return value placed:

1
        if(r->isStretCall && inv->_stretBuffer)
2
        {
3
            memcpy((void *)r->rdi, inv->_stretBuffer, [inv returnValueSize]);
4
        }

Everything is now complete, so the invocation is released, and control is returned to the assembly language glue:

1
        [inv release];
2
    }

The glue code will now copy the rax and rdx fields back into the respective CPU registers, then return control to the original method caller, which will see the return value either in those registers or in the stret buffer that it passed in rdi.

ConclusionThat wraps up the implementation of MAInvocation. It’s enormously complicated and involved, despite only supporting x86-64 and ignoring struct parameters and floating point of all kinds, which are a large part of the x86-64 calling conventions. NSInvocation not only supports all types of parameters and return values (aside from a few corner cases like union parameters), it also supports them on at least three different architectures: i386, x86-64, and ARM.

However, despite the complication, it’s all very much doable. Covering all of the cases requires a lot of time and effort, but there’s nothing mysterious or magical. It would require equivalents of the assembly glue functions for the other architectures, expanding the glue functions to cover the floating-point registers, and implementing all of the logic for which arguments go where in the MAInvocation Objective-C code.

MAInvocation was a lot of fun to build and gives great insight on just what NSInvocation is doing. It should be obvious, but don’t use MAInvocation for any real work. NSInvocation does all the same stuff and more, and no doubt does it better.

That’s it for today. Come back next time for another breathtaking adventure. Friday Q&A is driven by reader ideas, so until then, please keep sending in your ideas for topics to cover.