[apple/xnu.git] / iokit / DriverKit / OSObject.iig

/*
 * Copyright (c) 2019-2019 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#if !__IIG
#if KERNEL
#include <libkern/c++/OSObject.h>
#endif
#endif

#ifndef _IOKIT_UOSOBJECT_H
#define _IOKIT_UOSOBJECT_H

#if !KERNEL
#include <stddef.h>
#include <stdint.h>
#include <DriverKit/IOReturn.h>
#if DRIVERKIT_PRIVATE
#include <mach/port.h>
#endif /* DRIVERKIT_PRIVATE */
#if !__IIG
#include <string.h>
#include <DriverKit/OSMetaClass.h>
#endif  /* !__IIG */
class OSObject;
typedef OSObject * OSObjectPtr;
#endif /* !KERNEL */

#if !__IIG_ATTRIBUTES_DEFINED__

#define __IIG_ATTRIBUTES_DEFINED__      1

#if __IIG || __DOCUMENTATION__

#define IIG_KERNEL                              __attribute__((annotate("kernel")))
#define IIG_NATIVE                      __attribute__((annotate("native")))
#define IIG_LOCAL                       __attribute__((annotate("local")))
#define IIG_LOCALONLY                   __attribute__((annotate("localonly")))
#define IIG_REMOTE                      __attribute__((annotate("remote")))
#define IIG_LOCALHOST                   __attribute__((annotate("localhost")))
#define IIG_INVOKEREPLY                 __attribute__((annotate("invokereply")))
#define IIG_REPLY                       __attribute__((annotate("reply")))
#define IIG_PORTMAKESEND                __attribute__((annotate("MACH_MSG_TYPE_MAKE_SEND")))
#define IIG_PORTCOPYSEND                __attribute__((annotate("MACH_MSG_TYPE_COPY_SEND")))
#define IIG_TARGET                      __attribute__((annotate("target")))
#define IIG_TYPE(p)                     __attribute__((annotate("type=" # p)))
//#define IIG_ARRAY(maxcount)   __attribute__((annotate(# maxcount), annotate("array")))
#define IIG_EXTENDS(cls)                __attribute__((annotate("extends=" # cls)))
//#define IIG_INTERFACE                 __attribute__((annotate("interface")))
//#define IIG_IMPLEMENTS(i)             void __implements(i *);
#define IIG_QUEUENAME(name)             __attribute__((annotate("queuename=" # name)))
#define IIG_SERIALIZABLE                __attribute__((annotate("serializable")))

#if __IIG
#define KERNEL                                  IIG_KERNEL
#endif /* __IIG */
#define NATIVE                                  IIG_NATIVE
#define LOCAL                                   IIG_LOCAL
#define LOCALONLY                               IIG_LOCALONLY
#define REMOTE                                  IIG_REMOTE
#define LOCALHOST                               IIG_LOCALHOST
#define INVOKEREPLY                             IIG_INVOKEREPLY
#define REPLY                                   IIG_REPLY
#define PORTMAKESEND                    IIG_PORTMAKESEND
#define PORTCOPYSEND                    IIG_PORTCOPYSEND
#define TARGET                                  IIG_TARGET
#define TYPE(p)                                 IIG_TYPE(p)
//#define ARRAY(maxcount)               IIG_ARRAY(maxcount)
#define EXTENDS(cls)                    IIG_EXTENDS(cls)
//#define INTERFACE                             IIG_INTERFACE
//#define IMPLEMENTS(i)                 IIG_IMPLEMENTS(i)
#define QUEUENAME(name)                 IIG_QUEUENAME(name)

#else /* __IIG || __DOCUMENTATION__ */

#define IIG_KERNEL
#define IIG_NATIVE
#define IIG_LOCAL
#define IIG_LOCALONLY
#define IIG_REMOTE
#define IIG_LOCALHOST
#define IIG_INVOKEREPLY
#define IIG_REPLY
#define IIG_PORTMAKESEND
#define IIG_PORTCOPYSEND
#define IIG_TARGET
#define IIG_TYPE(p)
//#define IIG_ARRAY(maxcount)
#define IIG_EXTENDS(cls)
//#define IIG_INTERFACE
//#define IIG_IMPLEMENTS(i)
#define IIG_QUEUENAME(name)
#define IIG_SERIALIZABLE

#endif /* __IIG || __DOCUMENTATION__ */

#endif /* __IIG_ATTRIBUTES_DEFINED__ */


#if !__IIG
#if KERNEL
typedef OSObject OSContainer;
#else /* KERNEL */
class IIG_SERIALIZABLE OSContainer;
#endif /* KERNEL */
#else /* !__IIG */
class IIG_SERIALIZABLE OSContainer;
#endif  /* !__IIG */

class IIG_SERIALIZABLE OSData;
class IIG_SERIALIZABLE OSNumber;
class IIG_SERIALIZABLE OSString;
class IIG_SERIALIZABLE OSBoolean;
class IIG_SERIALIZABLE OSDictionary;
class IIG_SERIALIZABLE OSArray;

class OSMetaClass;
class IODispatchQueue;
typedef char IODispatchQueueName[256];

#if __IIG
class OSMetaClassBase
{
        virtual const OSMetaClass *
        getMetaClass() const LOCALONLY;

    virtual void
    retain() const LOCALONLY;

    virtual void
    release() const LOCALONLY;

        virtual bool
    isEqualTo(const OSMetaClassBase * anObject) const LOCALONLY;
};
#endif /* __IIG */


/*!
@iig implementation
#include <DriverKit/IODispatchQueue.h>
@iig end
*/

class OSObject : public OSMetaClassBase
{
public:

        virtual bool
        init() LOCALONLY;

        virtual void
        free() LOCALONLY;

    virtual void
    retain() const override;

    virtual void
    release() const override;

        virtual kern_return_t
        SetDispatchQueue(
                const IODispatchQueueName name,
                IODispatchQueue         * queue) KERNEL = 0;

        virtual kern_return_t
        CopyDispatchQueue(
                const IODispatchQueueName name,
                IODispatchQueue        ** queue) KERNEL = 0;
};

#define DEFN(classname, name)                                       \
name ## _Impl(classname ## _ ## name ## _Args)

/*
 * Use of the IMPL macro is discouraged and should be replaced by a normal c++
 * method implementation (with the all method arguments) and the name of the method
 * given a suffix '_Impl'
 */

#define IMPL(classname, name)                                       \
classname :: DEFN(classname, name)

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#endif /* ! _IOKIT_UOSOBJECT_H */