---

ipc.h

Go to the documentation of this file.

#ifndef __L4SYS__INCLUDE__L4API_FIASCO__IPC_H__
#define __L4SYS__INCLUDE__L4API_FIASCO__IPC_H__

#include <l4/sys/types.h>

#define L4_IPC_NIL_DESCRIPTOR   (~0UL)

#define L4_IPC_SHORT_MSG        0

#define L4_IPC_SHORT_FPAGE      ((void *)2)

#define L4_IPC_STRING_SHIFT     8    
#define L4_IPC_DWORD_SHIFT      13   
#define L4_IPC_FLAG_NEXT_PERIOD 0x10000 


#define L4_IPC_DOPE(dwords, strings) \
( (l4_msgdope_t) {md: {0, 0, 0, 0, 0, 0, strings, dwords }})


#define L4_IPC_MAPMSG(address, size)  \
     ((void *)(l4_umword_t)( ((address) & L4_PAGEMASK) | ((size) << 2) \
                             | (unsigned long)L4_IPC_SHORT_FPAGE))

#define L4_IPC_IOMAPMSG(port, iosize)  \
     ((void *)(l4_umword_t)( L4_IPC_IOMAPMSG_BASE | ((port) << 12) | ((iosize) << 2) \
                             | (unsigned long)L4_IPC_SHORT_FPAGE))

#define L4_IPC_CAPMAPMSG(taskno, order)  \
     ((void *)(l4_umword_t)( L4_IPC_CAPMAPMSG_BASE | ((taskno) << 12) | ((order) << 2) \
                             | (unsigned long)L4_IPC_SHORT_FPAGE))

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

#define L4_IPC_ERROR_MASK       0xF0    
#define L4_IPC_DECEIT_MASK      0x01    
#define L4_IPC_FPAGE_MASK       0x02    
#define L4_IPC_REDIRECT_MASK    0x04    
#define L4_IPC_SRC_MASK         0x08    
#define L4_IPC_SND_ERR_MASK     0x10    
#define L4_IPC_IS_ERROR(x)    (((x).msgdope) & L4_IPC_ERROR_MASK)

#define L4_IPC_MSG_DECEITED(x)    (((x).msgdope) & L4_IPC_DECEIT_MASK)

#define L4_IPC_MSG_REDIRECTED(x)  (((x).msgdope) & L4_IPC_REDIRECT_MASK)

#define L4_IPC_SRC_INSIDE(x)    (((x).msgdope) & L4_IPC_SRC_MASK)

#define L4_IPC_SND_ERROR(x)   (((x).msgdope) & L4_IPC_SND_ERR_MASK)


/*****************************************************************************
 *** IPC results
 *****************************************************************************/

#define L4_IPC_ERROR(x)       (((x).msgdope) & L4_IPC_ERROR_MASK)

#define L4_IPC_ENOT_EXISTENT  0x10   
#define L4_IPC_RETIMEOUT      0x20   
#define L4_IPC_SETIMEOUT      0x30   
#define L4_IPC_RECANCELED     0x40   
#define L4_IPC_SECANCELED     0x50   
#define L4_IPC_REMAPFAILED    0x60   
#define L4_IPC_SEMAPFAILED    0x70   
#define L4_IPC_RESNDPFTO      0x80   
#define L4_IPC_SESNDPFTO      0x90   
#define L4_IPC_RERCVPFTO      0xA0   
#define L4_IPC_SERCVPFTO      0xB0   
#define L4_IPC_REABORTED      0xC0   
#define L4_IPC_SEABORTED      0xD0   
#define L4_IPC_REMSGCUT       0xE0   
#define L4_IPC_SEMSGCUT       0xF0   
#define L4_IPC_SHORT_MSG_NODONATE ((void*)((unsigned)L4_IPC_SHORT_MSG|\
             L4_IPC_DECEIT_MASK))


/*****************************************************************************
 *** IPC parameters
 *****************************************************************************/

typedef struct {
  l4_fpage_t   fpage;      
  l4_msgdope_t size;       
  l4_msgdope_t send;       
  l4_umword_t  word[1];    
} l4_msg_t;


typedef struct {
  l4_threadid_t dest;         
  l4_threadid_t true_src;     
} l4_ipc_deceit_ids_t;


/*****************************************************************************
 *** IPC calls
 *****************************************************************************/

L4_INLINE int
l4_ipc_call_tag(l4_threadid_t dest,
                const void *snd_msg,
                l4_umword_t snd_dword0,
                l4_umword_t snd_dword1,
                l4_msgtag_t tag,
                void *rcv_msg,
                l4_umword_t *rcv_dword0,
                l4_umword_t *rcv_dword1,
                l4_timeout_t timeout,
                l4_msgdope_t *result,
                l4_msgtag_t *rtag);

