source: mainline/kernel/generic/include/ipc/ipc.h@ 05ffb41

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

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