source: mainline/kernel/generic/include/ipc/ipc.h@ bc117a5

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since bc117a5 was bc117a5, checked in by Jakub Jermar <jakub@…>, 9 years ago

Partially revert jakub@…

This changeset reintroduces portions of the synchronous IPC mechanism for
internal use by the kernel / user_backend. The synchronous IPC is not
exported to user space and is simpler than in its original form.
  • Property mode set to 100644
File size: 5.5 KB
Line 
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/** @addtogroup genericipc
30 * @{
31 */
32/** @file
33 */
34
35#ifndef KERN_IPC_H_
36#define KERN_IPC_H_
37
38#include <synch/spinlock.h>
39#include <synch/mutex.h>
40#include <synch/waitq.h>
41#include <abi/ipc/ipc.h>
42#include <abi/proc/task.h>
43#include <typedefs.h>
44
45#define IPC_MAX_PHONES 64
46
47struct answerbox;
48struct task;
49
50typedef enum {
51 /** Phone is free and can be allocated */
52 IPC_PHONE_FREE = 0,
53 /** Phone is connecting somewhere */
54 IPC_PHONE_CONNECTING,
55 /** Phone is connected */
56 IPC_PHONE_CONNECTED,
57 /** Phone is hung up, waiting for answers to come */
58 IPC_PHONE_HUNGUP,
59 /** Phone was hungup from server */
60 IPC_PHONE_SLAMMED
61} ipc_phone_state_t;
62
63/** Structure identifying phone (in TASK structure) */
64typedef struct {
65 mutex_t lock;
66 link_t link;
67 struct task *caller;
68 struct answerbox *callee;
69 ipc_phone_state_t state;
70 atomic_t active_calls;
71} phone_t;
72
73typedef struct answerbox {
74 IRQ_SPINLOCK_DECLARE(lock);
75
76 /** Answerbox is active until it enters cleanup. */
77 bool active;
78
79 struct task *task;
80
81 waitq_t wq;
82
83 /** Phones connected to this answerbox. */
84 list_t connected_phones;
85 /** Received calls. */
86 list_t calls;
87 list_t dispatched_calls; /* Should be hash table in the future */
88
89 /** Answered calls. */
90 list_t answers;
91
92 IRQ_SPINLOCK_DECLARE(irq_lock);
93
94 /** Notifications from IRQ handlers. */
95 list_t irq_notifs;
96 /** IRQs with notifications to this answerbox. */
97 list_t irq_list;
98} answerbox_t;
99
100typedef struct {
101 sysarg_t args[IPC_CALL_LEN];
102 /**
103 * Task which made or forwarded the call with IPC_FF_ROUTE_FROM_ME,
104 * or the task which answered the call.
105 */
106 task_id_t task_id;
107 /** Phone which made or last masqueraded this call. */
108 phone_t *phone;
109} ipc_data_t;
110
111typedef struct {
112 /**
113 * Task link.
114 * Valid only when the call is not forgotten.
115 * Protected by the task's active_calls_lock.
116 */
117 link_t ta_link;
118
119 atomic_t refcnt;
120
121 /** Answerbox link. */
122 link_t ab_link;
123
124 unsigned int flags;
125
126 /** Protects the forget member. */
127 SPINLOCK_DECLARE(forget_lock);
128
129 /**
130 * True if the caller 'forgot' this call and donated it to the callee.
131 * Forgotten calls are discarded upon answering (the answer is not
132 * delivered) and answered calls cannot be forgotten. Forgotten calls
133 * also do not figure on the task's active call list.
134 *
135 * We keep this separate from the flags so that it is not necessary
136 * to take a lock when accessing them.
137 */
138 bool forget;
139
140 /** True if the call is in the active list. */
141 bool active;
142
143 /**
144 * Identification of the caller.
145 * Valid only when the call is not forgotten.
146 */
147 struct task *sender;
148
149 /*
150 * Answerbox that will receive the answer.
151 * This will most of the times be the sender's answerbox,
152 * but we allow for useful exceptions.
153 */
154 answerbox_t *callerbox;
155
156 /** Phone which was used to send the call. */
157 phone_t *caller_phone;
158
159 /** Private data to internal IPC. */
160 sysarg_t priv;
161
162 /** Data passed from/to userspace. */
163 ipc_data_t data;
164
165 /** Method as it was sent in the request. */
166 sysarg_t request_method;
167
168 /** Buffer for IPC_M_DATA_WRITE and IPC_M_DATA_READ. */
169 uint8_t *buffer;
170} call_t;
171
172extern answerbox_t *ipc_phone_0;
173
174extern void ipc_init(void);
175
176extern call_t *ipc_call_alloc(unsigned int);
177extern void ipc_call_free(call_t *);
178extern void ipc_call_hold(call_t *);
179extern void ipc_call_release(call_t *);
180
181extern int ipc_call_sync(phone_t *, call_t *);
182extern int ipc_call(phone_t *, call_t *);
183extern call_t *ipc_wait_for_call(answerbox_t *, uint32_t, unsigned int);
184extern int ipc_forward(call_t *, phone_t *, answerbox_t *, unsigned int);
185extern void ipc_answer(answerbox_t *, call_t *);
186extern void _ipc_answer_free_call(call_t *, bool);
187
188extern void ipc_phone_init(phone_t *, struct task *);
189extern bool ipc_phone_connect(phone_t *, answerbox_t *);
190extern int ipc_phone_hangup(phone_t *);
191
192extern void ipc_answerbox_init(answerbox_t *, struct task *);
193
194extern void ipc_cleanup(void);
195extern void ipc_backsend_err(phone_t *, call_t *, sysarg_t);
196extern void ipc_answerbox_slam_phones(answerbox_t *, bool);
197extern void ipc_cleanup_call_list(answerbox_t *, list_t *);
198
199extern void ipc_print_task(task_id_t);
200
201#endif
202
203/** @}
204 */
Note: See TracBrowser for help on using the repository browser.