ipc.h

Go to the documentation of this file.

/*
 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
 *               Alexander Warg <warg@os.inf.tu-dresden.de>,
 *               Björn Döbel <doebel@os.inf.tu-dresden.de>,
 *               Torsten Frenzel <frenzel@os.inf.tu-dresden.de>
 *     economic rights: Technische Universität Dresden (Germany)
 *
 * License: see LICENSE.spdx (in this directory or the directories above)
 */
#ifndef __L4SYS__INCLUDE__L4API_FIASCO__IPC_H__
#define __L4SYS__INCLUDE__L4API_FIASCO__IPC_H__
 
#include <l4/sys/types.h>
#include <l4/sys/utcb.h>
#include <l4/sys/err.h>

 
/*****************************************************************************
 *** IPC result checking
 *****************************************************************************/


enum l4_ipc_tcr_error_t
{
  L4_IPC_ERROR_MASK       = 0x1F, 
  L4_IPC_SND_ERR_MASK     = 0x01, 
 
  L4_IPC_ENOT_EXISTENT    = 0x04, 
  L4_IPC_RETIMEOUT        = 0x03, 
  L4_IPC_SETIMEOUT        = 0x02, 
  L4_IPC_RECANCELED       = 0x07, 
  L4_IPC_SECANCELED       = 0x06, 
  L4_IPC_REMAPFAILED      = 0x11, 
  L4_IPC_SEMAPFAILED      = 0x10, 
  L4_IPC_RESNDPFTO        = 0x0b, 
  L4_IPC_SESNDPFTO        = 0x0a, 
  L4_IPC_RERCVPFTO        = 0x0d, 
  L4_IPC_SERCVPFTO        = 0x0c, 
  L4_IPC_REABORTED        = 0x0f, 
  L4_IPC_SEABORTED        = 0x0e, 
  L4_IPC_REMSGCUT         = 0x09,

  L4_IPC_SEMSGCUT         = 0x08,

  L4_IPC_NO_REPLY_CAP     = 0x13,
};
 

L4_INLINE l4_umword_t
l4_ipc_error(l4_msgtag_t tag, l4_utcb_t *utcb) L4_NOTHROW;
 

L4_INLINE l4_ret_t
l4_error(l4_msgtag_t tag) L4_NOTHROW;
 
L4_INLINE l4_ret_t
l4_error_u(l4_msgtag_t tag, l4_utcb_t *utcb) L4_NOTHROW;
 
/*****************************************************************************
 *** IPC results
 *****************************************************************************/

L4_INLINE int l4_ipc_is_snd_error(l4_utcb_t *utcb) L4_NOTHROW;

L4_INLINE int l4_ipc_is_rcv_error(l4_utcb_t *utcb) L4_NOTHROW;

L4_INLINE int l4_ipc_error_code(l4_utcb_t *utcb) L4_NOTHROW;

L4_CONSTEXPR L4_INLINE l4_ret_t
l4_ipc_to_errno(unsigned long ipc_error_code) L4_NOTHROW;
 
 
/*****************************************************************************
 *** IPC calls
 *****************************************************************************/

L4_INLINE l4_msgtag_t
l4_ipc_send(l4_cap_idx_t dest, l4_utcb_t *utcb, l4_msgtag_t tag,
            l4_timeout_t timeout) L4_NOTHROW;
 

L4_INLINE l4_msgtag_t
l4_ipc_wait(l4_utcb_t *utcb, l4_umword_t *label,
            l4_timeout_t timeout) L4_NOTHROW;
 

L4_INLINE l4_msgtag_t
l4_ipc_receive(l4_cap_idx_t object, l4_utcb_t *utcb,
               l4_timeout_t timeout) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_ipc_call(l4_cap_idx_t object, l4_utcb_t *utcb, l4_msgtag_t tag,
            l4_timeout_t timeout) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_ipc_reply(l4_cap_idx_t reply_cap, l4_utcb_t *utcb, l4_msgtag_t tag,
             l4_timeout_t timeout) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_ipc_reply_and_wait(l4_utcb_t *utcb, l4_msgtag_t tag,
                      l4_umword_t *label, l4_timeout_t timeout) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_ipc_send_and_wait(l4_cap_idx_t dest, l4_utcb_t *utcb, l4_msgtag_t tag,
                     l4_umword_t *label, l4_timeout_t timeout) L4_NOTHROW;

 
