Event.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef EVENT_H
#define EVENT_H

#include "pedigree/kernel/Spinlock.h"
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/List.h"
#include "pedigree/kernel/utilities/new"

#ifdef THREADS
class Thread;
#endif

#define EVENT_LIMIT 4096

#define EVENT_TID_MAX 255

#define MAX_NESTED_EVENTS 16

#define EVENT_MAGIC 0x8899AABBCCDDEEFFULL

class EXPORTED_PUBLIC Event
{
  public:
    Event(
        uintptr_t handlerAddress, bool isDeletable,
        size_t specificNestingLevel = ~0UL);
    virtual ~Event();

    static uintptr_t getTrampoline();

    static uintptr_t getSecondaryTrampoline();

    static uintptr_t getHandlerBuffer();

    static uintptr_t getLastHandlerBuffer();

    virtual bool isDeletable();

    virtual size_t serialize(uint8_t *pBuffer) = 0;

    static bool unserialize(uint8_t *pBuffer, Event &event);

    static size_t getEventType(uint8_t *pBuffer);

    uintptr_t getHandlerAddress()
    {
        return m_HandlerAddress;
    }

    size_t getSpecificNestingLevel()
    {
        return m_NestingLevel;
    }

    virtual size_t getNumber() = 0;

    Event(const Event &other);
    Event &operator=(const Event &other);

#ifdef THREADS

    void registerThread(Thread *thread);

    void deregisterThread(Thread *thread);

    size_t pendingCount();
#endif

    virtual void waitForDeliveries();

  protected:
    uintptr_t m_HandlerAddress;

    bool m_bIsDeletable;

    size_t m_NestingLevel;

    size_t m_Magic;

#ifdef THREADS

    List<Thread *> m_Threads;

    Spinlock m_Lock;
#endif
};

#endif