Rev 2934 | Rev 3054 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
| Rev 2934 | Rev 3020 | ||
|---|---|---|---|
| 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 | /** @addtogroup genericipc |
29 | /** @addtogroup genericipc |
| 30 | * @{ |
30 | * @{ |
| 31 | */ |
31 | */ |
| 32 | /** @file |
32 | /** @file |
| 33 | */ |
33 | */ |
| 34 | 34 | ||
| 35 | #include <arch.h> |
35 | #include <arch.h> |
| 36 | #include <proc/task.h> |
36 | #include <proc/task.h> |
| 37 | #include <proc/thread.h> |
37 | #include <proc/thread.h> |
| 38 | #include <errno.h> |
38 | #include <errno.h> |
| 39 | #include <memstr.h> |
39 | #include <memstr.h> |
| 40 | #include <debug.h> |
40 | #include <debug.h> |
| 41 | #include <ipc/ipc.h> |
41 | #include <ipc/ipc.h> |
| 42 | #include <ipc/sysipc.h> |
42 | #include <ipc/sysipc.h> |
| 43 | #include <ipc/irq.h> |
43 | #include <ipc/irq.h> |
| 44 | #include <ipc/ipcrsc.h> |
44 | #include <ipc/ipcrsc.h> |
| 45 | #include <arch/interrupt.h> |
45 | #include <arch/interrupt.h> |
| 46 | #include <print.h> |
46 | #include <print.h> |
| 47 | #include <syscall/copy.h> |
47 | #include <syscall/copy.h> |
| 48 | #include <security/cap.h> |
48 | #include <security/cap.h> |
| 49 | #include <mm/as.h> |
49 | #include <mm/as.h> |
| 50 | #include <print.h> |
50 | #include <print.h> |
| 51 | 51 | ||
| 52 | /** |
52 | /** |
| 53 | * Maximum buffer size allowed for IPC_M_DATA_WRITE and IPC_M_DATA_READ |
53 | * Maximum buffer size allowed for IPC_M_DATA_WRITE and IPC_M_DATA_READ |
| 54 | * requests. |
54 | * requests. |
| 55 | */ |
55 | */ |
| 56 | #define DATA_XFER_LIMIT (64 * 1024) |
56 | #define DATA_XFER_LIMIT (64 * 1024) |
| 57 | 57 | ||
| 58 | #define GET_CHECK_PHONE(phone, phoneid, err) \ |
58 | #define GET_CHECK_PHONE(phone, phoneid, err) \ |
| 59 | { \ |
59 | { \ |
| 60 | if (phoneid > IPC_MAX_PHONES) { \ |
60 | if (phoneid > IPC_MAX_PHONES) { \ |
| 61 | err; \ |
61 | err; \ |
| 62 | } \ |
62 | } \ |
| 63 | phone = &TASK->phones[phoneid]; \ |
63 | phone = &TASK->phones[phoneid]; \ |
| 64 | } |
64 | } |
| 65 | 65 | ||
| 66 | #define STRUCT_TO_USPACE(dst, src) copy_to_uspace(dst, src, sizeof(*(src))) |
66 | #define STRUCT_TO_USPACE(dst, src) copy_to_uspace(dst, src, sizeof(*(src))) |
| 67 | 67 | ||
| 68 | /** Decide if the method is a system method. |
68 | /** Decide if the method is a system method. |
| 69 | * |
69 | * |
| 70 | * @param method Method to be decided. |
70 | * @param method Method to be decided. |
| 71 | * |
71 | * |
| 72 | * @return Return 1 if the method is a system method. |
72 | * @return Return 1 if the method is a system method. |
| 73 | * Otherwise return 0. |
73 | * Otherwise return 0. |
| 74 | */ |
74 | */ |
| 75 | static inline int method_is_system(unative_t method) |
75 | static inline int method_is_system(unative_t method) |
| 76 | { |
76 | { |
| 77 | if (method <= IPC_M_LAST_SYSTEM) |
77 | if (method <= IPC_M_LAST_SYSTEM) |
| 78 | return 1; |
78 | return 1; |
| 79 | return 0; |
79 | return 0; |
| 80 | } |
80 | } |
| 81 | 81 | ||
| 82 | /** Decide if the message with this method is forwardable. |
82 | /** Decide if the message with this method is forwardable. |
| 83 | * |
83 | * |
| 84 | * - some system messages may be forwarded, for some of them |
84 | * - some system messages may be forwarded, for some of them |
| 85 | * it is useless |
85 | * it is useless |
| 86 | * |
86 | * |
| 87 | * @param method Method to be decided. |
87 | * @param method Method to be decided. |
| 88 | * |
88 | * |
| 89 | * @return Return 1 if the method is forwardable. |
89 | * @return Return 1 if the method is forwardable. |
| 90 | * Otherwise return 0. |
90 | * Otherwise return 0. |
| 91 | */ |
91 | */ |
| 92 | static inline int method_is_forwardable(unative_t method) |
92 | static inline int method_is_forwardable(unative_t method) |
| 93 | { |
93 | { |
| 94 | switch (method) { |
94 | switch (method) { |
| 95 | case IPC_M_PHONE_HUNGUP: |
95 | case IPC_M_PHONE_HUNGUP: |
| 96 | /* This message is meant only for the original recipient. */ |
96 | /* This message is meant only for the original recipient. */ |
| 97 | return 0; |
97 | return 0; |
| 98 | default: |
98 | default: |
| 99 | return 1; |
99 | return 1; |
| 100 | } |
100 | } |
| 101 | } |
101 | } |
| 102 | 102 | ||
| 103 | /** Decide if the message with this method is immutable on forward. |
103 | /** Decide if the message with this method is immutable on forward. |
| 104 | * |
104 | * |
| 105 | * - some system messages may be forwarded but their content cannot be altered |
105 | * - some system messages may be forwarded but their content cannot be altered |
| 106 | * |
106 | * |
| 107 | * @param method Method to be decided. |
107 | * @param method Method to be decided. |
| 108 | * |
108 | * |
| 109 | * @return Return 1 if the method is immutable on forward. |
109 | * @return Return 1 if the method is immutable on forward. |
| 110 | * Otherwise return 0. |
110 | * Otherwise return 0. |
| 111 | */ |
111 | */ |
| 112 | static inline int method_is_immutable(unative_t method) |
112 | static inline int method_is_immutable(unative_t method) |
| 113 | { |
113 | { |
| 114 | switch (method) { |
114 | switch (method) { |
| 115 | case IPC_M_SHARE_OUT: |
115 | case IPC_M_SHARE_OUT: |
| 116 | case IPC_M_SHARE_IN: |
116 | case IPC_M_SHARE_IN: |
| 117 | case IPC_M_DATA_WRITE: |
117 | case IPC_M_DATA_WRITE: |
| 118 | case IPC_M_DATA_READ: |
118 | case IPC_M_DATA_READ: |
| 119 | return 1; |
119 | return 1; |
| 120 | break; |
120 | break; |
| 121 | default: |
121 | default: |
| 122 | return 0; |
122 | return 0; |
| 123 | } |
123 | } |
| 124 | } |
124 | } |
| 125 | 125 | ||
| 126 | 126 | ||
| 127 | /*********************************************************************** |
127 | /*********************************************************************** |
| 128 | * Functions that preprocess answer before sending it to the recepient. |
128 | * Functions that preprocess answer before sending it to the recepient. |
| 129 | ***********************************************************************/ |
129 | ***********************************************************************/ |
| 130 | 130 | ||
| 131 | /** Decide if the caller (e.g. ipc_answer()) should save the old call contents |
131 | /** Decide if the caller (e.g. ipc_answer()) should save the old call contents |
| 132 | * for answer_preprocess(). |
132 | * for answer_preprocess(). |
| 133 | * |
133 | * |
| 134 | * @param call Call structure to be decided. |
134 | * @param call Call structure to be decided. |
| 135 | * |
135 | * |
| 136 | * @return Return 1 if the old call contents should be saved. |
136 | * @return Return 1 if the old call contents should be saved. |
| 137 | * Return 0 otherwise. |
137 | * Return 0 otherwise. |
| 138 | */ |
138 | */ |
| 139 | static inline int answer_need_old(call_t *call) |
139 | static inline int answer_need_old(call_t *call) |
| 140 | { |
140 | { |
| 141 | switch (IPC_GET_METHOD(call->data)) { |
141 | switch (IPC_GET_METHOD(call->data)) { |
| 142 | case IPC_M_CONNECT_TO_ME: |
142 | case IPC_M_CONNECT_TO_ME: |
| 143 | case IPC_M_CONNECT_ME_TO: |
143 | case IPC_M_CONNECT_ME_TO: |
| 144 | case IPC_M_SHARE_OUT: |
144 | case IPC_M_SHARE_OUT: |
| 145 | case IPC_M_SHARE_IN: |
145 | case IPC_M_SHARE_IN: |
| 146 | case IPC_M_DATA_WRITE: |
146 | case IPC_M_DATA_WRITE: |
| 147 | case IPC_M_DATA_READ: |
147 | case IPC_M_DATA_READ: |
| 148 | return 1; |
148 | return 1; |
| 149 | default: |
149 | default: |
| 150 | return 0; |
150 | return 0; |
| 151 | } |
151 | } |
| 152 | } |
152 | } |
| 153 | 153 | ||
| 154 | /** Interpret process answer as control information. |
154 | /** Interpret process answer as control information. |
| 155 | * |
155 | * |
| 156 | * This function is called directly after sys_ipc_answer(). |
156 | * This function is called directly after sys_ipc_answer(). |
| 157 | * |
157 | * |
| 158 | * @param answer Call structure with the answer. |
158 | * @param answer Call structure with the answer. |
| 159 | * @param olddata Saved data of the request. |
159 | * @param olddata Saved data of the request. |
| 160 | * |
160 | * |
| 161 | * @return Return 0 on success or an error code. |
161 | * @return Return 0 on success or an error code. |
| 162 | */ |
162 | */ |
| 163 | static inline int answer_preprocess(call_t *answer, ipc_data_t *olddata) |
163 | static inline int answer_preprocess(call_t *answer, ipc_data_t *olddata) |
| 164 | { |
164 | { |
| 165 | int phoneid; |
165 | int phoneid; |
| 166 | 166 | ||
| 167 | if ((native_t) IPC_GET_RETVAL(answer->data) == EHANGUP) { |
167 | if ((native_t) IPC_GET_RETVAL(answer->data) == EHANGUP) { |
| 168 | /* In case of forward, hangup the forwared phone, |
168 | /* In case of forward, hangup the forwared phone, |
| 169 | * not the originator |
169 | * not the originator |
| 170 | */ |
170 | */ |
| 171 | spinlock_lock(&answer->data.phone->lock); |
171 | mutex_lock(&answer->data.phone->lock); |
| 172 | spinlock_lock(&TASK->answerbox.lock); |
172 | spinlock_lock(&TASK->answerbox.lock); |
| 173 | if (answer->data.phone->state == IPC_PHONE_CONNECTED) { |
173 | if (answer->data.phone->state == IPC_PHONE_CONNECTED) { |
| 174 | list_remove(&answer->data.phone->link); |
174 | list_remove(&answer->data.phone->link); |
| 175 | answer->data.phone->state = IPC_PHONE_SLAMMED; |
175 | answer->data.phone->state = IPC_PHONE_SLAMMED; |
| 176 | } |
176 | } |
| 177 | spinlock_unlock(&TASK->answerbox.lock); |
177 | spinlock_unlock(&TASK->answerbox.lock); |
| 178 | spinlock_unlock(&answer->data.phone->lock); |
178 | mutex_unlock(&answer->data.phone->lock); |
| 179 | } |
179 | } |
| 180 | 180 | ||
| 181 | if (!olddata) |
181 | if (!olddata) |
| 182 | return 0; |
182 | return 0; |
| 183 | 183 | ||
| 184 | if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) { |
184 | if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) { |
| 185 | phoneid = IPC_GET_ARG5(*olddata); |
185 | phoneid = IPC_GET_ARG5(*olddata); |
| 186 | if (IPC_GET_RETVAL(answer->data)) { |
186 | if (IPC_GET_RETVAL(answer->data)) { |
| 187 | /* The connection was not accepted */ |
187 | /* The connection was not accepted */ |
| 188 | phone_dealloc(phoneid); |
188 | phone_dealloc(phoneid); |
| 189 | } else { |
189 | } else { |
| 190 | /* The connection was accepted */ |
190 | /* The connection was accepted */ |
| 191 | phone_connect(phoneid, &answer->sender->answerbox); |
191 | phone_connect(phoneid, &answer->sender->answerbox); |
| 192 | /* Set 'phone hash' as arg5 of response */ |
192 | /* Set 'phone hash' as arg5 of response */ |
| 193 | IPC_SET_ARG5(answer->data, |
193 | IPC_SET_ARG5(answer->data, |
| 194 | (unative_t) &TASK->phones[phoneid]); |
194 | (unative_t) &TASK->phones[phoneid]); |
| 195 | } |
195 | } |
| 196 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) { |
196 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) { |
| 197 | /* If the users accepted call, connect */ |
197 | /* If the users accepted call, connect */ |
| 198 | if (!IPC_GET_RETVAL(answer->data)) { |
198 | if (!IPC_GET_RETVAL(answer->data)) { |
| 199 | ipc_phone_connect((phone_t *) IPC_GET_ARG5(*olddata), |
199 | ipc_phone_connect((phone_t *) IPC_GET_ARG5(*olddata), |
| 200 | &TASK->answerbox); |
200 | &TASK->answerbox); |
| 201 | } |
201 | } |
| 202 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_OUT) { |
202 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_OUT) { |
| 203 | if (!IPC_GET_RETVAL(answer->data)) { |
203 | if (!IPC_GET_RETVAL(answer->data)) { |
| 204 | /* Accepted, handle as_area receipt */ |
204 | /* Accepted, handle as_area receipt */ |
| 205 | ipl_t ipl; |
205 | ipl_t ipl; |
| 206 | int rc; |
206 | int rc; |
| 207 | as_t *as; |
207 | as_t *as; |
| 208 | 208 | ||
| 209 | ipl = interrupts_disable(); |
209 | ipl = interrupts_disable(); |
| 210 | spinlock_lock(&answer->sender->lock); |
210 | spinlock_lock(&answer->sender->lock); |
| 211 | as = answer->sender->as; |
211 | as = answer->sender->as; |
| 212 | spinlock_unlock(&answer->sender->lock); |
212 | spinlock_unlock(&answer->sender->lock); |
| 213 | interrupts_restore(ipl); |
213 | interrupts_restore(ipl); |
| 214 | 214 | ||
| 215 | rc = as_area_share(as, IPC_GET_ARG1(*olddata), |
215 | rc = as_area_share(as, IPC_GET_ARG1(*olddata), |
| 216 | IPC_GET_ARG2(*olddata), AS, |
216 | IPC_GET_ARG2(*olddata), AS, |
| 217 | IPC_GET_ARG1(answer->data), IPC_GET_ARG3(*olddata)); |
217 | IPC_GET_ARG1(answer->data), IPC_GET_ARG3(*olddata)); |
| 218 | IPC_SET_RETVAL(answer->data, rc); |
218 | IPC_SET_RETVAL(answer->data, rc); |
| 219 | return rc; |
219 | return rc; |
| 220 | } |
220 | } |
| 221 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_IN) { |
221 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_IN) { |
| 222 | if (!IPC_GET_RETVAL(answer->data)) { |
222 | if (!IPC_GET_RETVAL(answer->data)) { |
| 223 | ipl_t ipl; |
223 | ipl_t ipl; |
| 224 | as_t *as; |
224 | as_t *as; |
| 225 | int rc; |
225 | int rc; |
| 226 | 226 | ||
| 227 | ipl = interrupts_disable(); |
227 | ipl = interrupts_disable(); |
| 228 | spinlock_lock(&answer->sender->lock); |
228 | spinlock_lock(&answer->sender->lock); |
| 229 | as = answer->sender->as; |
229 | as = answer->sender->as; |
| 230 | spinlock_unlock(&answer->sender->lock); |
230 | spinlock_unlock(&answer->sender->lock); |
| 231 | interrupts_restore(ipl); |
231 | interrupts_restore(ipl); |
| 232 | 232 | ||
| 233 | rc = as_area_share(AS, IPC_GET_ARG1(answer->data), |
233 | rc = as_area_share(AS, IPC_GET_ARG1(answer->data), |
| 234 | IPC_GET_ARG2(*olddata), as, IPC_GET_ARG1(*olddata), |
234 | IPC_GET_ARG2(*olddata), as, IPC_GET_ARG1(*olddata), |
| 235 | IPC_GET_ARG2(answer->data)); |
235 | IPC_GET_ARG2(answer->data)); |
| 236 | IPC_SET_RETVAL(answer->data, rc); |
236 | IPC_SET_RETVAL(answer->data, rc); |
| 237 | } |
237 | } |
| 238 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_READ) { |
238 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_READ) { |
| 239 | ASSERT(!answer->buffer); |
239 | ASSERT(!answer->buffer); |
| 240 | if (!IPC_GET_RETVAL(answer->data)) { |
240 | if (!IPC_GET_RETVAL(answer->data)) { |
| 241 | /* The recipient agreed to send data. */ |
241 | /* The recipient agreed to send data. */ |
| 242 | uintptr_t src = IPC_GET_ARG1(answer->data); |
242 | uintptr_t src = IPC_GET_ARG1(answer->data); |
| 243 | uintptr_t dst = IPC_GET_ARG1(*olddata); |
243 | uintptr_t dst = IPC_GET_ARG1(*olddata); |
| 244 | size_t max_size = IPC_GET_ARG2(*olddata); |
244 | size_t max_size = IPC_GET_ARG2(*olddata); |
| 245 | size_t size = IPC_GET_ARG2(answer->data); |
245 | size_t size = IPC_GET_ARG2(answer->data); |
| 246 | if (size && size <= max_size) { |
246 | if (size && size <= max_size) { |
| 247 | /* |
247 | /* |
| 248 | * Copy the destination VA so that this piece of |
248 | * Copy the destination VA so that this piece of |
| 249 | * information is not lost. |
249 | * information is not lost. |
| 250 | */ |
250 | */ |
| 251 | IPC_SET_ARG1(answer->data, dst); |
251 | IPC_SET_ARG1(answer->data, dst); |
| 252 | 252 | ||
| 253 | answer->buffer = malloc(size, 0); |
253 | answer->buffer = malloc(size, 0); |
| 254 | int rc = copy_from_uspace(answer->buffer, |
254 | int rc = copy_from_uspace(answer->buffer, |
| 255 | (void *) src, size); |
255 | (void *) src, size); |
| 256 | if (rc) { |
256 | if (rc) { |
| 257 | IPC_SET_RETVAL(answer->data, rc); |
257 | IPC_SET_RETVAL(answer->data, rc); |
| 258 | free(answer->buffer); |
258 | free(answer->buffer); |
| 259 | answer->buffer = NULL; |
259 | answer->buffer = NULL; |
| 260 | } |
260 | } |
| 261 | } else if (!size) { |
261 | } else if (!size) { |
| 262 | IPC_SET_RETVAL(answer->data, EOK); |
262 | IPC_SET_RETVAL(answer->data, EOK); |
| 263 | } else { |
263 | } else { |
| 264 | IPC_SET_RETVAL(answer->data, ELIMIT); |
264 | IPC_SET_RETVAL(answer->data, ELIMIT); |
| 265 | } |
265 | } |
| 266 | } |
266 | } |
| 267 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_WRITE) { |
267 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_WRITE) { |
| 268 | ASSERT(answer->buffer); |
268 | ASSERT(answer->buffer); |
| 269 | if (!IPC_GET_RETVAL(answer->data)) { |
269 | if (!IPC_GET_RETVAL(answer->data)) { |
| 270 | /* The recipient agreed to receive data. */ |
270 | /* The recipient agreed to receive data. */ |
| 271 | int rc; |
271 | int rc; |
| 272 | uintptr_t dst; |
272 | uintptr_t dst; |
| 273 | uintptr_t size; |
273 | uintptr_t size; |
| 274 | uintptr_t max_size; |
274 | uintptr_t max_size; |
| 275 | 275 | ||
| 276 | dst = IPC_GET_ARG1(answer->data); |
276 | dst = IPC_GET_ARG1(answer->data); |
| 277 | size = IPC_GET_ARG2(answer->data); |
277 | size = IPC_GET_ARG2(answer->data); |
| 278 | max_size = IPC_GET_ARG2(*olddata); |
278 | max_size = IPC_GET_ARG2(*olddata); |
| 279 | 279 | ||
| 280 | if (size <= max_size) { |
280 | if (size <= max_size) { |
| 281 | rc = copy_to_uspace((void *) dst, |
281 | rc = copy_to_uspace((void *) dst, |
| 282 | answer->buffer, size); |
282 | answer->buffer, size); |
| 283 | if (rc) |
283 | if (rc) |
| 284 | IPC_SET_RETVAL(answer->data, rc); |
284 | IPC_SET_RETVAL(answer->data, rc); |
| 285 | } else { |
285 | } else { |
| 286 | IPC_SET_RETVAL(answer->data, ELIMIT); |
286 | IPC_SET_RETVAL(answer->data, ELIMIT); |
| 287 | } |
287 | } |
| 288 | } |
288 | } |
| 289 | free(answer->buffer); |
289 | free(answer->buffer); |
| 290 | answer->buffer = NULL; |
290 | answer->buffer = NULL; |
| 291 | } |
291 | } |
| 292 | return 0; |
292 | return 0; |
| 293 | } |
293 | } |
| 294 | 294 | ||
| 295 | /** Called before the request is sent. |
295 | /** Called before the request is sent. |
| 296 | * |
296 | * |
| 297 | * @param call Call structure with the request. |
297 | * @param call Call structure with the request. |
| 298 | * |
298 | * |
| 299 | * @return Return 0 on success, ELIMIT or EPERM on error. |
299 | * @return Return 0 on success, ELIMIT or EPERM on error. |
| 300 | */ |
300 | */ |
| 301 | static int request_preprocess(call_t *call) |
301 | static int request_preprocess(call_t *call) |
| 302 | { |
302 | { |
| 303 | int newphid; |
303 | int newphid; |
| 304 | size_t size; |
304 | size_t size; |
| 305 | uintptr_t src; |
305 | uintptr_t src; |
| 306 | int rc; |
306 | int rc; |
| 307 | 307 | ||
| 308 | switch (IPC_GET_METHOD(call->data)) { |
308 | switch (IPC_GET_METHOD(call->data)) { |
| 309 | case IPC_M_CONNECT_ME_TO: |
309 | case IPC_M_CONNECT_ME_TO: |
| 310 | newphid = phone_alloc(); |
310 | newphid = phone_alloc(); |
| 311 | if (newphid < 0) |
311 | if (newphid < 0) |
| 312 | return ELIMIT; |
312 | return ELIMIT; |
| 313 | /* Set arg5 for server */ |
313 | /* Set arg5 for server */ |
| 314 | IPC_SET_ARG5(call->data, (unative_t) &TASK->phones[newphid]); |
314 | IPC_SET_ARG5(call->data, (unative_t) &TASK->phones[newphid]); |
| 315 | call->flags |= IPC_CALL_CONN_ME_TO; |
315 | call->flags |= IPC_CALL_CONN_ME_TO; |
| 316 | call->priv = newphid; |
316 | call->priv = newphid; |
| 317 | break; |
317 | break; |
| 318 | case IPC_M_SHARE_OUT: |
318 | case IPC_M_SHARE_OUT: |
| 319 | size = as_area_get_size(IPC_GET_ARG1(call->data)); |
319 | size = as_area_get_size(IPC_GET_ARG1(call->data)); |
| 320 | if (!size) |
320 | if (!size) |
| 321 | return EPERM; |
321 | return EPERM; |
| 322 | IPC_SET_ARG2(call->data, size); |
322 | IPC_SET_ARG2(call->data, size); |
| 323 | break; |
323 | break; |
| 324 | case IPC_M_DATA_READ: |
324 | case IPC_M_DATA_READ: |
| 325 | size = IPC_GET_ARG2(call->data); |
325 | size = IPC_GET_ARG2(call->data); |
| 326 | if ((size <= 0 || (size > DATA_XFER_LIMIT))) |
326 | if ((size <= 0 || (size > DATA_XFER_LIMIT))) |
| 327 | return ELIMIT; |
327 | return ELIMIT; |
| 328 | break; |
328 | break; |
| 329 | case IPC_M_DATA_WRITE: |
329 | case IPC_M_DATA_WRITE: |
| 330 | src = IPC_GET_ARG1(call->data); |
330 | src = IPC_GET_ARG1(call->data); |
| 331 | size = IPC_GET_ARG2(call->data); |
331 | size = IPC_GET_ARG2(call->data); |
| 332 | 332 | ||
| 333 | if ((size <= 0) || (size > DATA_XFER_LIMIT)) |
333 | if ((size <= 0) || (size > DATA_XFER_LIMIT)) |
| 334 | return ELIMIT; |
334 | return ELIMIT; |
| 335 | 335 | ||
| 336 | call->buffer = (uint8_t *) malloc(size, 0); |
336 | call->buffer = (uint8_t *) malloc(size, 0); |
| 337 | rc = copy_from_uspace(call->buffer, (void *) src, size); |
337 | rc = copy_from_uspace(call->buffer, (void *) src, size); |
| 338 | if (rc != 0) { |
338 | if (rc != 0) { |
| 339 | free(call->buffer); |
339 | free(call->buffer); |
| 340 | return rc; |
340 | return rc; |
| 341 | } |
341 | } |
| 342 | break; |
342 | break; |
| 343 | default: |
343 | default: |
| 344 | break; |
344 | break; |
| 345 | } |
345 | } |
| 346 | return 0; |
346 | return 0; |
| 347 | } |
347 | } |
| 348 | 348 | ||
| 349 | /******************************************************************************* |
349 | /******************************************************************************* |
| 350 | * Functions called to process received call/answer before passing it to uspace. |
350 | * Functions called to process received call/answer before passing it to uspace. |
| 351 | *******************************************************************************/ |
351 | *******************************************************************************/ |
| 352 | 352 | ||
| 353 | /** Do basic kernel processing of received call answer. |
353 | /** Do basic kernel processing of received call answer. |
| 354 | * |
354 | * |
| 355 | * @param call Call structure with the answer. |
355 | * @param call Call structure with the answer. |
| 356 | */ |
356 | */ |
| 357 | static void process_answer(call_t *call) |
357 | static void process_answer(call_t *call) |
| 358 | { |
358 | { |
| 359 | if (((native_t) IPC_GET_RETVAL(call->data) == EHANGUP) && |
359 | if (((native_t) IPC_GET_RETVAL(call->data) == EHANGUP) && |
| 360 | (call->flags & IPC_CALL_FORWARDED)) |
360 | (call->flags & IPC_CALL_FORWARDED)) |
| 361 | IPC_SET_RETVAL(call->data, EFORWARD); |
361 | IPC_SET_RETVAL(call->data, EFORWARD); |
| 362 | 362 | ||
| 363 | if (call->flags & IPC_CALL_CONN_ME_TO) { |
363 | if (call->flags & IPC_CALL_CONN_ME_TO) { |
| 364 | if (IPC_GET_RETVAL(call->data)) |
364 | if (IPC_GET_RETVAL(call->data)) |
| 365 | phone_dealloc(call->priv); |
365 | phone_dealloc(call->priv); |
| 366 | else |
366 | else |
| 367 | IPC_SET_ARG5(call->data, call->priv); |
367 | IPC_SET_ARG5(call->data, call->priv); |
| 368 | } |
368 | } |
| 369 | 369 | ||
| 370 | if (call->buffer) { |
370 | if (call->buffer) { |
| 371 | /* This must be an affirmative answer to IPC_M_DATA_READ. */ |
371 | /* This must be an affirmative answer to IPC_M_DATA_READ. */ |
| 372 | uintptr_t dst = IPC_GET_ARG1(call->data); |
372 | uintptr_t dst = IPC_GET_ARG1(call->data); |
| 373 | size_t size = IPC_GET_ARG2(call->data); |
373 | size_t size = IPC_GET_ARG2(call->data); |
| 374 | int rc = copy_to_uspace((void *) dst, call->buffer, size); |
374 | int rc = copy_to_uspace((void *) dst, call->buffer, size); |
| 375 | if (rc) |
375 | if (rc) |
| 376 | IPC_SET_RETVAL(call->data, rc); |
376 | IPC_SET_RETVAL(call->data, rc); |
| 377 | free(call->buffer); |
377 | free(call->buffer); |
| 378 | call->buffer = NULL; |
378 | call->buffer = NULL; |
| 379 | } |
379 | } |
| 380 | } |
380 | } |
| 381 | 381 | ||
| 382 | /** Do basic kernel processing of received call request. |
382 | /** Do basic kernel processing of received call request. |
| 383 | * |
383 | * |
| 384 | * @param box Destination answerbox structure. |
384 | * @param box Destination answerbox structure. |
| 385 | * @param call Call structure with the request. |
385 | * @param call Call structure with the request. |
| 386 | * |
386 | * |
| 387 | * @return Return 0 if the call should be passed to userspace. |
387 | * @return Return 0 if the call should be passed to userspace. |
| 388 | * Return -1 if the call should be ignored. |
388 | * Return -1 if the call should be ignored. |
| 389 | */ |
389 | */ |
| 390 | static int process_request(answerbox_t *box, call_t *call) |
390 | static int process_request(answerbox_t *box, call_t *call) |
| 391 | { |
391 | { |
| 392 | int phoneid; |
392 | int phoneid; |
| 393 | 393 | ||
| 394 | if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) { |
394 | if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) { |
| 395 | phoneid = phone_alloc(); |
395 | phoneid = phone_alloc(); |
| 396 | if (phoneid < 0) { /* Failed to allocate phone */ |
396 | if (phoneid < 0) { /* Failed to allocate phone */ |
| 397 | IPC_SET_RETVAL(call->data, ELIMIT); |
397 | IPC_SET_RETVAL(call->data, ELIMIT); |
| 398 | ipc_answer(box, call); |
398 | ipc_answer(box, call); |
| 399 | return -1; |
399 | return -1; |
| 400 | } |
400 | } |
| 401 | IPC_SET_ARG5(call->data, phoneid); |
401 | IPC_SET_ARG5(call->data, phoneid); |
| 402 | } |
402 | } |
| 403 | return 0; |
403 | return 0; |
| 404 | } |
404 | } |
| 405 | 405 | ||
| 406 | /** Make a fast call over IPC, wait for reply and return to user. |
406 | /** Make a fast call over IPC, wait for reply and return to user. |
| 407 | * |
407 | * |
| 408 | * This function can handle only three arguments of payload, but is faster than |
408 | * This function can handle only three arguments of payload, but is faster than |
| 409 | * the generic function (i.e. sys_ipc_call_sync_slow()). |
409 | * the generic function (i.e. sys_ipc_call_sync_slow()). |
| 410 | * |
410 | * |
| 411 | * @param phoneid Phone handle for the call. |
411 | * @param phoneid Phone handle for the call. |
| 412 | * @param method Method of the call. |
412 | * @param method Method of the call. |
| 413 | * @param arg1 Service-defined payload argument. |
413 | * @param arg1 Service-defined payload argument. |
| 414 | * @param arg2 Service-defined payload argument. |
414 | * @param arg2 Service-defined payload argument. |
| 415 | * @param arg3 Service-defined payload argument. |
415 | * @param arg3 Service-defined payload argument. |
| 416 | * @param data Address of userspace structure where the reply call will |
416 | * @param data Address of userspace structure where the reply call will |
| 417 | * be stored. |
417 | * be stored. |
| 418 | * |
418 | * |
| 419 | * @return Returns 0 on success. |
419 | * @return Returns 0 on success. |
| 420 | * Return ENOENT if there is no such phone handle. |
420 | * Return ENOENT if there is no such phone handle. |
| 421 | */ |
421 | */ |
| 422 | unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method, |
422 | unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method, |
| 423 | unative_t arg1, unative_t arg2, unative_t arg3, ipc_data_t *data) |
423 | unative_t arg1, unative_t arg2, unative_t arg3, ipc_data_t *data) |
| 424 | { |
424 | { |
| 425 | call_t call; |
425 | call_t call; |
| 426 | phone_t *phone; |
426 | phone_t *phone; |
| 427 | int res; |
427 | int res; |
| 428 | int rc; |
428 | int rc; |
| 429 | 429 | ||
| 430 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
430 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
| 431 | 431 | ||
| 432 | ipc_call_static_init(&call); |
432 | ipc_call_static_init(&call); |
| 433 | IPC_SET_METHOD(call.data, method); |
433 | IPC_SET_METHOD(call.data, method); |
| 434 | IPC_SET_ARG1(call.data, arg1); |
434 | IPC_SET_ARG1(call.data, arg1); |
| 435 | IPC_SET_ARG2(call.data, arg2); |
435 | IPC_SET_ARG2(call.data, arg2); |
| 436 | IPC_SET_ARG3(call.data, arg3); |
436 | IPC_SET_ARG3(call.data, arg3); |
| 437 | /* |
437 | /* |
| 438 | * To achieve deterministic behavior, zero out arguments that are beyond |
438 | * To achieve deterministic behavior, zero out arguments that are beyond |
| 439 | * the limits of the fast version. |
439 | * the limits of the fast version. |
| 440 | */ |
440 | */ |
| 441 | IPC_SET_ARG4(call.data, 0); |
441 | IPC_SET_ARG4(call.data, 0); |
| 442 | IPC_SET_ARG5(call.data, 0); |
442 | IPC_SET_ARG5(call.data, 0); |
| 443 | 443 | ||
| 444 | if (!(res = request_preprocess(&call))) { |
444 | if (!(res = request_preprocess(&call))) { |
| 445 | ipc_call_sync(phone, &call); |
445 | ipc_call_sync(phone, &call); |
| 446 | process_answer(&call); |
446 | process_answer(&call); |
| 447 | } else { |
447 | } else { |
| 448 | IPC_SET_RETVAL(call.data, res); |
448 | IPC_SET_RETVAL(call.data, res); |
| 449 | } |
449 | } |
| 450 | rc = STRUCT_TO_USPACE(&data->args, &call.data.args); |
450 | rc = STRUCT_TO_USPACE(&data->args, &call.data.args); |
| 451 | if (rc != 0) |
451 | if (rc != 0) |
| 452 | return rc; |
452 | return rc; |
| 453 | 453 | ||
| 454 | return 0; |
454 | return 0; |
| 455 | } |
455 | } |
| 456 | 456 | ||
| 457 | /** Make a synchronous IPC call allowing to transmit the entire payload. |
457 | /** Make a synchronous IPC call allowing to transmit the entire payload. |
| 458 | * |
458 | * |
| 459 | * @param phoneid Phone handle for the call. |
459 | * @param phoneid Phone handle for the call. |
| 460 | * @param question Userspace address of call data with the request. |
460 | * @param question Userspace address of call data with the request. |
| 461 | * @param reply Userspace address of call data where to store the |
461 | * @param reply Userspace address of call data where to store the |
| 462 | * answer. |
462 | * answer. |
| 463 | * |
463 | * |
| 464 | * @return Zero on success or an error code. |
464 | * @return Zero on success or an error code. |
| 465 | */ |
465 | */ |
| 466 | unative_t sys_ipc_call_sync_slow(unative_t phoneid, ipc_data_t *question, |
466 | unative_t sys_ipc_call_sync_slow(unative_t phoneid, ipc_data_t *question, |
| 467 | ipc_data_t *reply) |
467 | ipc_data_t *reply) |
| 468 | { |
468 | { |
| 469 | call_t call; |
469 | call_t call; |
| 470 | phone_t *phone; |
470 | phone_t *phone; |
| 471 | int res; |
471 | int res; |
| 472 | int rc; |
472 | int rc; |
| 473 | 473 | ||
| 474 | ipc_call_static_init(&call); |
474 | ipc_call_static_init(&call); |
| 475 | rc = copy_from_uspace(&call.data.args, &question->args, |
475 | rc = copy_from_uspace(&call.data.args, &question->args, |
| 476 | sizeof(call.data.args)); |
476 | sizeof(call.data.args)); |
| 477 | if (rc != 0) |
477 | if (rc != 0) |
| 478 | return (unative_t) rc; |
478 | return (unative_t) rc; |
| 479 | 479 | ||
| 480 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
480 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
| 481 | 481 | ||
| 482 | if (!(res = request_preprocess(&call))) { |
482 | if (!(res = request_preprocess(&call))) { |
| 483 | ipc_call_sync(phone, &call); |
483 | ipc_call_sync(phone, &call); |
| 484 | process_answer(&call); |
484 | process_answer(&call); |
| 485 | } else |
485 | } else |
| 486 | IPC_SET_RETVAL(call.data, res); |
486 | IPC_SET_RETVAL(call.data, res); |
| 487 | 487 | ||
| 488 | rc = STRUCT_TO_USPACE(&reply->args, &call.data.args); |
488 | rc = STRUCT_TO_USPACE(&reply->args, &call.data.args); |
| 489 | if (rc != 0) |
489 | if (rc != 0) |
| 490 | return rc; |
490 | return rc; |
| 491 | 491 | ||
| 492 | return 0; |
492 | return 0; |
| 493 | } |
493 | } |
| 494 | 494 | ||
| 495 | /** Check that the task did not exceed the allowed limit of asynchronous calls. |
495 | /** Check that the task did not exceed the allowed limit of asynchronous calls. |
| 496 | * |
496 | * |
| 497 | * @return Return 0 if limit not reached or -1 if limit exceeded. |
497 | * @return Return 0 if limit not reached or -1 if limit exceeded. |
| 498 | */ |
498 | */ |
| 499 | static int check_call_limit(void) |
499 | static int check_call_limit(void) |
| 500 | { |
500 | { |
| 501 | if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) { |
501 | if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) { |
| 502 | atomic_dec(&TASK->active_calls); |
502 | atomic_dec(&TASK->active_calls); |
| 503 | return -1; |
503 | return -1; |
| 504 | } |
504 | } |
| 505 | return 0; |
505 | return 0; |
| 506 | } |
506 | } |
| 507 | 507 | ||
| 508 | /** Make a fast asynchronous call over IPC. |
508 | /** Make a fast asynchronous call over IPC. |
| 509 | * |
509 | * |
| 510 | * This function can only handle four arguments of payload, but is faster than |
510 | * This function can only handle four arguments of payload, but is faster than |
| 511 | * the generic function sys_ipc_call_async_slow(). |
511 | * the generic function sys_ipc_call_async_slow(). |
| 512 | * |
512 | * |
| 513 | * @param phoneid Phone handle for the call. |
513 | * @param phoneid Phone handle for the call. |
| 514 | * @param method Method of the call. |
514 | * @param method Method of the call. |
| 515 | * @param arg1 Service-defined payload argument. |
515 | * @param arg1 Service-defined payload argument. |
| 516 | * @param arg2 Service-defined payload argument. |
516 | * @param arg2 Service-defined payload argument. |
| 517 | * @param arg3 Service-defined payload argument. |
517 | * @param arg3 Service-defined payload argument. |
| 518 | * @param arg4 Service-defined payload argument. |
518 | * @param arg4 Service-defined payload argument. |
| 519 | * |
519 | * |
| 520 | * @return Return call hash on success. |
520 | * @return Return call hash on success. |
| 521 | * Return IPC_CALLRET_FATAL in case of a fatal error and |
521 | * Return IPC_CALLRET_FATAL in case of a fatal error and |
| 522 | * IPC_CALLRET_TEMPORARY if there are too many pending |
522 | * IPC_CALLRET_TEMPORARY if there are too many pending |
| 523 | * asynchronous requests; answers should be handled first. |
523 | * asynchronous requests; answers should be handled first. |
| 524 | */ |
524 | */ |
| 525 | unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method, |
525 | unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method, |
| 526 | unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4) |
526 | unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4) |
| 527 | { |
527 | { |
| 528 | call_t *call; |
528 | call_t *call; |
| 529 | phone_t *phone; |
529 | phone_t *phone; |
| 530 | int res; |
530 | int res; |
| 531 | 531 | ||
| 532 | if (check_call_limit()) |
532 | if (check_call_limit()) |
| 533 | return IPC_CALLRET_TEMPORARY; |
533 | return IPC_CALLRET_TEMPORARY; |
| 534 | 534 | ||
| 535 | GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL); |
535 | GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL); |
| 536 | 536 | ||
| 537 | call = ipc_call_alloc(0); |
537 | call = ipc_call_alloc(0); |
| 538 | IPC_SET_METHOD(call->data, method); |
538 | IPC_SET_METHOD(call->data, method); |
| 539 | IPC_SET_ARG1(call->data, arg1); |
539 | IPC_SET_ARG1(call->data, arg1); |
| 540 | IPC_SET_ARG2(call->data, arg2); |
540 | IPC_SET_ARG2(call->data, arg2); |
| 541 | IPC_SET_ARG3(call->data, arg3); |
541 | IPC_SET_ARG3(call->data, arg3); |
| 542 | IPC_SET_ARG4(call->data, arg4); |
542 | IPC_SET_ARG4(call->data, arg4); |
| 543 | /* |
543 | /* |
| 544 | * To achieve deterministic behavior, zero out arguments that are beyond |
544 | * To achieve deterministic behavior, zero out arguments that are beyond |
| 545 | * the limits of the fast version. |
545 | * the limits of the fast version. |
| 546 | */ |
546 | */ |
| 547 | IPC_SET_ARG5(call->data, 0); |
547 | IPC_SET_ARG5(call->data, 0); |
| 548 | 548 | ||
| 549 | if (!(res = request_preprocess(call))) |
549 | if (!(res = request_preprocess(call))) |
| 550 | ipc_call(phone, call); |
550 | ipc_call(phone, call); |
| 551 | else |
551 | else |
| 552 | ipc_backsend_err(phone, call, res); |
552 | ipc_backsend_err(phone, call, res); |
| 553 | 553 | ||
| 554 | return (unative_t) call; |
554 | return (unative_t) call; |
| 555 | } |
555 | } |
| 556 | 556 | ||
| 557 | /** Make an asynchronous IPC call allowing to transmit the entire payload. |
557 | /** Make an asynchronous IPC call allowing to transmit the entire payload. |
| 558 | * |
558 | * |
| 559 | * @param phoneid Phone handle for the call. |
559 | * @param phoneid Phone handle for the call. |
| 560 | * @param data Userspace address of call data with the request. |
560 | * @param data Userspace address of call data with the request. |
| 561 | * |
561 | * |
| 562 | * @return See sys_ipc_call_async_fast(). |
562 | * @return See sys_ipc_call_async_fast(). |
| 563 | */ |
563 | */ |
| 564 | unative_t sys_ipc_call_async_slow(unative_t phoneid, ipc_data_t *data) |
564 | unative_t sys_ipc_call_async_slow(unative_t phoneid, ipc_data_t *data) |
| 565 | { |
565 | { |
| 566 | call_t *call; |
566 | call_t *call; |
| 567 | phone_t *phone; |
567 | phone_t *phone; |
| 568 | int res; |
568 | int res; |
| 569 | int rc; |
569 | int rc; |
| 570 | 570 | ||
| 571 | if (check_call_limit()) |
571 | if (check_call_limit()) |
| 572 | return IPC_CALLRET_TEMPORARY; |
572 | return IPC_CALLRET_TEMPORARY; |
| 573 | 573 | ||
| 574 | GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL); |
574 | GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL); |
| 575 | 575 | ||
| 576 | call = ipc_call_alloc(0); |
576 | call = ipc_call_alloc(0); |
| 577 | rc = copy_from_uspace(&call->data.args, &data->args, |
577 | rc = copy_from_uspace(&call->data.args, &data->args, |
| 578 | sizeof(call->data.args)); |
578 | sizeof(call->data.args)); |
| 579 | if (rc != 0) { |
579 | if (rc != 0) { |
| 580 | ipc_call_free(call); |
580 | ipc_call_free(call); |
| 581 | return (unative_t) rc; |
581 | return (unative_t) rc; |
| 582 | } |
582 | } |
| 583 | if (!(res = request_preprocess(call))) |
583 | if (!(res = request_preprocess(call))) |
| 584 | ipc_call(phone, call); |
584 | ipc_call(phone, call); |
| 585 | else |
585 | else |
| 586 | ipc_backsend_err(phone, call, res); |
586 | ipc_backsend_err(phone, call, res); |
| 587 | 587 | ||
| 588 | return (unative_t) call; |
588 | return (unative_t) call; |
| 589 | } |
589 | } |
| 590 | 590 | ||
| 591 | /** Forward a received call to another destination. |
591 | /** Forward a received call to another destination. |
| 592 | * |
592 | * |
| 593 | * @param callid Hash of the call to forward. |
593 | * @param callid Hash of the call to forward. |
| 594 | * @param phoneid Phone handle to use for forwarding. |
594 | * @param phoneid Phone handle to use for forwarding. |
| 595 | * @param method New method to use for the forwarded call. |
595 | * @param method New method to use for the forwarded call. |
| 596 | * @param arg1 New value of the first argument for the forwarded call. |
596 | * @param arg1 New value of the first argument for the forwarded call. |
| 597 | * @param arg2 New value of the second argument for the forwarded call. |
597 | * @param arg2 New value of the second argument for the forwarded call. |
| 598 | * @param mode Flags that specify mode of the forward operation. |
598 | * @param mode Flags that specify mode of the forward operation. |
| 599 | * |
599 | * |
| 600 | * @return Return 0 on succes, otherwise return an error code. |
600 | * @return Return 0 on succes, otherwise return an error code. |
| 601 | * |
601 | * |
| 602 | * In case the original method is a system method, ARG1, ARG2 and ARG3 are |
602 | * In case the original method is a system method, ARG1, ARG2 and ARG3 are |
| 603 | * overwritten in the forwarded message with the new method and the new arg1 and |
603 | * overwritten in the forwarded message with the new method and the new arg1 and |
| 604 | * arg2, respectively. Otherwise the METHOD, ARG1 and ARG2 are rewritten with |
604 | * arg2, respectively. Otherwise the METHOD, ARG1 and ARG2 are rewritten with |
| 605 | * the new method, arg1 and arg2, respectively. Also note there is a set of |
605 | * the new method, arg1 and arg2, respectively. Also note there is a set of |
| 606 | * immutable methods, for which the new method and argument is not set and |
606 | * immutable methods, for which the new method and argument is not set and |
| 607 | * these values are ignored. |
607 | * these values are ignored. |
| 608 | * |
608 | * |
| 609 | * Warning: When implementing support for changing additional payload |
609 | * Warning: When implementing support for changing additional payload |
| 610 | * arguments, make sure that ARG5 is not rewritten for certain |
610 | * arguments, make sure that ARG5 is not rewritten for certain |
| 611 | * system IPC |
611 | * system IPC |
| 612 | */ |
612 | */ |
| 613 | unative_t sys_ipc_forward_fast(unative_t callid, unative_t phoneid, |
613 | unative_t sys_ipc_forward_fast(unative_t callid, unative_t phoneid, |
| 614 | unative_t method, unative_t arg1, unative_t arg2, int mode) |
614 | unative_t method, unative_t arg1, unative_t arg2, int mode) |
| 615 | { |
615 | { |
| 616 | call_t *call; |
616 | call_t *call; |
| 617 | phone_t *phone; |
617 | phone_t *phone; |
| 618 | 618 | ||
| 619 | call = get_call(callid); |
619 | call = get_call(callid); |
| 620 | if (!call) |
620 | if (!call) |
| 621 | return ENOENT; |
621 | return ENOENT; |
| 622 | 622 | ||
| 623 | call->flags |= IPC_CALL_FORWARDED; |
623 | call->flags |= IPC_CALL_FORWARDED; |
| 624 | 624 | ||
| 625 | GET_CHECK_PHONE(phone, phoneid, { |
625 | GET_CHECK_PHONE(phone, phoneid, { |
| 626 | IPC_SET_RETVAL(call->data, EFORWARD); |
626 | IPC_SET_RETVAL(call->data, EFORWARD); |
| 627 | ipc_answer(&TASK->answerbox, call); |
627 | ipc_answer(&TASK->answerbox, call); |
| 628 | return ENOENT; |
628 | return ENOENT; |
| 629 | }); |
629 | }); |
| 630 | 630 | ||
| 631 | if (!method_is_forwardable(IPC_GET_METHOD(call->data))) { |
631 | if (!method_is_forwardable(IPC_GET_METHOD(call->data))) { |
| 632 | IPC_SET_RETVAL(call->data, EFORWARD); |
632 | IPC_SET_RETVAL(call->data, EFORWARD); |
| 633 | ipc_answer(&TASK->answerbox, call); |
633 | ipc_answer(&TASK->answerbox, call); |
| 634 | return EPERM; |
634 | return EPERM; |
| 635 | } |
635 | } |
| 636 | 636 | ||
| 637 | /* |
637 | /* |
| 638 | * Userspace is not allowed to change method of system methods on |
638 | * Userspace is not allowed to change method of system methods on |
| 639 | * forward, allow changing ARG1, ARG2 and ARG3 by means of method, |
639 | * forward, allow changing ARG1, ARG2 and ARG3 by means of method, |
| 640 | * arg1 and arg2. |
640 | * arg1 and arg2. |
| 641 | * If the method is immutable, don't change anything. |
641 | * If the method is immutable, don't change anything. |
| 642 | */ |
642 | */ |
| 643 | if (!method_is_immutable(IPC_GET_METHOD(call->data))) { |
643 | if (!method_is_immutable(IPC_GET_METHOD(call->data))) { |
| 644 | if (method_is_system(IPC_GET_METHOD(call->data))) { |
644 | if (method_is_system(IPC_GET_METHOD(call->data))) { |
| 645 | if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) |
645 | if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) |
| 646 | phone_dealloc(IPC_GET_ARG5(call->data)); |
646 | phone_dealloc(IPC_GET_ARG5(call->data)); |
| 647 | 647 | ||
| 648 | IPC_SET_ARG1(call->data, method); |
648 | IPC_SET_ARG1(call->data, method); |
| 649 | IPC_SET_ARG2(call->data, arg1); |
649 | IPC_SET_ARG2(call->data, arg1); |
| 650 | IPC_SET_ARG3(call->data, arg2); |
650 | IPC_SET_ARG3(call->data, arg2); |
| 651 | } else { |
651 | } else { |
| 652 | IPC_SET_METHOD(call->data, method); |
652 | IPC_SET_METHOD(call->data, method); |
| 653 | IPC_SET_ARG1(call->data, arg1); |
653 | IPC_SET_ARG1(call->data, arg1); |
| 654 | IPC_SET_ARG2(call->data, arg2); |
654 | IPC_SET_ARG2(call->data, arg2); |
| 655 | } |
655 | } |
| 656 | } |
656 | } |
| 657 | 657 | ||
| 658 | return ipc_forward(call, phone, &TASK->answerbox, mode); |
658 | return ipc_forward(call, phone, &TASK->answerbox, mode); |
| 659 | } |
659 | } |
| 660 | 660 | ||
| 661 | /** Answer an IPC call - fast version. |
661 | /** Answer an IPC call - fast version. |
| 662 | * |
662 | * |
| 663 | * This function can handle only two return arguments of payload, but is faster |
663 | * This function can handle only two return arguments of payload, but is faster |
| 664 | * than the generic sys_ipc_answer(). |
664 | * than the generic sys_ipc_answer(). |
| 665 | * |
665 | * |
| 666 | * @param callid Hash of the call to be answered. |
666 | * @param callid Hash of the call to be answered. |
| 667 | * @param retval Return value of the answer. |
667 | * @param retval Return value of the answer. |
| 668 | * @param arg1 Service-defined return value. |
668 | * @param arg1 Service-defined return value. |
| 669 | * @param arg2 Service-defined return value. |
669 | * @param arg2 Service-defined return value. |
| 670 | * @param arg3 Service-defined return value. |
670 | * @param arg3 Service-defined return value. |
| 671 | * @param arg4 Service-defined return value. |
671 | * @param arg4 Service-defined return value. |
| 672 | * |
672 | * |
| 673 | * @return Return 0 on success, otherwise return an error code. |
673 | * @return Return 0 on success, otherwise return an error code. |
| 674 | */ |
674 | */ |
| 675 | unative_t sys_ipc_answer_fast(unative_t callid, unative_t retval, |
675 | unative_t sys_ipc_answer_fast(unative_t callid, unative_t retval, |
| 676 | unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4) |
676 | unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4) |
| 677 | { |
677 | { |
| 678 | call_t *call; |
678 | call_t *call; |
| 679 | ipc_data_t saved_data; |
679 | ipc_data_t saved_data; |
| 680 | int saveddata = 0; |
680 | int saveddata = 0; |
| 681 | int rc; |
681 | int rc; |
| 682 | 682 | ||
| 683 | /* Do not answer notification callids */ |
683 | /* Do not answer notification callids */ |
| 684 | if (callid & IPC_CALLID_NOTIFICATION) |
684 | if (callid & IPC_CALLID_NOTIFICATION) |
| 685 | return 0; |
685 | return 0; |
| 686 | 686 | ||
| 687 | call = get_call(callid); |
687 | call = get_call(callid); |
| 688 | if (!call) |
688 | if (!call) |
| 689 | return ENOENT; |
689 | return ENOENT; |
| 690 | 690 | ||
| 691 | if (answer_need_old(call)) { |
691 | if (answer_need_old(call)) { |
| 692 | memcpy(&saved_data, &call->data, sizeof(call->data)); |
692 | memcpy(&saved_data, &call->data, sizeof(call->data)); |
| 693 | saveddata = 1; |
693 | saveddata = 1; |
| 694 | } |
694 | } |
| 695 | 695 | ||
| 696 | IPC_SET_RETVAL(call->data, retval); |
696 | IPC_SET_RETVAL(call->data, retval); |
| 697 | IPC_SET_ARG1(call->data, arg1); |
697 | IPC_SET_ARG1(call->data, arg1); |
| 698 | IPC_SET_ARG2(call->data, arg2); |
698 | IPC_SET_ARG2(call->data, arg2); |
| 699 | IPC_SET_ARG3(call->data, arg3); |
699 | IPC_SET_ARG3(call->data, arg3); |
| 700 | IPC_SET_ARG4(call->data, arg4); |
700 | IPC_SET_ARG4(call->data, arg4); |
| 701 | /* |
701 | /* |
| 702 | * To achieve deterministic behavior, zero out arguments that are beyond |
702 | * To achieve deterministic behavior, zero out arguments that are beyond |
| 703 | * the limits of the fast version. |
703 | * the limits of the fast version. |
| 704 | */ |
704 | */ |
| 705 | IPC_SET_ARG5(call->data, 0); |
705 | IPC_SET_ARG5(call->data, 0); |
| 706 | rc = answer_preprocess(call, saveddata ? &saved_data : NULL); |
706 | rc = answer_preprocess(call, saveddata ? &saved_data : NULL); |
| 707 | 707 | ||
| 708 | ipc_answer(&TASK->answerbox, call); |
708 | ipc_answer(&TASK->answerbox, call); |
| 709 | return rc; |
709 | return rc; |
| 710 | } |
710 | } |
| 711 | 711 | ||
| 712 | /** Answer an IPC call. |
712 | /** Answer an IPC call. |
| 713 | * |
713 | * |
| 714 | * @param callid Hash of the call to be answered. |
714 | * @param callid Hash of the call to be answered. |
| 715 | * @param data Userspace address of call data with the answer. |
715 | * @param data Userspace address of call data with the answer. |
| 716 | * |
716 | * |
| 717 | * @return Return 0 on success, otherwise return an error code. |
717 | * @return Return 0 on success, otherwise return an error code. |
| 718 | */ |
718 | */ |
| 719 | unative_t sys_ipc_answer_slow(unative_t callid, ipc_data_t *data) |
719 | unative_t sys_ipc_answer_slow(unative_t callid, ipc_data_t *data) |
| 720 | { |
720 | { |
| 721 | call_t *call; |
721 | call_t *call; |
| 722 | ipc_data_t saved_data; |
722 | ipc_data_t saved_data; |
| 723 | int saveddata = 0; |
723 | int saveddata = 0; |
| 724 | int rc; |
724 | int rc; |
| 725 | 725 | ||
| 726 | /* Do not answer notification callids */ |
726 | /* Do not answer notification callids */ |
| 727 | if (callid & IPC_CALLID_NOTIFICATION) |
727 | if (callid & IPC_CALLID_NOTIFICATION) |
| 728 | return 0; |
728 | return 0; |
| 729 | 729 | ||
| 730 | call = get_call(callid); |
730 | call = get_call(callid); |
| 731 | if (!call) |
731 | if (!call) |
| 732 | return ENOENT; |
732 | return ENOENT; |
| 733 | 733 | ||
| 734 | if (answer_need_old(call)) { |
734 | if (answer_need_old(call)) { |
| 735 | memcpy(&saved_data, &call->data, sizeof(call->data)); |
735 | memcpy(&saved_data, &call->data, sizeof(call->data)); |
| 736 | saveddata = 1; |
736 | saveddata = 1; |
| 737 | } |
737 | } |
| 738 | rc = copy_from_uspace(&call->data.args, &data->args, |
738 | rc = copy_from_uspace(&call->data.args, &data->args, |
| 739 | sizeof(call->data.args)); |
739 | sizeof(call->data.args)); |
| 740 | if (rc != 0) |
740 | if (rc != 0) |
| 741 | return rc; |
741 | return rc; |
| 742 | 742 | ||
| 743 | rc = answer_preprocess(call, saveddata ? &saved_data : NULL); |
743 | rc = answer_preprocess(call, saveddata ? &saved_data : NULL); |
| 744 | 744 | ||
| 745 | ipc_answer(&TASK->answerbox, call); |
745 | ipc_answer(&TASK->answerbox, call); |
| 746 | 746 | ||
| 747 | return rc; |
747 | return rc; |
| 748 | } |
748 | } |
| 749 | 749 | ||
| 750 | /** Hang up a phone. |
750 | /** Hang up a phone. |
| 751 | * |
751 | * |
| 752 | * @param Phone handle of the phone to be hung up. |
752 | * @param Phone handle of the phone to be hung up. |
| 753 | * |
753 | * |
| 754 | * @return Return 0 on success or an error code. |
754 | * @return Return 0 on success or an error code. |
| 755 | */ |
755 | */ |
| 756 | unative_t sys_ipc_hangup(int phoneid) |
756 | unative_t sys_ipc_hangup(int phoneid) |
| 757 | { |
757 | { |
| 758 | phone_t *phone; |
758 | phone_t *phone; |
| 759 | 759 | ||
| 760 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
760 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
| 761 | 761 | ||
| 762 | if (ipc_phone_hangup(phone)) |
762 | if (ipc_phone_hangup(phone)) |
| 763 | return -1; |
763 | return -1; |
| 764 | 764 | ||
| 765 | return 0; |
765 | return 0; |
| 766 | } |
766 | } |
| 767 | 767 | ||
| 768 | /** Wait for an incoming IPC call or an answer. |
768 | /** Wait for an incoming IPC call or an answer. |
| 769 | * |
769 | * |
| 770 | * @param calldata Pointer to buffer where the call/answer data is stored. |
770 | * @param calldata Pointer to buffer where the call/answer data is stored. |
| 771 | * @param usec Timeout. See waitq_sleep_timeout() for explanation. |
771 | * @param usec Timeout. See waitq_sleep_timeout() for explanation. |
| 772 | * @param flags Select mode of sleep operation. See waitq_sleep_timeout() |
772 | * @param flags Select mode of sleep operation. See waitq_sleep_timeout() |
| 773 | * for explanation. |
773 | * for explanation. |
| 774 | * |
774 | * |
| 775 | * @return Hash of the call. |
775 | * @return Hash of the call. |
| 776 | * If IPC_CALLID_NOTIFICATION bit is set in the hash, the |
776 | * If IPC_CALLID_NOTIFICATION bit is set in the hash, the |
| 777 | * call is a notification. IPC_CALLID_ANSWERED denotes an |
777 | * call is a notification. IPC_CALLID_ANSWERED denotes an |
| 778 | * answer. |
778 | * answer. |
| 779 | */ |
779 | */ |
| 780 | unative_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec, int flags) |
780 | unative_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec, int flags) |
| 781 | { |
781 | { |
| 782 | call_t *call; |
782 | call_t *call; |
| 783 | 783 | ||
| 784 | restart: |
784 | restart: |
| 785 | call = ipc_wait_for_call(&TASK->answerbox, usec, |
785 | call = ipc_wait_for_call(&TASK->answerbox, usec, |
| 786 | flags | SYNCH_FLAGS_INTERRUPTIBLE); |
786 | flags | SYNCH_FLAGS_INTERRUPTIBLE); |
| 787 | if (!call) |
787 | if (!call) |
| 788 | return 0; |
788 | return 0; |
| 789 | 789 | ||
| 790 | if (call->flags & IPC_CALL_NOTIF) { |
790 | if (call->flags & IPC_CALL_NOTIF) { |
| 791 | ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC)); |
791 | ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC)); |
| 792 | 792 | ||
| 793 | /* Set in_phone_hash to the interrupt counter */ |
793 | /* Set in_phone_hash to the interrupt counter */ |
| 794 | call->data.phone = (void *) call->priv; |
794 | call->data.phone = (void *) call->priv; |
| 795 | 795 | ||
| 796 | STRUCT_TO_USPACE(calldata, &call->data); |
796 | STRUCT_TO_USPACE(calldata, &call->data); |
| 797 | 797 | ||
| 798 | ipc_call_free(call); |
798 | ipc_call_free(call); |
| 799 | 799 | ||
| 800 | return ((unative_t) call) | IPC_CALLID_NOTIFICATION; |
800 | return ((unative_t) call) | IPC_CALLID_NOTIFICATION; |
| 801 | } |
801 | } |
| 802 | 802 | ||
| 803 | if (call->flags & IPC_CALL_ANSWERED) { |
803 | if (call->flags & IPC_CALL_ANSWERED) { |
| 804 | process_answer(call); |
804 | process_answer(call); |
| 805 | 805 | ||
| 806 | ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC)); |
806 | ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC)); |
| 807 | 807 | ||
| 808 | atomic_dec(&TASK->active_calls); |
808 | atomic_dec(&TASK->active_calls); |
| 809 | 809 | ||
| 810 | if (call->flags & IPC_CALL_DISCARD_ANSWER) { |
810 | if (call->flags & IPC_CALL_DISCARD_ANSWER) { |
| 811 | ipc_call_free(call); |
811 | ipc_call_free(call); |
| 812 | goto restart; |
812 | goto restart; |
| 813 | } |
813 | } |
| 814 | 814 | ||
| 815 | STRUCT_TO_USPACE(&calldata->args, &call->data.args); |
815 | STRUCT_TO_USPACE(&calldata->args, &call->data.args); |
| 816 | ipc_call_free(call); |
816 | ipc_call_free(call); |
| 817 | 817 | ||
| 818 | return ((unative_t) call) | IPC_CALLID_ANSWERED; |
818 | return ((unative_t) call) | IPC_CALLID_ANSWERED; |
| 819 | } |
819 | } |
| 820 | 820 | ||
| 821 | if (process_request(&TASK->answerbox, call)) |
821 | if (process_request(&TASK->answerbox, call)) |
| 822 | goto restart; |
822 | goto restart; |
| 823 | 823 | ||
| 824 | /* Include phone address('id') of the caller in the request, |
824 | /* Include phone address('id') of the caller in the request, |
| 825 | * copy whole call->data, not only call->data.args */ |
825 | * copy whole call->data, not only call->data.args */ |
| 826 | if (STRUCT_TO_USPACE(calldata, &call->data)) { |
826 | if (STRUCT_TO_USPACE(calldata, &call->data)) { |
| 827 | return 0; |
827 | return 0; |
| 828 | } |
828 | } |
| 829 | return (unative_t)call; |
829 | return (unative_t)call; |
| 830 | } |
830 | } |
| 831 | 831 | ||
| 832 | /** Connect an IRQ handler to a task. |
832 | /** Connect an IRQ handler to a task. |
| 833 | * |
833 | * |
| 834 | * @param inr IRQ number. |
834 | * @param inr IRQ number. |
| 835 | * @param devno Device number. |
835 | * @param devno Device number. |
| 836 | * @param method Method to be associated with the notification. |
836 | * @param method Method to be associated with the notification. |
| 837 | * @param ucode Uspace pointer to the top-half pseudocode. |
837 | * @param ucode Uspace pointer to the top-half pseudocode. |
| 838 | * |
838 | * |
| 839 | * @return EPERM or a return code returned by ipc_irq_register(). |
839 | * @return EPERM or a return code returned by ipc_irq_register(). |
| 840 | */ |
840 | */ |
| 841 | unative_t sys_ipc_register_irq(inr_t inr, devno_t devno, unative_t method, |
841 | unative_t sys_ipc_register_irq(inr_t inr, devno_t devno, unative_t method, |
| 842 | irq_code_t *ucode) |
842 | irq_code_t *ucode) |
| 843 | { |
843 | { |
| 844 | if (!(cap_get(TASK) & CAP_IRQ_REG)) |
844 | if (!(cap_get(TASK) & CAP_IRQ_REG)) |
| 845 | return EPERM; |
845 | return EPERM; |
| 846 | 846 | ||
| 847 | return ipc_irq_register(&TASK->answerbox, inr, devno, method, ucode); |
847 | return ipc_irq_register(&TASK->answerbox, inr, devno, method, ucode); |
| 848 | } |
848 | } |
| 849 | 849 | ||
| 850 | /** Disconnect an IRQ handler from a task. |
850 | /** Disconnect an IRQ handler from a task. |
| 851 | * |
851 | * |
| 852 | * @param inr IRQ number. |
852 | * @param inr IRQ number. |
| 853 | * @param devno Device number. |
853 | * @param devno Device number. |
| 854 | * |
854 | * |
| 855 | * @return Zero on success or EPERM on error.. |
855 | * @return Zero on success or EPERM on error.. |
| 856 | */ |
856 | */ |
| 857 | unative_t sys_ipc_unregister_irq(inr_t inr, devno_t devno) |
857 | unative_t sys_ipc_unregister_irq(inr_t inr, devno_t devno) |
| 858 | { |
858 | { |
| 859 | if (!(cap_get(TASK) & CAP_IRQ_REG)) |
859 | if (!(cap_get(TASK) & CAP_IRQ_REG)) |
| 860 | return EPERM; |
860 | return EPERM; |
| 861 | 861 | ||
| 862 | ipc_irq_unregister(&TASK->answerbox, inr, devno); |
862 | ipc_irq_unregister(&TASK->answerbox, inr, devno); |
| 863 | 863 | ||
| 864 | return 0; |
864 | return 0; |
| 865 | } |
865 | } |
| 866 | 866 | ||
| 867 | /** @} |
867 | /** @} |
| 868 | */ |
868 | */ |
| 869 | 869 | ||