L4_INLINE int
l4_ipc_call(l4_threadid_t dest,
            const void *snd_msg,
            l4_umword_t snd_dword0,
            l4_umword_t snd_dword1,
            void *rcv_msg,
            l4_umword_t *rcv_dword0,
            l4_umword_t *rcv_dword1,
            l4_timeout_t timeout,
            l4_msgdope_t *result);


L4_INLINE int
l4_ipc_reply_and_wait_tag(l4_threadid_t dest,
                          const void *snd_msg,
                          l4_umword_t snd_dword0,
                          l4_umword_t snd_dword1,
                          l4_msgtag_t tag,
                          l4_threadid_t *src,
                          void *rcv_msg,
                          l4_umword_t *rcv_dword0,
                          l4_umword_t *rcv_dword1,
                          l4_timeout_t timeout,
                          l4_msgdope_t *result,
                          l4_msgtag_t *rtag);

L4_INLINE int
l4_ipc_reply_and_wait(l4_threadid_t dest,
                      const void *snd_msg,
                      l4_umword_t snd_dword0,
                      l4_umword_t snd_dword1,
                      l4_threadid_t *src,
                      void *rcv_msg,
                      l4_umword_t *rcv_dword0,
                      l4_umword_t *rcv_dword1,
                      l4_timeout_t timeout,
                      l4_msgdope_t *result);


L4_INLINE int
l4_ipc_wait_next_period(l4_threadid_t *src,
      void *rcv_msg,
      l4_umword_t *rcv_dword0,
      l4_umword_t *rcv_dword1,
      l4_timeout_t timeout,
      l4_msgdope_t *result);


L4_INLINE int
l4_ipc_send_tag(l4_threadid_t dest,
                const void *snd_msg,
                l4_umword_t snd_dword0,
                l4_umword_t snd_dword1,
                l4_msgtag_t tag,
                l4_timeout_t timeout,
                l4_msgdope_t *result);

L4_INLINE int
l4_ipc_send(l4_threadid_t dest,
            const void *snd_msg,
            l4_umword_t snd_dword0,
            l4_umword_t snd_dword1,
            l4_timeout_t timeout,
            l4_msgdope_t *result);

L4_INLINE int
l4_ipc_wait_tag(l4_threadid_t *src,
                void *rcv_msg,
                l4_umword_t *rcv_dword0,
                l4_umword_t *rcv_dword1,
                l4_timeout_t timeout,
                l4_msgdope_t *result,
          l4_msgtag_t *tag);

L4_INLINE int
l4_ipc_wait(l4_threadid_t *src,
            void *rcv_msg,
            l4_umword_t *rcv_dword0,
            l4_umword_t *rcv_dword1,
            l4_timeout_t timeout,
            l4_msgdope_t *result);


L4_INLINE int
l4_ipc_receive_tag(l4_threadid_t src,
                   void *rcv_msg,
                   l4_umword_t *rcv_dword0,
                   l4_umword_t *rcv_dword1,
                   l4_timeout_t timeout,
                   l4_msgdope_t *result,
                   l4_msgtag_t *tag);
L4_INLINE int
l4_ipc_receive(l4_threadid_t src,
               void *rcv_msg,
               l4_umword_t *rcv_dword0,
               l4_umword_t *rcv_dword1,
               l4_timeout_t timeout,
               l4_msgdope_t *result);


L4_INLINE int
l4_ipc_sleep(l4_timeout_t timeout);

L4_INLINE int
l4_ipc_fpage_received(l4_msgdope_t msgdope);

L4_INLINE int
l4_ipc_is_fpage_granted(l4_fpage_t fp);

L4_INLINE int
l4_ipc_is_fpage_writable(l4_fpage_t fp);

L4_INLINE long
l4_is_rcv_map_descr(const void *msg);

L4_INLINE long
l4_is_long_rcv_descr(const void *msg);

L4_INLINE long
l4_is_long_snd_descr(const void *msg);

L4_INLINE const l4_msg_t *
l4_get_snd_msg_from_descr(const void *msg);

L4_INLINE l4_msg_t *
l4_get_rcv_msg_from_descr(void *msg);

/*
 * Internal defines used to build IPC parameters for the L4 kernel
 */

#define L4_IPC_DECEIT           1     
#define L4_IPC_OPEN_IPC         1     

#endif /* ! __L4SYS__INCLUDE__L4API_FIASCO__IPC_H__ */

---