Rev 1281 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 1281 | Rev 1329 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (C) 2006 Ondrej Palkovsky |
2 | * Copyright (C) 2006 Ondrej Palkovsky |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
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 |
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. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
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 |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
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 |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
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 |
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. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | #ifndef __IPC_H__ |
29 | #ifndef __IPC_H__ |
30 | #define __IPC_H__ |
30 | #define __IPC_H__ |
31 | 31 | ||
32 | /* Length of data being transfered with IPC call */ |
32 | /* Length of data being transfered with IPC call */ |
33 | /* - the uspace may not be able to utilize full length */ |
33 | /* - the uspace may not be able to utilize full length */ |
34 | #define IPC_CALL_LEN 4 |
34 | #define IPC_CALL_LEN 4 |
35 | 35 | ||
36 | /** Maximum active async calls per thread */ |
36 | /** Maximum active async calls per thread */ |
37 | #define IPC_MAX_ASYNC_CALLS 4 |
37 | #define IPC_MAX_ASYNC_CALLS 4 |
38 | 38 | ||
39 | /* Flags for calls */ |
39 | /* Flags for calls */ |
40 | #define IPC_CALL_ANSWERED (1<<0) /**< This is answer to a call */ |
40 | #define IPC_CALL_ANSWERED (1<<0) /**< This is answer to a call */ |
41 | #define IPC_CALL_STATIC_ALLOC (1<<1) /**< This call will not be freed on error */ |
41 | #define IPC_CALL_STATIC_ALLOC (1<<1) /**< This call will not be freed on error */ |
42 | #define IPC_CALL_DISCARD_ANSWER (1<<2) /**< Answer will not be passed to |
42 | #define IPC_CALL_DISCARD_ANSWER (1<<2) /**< Answer will not be passed to |
43 | * userspace, will be discarded */ |
43 | * userspace, will be discarded */ |
44 | #define IPC_CALL_FORWARDED (1<<3) /* Call was forwarded */ |
44 | #define IPC_CALL_FORWARDED (1<<3) /* Call was forwarded */ |
45 | #define IPC_CALL_CONN_ME_TO (1<<4) /* Identify connect_me_to */ |
45 | #define IPC_CALL_CONN_ME_TO (1<<4) /* Identify connect_me_to */ |
46 | #define IPC_CALL_NOTIF (1<<5) /* Interrupt notification */ |
46 | #define IPC_CALL_NOTIF (1<<5) /* Interrupt notification */ |
47 | 47 | ||
48 | /* Flags for ipc_wait_for_call */ |
48 | /* Flags for ipc_wait_for_call */ |
49 | #define IPC_WAIT_NONBLOCKING 1 |
49 | #define IPC_WAIT_NONBLOCKING 1 |
50 | 50 | ||
51 | /* Flags of callid (the addresses are aligned at least to 4, |
51 | /* Flags of callid (the addresses are aligned at least to 4, |
52 | * that is why we can use bottom 2 bits of the call address |
52 | * that is why we can use bottom 2 bits of the call address |
53 | */ |
53 | */ |
54 | #define IPC_CALLID_ANSWERED 1 /**< Type of this msg is 'answer' */ |
54 | #define IPC_CALLID_ANSWERED 1 /**< Type of this msg is 'answer' */ |
55 | #define IPC_CALLID_NOTIFICATION 2 /**< Type of this msg is 'notification' */ |
55 | #define IPC_CALLID_NOTIFICATION 2 /**< Type of this msg is 'notification' */ |
56 | 56 | ||
57 | /* Return values from IPC_ASYNC */ |
57 | /* Return values from IPC_ASYNC */ |
58 | #define IPC_CALLRET_FATAL -1 |
58 | #define IPC_CALLRET_FATAL -1 |
59 | #define IPC_CALLRET_TEMPORARY -2 |
59 | #define IPC_CALLRET_TEMPORARY -2 |
60 | 60 | ||
61 | 61 | ||
62 | /* Macros for manipulating calling data */ |
62 | /* Macros for manipulating calling data */ |
63 | #define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval)) |
63 | #define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval)) |
64 | #define IPC_SET_METHOD(data, val) ((data).args[0] = (val)) |
64 | #define IPC_SET_METHOD(data, val) ((data).args[0] = (val)) |
65 | #define IPC_SET_ARG1(data, val) ((data).args[1] = (val)) |
65 | #define IPC_SET_ARG1(data, val) ((data).args[1] = (val)) |
66 | #define IPC_SET_ARG2(data, val) ((data).args[2] = (val)) |
66 | #define IPC_SET_ARG2(data, val) ((data).args[2] = (val)) |
67 | #define IPC_SET_ARG3(data, val) ((data).args[3] = (val)) |
67 | #define IPC_SET_ARG3(data, val) ((data).args[3] = (val)) |
68 | 68 | ||
69 | #define IPC_GET_METHOD(data) ((data).args[0]) |
69 | #define IPC_GET_METHOD(data) ((data).args[0]) |
70 | #define IPC_GET_RETVAL(data) ((data).args[0]) |
70 | #define IPC_GET_RETVAL(data) ((data).args[0]) |
71 | 71 | ||
72 | #define IPC_GET_ARG1(data) ((data).args[1]) |
72 | #define IPC_GET_ARG1(data) ((data).args[1]) |
73 | #define IPC_GET_ARG2(data) ((data).args[2]) |
73 | #define IPC_GET_ARG2(data) ((data).args[2]) |
74 | #define IPC_GET_ARG3(data) ((data).args[3]) |
74 | #define IPC_GET_ARG3(data) ((data).args[3]) |
75 | 75 | ||
76 | /* Well known phone descriptors */ |
76 | /* Well known phone descriptors */ |
77 | #define PHONE_NS 0 |
77 | #define PHONE_NS 0 |
78 | 78 | ||
79 | /* System-specific methods - only through special syscalls |
79 | /* System-specific methods - only through special syscalls |
80 | * These methods have special behaviour |
80 | * These methods have special behaviour |
81 | */ |
81 | */ |
82 | /** Protocol for CONNECT - TO - ME |
82 | /** Protocol for CONNECT - TO - ME |
83 | * |
83 | * |
84 | * Calling process asks the callee to create a callback connection, |
84 | * Calling process asks the callee to create a callback connection, |
85 | * so that it can start initiating new messages. |
85 | * so that it can start initiating new messages. |
86 | * |
86 | * |
87 | * The protocol for negotiating is: |
87 | * The protocol for negotiating is: |
88 | * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME |
88 | * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME |
89 | * - sys_wait_for_call - upon receipt tries to allocate new phone |
89 | * - sys_wait_for_call - upon receipt tries to allocate new phone |
90 | * - if it fails, responds with ELIMIT |
90 | * - if it fails, responds with ELIMIT |
91 | * - passes call to userspace. If userspace |
91 | * - passes call to userspace. If userspace |
92 | * responds with error, phone is deallocated and |
92 | * responds with error, phone is deallocated and |
93 | * error is sent back to caller. Otherwise |
93 | * error is sent back to caller. Otherwise |
94 | * the call is accepted and the response is sent back. |
94 | * the call is accepted and the response is sent back. |
95 | * - the allocated phoneid is passed to userspace |
95 | * - the allocated phoneid is passed to userspace |
96 | * (on the receiving sid) as ARG3 of the call. |
96 | * (on the receiving sid) as ARG3 of the call. |
97 | * - the caller obtains taskid of the called thread |
97 | * - the caller obtains taskid of the called thread |
98 | */ |
98 | */ |
99 | #define IPC_M_CONNECT_TO_ME 1 |
99 | #define IPC_M_CONNECT_TO_ME 1 |
100 | /** Protocol for CONNECT - ME - TO |
100 | /** Protocol for CONNECT - ME - TO |
101 | * |
101 | * |
102 | * Calling process asks the callee to create for him a new connection. |
102 | * Calling process asks the callee to create for him a new connection. |
103 | * E.g. the caller wants a name server to connect him to print server. |
103 | * E.g. the caller wants a name server to connect him to print server. |
104 | * |
104 | * |
105 | * The protocol for negotiating is: |
105 | * The protocol for negotiating is: |
106 | * - sys_connect_me_to - send a synchronous message to name server |
106 | * - sys_connect_me_to - send a synchronous message to name server |
107 | * indicating that it wants to be connected to some |
107 | * indicating that it wants to be connected to some |
108 | * service |
108 | * service |
109 | * - arg1/2 are user specified, arg3 contains |
109 | * - arg1/2 are user specified, arg3 contains |
110 | * address of the phone that should be connected |
110 | * address of the phone that should be connected |
111 | * (TODO: it leaks to userspace) |
111 | * (TODO: it leaks to userspace) |
112 | * recepient - if ipc_answer == 0, then accept connection |
112 | * recepient - if ipc_answer == 0, then accept connection |
113 | * - otherwise connection refused |
113 | * - otherwise connection refused |
114 | * - recepient may forward message. Forwarding |
114 | * - recepient may forward message. Forwarding |
115 | * system message |
115 | * system message |
116 | * |
116 | * |
117 | */ |
117 | */ |
118 | #define IPC_M_CONNECT_ME_TO 2 |
118 | #define IPC_M_CONNECT_ME_TO 2 |
119 | /** This message is sent to answerbox when the phone |
119 | /** This message is sent to answerbox when the phone |
120 | * is hung up |
120 | * is hung up |
121 | */ |
121 | */ |
122 | #define IPC_M_PHONE_HUNGUP 3 |
122 | #define IPC_M_PHONE_HUNGUP 3 |
123 | /** Interrupt notification */ |
123 | /** Interrupt notification */ |
124 | #define IPC_M_INTERRUPT 4 |
124 | #define IPC_M_INTERRUPT 4 |
- | 125 | /** Send as_area over ipc |
|
- | 126 | * - ARG2 - src base address |
|
- | 127 | * - ARG3 - size of src as(filled automatically by kernel) |
|
- | 128 | * - on answer ARG1 - dst base adress |
|
- | 129 | */ |
|
- | 130 | #define IPC_M_AS_SEND 5 |
|
125 | 131 | ||
126 | 132 | ||
127 | /* Well-known methods */ |
133 | /* Well-known methods */ |
128 | #define IPC_M_LAST_SYSTEM 511 |
134 | #define IPC_M_LAST_SYSTEM 511 |
129 | #define IPC_M_PING 512 |
135 | #define IPC_M_PING 512 |
130 | /* User methods */ |
136 | /* User methods */ |
131 | #define FIRST_USER_METHOD 1024 |
137 | #define FIRST_USER_METHOD 1024 |
132 | 138 | ||
133 | #ifdef KERNEL |
139 | #ifdef KERNEL |
134 | 140 | ||
135 | #include <synch/mutex.h> |
141 | #include <synch/mutex.h> |
136 | #include <synch/condvar.h> |
142 | #include <synch/condvar.h> |
137 | #include <adt/list.h> |
143 | #include <adt/list.h> |
138 | 144 | ||
139 | #define IPC_MAX_PHONES 16 |
145 | #define IPC_MAX_PHONES 16 |
140 | 146 | ||
141 | typedef struct answerbox_s answerbox_t; |
147 | typedef struct answerbox_s answerbox_t; |
142 | typedef struct phone_s phone_t; |
148 | typedef struct phone_s phone_t; |
143 | typedef struct { |
149 | typedef struct { |
144 | __native args[IPC_CALL_LEN]; |
150 | __native args[IPC_CALL_LEN]; |
145 | phone_t *phone; |
151 | phone_t *phone; |
146 | }ipc_data_t; |
152 | }ipc_data_t; |
147 | 153 | ||
148 | struct answerbox_s { |
154 | struct answerbox_s { |
149 | SPINLOCK_DECLARE(lock); |
155 | SPINLOCK_DECLARE(lock); |
150 | 156 | ||
151 | task_t *task; |
157 | task_t *task; |
152 | 158 | ||
153 | waitq_t wq; |
159 | waitq_t wq; |
154 | 160 | ||
155 | link_t connected_phones; /**< Phones connected to this answerbox */ |
161 | link_t connected_phones; /**< Phones connected to this answerbox */ |
156 | link_t calls; /**< Received calls */ |
162 | link_t calls; /**< Received calls */ |
157 | link_t dispatched_calls; /* Should be hash table in the future */ |
163 | link_t dispatched_calls; /* Should be hash table in the future */ |
158 | 164 | ||
159 | link_t answers; /**< Answered calls */ |
165 | link_t answers; /**< Answered calls */ |
160 | 166 | ||
161 | SPINLOCK_DECLARE(irq_lock); |
167 | SPINLOCK_DECLARE(irq_lock); |
162 | link_t irq_notifs; /**< Notifications from IRQ handlers */ |
168 | link_t irq_notifs; /**< Notifications from IRQ handlers */ |
163 | }; |
169 | }; |
164 | 170 | ||
165 | typedef enum { |
171 | typedef enum { |
166 | IPC_BUSY_FREE = 0, |
172 | IPC_BUSY_FREE = 0, |
167 | IPC_BUSY_CONNECTING, |
173 | IPC_BUSY_CONNECTING, |
168 | IPC_BUSY_CONNECTED |
174 | IPC_BUSY_CONNECTED |
169 | } ipc_busy_t; |
175 | } ipc_busy_t; |
170 | 176 | ||
171 | struct phone_s { |
177 | struct phone_s { |
172 | SPINLOCK_DECLARE(lock); |
178 | SPINLOCK_DECLARE(lock); |
173 | link_t list; |
179 | link_t list; |
174 | answerbox_t *callee; |
180 | answerbox_t *callee; |
175 | ipc_busy_t busy; |
181 | ipc_busy_t busy; |
176 | atomic_t active_calls; |
182 | atomic_t active_calls; |
177 | }; |
183 | }; |
178 | 184 | ||
179 | typedef struct { |
185 | typedef struct { |
180 | link_t list; |
186 | link_t list; |
181 | 187 | ||
182 | int flags; |
188 | int flags; |
183 | 189 | ||
184 | /* Identification of the caller */ |
190 | /* Identification of the caller */ |
185 | task_t *sender; |
191 | task_t *sender; |
186 | /* The caller box is different from sender->answerbox |
192 | /* The caller box is different from sender->answerbox |
187 | * for synchronous calls |
193 | * for synchronous calls |
188 | */ |
194 | */ |
189 | answerbox_t *callerbox; |
195 | answerbox_t *callerbox; |
190 | 196 | ||
191 | __native private; /**< Private data to internal IPC */ |
197 | __native private; /**< Private data to internal IPC */ |
192 | 198 | ||
193 | ipc_data_t data; /**< Data passed from/to userspace */ |
199 | ipc_data_t data; /**< Data passed from/to userspace */ |
194 | }call_t; |
200 | }call_t; |
195 | 201 | ||
196 | extern void ipc_init(void); |
202 | extern void ipc_init(void); |
197 | extern call_t * ipc_wait_for_call(answerbox_t *box, int flags); |
203 | extern call_t * ipc_wait_for_call(answerbox_t *box, int flags); |
198 | extern void ipc_answer(answerbox_t *box, call_t *request); |
204 | extern void ipc_answer(answerbox_t *box, call_t *request); |
199 | extern int ipc_call(phone_t *phone, call_t *call); |
205 | extern int ipc_call(phone_t *phone, call_t *call); |
200 | extern void ipc_call_sync(phone_t *phone, call_t *request); |
206 | extern void ipc_call_sync(phone_t *phone, call_t *request); |
201 | extern void ipc_phone_init(phone_t *phone); |
207 | extern void ipc_phone_init(phone_t *phone); |
202 | extern void ipc_phone_connect(phone_t *phone, answerbox_t *box); |
208 | extern void ipc_phone_connect(phone_t *phone, answerbox_t *box); |
203 | extern void ipc_call_free(call_t *call); |
209 | extern void ipc_call_free(call_t *call); |
204 | extern call_t * ipc_call_alloc(int flags); |
210 | extern call_t * ipc_call_alloc(int flags); |
205 | extern void ipc_answerbox_init(answerbox_t *box); |
211 | extern void ipc_answerbox_init(answerbox_t *box); |
206 | extern void ipc_call_static_init(call_t *call); |
212 | extern void ipc_call_static_init(call_t *call); |
207 | extern void task_print_list(void); |
213 | extern void task_print_list(void); |
208 | extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox); |
214 | extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox); |
209 | extern void ipc_cleanup(task_t *task); |
215 | extern void ipc_cleanup(task_t *task); |
210 | extern int ipc_phone_hangup(phone_t *phone); |
216 | extern int ipc_phone_hangup(phone_t *phone); |
211 | extern void ipc_backsend_err(phone_t *phone, call_t *call, __native err); |
217 | extern void ipc_backsend_err(phone_t *phone, call_t *call, __native err); |
212 | 218 | ||
213 | 219 | ||
214 | extern answerbox_t *ipc_phone_0; |
220 | extern answerbox_t *ipc_phone_0; |
215 | 221 | ||
216 | #endif |
222 | #endif |
217 | 223 | ||
218 | #endif |
224 | #endif |
219 | 225 |