#if 0
L4_INLINE l4_msgtag_t
l4_ipc_wait_next_period(l4_utcb_t *utcb,
                        l4_umword_t *label,
                        l4_timeout_t timeout);
 
#endif

L4_ALWAYS_INLINE l4_msgtag_t
l4_ipc(l4_cap_idx_t dest,
       l4_utcb_t *utcb,
       l4_umword_t flags,
       l4_umword_t slabel,
       l4_msgtag_t tag,
       l4_umword_t *rlabel,
       l4_timeout_t timeout) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_ipc_sleep(l4_timeout_t timeout) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_ipc_sleep_ms(l4_uint32_t ms) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_ipc_sleep_us(l4_uint64_t us) L4_NOTHROW;

L4_INLINE int
l4_sndfpage_add(l4_fpage_t const snd_fpage, unsigned long snd_base,
                l4_msgtag_t *tag) L4_NOTHROW;
 
/*
 * \internal
 * \ingroup l4_ipc_api
 */
L4_INLINE int
l4_sndfpage_add_u(l4_fpage_t const snd_fpage, unsigned long snd_base,
                  l4_msgtag_t *tag, l4_utcb_t *utcb) L4_NOTHROW;
 
 
/************************************************************************
 * Implementations
 **********************/
 
L4_CONSTEXPR L4_INLINE l4_ret_t
l4_ipc_to_errno(unsigned long ipc_error_code) L4_NOTHROW
{ return -(L4_EIPC_LO + ipc_error_code); }
 
L4_INLINE l4_msgtag_t
l4_ipc_call(l4_cap_idx_t object, l4_utcb_t *utcb, l4_msgtag_t tag,
            l4_timeout_t timeout) L4_NOTHROW
{
  return l4_ipc(object, utcb, L4_SYSF_CALL, 0, tag, 0, timeout);
}
 
L4_INLINE l4_msgtag_t
l4_ipc_reply(l4_cap_idx_t reply_cap, l4_utcb_t *utcb, l4_msgtag_t tag,
             l4_timeout_t timeout) L4_NOTHROW
{
  return l4_ipc(reply_cap, utcb, L4_SYSF_REPLY | L4_SYSF_SEND, 0, tag, 0,
                timeout);
}
 
L4_INLINE l4_msgtag_t
l4_ipc_reply_and_wait(l4_utcb_t *utcb, l4_msgtag_t tag,
                      l4_umword_t *label, l4_timeout_t timeout) L4_NOTHROW
{
  return l4_ipc(L4_INVALID_CAP, utcb, L4_SYSF_REPLY_AND_WAIT, 0, tag, label, timeout);
}
 
L4_INLINE l4_msgtag_t
l4_ipc_send_and_wait(l4_cap_idx_t dest, l4_utcb_t *utcb, l4_msgtag_t tag,
                     l4_umword_t *label, l4_timeout_t timeout) L4_NOTHROW
{
  return l4_ipc(dest, utcb, L4_SYSF_SEND_AND_WAIT, 0, tag, label, timeout);
}
 
L4_INLINE l4_msgtag_t
l4_ipc_send(l4_cap_idx_t dest, l4_utcb_t *utcb, l4_msgtag_t tag,
            l4_timeout_t timeout) L4_NOTHROW
{
  return l4_ipc(dest, utcb, L4_SYSF_SEND, 0, tag, 0, timeout);
}
 
L4_INLINE l4_msgtag_t
l4_ipc_wait(l4_utcb_t *utcb, l4_umword_t *label,
            l4_timeout_t timeout) L4_NOTHROW
{
  l4_msgtag_t t;
  t.raw = 0;
  return l4_ipc(L4_INVALID_CAP, utcb, L4_SYSF_WAIT, 0, t, label, timeout);
}
 
