1 | /*
|
---|
2 | * Copyright (c) 2008 Jiri Svoboda
|
---|
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 loader
|
---|
30 | * @{
|
---|
31 | */
|
---|
32 | /**
|
---|
33 | * @file
|
---|
34 | *
|
---|
35 | * The program loader is a special init binary. Its image is used
|
---|
36 | * to create a new task upon a @c task_spawn syscall. The syscall
|
---|
37 | * returns the id of a phone connected to the newly created task.
|
---|
38 | *
|
---|
39 | * The caller uses this phone to send the pathname and various other
|
---|
40 | * information to the loader. This is normally done by the C library
|
---|
41 | * and completely hidden from applications.
|
---|
42 | */
|
---|
43 |
|
---|
44 | #include <stdio.h>
|
---|
45 | #include <stdlib.h>
|
---|
46 | #include <stdbool.h>
|
---|
47 | #include <stddef.h>
|
---|
48 | #include <ipc/services.h>
|
---|
49 | #include <ipc/loader.h>
|
---|
50 | #include <ns.h>
|
---|
51 | #include <loader/pcb.h>
|
---|
52 | #include <entry_point.h>
|
---|
53 | #include <errno.h>
|
---|
54 | #include <async.h>
|
---|
55 | #include <str.h>
|
---|
56 | #include <as.h>
|
---|
57 | #include <elf/elf.h>
|
---|
58 | #include <elf/elf_load.h>
|
---|
59 | #include <vfs/vfs.h>
|
---|
60 | #include <vfs/inbox.h>
|
---|
61 |
|
---|
62 | #ifdef CONFIG_RTLD
|
---|
63 | #include <rtld/rtld.h>
|
---|
64 | #endif
|
---|
65 |
|
---|
66 | #define DPRINTF(...) ((void) 0)
|
---|
67 |
|
---|
68 | /** File that will be loaded */
|
---|
69 | static char *progname = NULL;
|
---|
70 | static int program_fd = -1;
|
---|
71 |
|
---|
72 | /** The Program control block */
|
---|
73 | static pcb_t pcb;
|
---|
74 |
|
---|
75 | /** Current working directory */
|
---|
76 | static char *cwd = NULL;
|
---|
77 |
|
---|
78 | /** Number of arguments */
|
---|
79 | static int argc = 0;
|
---|
80 | /** Argument vector */
|
---|
81 | static char **argv = NULL;
|
---|
82 | /** Buffer holding all arguments */
|
---|
83 | static char *arg_buf = NULL;
|
---|
84 |
|
---|
85 | /** Inbox entries. */
|
---|
86 | static struct pcb_inbox_entry inbox[INBOX_MAX_ENTRIES];
|
---|
87 | static int inbox_entries = 0;
|
---|
88 |
|
---|
89 | static elf_info_t prog_info;
|
---|
90 |
|
---|
91 | /** Used to limit number of connections to one. */
|
---|
92 | static bool connected = false;
|
---|
93 |
|
---|
94 | static void ldr_get_taskid(ipc_call_t *req)
|
---|
95 | {
|
---|
96 | ipc_call_t call;
|
---|
97 | task_id_t task_id;
|
---|
98 | size_t len;
|
---|
99 |
|
---|
100 | task_id = task_get_id();
|
---|
101 |
|
---|
102 | if (!async_data_read_receive(&call, &len)) {
|
---|
103 | async_answer_0(&call, EINVAL);
|
---|
104 | async_answer_0(req, EINVAL);
|
---|
105 | return;
|
---|
106 | }
|
---|
107 |
|
---|
108 | if (len > sizeof(task_id))
|
---|
109 | len = sizeof(task_id);
|
---|
110 |
|
---|
111 | DPRINTF("LOADER_GET_TASKID() = %lu\n", (unsigned long) task_id);
|
---|
112 | async_data_read_finalize(&call, &task_id, len);
|
---|
113 | async_answer_0(req, EOK);
|
---|
114 | }
|
---|
115 |
|
---|
116 | /** Receive a call setting the current working directory.
|
---|
117 | *
|
---|
118 | */
|
---|
119 | static void ldr_set_cwd(ipc_call_t *req)
|
---|
120 | {
|
---|
121 | char *buf;
|
---|
122 | errno_t rc = async_data_write_accept((void **) &buf, true, 0, 0, 0, NULL);
|
---|
123 |
|
---|
124 | if (rc == EOK) {
|
---|
125 | if (cwd != NULL)
|
---|
126 | free(cwd);
|
---|
127 |
|
---|
128 | cwd = buf;
|
---|
129 | }
|
---|
130 |
|
---|
131 | DPRINTF("LOADER_SET_CWD('%s')\n", cwd);
|
---|
132 | async_answer_0(req, rc);
|
---|
133 | }
|
---|
134 |
|
---|
135 | /** Receive a call setting the program to execute.
|
---|
136 | *
|
---|
137 | */
|
---|
138 | static void ldr_set_program(ipc_call_t *req)
|
---|
139 | {
|
---|
140 | ipc_call_t call;
|
---|
141 | size_t namesize;
|
---|
142 | if (!async_data_write_receive(&call, &namesize)) {
|
---|
143 | async_answer_0(req, EINVAL);
|
---|
144 | return;
|
---|
145 | }
|
---|
146 |
|
---|
147 | char *name = malloc(namesize);
|
---|
148 | // FIXME: check return value
|
---|
149 |
|
---|
150 | errno_t rc = async_data_write_finalize(&call, name, namesize);
|
---|
151 | if (rc != EOK) {
|
---|
152 | async_answer_0(req, EINVAL);
|
---|
153 | return;
|
---|
154 | }
|
---|
155 |
|
---|
156 | int file;
|
---|
157 | rc = vfs_receive_handle(true, &file);
|
---|
158 | if (rc != EOK) {
|
---|
159 | async_answer_0(req, EINVAL);
|
---|
160 | return;
|
---|
161 | }
|
---|
162 |
|
---|
163 | DPRINTF("LOADER_SET_PROGRAM('%s')\n", name);
|
---|
164 |
|
---|
165 | progname = name;
|
---|
166 | program_fd = file;
|
---|
167 | async_answer_0(req, EOK);
|
---|
168 | }
|
---|
169 |
|
---|
170 | /** Receive a call setting arguments of the program to execute.
|
---|
171 | *
|
---|
172 | */
|
---|
173 | static void ldr_set_args(ipc_call_t *req)
|
---|
174 | {
|
---|
175 | char *buf;
|
---|
176 | size_t buf_size;
|
---|
177 | errno_t rc = async_data_write_accept((void **) &buf, true, 0, 0, 0, &buf_size);
|
---|
178 |
|
---|
179 | if (rc == EOK) {
|
---|
180 | /*
|
---|
181 | * Count number of arguments
|
---|
182 | */
|
---|
183 | char *cur = buf;
|
---|
184 | int count = 0;
|
---|
185 |
|
---|
186 | while (cur < buf + buf_size) {
|
---|
187 | size_t arg_size = str_size(cur);
|
---|
188 | cur += arg_size + 1;
|
---|
189 | count++;
|
---|
190 | }
|
---|
191 |
|
---|
192 | /*
|
---|
193 | * Allocate new argv
|
---|
194 | */
|
---|
195 | char **_argv = (char **) malloc((count + 1) * sizeof(char *));
|
---|
196 | if (_argv == NULL) {
|
---|
197 | free(buf);
|
---|
198 | async_answer_0(req, ENOMEM);
|
---|
199 | return;
|
---|
200 | }
|
---|
201 |
|
---|
202 | /*
|
---|
203 | * Fill the new argv with argument pointers
|
---|
204 | */
|
---|
205 | cur = buf;
|
---|
206 | count = 0;
|
---|
207 | while (cur < buf + buf_size) {
|
---|
208 | _argv[count] = cur;
|
---|
209 |
|
---|
210 | size_t arg_size = str_size(cur);
|
---|
211 | cur += arg_size + 1;
|
---|
212 | count++;
|
---|
213 | }
|
---|
214 | _argv[count] = NULL;
|
---|
215 |
|
---|
216 | /*
|
---|
217 | * Copy temporary data to global variables
|
---|
218 | */
|
---|
219 | if (arg_buf != NULL)
|
---|
220 | free(arg_buf);
|
---|
221 |
|
---|
222 | if (argv != NULL)
|
---|
223 | free(argv);
|
---|
224 |
|
---|
225 | for (int i = 0; i < count; i++)
|
---|
226 | DPRINTF("LOADER_SET_ARGS('%s')\n", _argv[i]);
|
---|
227 |
|
---|
228 | argc = count;
|
---|
229 | arg_buf = buf;
|
---|
230 | argv = _argv;
|
---|
231 | }
|
---|
232 |
|
---|
233 | async_answer_0(req, rc);
|
---|
234 | }
|
---|
235 |
|
---|
236 | /** Receive a call setting inbox files of the program to execute.
|
---|
237 | *
|
---|
238 | */
|
---|
239 | static void ldr_add_inbox(ipc_call_t *req)
|
---|
240 | {
|
---|
241 | if (inbox_entries == INBOX_MAX_ENTRIES) {
|
---|
242 | async_answer_0(req, ERANGE);
|
---|
243 | return;
|
---|
244 | }
|
---|
245 |
|
---|
246 | ipc_call_t call;
|
---|
247 | size_t namesize;
|
---|
248 | if (!async_data_write_receive(&call, &namesize)) {
|
---|
249 | async_answer_0(req, EINVAL);
|
---|
250 | return;
|
---|
251 | }
|
---|
252 |
|
---|
253 | char *name = malloc(namesize);
|
---|
254 | errno_t rc = async_data_write_finalize(&call, name, namesize);
|
---|
255 | if (rc != EOK) {
|
---|
256 | async_answer_0(req, EINVAL);
|
---|
257 | return;
|
---|
258 | }
|
---|
259 |
|
---|
260 | int file;
|
---|
261 | rc = vfs_receive_handle(true, &file);
|
---|
262 | if (rc != EOK) {
|
---|
263 | async_answer_0(req, EINVAL);
|
---|
264 | return;
|
---|
265 | }
|
---|
266 |
|
---|
267 | DPRINTF("LOADER_ADD_INBOX('%s')\n", name);
|
---|
268 |
|
---|
269 | /*
|
---|
270 | * We need to set the root early for dynamically linked binaries so
|
---|
271 | * that the loader can use it too.
|
---|
272 | */
|
---|
273 | if (str_cmp(name, "root") == 0)
|
---|
274 | vfs_root_set(file);
|
---|
275 |
|
---|
276 | inbox[inbox_entries].name = name;
|
---|
277 | inbox[inbox_entries].file = file;
|
---|
278 | inbox_entries++;
|
---|
279 | async_answer_0(req, EOK);
|
---|
280 | }
|
---|
281 |
|
---|
282 | /** Load the previously selected program.
|
---|
283 | *
|
---|
284 | * @return 0 on success, !0 on error.
|
---|
285 | *
|
---|
286 | */
|
---|
287 | static int ldr_load(ipc_call_t *req)
|
---|
288 | {
|
---|
289 | DPRINTF("LOADER_LOAD()\n");
|
---|
290 |
|
---|
291 | int rc = elf_load(program_fd, &prog_info);
|
---|
292 | if (rc != EE_OK) {
|
---|
293 | DPRINTF("Failed to load executable for '%s'.\n", progname);
|
---|
294 | async_answer_0(req, EINVAL);
|
---|
295 | return 1;
|
---|
296 | }
|
---|
297 |
|
---|
298 | DPRINTF("Loaded.\n");
|
---|
299 |
|
---|
300 | #ifdef CONFIG_RTLD
|
---|
301 | if (prog_info.env) {
|
---|
302 | pcb.tcb = rtld_tls_make(prog_info.env);
|
---|
303 | } else {
|
---|
304 | pcb.tcb = tls_make(prog_info.finfo.base);
|
---|
305 | }
|
---|
306 | #else
|
---|
307 | pcb.tcb = tls_make(prog_info.finfo.base);
|
---|
308 | #endif
|
---|
309 |
|
---|
310 | elf_set_pcb(&prog_info, &pcb);
|
---|
311 |
|
---|
312 | DPRINTF("PCB set.\n");
|
---|
313 |
|
---|
314 | pcb.cwd = cwd;
|
---|
315 |
|
---|
316 | pcb.argc = argc;
|
---|
317 | pcb.argv = argv;
|
---|
318 |
|
---|
319 | pcb.inbox = inbox;
|
---|
320 | pcb.inbox_entries = inbox_entries;
|
---|
321 |
|
---|
322 | DPRINTF("Answering.\n");
|
---|
323 | async_answer_0(req, EOK);
|
---|
324 | return 0;
|
---|
325 | }
|
---|
326 |
|
---|
327 | /** Run the previously loaded program.
|
---|
328 | *
|
---|
329 | * @return 0 on success, !0 on error.
|
---|
330 | *
|
---|
331 | */
|
---|
332 | static __attribute__((noreturn)) void ldr_run(ipc_call_t *req)
|
---|
333 | {
|
---|
334 | DPRINTF("Set task name\n");
|
---|
335 |
|
---|
336 | /* Set the task name. */
|
---|
337 | task_set_name(progname);
|
---|
338 |
|
---|
339 | /* Run program */
|
---|
340 | DPRINTF("Reply OK\n");
|
---|
341 | async_answer_0(req, EOK);
|
---|
342 |
|
---|
343 | /*
|
---|
344 | * Wait for the hangup from the other side in order not to leave any
|
---|
345 | * unanswered IPC_M_PHONE_HUNGUP messages behind.
|
---|
346 | */
|
---|
347 | async_get_call(req);
|
---|
348 | assert(!IPC_GET_IMETHOD(*req));
|
---|
349 | async_answer_0(req, EOK);
|
---|
350 |
|
---|
351 | DPRINTF("Jump to entry point at %p\n", pcb.entry);
|
---|
352 |
|
---|
353 | __tcb_reset();
|
---|
354 | entry_point_jmp(prog_info.finfo.entry, &pcb);
|
---|
355 |
|
---|
356 | /* Not reached */
|
---|
357 | }
|
---|
358 |
|
---|
359 | /** Handle loader connection.
|
---|
360 | *
|
---|
361 | * Receive and carry out commands (of which the last one should be
|
---|
362 | * to execute the loaded program).
|
---|
363 | *
|
---|
364 | */
|
---|
365 | static void ldr_connection(ipc_call_t *icall, void *arg)
|
---|
366 | {
|
---|
367 | /* Already have a connection? */
|
---|
368 | if (connected) {
|
---|
369 | async_answer_0(icall, ELIMIT);
|
---|
370 | return;
|
---|
371 | }
|
---|
372 |
|
---|
373 | connected = true;
|
---|
374 |
|
---|
375 | /* Accept the connection */
|
---|
376 | async_answer_5(icall, EOK, 0, 0, 0, 0, async_get_label());
|
---|
377 |
|
---|
378 | /* Ignore parameters, the connection is already open */
|
---|
379 | (void) icall;
|
---|
380 |
|
---|
381 | while (true) {
|
---|
382 | errno_t retval;
|
---|
383 | ipc_call_t call;
|
---|
384 | async_get_call(&call);
|
---|
385 |
|
---|
386 | if (!IPC_GET_IMETHOD(call)) {
|
---|
387 | async_answer_0(&call, EOK);
|
---|
388 | exit(0);
|
---|
389 | }
|
---|
390 |
|
---|
391 | switch (IPC_GET_IMETHOD(call)) {
|
---|
392 | case LOADER_GET_TASKID:
|
---|
393 | ldr_get_taskid(&call);
|
---|
394 | continue;
|
---|
395 | case LOADER_SET_CWD:
|
---|
396 | ldr_set_cwd(&call);
|
---|
397 | continue;
|
---|
398 | case LOADER_SET_PROGRAM:
|
---|
399 | ldr_set_program(&call);
|
---|
400 | continue;
|
---|
401 | case LOADER_SET_ARGS:
|
---|
402 | ldr_set_args(&call);
|
---|
403 | continue;
|
---|
404 | case LOADER_ADD_INBOX:
|
---|
405 | ldr_add_inbox(&call);
|
---|
406 | continue;
|
---|
407 | case LOADER_LOAD:
|
---|
408 | ldr_load(&call);
|
---|
409 | continue;
|
---|
410 | case LOADER_RUN:
|
---|
411 | ldr_run(&call);
|
---|
412 | /* Not reached */
|
---|
413 | default:
|
---|
414 | retval = EINVAL;
|
---|
415 | break;
|
---|
416 | }
|
---|
417 |
|
---|
418 | async_answer_0(&call, retval);
|
---|
419 | }
|
---|
420 | }
|
---|
421 |
|
---|
422 | /** Program loader main function.
|
---|
423 | */
|
---|
424 | int main(int argc, char *argv[])
|
---|
425 | {
|
---|
426 | /* Introduce this task to the NS (give it our task ID). */
|
---|
427 | task_id_t id = task_get_id();
|
---|
428 | errno_t rc = ns_intro(id);
|
---|
429 | if (rc != EOK)
|
---|
430 | return rc;
|
---|
431 |
|
---|
432 | /* Register at naming service. */
|
---|
433 | rc = service_register(SERVICE_LOADER, INTERFACE_LOADER,
|
---|
434 | ldr_connection, NULL);
|
---|
435 | if (rc != EOK)
|
---|
436 | return rc;
|
---|
437 |
|
---|
438 | async_manager();
|
---|
439 |
|
---|
440 | /* Never reached */
|
---|
441 | return 0;
|
---|
442 | }
|
---|
443 |
|
---|
444 | /** @}
|
---|
445 | */
|
---|