9c134d28e2dc0764fee918db2e9cd6d59fba3c73
[barrelfish] / lib / barrelfish / init.c
1 /**
2  * \file
3  * \brief Barrelfish library initialization.
4  */
5
6 /*
7  * Copyright (c) 2007-2012, ETH Zurich.
8  * Copyright (c) 2014, HP Labs.
9  * All rights reserved.
10  *
11  * This file is distributed under the terms in the attached LICENSE file.
12  * If you do not find this file, copies can be found by writing to:
13  * ETH Zurich D-INFK, CAB F.78, Universitaetstr. 6, CH-8092 Zurich,
14  * Attn: Systems Group.
15  */
16
17 #include <stdio.h>
18 #include <barrelfish/barrelfish.h>
19 #include <barrelfish/idc.h>
20 #include <barrelfish/dispatch.h>
21 #include <barrelfish/curdispatcher_arch.h>
22 #include <barrelfish/dispatcher_arch.h>
23 #include <barrelfish_kpi/dispatcher_shared.h>
24 #include <barrelfish/terminal.h>
25 #include <barrelfish/morecore.h>
26 #include <barrelfish/monitor_client.h>
27 #include <barrelfish/nameservice_client.h>
28 #include <barrelfish/spawn_client.h>
29 #include <barrelfish_kpi/domain_params.h>
30 #include <if/monitor_defs.h>
31 #include <trace/trace.h>
32 #include <octopus/init.h>
33 #include "threads_priv.h"
34 #include "init.h"
35
36 /// Are we the init domain (and thus need to take some special paths)?
37 static bool init_domain;
38
39 extern size_t (*_libc_terminal_read_func)(char *, size_t);
40 extern size_t (*_libc_terminal_write_func)(const char *, size_t);
41 extern void (*_libc_exit_func)(int);
42 extern void (*_libc_assert_func)(const char *, const char *, const char *, int);
43
44 void libc_exit(int);
45
46 void libc_exit(int status)
47 {
48     errval_t err;
49
50     if (!init_domain) {
51         terminal_exit();
52     }
53
54     // Use spawnd if spawned through spawnd
55     if(disp_get_domain_id() == 0) {
56 #if 0 // XXX: revocation goes through the mon, but monitor ep is revoked in the process
57         err = cap_revoke(cap_dispatcher);
58         if (err_is_fail(err)) {
59             DEBUG_ERR(err, "revoking dispatcher failed in _Exit, spinning!");
60             //sys_print("revoking dispatcher failed in _Exit, spinning!", 100);
61             while (1) {}
62         }
63         err = cap_delete(cap_dispatcher);
64         DEBUG_ERR(err, "deleting dispatcher failed in _Exit, spinning!");
65         //sys_print("deleting dispatcher failed in _Exit, spinning!", 100);
66 #endif
67
68         // XXX: Leak all other domain allocations
69     } else {
70         err = spawn_exit(status);
71         if(err_is_fail(err)) {
72             DEBUG_ERR(err, "spawn_exit");
73         }
74     }
75
76     thread_exit(status);
77     // If we're not dead by now, we wait
78     while (1) {}
79 }
80
81 static void libc_assert(const char *expression, const char *file,
82                         const char *function, int line)
83 {
84     char buf[512];
85     size_t len;
86
87     /* Formatting as per suggestion in C99 spec 7.2.1.1 */
88     len = snprintf(buf, sizeof(buf), "Assertion failed on core %d in %.*s: %s,"
89                    " function %s, file %s, line %d.\n",
90                    disp_get_core_id(), DISP_NAME_LEN,
91                    disp_name(), expression, function, file, line);
92     sys_print(buf, len < sizeof(buf) ? len : sizeof(buf));
93 }
94
95 /* Set libc function pointers */
96 void barrelfish_libc_glue_init(void)
97 {
98     _libc_terminal_read_func = terminal_read;
99     _libc_terminal_write_func = terminal_write;
100     _libc_exit_func = libc_exit;
101     _libc_assert_func = libc_assert;
102     /* morecore func is setup by morecore_init() */
103
104     // XXX: set a static buffer for stdout
105     // this avoids an implicit call to malloc() on the first printf
106     static char buf[BUFSIZ];
107     setvbuf(stdout, buf, _IOLBF, sizeof(buf));
108 }
109
110 static void monitor_bind_cont(void *st, errval_t err, struct monitor_binding *b);
111
112 #ifdef CONFIG_TRACE
113 errval_t trace_my_setup(void)
114 {
115 #ifndef TRACING_EXISTS
116     return SYS_ERR_OK;
117 #else
118     errval_t err;
119
120     struct capref cap = {
121         .cnode  = cnode_task,
122         .slot   = TASKCN_SLOT_TRACEBUF
123     };
124
125     if (disp_get_core_id() >= TRACE_COREID_LIMIT) {
126         // can't support tracing on this core. sorry :(
127         return SYS_ERR_OK;
128     }
129
130     err = vspace_map_one_frame((void**)&trace_buffer_master, TRACE_ALLOC_SIZE,
131                                cap, NULL, NULL);
132     if (err_is_fail(err)) {
133         DEBUG_ERR(err, "vspace_map_one_frame failed");
134         return err;
135     }
136
137     trace_buffer_va = trace_buffer_master +
138         (disp_get_core_id() * TRACE_PERCORE_BUF_SIZE);
139
140     dispatcher_handle_t handle = curdispatcher();
141     struct dispatcher_generic *disp = get_dispatcher_generic(handle);
142     // Update pointer to trace buffer in child's dispatcher
143     disp->trace_buf = (struct trace_buffer *)trace_buffer_va;
144
145     return SYS_ERR_OK;
146 #endif
147 }
148 #endif
149
150 static bool request_done = false;
151
152 static bool parse_argv(struct spawn_domain_params *params, size_t *morecore_alignment)
153 {
154     // grab pagesize config from argv if available
155     size_t morecore_pagesize = MORECORE_PAGESIZE;
156     int i = 1;
157     bool found = false;
158     for (; i < params->argc; i++) {
159         if (!found) {
160             if (!strncmp(params->argv[i], "morecore=", 9)) {
161                 morecore_pagesize = strtol(params->argv[i]+9, NULL, 0);
162                 // check for valid page size
163                 switch (morecore_pagesize) {
164 #ifdef __x86_64__
165                     case HUGE_PAGE_SIZE:
166 #endif
167                     case BASE_PAGE_SIZE:
168                     case LARGE_PAGE_SIZE:
169                         break;
170                     default:
171                         morecore_pagesize = MORECORE_PAGESIZE;
172                 }
173                 found = true;
174             }
175         } else {
176             // found so move all other args one to the front
177             params->argv[i-1] = params->argv[i];
178         }
179     }
180     if (found) {
181         params->argc -= 1;
182     }
183
184     if (morecore_alignment) {
185         *morecore_alignment = morecore_pagesize;
186     }
187
188     return found;
189 }
190
191 /** \brief Initialise libbarrelfish.
192  *
193  * This runs on a thread in every domain, after the dispatcher is setup but
194  * before main() runs.
195  */
196 errval_t barrelfish_init_onthread(struct spawn_domain_params *params)
197 {
198     errval_t err;
199
200     // do we have an environment?
201     if (params != NULL && params->envp[0] != NULL) {
202         extern char **environ;
203         environ = params->envp;
204     }
205
206     // Init default waitset for this dispatcher
207     struct waitset *default_ws = get_default_waitset();
208     waitset_init(default_ws);
209
210     // Initialize ram_alloc state
211     ram_alloc_init();
212     /* All domains use smallcn to initialize */
213     err = ram_alloc_set(ram_alloc_fixed);
214     if (err_is_fail(err)) {
215         return err_push(err, LIB_ERR_RAM_ALLOC_SET);
216     }
217
218     err = vspace_current_init(init_domain);
219     if (err_is_fail(err)) {
220         return err_push(err, LIB_ERR_VSPACE_INIT);
221     }
222
223     err = slot_alloc_init();
224     if (err_is_fail(err)) {
225         return err_push(err, LIB_ERR_SLOT_ALLOC_INIT);
226     }
227
228     // reconstruct our pmap from data passed to us by our parent
229     if (params != NULL && params->vspace_buf != NULL) {
230         struct pmap *pmap = get_current_pmap();
231         err = pmap->f.deserialise(pmap, params->vspace_buf,
232                                   params->vspace_buf_len);
233         if (err_is_fail(err)) {
234             return err_push(err, LIB_ERR_VSPACE_INIT);
235         }
236     } else if (init_domain) {
237         // TODO: the kernel boots us with a deterministic pmap structure: use it
238     }
239
240     if (init_domain) {
241         // we cannot use large pages in the init domains because we are not
242         // connected to the memory server and need to work with the 4k pages
243         // in the base cn.
244         err = morecore_init(BASE_PAGE_SIZE);
245     } else {
246         size_t morecore_pagesize = 0;
247         parse_argv(params, &morecore_pagesize);
248         err = morecore_init(morecore_pagesize);
249     }
250     if (err_is_fail(err)) {
251         return err_push(err, LIB_ERR_MORECORE_INIT);
252     }
253
254     lmp_endpoint_init();
255
256     // init domains only get partial init
257     if (init_domain) {
258         return SYS_ERR_OK;
259     }
260
261     /* bind to monitor */
262     struct monitor_lmp_binding *mcb =
263         malloc(sizeof(struct monitor_lmp_binding));
264     assert(mcb != NULL);
265     set_monitor_binding(&mcb->b);
266
267     errval_t init_complete_err;
268
269     request_done = false;
270     err = monitor_client_lmp_bind(mcb, monitor_bind_cont, &init_complete_err,
271                                   default_ws, DEFAULT_LMP_BUF_WORDS);
272     if (err_is_fail(err)) {
273         return err_push(err, LIB_ERR_MONITOR_CLIENT_BIND);
274     }
275
276     // dispatch events on the waitset until monitor binding completes
277     while (!request_done) {
278         err = event_dispatch(default_ws);
279         if (err_is_fail(err)) {
280             return err_push(err, LIB_ERR_EVENT_DISPATCH);
281         }
282     }
283
284     if(err_is_fail(init_complete_err)) {
285         USER_PANIC_ERR(err, "during initialization");
286     }
287
288     idc_init();
289
290     /* Bind with monitor's blocking rpc channel */
291     err = monitor_client_blocking_rpc_init();
292     if (err_is_fail(err)) {
293         return err_push(err, LIB_ERR_MONITOR_RPC_BIND);
294     }
295
296     /* XXX: Setup the channel with mem_serv and use the channel instead */
297     err = ram_alloc_set(NULL);
298     if (err_is_fail(err)) {
299         return err_push(err, LIB_ERR_RAM_ALLOC_SET);
300     }
301
302     // switch morecore to intended configuration
303     err = morecore_reinit();
304     if (err_is_fail(err)) {
305         return err_push(err, LIB_ERR_MORECORE_INIT);
306     }
307
308 #ifdef CONFIG_TRACE
309     err = trace_my_setup();
310     if (err_is_fail(err)) {
311         DEBUG_ERR(err, "trace_my_setup failed");
312         return err;
313     }
314 #endif
315
316     // try to connect to name service (may fail if we are the skb or ramfsd!)
317     err = nameservice_client_blocking_bind();
318     if (err_is_fail(err)) {
319         if (err_no(err) == LIB_ERR_GET_NAME_IREF) {
320             // skip everything else if we don't have a nameservice
321             return SYS_ERR_OK;
322         } else {
323             return err_push(err, LIB_ERR_NAMESERVICE_CLIENT_INIT);
324         }
325     }
326
327     // init terminal
328     err = terminal_init();
329     if (err_is_fail(err)) {
330         return err_push(err, LIB_ERR_TERMINAL_INIT);
331     }
332
333     // Init domain spanning code
334     err = domain_init();
335     if (err_is_fail(err)) {
336         return err_push(err, LIB_ERR_DOMAIN_INIT);
337     }
338
339     // XXX: Record text/data mappings from environment
340     char *p = getenv("ARRAKIS_PMAP");
341     if(p != NULL) {
342         struct morecore_state *mcstate = get_morecore_state();
343         for(mcstate->v2p_entries = 0; *p != '\0'; mcstate->v2p_entries++) {
344             assert(mcstate->v2p_entries < MAX_V2P_MAPPINGS);
345             struct v2pmap *e = &mcstate->v2p_mappings[mcstate->v2p_entries];
346             int r = sscanf(p, "%" PRIxGENVADDR ":%" PRIxGENPADDR ":%zx ", &e->va, &e->pa, &e->size);
347             assert(r == 3);
348             p = strchr(p, ' ') + 1;
349         }
350     }
351
352     return err;
353 }
354
355 static void monitor_bind_cont(void *st, errval_t err, struct monitor_binding *b)
356 {
357     // hacky errval_t state pointer used to signal completion
358     errval_t *init_complete_err = st;
359
360     assert(!init_domain);
361     *init_complete_err = err;
362
363     // signal completion
364     request_done = true;
365 }
366
367 /**
368  *  \brief Initialise libbarrelfish, while disabled.
369  *
370  * This runs on the dispatcher's stack, while disabled, before the dispatcher is
371  * setup. We can't call anything that needs to be enabled (ie. cap invocations)
372  * or uses threads. This is called from crt0.
373  */
374 void barrelfish_init_disabled(dispatcher_handle_t handle, bool init_dom_arg);
375 void barrelfish_init_disabled(dispatcher_handle_t handle, bool init_dom_arg)
376 {
377     init_domain = init_dom_arg;
378     disp_init_disabled(handle);
379     thread_init_disabled(handle, init_dom_arg);
380 }