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