Subversion Repositories HelenOS-historic

Rev

Rev 965 | Rev 1027 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (C) 2006 Ondrej Palkovsky
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. #ifndef __IPC_H__
  30. #define __IPC_H__
  31.  
  32. /* Length of data being transfered with IPC call */
  33. /* - the uspace may not be able to utilize full length */
  34. #define IPC_CALL_LEN    4
  35.  
  36. /** Maximum active async calls per thread */
  37. #define IPC_MAX_ASYNC_CALLS  4
  38.  
  39. /* Flags for calls */
  40. #define IPC_CALL_ANSWERED      1 /**< This is answer to a call */
  41. #define IPC_CALL_STATIC_ALLOC  2 /**< This call will not be freed on error */
  42.  
  43. /* Flags for ipc_wait_for_call */
  44. #define IPC_WAIT_NONBLOCKING   1
  45.  
  46. /* Flags of callid */
  47. #define IPC_CALLID_ANSWERED  1
  48.  
  49. /* Return values from IPC_ASYNC */
  50. #define IPC_CALLRET_FATAL         -1
  51. #define IPC_CALLRET_TEMPORARY     -2
  52.  
  53.  
  54. /* Macros for manipulating calling data */
  55. #define IPC_SET_RETVAL(data, retval)   ((data)[0] = (retval))
  56. #define IPC_SET_METHOD(data, val)   ((data)[0] = (val))
  57. #define IPC_SET_ARG1(data, val)   ((data)[1] = (val))
  58. #define IPC_SET_ARG2(data, val)   ((data)[2] = (val))
  59. #define IPC_SET_ARG3(data, val)   ((data)[3] = (val))
  60.  
  61. #define IPC_GET_METHOD(data)           ((data)[0])
  62. #define IPC_GET_RETVAL(data)           ((data)[0])
  63.  
  64. #define IPC_GET_ARG1(data)              ((data)[1])
  65. #define IPC_GET_ARG2(data)              ((data)[2])
  66. #define IPC_GET_ARG3(data)              ((data)[3])
  67.  
  68. /* Well known phone descriptors */
  69. #define PHONE_NS              0
  70.  
  71. #ifdef KERNEL
  72.  
  73. #include <synch/mutex.h>
  74. #include <synch/condvar.h>
  75. #include <adt/list.h>
  76.  
  77. #define IPC_MAX_PHONES  16
  78.  
  79.  
  80. typedef struct answerbox answerbox_t;
  81.  
  82. typedef struct {
  83.     link_t list;
  84.     answerbox_t *callerbox;
  85.     int flags;
  86.     __native data[IPC_CALL_LEN];
  87. } call_t;
  88.  
  89. struct answerbox {
  90.     SPINLOCK_DECLARE(lock);
  91.  
  92.     mutex_t mutex;
  93.     condvar_t cv;
  94.  
  95.     link_t connected_phones; /**< Phones connected to this answerbox */
  96.     link_t calls;            /**< Received calls */
  97.     link_t dispatched_calls; /* Should be hash table in the future */
  98.  
  99.     link_t answers;          /**< Answered calls */
  100. };
  101.  
  102. typedef struct {
  103.     SPINLOCK_DECLARE(lock);
  104.     link_t list;
  105.     answerbox_t *callee;
  106. } phone_t;
  107.  
  108. extern void ipc_init(void);
  109. extern call_t * ipc_wait_for_call(answerbox_t *box, int flags);
  110. extern void ipc_answer(answerbox_t *box, call_t *request);
  111. extern void ipc_call(phone_t *phone, call_t *request);
  112. extern void ipc_call_sync(phone_t *phone, call_t *request);
  113. extern void ipc_phone_destroy(phone_t *phone);
  114. extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
  115. extern void ipc_call_free(call_t *call);
  116. extern call_t * ipc_call_alloc(void);
  117. extern void ipc_answerbox_init(answerbox_t *box);
  118. extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
  119. extern void ipc_call_init(call_t *call);
  120.  
  121. extern answerbox_t *ipc_phone_0;
  122.  
  123. #endif
  124.  
  125. #endif
  126.