system/include/pedigree/kernel/process/Ipc.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 _PROCESS_IPC_H
#define _PROCESS_IPC_H

#include "pedigree/kernel/Log.h"
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/process/Mutex.h"
#include "pedigree/kernel/process/Semaphore.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/List.h"
#include "pedigree/kernel/utilities/String.h"
#include "pedigree/kernel/utilities/new"

class MemoryRegion;

namespace Ipc
{
class EXPORTED_PUBLIC IpcMessage
{
  public:
    IpcMessage();

    IpcMessage(size_t nBytes, uintptr_t regionHandle = 0);

    virtual ~IpcMessage();

    void *getBuffer();

    void *getHandle();

    IpcMessage(const IpcMessage &src)
    {
        if (src.nPages > 1)
            FATAL("IpcMessage: copy constructor misused.");
        nPages = src.nPages;
        m_vAddr = src.m_vAddr;
        m_pMemRegion = src.m_pMemRegion;
    }

  private:
    size_t nPages;

    uintptr_t m_vAddr;

    MemoryRegion *m_pMemRegion;
};

class IpcEndpoint
{
  public:
    IpcEndpoint(const String &name)
        : m_Name(name), m_Queue(), m_QueueSize(0), m_QueueLock(false)
    {
        NOTICE("Creating endpoint with name " << name);
        NOTICE("Endpoint is at " << reinterpret_cast<uintptr_t>(this));
    }

    ~IpcEndpoint() NORETURN
    {
        FATAL("IpcEndpoint " << m_Name << " is being destroyed.");
    }

    Mutex *pushMessage(IpcMessage *pMessage, bool bAsync);

    IpcMessage *getMessage(bool bBlock = false);

    const String &getName() const
    {
        return m_Name;
    }

  private:
    struct QueuedMessage
    {
        Mutex *pMutex;
        IpcMessage *pMessage;
        bool bAsync;
    };

    String m_Name;

    List<QueuedMessage *> m_Queue;
    Semaphore m_QueueSize;

    Mutex m_QueueLock;
};

EXPORTED_PUBLIC bool
send(IpcEndpoint *pEndpoint, IpcMessage *pMessage, bool bAsync = false);
EXPORTED_PUBLIC bool
recv(IpcEndpoint *pEndpoint, IpcMessage **pMessage, bool bAsync = false);

EXPORTED_PUBLIC IpcEndpoint *getEndpoint(String &name);

EXPORTED_PUBLIC void createEndpoint(String &name);
EXPORTED_PUBLIC void removeEndpoint(String &name);
};  // namespace Ipc

#endif