L4_INLINE l4_msgtag_t
l4_ipc_receive(l4_cap_idx_t object, l4_utcb_t *utcb,
               l4_timeout_t timeout) L4_NOTHROW
{
  l4_msgtag_t t;
  t.raw = 0;
  return l4_ipc(object, utcb, L4_SYSF_RECV, 0, t, 0, timeout);
}
 
L4_INLINE l4_msgtag_t
l4_ipc_sleep(l4_timeout_t timeout) L4_NOTHROW
{ return l4_ipc_receive(L4_INVALID_CAP, NULL, timeout); }
 
L4_INLINE l4_msgtag_t
l4_ipc_sleep_ms(l4_uint32_t ms) L4_NOTHROW
{
  l4_uint64_t us = ms * 1000ULL; // cannot overflow because ms < 2^32
  return l4_ipc_sleep(l4_timeout(L4_IPC_TIMEOUT_NEVER, l4_timeout_from_us(us)));
}
 
L4_INLINE l4_msgtag_t
l4_ipc_sleep_us(l4_uint64_t us) L4_NOTHROW
{
  return l4_ipc_sleep(l4_timeout(L4_IPC_TIMEOUT_NEVER,
                                 l4_timeout_from_us(us)));
}
 
L4_INLINE l4_umword_t
l4_ipc_error(l4_msgtag_t tag, l4_utcb_t *utcb) L4_NOTHROW
{
  if (L4_LIKELY(!l4_msgtag_has_error(tag)))
    return 0;
  return l4_utcb_tcr_u(utcb)->error & L4_IPC_ERROR_MASK;
}
 
L4_INLINE l4_ret_t
l4_error_u(l4_msgtag_t tag, l4_utcb_t *u) L4_NOTHROW
{
  if (L4_UNLIKELY(l4_msgtag_has_error(tag)))
    return l4_ipc_to_errno(l4_utcb_tcr_u(u)->error & L4_IPC_ERROR_MASK);
 
  return l4_msgtag_label(tag);
}
 
L4_INLINE l4_ret_t
l4_error(l4_msgtag_t tag) L4_NOTHROW
{
  return l4_error_u(tag, l4_utcb());
}
 
 
L4_INLINE int l4_ipc_is_snd_error(l4_utcb_t *u) L4_NOTHROW
{ return (l4_utcb_tcr_u(u)->error & 1) == 0; }
 
L4_INLINE int l4_ipc_is_rcv_error(l4_utcb_t *u) L4_NOTHROW
{ return l4_utcb_tcr_u(u)->error & 1; }
 
L4_INLINE int l4_ipc_error_code(l4_utcb_t *u) L4_NOTHROW
{ return l4_utcb_tcr_u(u)->error & L4_IPC_ERROR_MASK; }
 
 
/*
 * \internal
 * \ingroup l4_ipc_api
 */
L4_INLINE int
l4_sndfpage_add_u(l4_fpage_t const snd_fpage, unsigned long snd_base,
                  l4_msgtag_t *tag, l4_utcb_t *utcb) L4_NOTHROW
{
  l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
  int i = l4_msgtag_words(*tag) + 2 * l4_msgtag_items(*tag);
 
  if (i >= L4_UTCB_GENERIC_DATA_SIZE - 1)
    return -L4_ENOMEM;
 
  v->mr[i]     = snd_base | L4_ITEM_MAP | L4_ITEM_CONT;
  v->mr[i + 1] = snd_fpage.raw;
 
  *tag = l4_msgtag(l4_msgtag_label(*tag), l4_msgtag_words(*tag),
                   l4_msgtag_items(*tag) + 1, l4_msgtag_flags(*tag));
  return 0;
}
 
L4_INLINE int
l4_sndfpage_add(l4_fpage_t const snd_fpage, unsigned long snd_base,
                l4_msgtag_t *tag) L4_NOTHROW
{
  return l4_sndfpage_add_u(snd_fpage, snd_base, tag, l4_utcb());
}
 
#include <l4/sys/arch/ipc.h>
 
#endif /* ! __L4SYS__INCLUDE__L4API_FIASCO__IPC_H__ */