source: mainline/kernel/generic/include/ipc/ipc.h@ 98cb5e0d

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

Return IPC_CALLID_* in call data instead of callid

Callid will be replaced by capability handles soon so the API needs
to be cleanup up and any flags passed together with callid must be
passed using some other way.
  • Property mode set to 100644
File size: 5.6 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#include <mm/slab.h>
45#include <cap/cap.h>
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 phone {
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 kobject_t *kobject;
72} phone_t;
73
74typedef struct answerbox {
75 IRQ_SPINLOCK_DECLARE(lock);
76
77 /** Answerbox is active until it enters cleanup. */
78 bool active;
79
80 struct task *task;
81
82 waitq_t wq;
83
84 /** Phones connected to this answerbox. */
85 list_t connected_phones;
86 /** Received calls. */
87 list_t calls;
88 list_t dispatched_calls; /* Should be hash table in the future */
89
90 /** Answered calls. */
91 list_t answers;
92
93 IRQ_SPINLOCK_DECLARE(irq_lock);
94
95 /** Notifications from IRQ handlers. */
96 list_t irq_notifs;
97} answerbox_t;
98
99typedef struct {
100 sysarg_t args[IPC_CALL_LEN];
101 /**
102 * Task which made or forwarded the call with IPC_FF_ROUTE_FROM_ME,
103 * or the task which answered the call.
104 */
105 task_id_t task_id;
106 /** Phone which made or last masqueraded this call. */
107 phone_t *phone;
108 /** Flags */
109 unsigned flags;
110 /** User-defined label */
111 sysarg_t label;
112} ipc_data_t;
113
114typedef struct {
115 kobject_t *kobject;
116
117 /**
118 * Task link.
119 * Valid only when the call is not forgotten.
120 * Protected by the task's active_calls_lock.
121 */
122 link_t ta_link;
123
124 /** Answerbox link. */
125 link_t ab_link;
126
127 unsigned int flags;
128
129 /** Protects the forget member. */
130 SPINLOCK_DECLARE(forget_lock);
131
132 /**
133 * True if the caller 'forgot' this call and donated it to the callee.
134 * Forgotten calls are discarded upon answering (the answer is not
135 * delivered) and answered calls cannot be forgotten. Forgotten calls
136 * also do not figure on the task's active call list.
137 *
138 * We keep this separate from the flags so that it is not necessary
139 * to take a lock when accessing them.
140 */
141 bool forget;
142
143 /** True if the call is in the active list. */
144 bool active;
145
146 /**
147 * Identification of the caller.
148 * Valid only when the call is not forgotten.
149 */
150 struct task *sender;
151
152 /*
153 * Answerbox that will receive the answer.
154 * This will most of the times be the sender's answerbox,
155 * but we allow for useful exceptions.
156 */
157 answerbox_t *callerbox;
158
159 /** Phone which was used to send the call. */
160 phone_t *caller_phone;
161
162 /** Private data to internal IPC. */
163 sysarg_t priv;
164
165 /** Data passed from/to userspace. */
166 ipc_data_t data;
167
168 /** Method as it was sent in the request. */
169 sysarg_t request_method;
170
171 /** Buffer for IPC_M_DATA_WRITE and IPC_M_DATA_READ. */
172 uint8_t *buffer;
173} call_t;
174
175extern slab_cache_t *phone_slab;
176
177extern answerbox_t *ipc_phone_0;
178
179extern void ipc_init(void);
180
181extern call_t *ipc_call_alloc(unsigned int);
182extern void ipc_call_free(call_t *);
183extern void ipc_call_hold(call_t *);
184extern void ipc_call_release(call_t *);
185
186extern int ipc_call_sync(phone_t *, call_t *);
187extern int ipc_call(phone_t *, call_t *);
188extern call_t *ipc_wait_for_call(answerbox_t *, uint32_t, unsigned int);
189extern int ipc_forward(call_t *, phone_t *, answerbox_t *, unsigned int);
190extern void ipc_answer(answerbox_t *, call_t *);
191extern void _ipc_answer_free_call(call_t *, bool);
192
193extern void ipc_phone_init(phone_t *, struct task *);
194extern bool ipc_phone_connect(phone_t *, answerbox_t *);
195extern int ipc_phone_hangup(phone_t *);
196
197extern void ipc_answerbox_init(answerbox_t *, struct task *);
198
199extern void ipc_cleanup(void);
200extern void ipc_backsend_err(phone_t *, call_t *, sysarg_t);
201extern void ipc_answerbox_slam_phones(answerbox_t *, bool);
202extern void ipc_cleanup_call_list(answerbox_t *, list_t *);
203
204extern void ipc_print_task(task_id_t);
205
206#endif
207
208/** @}
209 */
Note: See TracBrowser for help on using the repository browser.