L4Re Operating System Framework
Interface and Usage Documentation
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
factory.h
Go to the documentation of this file.
1
6/*
7 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
8 * Alexander Warg <warg@os.inf.tu-dresden.de>,
9 * Björn Döbel <doebel@os.inf.tu-dresden.de>,
10 * Torsten Frenzel <frenzel@os.inf.tu-dresden.de>,
11 * Henning Schild <hschild@os.inf.tu-dresden.de>
12 * economic rights: Technische Universität Dresden (Germany)
13 *
14 * License: see LICENSE.spdx (in this directory or the directories above)
15 */
16#pragma once
17
18#include <l4/sys/compiler.h>
19#include <l4/sys/types.h>
20#include <l4/sys/utcb.h>
21
86L4_INLINE l4_msgtag_t
87l4_factory_create_task(l4_cap_idx_t factory, l4_cap_idx_t target_cap,
88 l4_fpage_t *utcb_area) L4_NOTHROW;
89
94L4_INLINE l4_msgtag_t
95l4_factory_create_task_u(l4_cap_idx_t factory, l4_cap_idx_t target_cap,
96 l4_fpage_t *utcb_area, l4_utcb_t *utcb) L4_NOTHROW;
97
116L4_INLINE l4_msgtag_t
117l4_factory_create_thread(l4_cap_idx_t factory,
118 l4_cap_idx_t target_cap) L4_NOTHROW;
119
124L4_INLINE l4_msgtag_t
125l4_factory_create_thread_u(l4_cap_idx_t factory,
126 l4_cap_idx_t target_cap, l4_utcb_t *utcb) L4_NOTHROW;
127
153L4_INLINE l4_msgtag_t
154l4_factory_create_factory(l4_cap_idx_t factory, l4_cap_idx_t target_cap,
155 unsigned long limit) L4_NOTHROW;
156
161L4_INLINE l4_msgtag_t
162l4_factory_create_factory_u(l4_cap_idx_t factory, l4_cap_idx_t target_cap,
163 unsigned long limit, l4_utcb_t *utcb) L4_NOTHROW;
164
194L4_INLINE l4_msgtag_t
195l4_factory_create_gate(l4_cap_idx_t factory,
196 l4_cap_idx_t target_cap,
197 l4_cap_idx_t thread_cap, l4_umword_t label) L4_NOTHROW;
198
203L4_INLINE l4_msgtag_t
204l4_factory_create_gate_u(l4_cap_idx_t factory,
205 l4_cap_idx_t target_cap,
206 l4_cap_idx_t thread_cap, l4_umword_t label,
207 l4_utcb_t *utcb) L4_NOTHROW;
208
225L4_INLINE l4_msgtag_t
226l4_factory_create_irq(l4_cap_idx_t factory,
227 l4_cap_idx_t target_cap) L4_NOTHROW;
228
233L4_INLINE l4_msgtag_t
234l4_factory_create_irq_u(l4_cap_idx_t factory,
235 l4_cap_idx_t target_cap, l4_utcb_t *utcb) L4_NOTHROW;
236
255L4_INLINE l4_msgtag_t
256l4_factory_create_vm(l4_cap_idx_t factory,
257 l4_cap_idx_t target_cap) L4_NOTHROW;
258
278L4_INLINE l4_msgtag_t
279l4_factory_create_vcpu_context(l4_cap_idx_t factory,
280 l4_cap_idx_t target_cap) L4_NOTHROW;
281
286L4_INLINE l4_msgtag_t
287l4_factory_create_vm_u(l4_cap_idx_t factory,
288 l4_cap_idx_t target_cap, l4_utcb_t *utcb) L4_NOTHROW;
289
294L4_INLINE l4_msgtag_t
295l4_factory_create_vcpu_context_u(l4_cap_idx_t factory,
296 l4_cap_idx_t target_cap,
297 l4_utcb_t *utcb) L4_NOTHROW;
298
303L4_INLINE l4_msgtag_t
304l4_factory_create_start_u(long obj, l4_cap_idx_t target,
305 l4_utcb_t *utcb) L4_NOTHROW;
306
311L4_INLINE int
312l4_factory_create_add_fpage_u(l4_fpage_t d, l4_msgtag_t *tag,
313 l4_utcb_t *utcb) L4_NOTHROW;
314
319L4_INLINE int
320l4_factory_create_add_int_u(l4_mword_t d, l4_msgtag_t *tag,
321 l4_utcb_t *utcb) L4_NOTHROW;
322
327L4_INLINE int
328l4_factory_create_add_uint_u(l4_umword_t d, l4_msgtag_t *tag,
329 l4_utcb_t *utcb) L4_NOTHROW;
330
335L4_INLINE int
336l4_factory_create_add_str_u(char const *s, l4_msgtag_t *tag,
337 l4_utcb_t *utcb) L4_NOTHROW;
338
343L4_INLINE int
344l4_factory_create_add_lstr_u(char const *s, unsigned len, l4_msgtag_t *tag,
345 l4_utcb_t *utcb) L4_NOTHROW;
346
351L4_INLINE int
352l4_factory_create_add_nil_u(l4_msgtag_t *tag, l4_utcb_t *utcb) L4_NOTHROW;
353
358L4_INLINE l4_msgtag_t
359l4_factory_create_commit_u(l4_cap_idx_t factory, l4_msgtag_t tag,
360 l4_utcb_t *utcb) L4_NOTHROW;
361
366L4_INLINE l4_msgtag_t
367l4_factory_create_u(l4_cap_idx_t factory, long obj, l4_cap_idx_t target,
368 l4_utcb_t *utcb) L4_NOTHROW;
369
370
388L4_INLINE l4_msgtag_t
389l4_factory_create(l4_cap_idx_t factory, long obj,
390 l4_cap_idx_t target) L4_NOTHROW;
391
392/* IMPLEMENTATION -----------------------------------------------------------*/
393
394#include <l4/sys/ipc.h>
395
396L4_INLINE l4_msgtag_t
397l4_factory_create_task_u(l4_cap_idx_t factory,
398 l4_cap_idx_t target_cap, l4_fpage_t *utcb_area,
399 l4_utcb_t *u) L4_NOTHROW
400{
401 l4_msgtag_t t;
402 t = l4_factory_create_start_u(L4_PROTO_TASK, target_cap, u);
403 l4_factory_create_add_fpage_u(*utcb_area, &t, u);
404 t = l4_factory_create_commit_u(factory, t, u);
405 if (!l4_msgtag_has_error(t))
406 {
407 l4_msg_regs_t *v = l4_utcb_mr_u(u);
408 utcb_area->raw = v->mr[0];
409 }
410 return t;
411}
412
413L4_INLINE l4_msgtag_t
414l4_factory_create_thread_u(l4_cap_idx_t factory,
415 l4_cap_idx_t target_cap, l4_utcb_t *u) L4_NOTHROW
416{
417 return l4_factory_create_u(factory, L4_PROTO_THREAD, target_cap, u);
418}
419
420L4_INLINE l4_msgtag_t
421l4_factory_create_factory_u(l4_cap_idx_t factory,
422 l4_cap_idx_t target_cap, unsigned long limit,
423 l4_utcb_t *u) L4_NOTHROW
424{
425 l4_msgtag_t t;
426 t = l4_factory_create_start_u(L4_PROTO_FACTORY, target_cap, u);
427 l4_factory_create_add_uint_u(limit, &t, u);
428 return l4_factory_create_commit_u(factory, t, u);
429}
430
431L4_INLINE l4_msgtag_t
432l4_factory_create_gate_u(l4_cap_idx_t factory,
433 l4_cap_idx_t target_cap,
434 l4_cap_idx_t thread_cap, l4_umword_t label,
435 l4_utcb_t *u) L4_NOTHROW
436{
437 l4_msgtag_t t;
438 l4_msg_regs_t *v;
439 int items = 0;
440 t = l4_factory_create_start_u(0, target_cap, u);
441 l4_factory_create_add_uint_u(label, &t, u);
442 v = l4_utcb_mr_u(u);
443 if (!(thread_cap & L4_INVALID_CAP_BIT))
444 {
445 items = 1;
446 v->mr[3] = l4_map_obj_control(0,0);
447 v->mr[4] = l4_obj_fpage(thread_cap, 0, L4_CAP_FPAGE_RWS).raw;
448 }
449 t = l4_msgtag(l4_msgtag_label(t), l4_msgtag_words(t), items, l4_msgtag_flags(t));
450 return l4_factory_create_commit_u(factory, t, u);
451}
452
453L4_INLINE l4_msgtag_t
454l4_factory_create_irq_u(l4_cap_idx_t factory,
455 l4_cap_idx_t target_cap, l4_utcb_t *u) L4_NOTHROW
456{
457 return l4_factory_create_u(factory, L4_PROTO_IRQ_SENDER, target_cap, u);
458}
459
460L4_INLINE l4_msgtag_t
461l4_factory_create_vm_u(l4_cap_idx_t factory,
462 l4_cap_idx_t target_cap,
463 l4_utcb_t *u) L4_NOTHROW
464{
465 return l4_factory_create_u(factory, L4_PROTO_VM, target_cap, u);
466}
467
468L4_INLINE l4_msgtag_t
469l4_factory_create_vcpu_context_u(l4_cap_idx_t factory,
470 l4_cap_idx_t target_cap,
471 l4_utcb_t *u) L4_NOTHROW
472{
473 return l4_factory_create_u(factory, L4_PROTO_VCPU_CONTEXT, target_cap, u);
474}
475
476
477
478
479
480L4_INLINE l4_msgtag_t
481l4_factory_create_task(l4_cap_idx_t factory,
482 l4_cap_idx_t target_cap, l4_fpage_t *utcb_area) L4_NOTHROW
483{
484 return l4_factory_create_task_u(factory, target_cap, utcb_area, l4_utcb());
485}
486
487L4_INLINE l4_msgtag_t
488l4_factory_create_thread(l4_cap_idx_t factory,
489 l4_cap_idx_t target_cap) L4_NOTHROW
490{
491 return l4_factory_create_thread_u(factory, target_cap, l4_utcb());
492}
493
494L4_INLINE l4_msgtag_t
495l4_factory_create_factory(l4_cap_idx_t factory,
496 l4_cap_idx_t target_cap, unsigned long limit) L4_NOTHROW
497
498{
499 return l4_factory_create_factory_u(factory, target_cap, limit, l4_utcb());
500}
501
502L4_INLINE l4_msgtag_t
503l4_factory_create_gate(l4_cap_idx_t factory,
504 l4_cap_idx_t target_cap,
505 l4_cap_idx_t thread_cap, l4_umword_t label) L4_NOTHROW
506{
507 return l4_factory_create_gate_u(factory, target_cap, thread_cap, label, l4_utcb());
508}
509
510L4_INLINE l4_msgtag_t
511l4_factory_create_irq(l4_cap_idx_t factory,
512 l4_cap_idx_t target_cap) L4_NOTHROW
513{
514 return l4_factory_create_irq_u(factory, target_cap, l4_utcb());
515}
516
517L4_INLINE l4_msgtag_t
518l4_factory_create_vm(l4_cap_idx_t factory,
519 l4_cap_idx_t target_cap) L4_NOTHROW
520{
521 return l4_factory_create_vm_u(factory, target_cap, l4_utcb());
522}
523
524L4_INLINE l4_msgtag_t
525l4_factory_create_vcpu_context(l4_cap_idx_t factory,
526 l4_cap_idx_t target_cap) L4_NOTHROW
527{
528 return l4_factory_create_vcpu_context_u(factory, target_cap, l4_utcb());
529}
530
531L4_INLINE l4_msgtag_t
532l4_factory_create_start_u(long obj, l4_cap_idx_t target_cap,
533 l4_utcb_t *u) L4_NOTHROW
534{
535 l4_msg_regs_t *v = l4_utcb_mr_u(u);
536 l4_buf_regs_t *b = l4_utcb_br_u(u);
537 v->mr[0] = obj;
538 b->bdr = 0;
539 b->br[0] = target_cap | L4_RCV_ITEM_SINGLE_CAP;
540 return l4_msgtag(L4_PROTO_FACTORY, 1, 0, 0);
541}
542
543L4_INLINE int
544l4_factory_create_add_fpage_u(l4_fpage_t d, l4_msgtag_t *tag,
545 l4_utcb_t *u) L4_NOTHROW
546{
547 l4_msg_regs_t *v = l4_utcb_mr_u(u);
548 int w = l4_msgtag_words(*tag);
549 if (w + 2 > L4_UTCB_GENERIC_DATA_SIZE)
550 return 0;
551 v->mr[w] = L4_VARG_TYPE_FPAGE | (sizeof(l4_fpage_t) << 16);
552 v->mr[w + 1] = d.raw;
553 w += 2;
554 tag->raw = (tag->raw & ~0x3fUL) | (w & 0x3f);
555 return 1;
556}
557
558L4_INLINE int
559l4_factory_create_add_int_u(l4_mword_t d, l4_msgtag_t *tag,
560 l4_utcb_t *u) L4_NOTHROW
561{
562 l4_msg_regs_t *v = l4_utcb_mr_u(u);
563 int w = l4_msgtag_words(*tag);
564 if (w + 2 > L4_UTCB_GENERIC_DATA_SIZE)
565 return 0;
566 v->mr[w] = L4_VARG_TYPE_MWORD | (sizeof(l4_mword_t) << 16);
567 v->mr[w + 1] = d;
568 w += 2;
569 tag->raw = (tag->raw & ~0x3fUL) | (w & 0x3f);
570 return 1;
571}
572
573L4_INLINE int
574l4_factory_create_add_uint_u(l4_umword_t d, l4_msgtag_t *tag,
575 l4_utcb_t *u) L4_NOTHROW
576{
577 l4_msg_regs_t *v = l4_utcb_mr_u(u);
578 int w = l4_msgtag_words(*tag);
579 if (w + 2 > L4_UTCB_GENERIC_DATA_SIZE)
580 return 0;
581 v->mr[w] = L4_VARG_TYPE_UMWORD | (sizeof(l4_umword_t) << 16);
582 v->mr[w + 1] = d;
583 w += 2;
584 tag->raw = (tag->raw & ~0x3fUL) | (w & 0x3f);
585 return 1;
586}
587
588L4_INLINE int
589l4_factory_create_add_str_u(char const *s, l4_msgtag_t *tag,
590 l4_utcb_t *u) L4_NOTHROW
591{
592 return l4_factory_create_add_lstr_u(s, __builtin_strlen(s) + 1, tag, u);
593}
594
595L4_INLINE int
596l4_factory_create_add_lstr_u(char const *s, unsigned len, l4_msgtag_t *tag,
597 l4_utcb_t *u) L4_NOTHROW
598{
599
600 l4_msg_regs_t *v = l4_utcb_mr_u(u);
601 unsigned w = l4_msgtag_words(*tag);
602 char *c;
603 unsigned i;
604
605 if (w + 1 + l4_bytes_to_mwords(len) > L4_UTCB_GENERIC_DATA_SIZE)
606 return 0;
607
608 v->mr[w] = L4_VARG_TYPE_STRING | (len << 16);
609 c = (char*)&v->mr[w + 1];
610 for (i = 0; i < len; ++i)
611 *c++ = *s++;
612
613 w = w + 1 + l4_bytes_to_mwords(len);
614
615 tag->raw = (tag->raw & ~0x3fUL) | (w & 0x3f);
616 return 1;
617}
618
619L4_INLINE int
620l4_factory_create_add_nil_u(l4_msgtag_t *tag, l4_utcb_t *utcb) L4_NOTHROW
621{
622 l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
623 int w = l4_msgtag_words(*tag);
624 v->mr[w] = L4_VARG_TYPE_NIL;
625 ++w;
626 tag->raw = (tag->raw & ~0x3fUL) | (w & 0x3f);
627 return 1;
628}
629
630
631L4_INLINE l4_msgtag_t
632l4_factory_create_commit_u(l4_cap_idx_t factory, l4_msgtag_t tag,
633 l4_utcb_t *u) L4_NOTHROW
634{
635 return l4_ipc_call(factory, u, tag, L4_IPC_NEVER);
636}
637
638L4_INLINE l4_msgtag_t
639l4_factory_create_u(l4_cap_idx_t factory, long obj, l4_cap_idx_t target,
640 l4_utcb_t *utcb) L4_NOTHROW
641{
642 l4_msgtag_t t = l4_factory_create_start_u(obj, target, utcb);
643 return l4_factory_create_commit_u(factory, t, utcb);
644}
645
646
647L4_INLINE l4_msgtag_t
648l4_factory_create(l4_cap_idx_t factory, long obj,
649 l4_cap_idx_t target) L4_NOTHROW
650{
651 return l4_factory_create_u(factory, obj, target, l4_utcb());
652}
compiler.h
L4 compiler related defines.
l4_umword_t
unsigned long l4_umword_t
Unsigned machine word.
Definition l4int.h:40
l4_mword_t
signed long l4_mword_t
Signed machine word.
Definition l4int.h:37
l4_cap_idx_t
unsigned long l4_cap_idx_t
Capability selector type.
Definition types.h:335
l4_factory_create_gate
l4_msgtag_t l4_factory_create_gate(l4_cap_idx_t factory, l4_cap_idx_t target_cap, l4_cap_idx_t thread_cap, l4_umword_t label) L4_NOTHROW
Create a new IPC gate.
Definition factory.h:503
l4_factory_create_thread
l4_msgtag_t l4_factory_create_thread(l4_cap_idx_t factory, l4_cap_idx_t target_cap) L4_NOTHROW
Create a new thread.
Definition factory.h:488
l4_factory_create_irq
l4_msgtag_t l4_factory_create_irq(l4_cap_idx_t factory, l4_cap_idx_t target_cap) L4_NOTHROW
Create a new IRQ sender.
Definition factory.h:511
l4_factory_create_vcpu_context
l4_msgtag_t l4_factory_create_vcpu_context(l4_cap_idx_t factory, l4_cap_idx_t target_cap) L4_NOTHROW
Create a new vCPU context.
Definition factory.h:525
l4_factory_create_factory
l4_msgtag_t l4_factory_create_factory(l4_cap_idx_t factory, l4_cap_idx_t target_cap, unsigned long limit) L4_NOTHROW
Create a new factory.
Definition factory.h:495
l4_factory_create_task
l4_msgtag_t l4_factory_create_task(l4_cap_idx_t factory, l4_cap_idx_t target_cap, l4_fpage_t *utcb_area) L4_NOTHROW
Create a new task.
Definition factory.h:481
l4_factory_create
l4_msgtag_t l4_factory_create(l4_cap_idx_t factory, long obj, l4_cap_idx_t target) L4_NOTHROW
Create a new object.
Definition factory.h:648
l4_factory_create_vm
l4_msgtag_t l4_factory_create_vm(l4_cap_idx_t factory, l4_cap_idx_t target_cap) L4_NOTHROW
Create a new virtual machine.
Definition factory.h:518
l4_obj_fpage
l4_fpage_t l4_obj_fpage(l4_cap_idx_t obj, unsigned int order, unsigned char rights) L4_NOTHROW
Create a kernel-object flexpage.
Definition __l4_fpage.h:715
L4_CAP_FPAGE_RWS
@ L4_CAP_FPAGE_RWS
Read, interface specific 'W', and 'S' rights for capability flexpages.
Definition __l4_fpage.h:206
l4_ipc_call
l4_msgtag_t l4_ipc_call(l4_cap_idx_t object, l4_utcb_t *utcb, l4_msgtag_t tag, l4_timeout_t timeout) L4_NOTHROW
Object call (usual invocation).
Definition ipc.h:565
l4_bytes_to_mwords
unsigned l4_bytes_to_mwords(unsigned size) L4_NOTHROW
Determine how many machine words (l4_umword_t) are required to store a buffer of 'size' bytes.
Definition consts.h:496
l4_map_obj_control
l4_umword_t l4_map_obj_control(l4_umword_t spot, unsigned grant) L4_NOTHROW
Create the first word for a map item that is a send item for the object space.
Definition __l4_fpage.h:749
L4_RCV_ITEM_SINGLE_CAP
@ L4_RCV_ITEM_SINGLE_CAP
Mark the receive buffer to be a small receive item that describes a buffer for a single object capabi...
Definition consts.h:275
l4_msgtag_has_error
unsigned l4_msgtag_has_error(l4_msgtag_t t) L4_NOTHROW
Test for error indicator flag.
Definition types.h:439
l4_msgtag
l4_msgtag_t l4_msgtag(long label, unsigned words, unsigned items, unsigned flags) L4_NOTHROW
Create a message tag from the specified values.
Definition types.h:404
l4_msgtag_words
unsigned l4_msgtag_words(l4_msgtag_t t) L4_NOTHROW
Get the number of untyped words.
Definition types.h:426
l4_msgtag_flags
unsigned l4_msgtag_flags(l4_msgtag_t t) L4_NOTHROW
Get the flags.
Definition types.h:434
l4_msgtag_label
long l4_msgtag_label(l4_msgtag_t t) L4_NOTHROW
Get the protocol of tag.
Definition types.h:416
L4_PROTO_FACTORY
@ L4_PROTO_FACTORY
Protocol for messages to a factory object.
Definition types.h:56
L4_PROTO_IRQ_SENDER
@ L4_PROTO_IRQ_SENDER
Protocol for IRQ senders (IRQ -> IPC)
Definition types.h:59
L4_PROTO_TASK
@ L4_PROTO_TASK
Protocol for messages to a task object.
Definition types.h:52
L4_PROTO_VM
@ L4_PROTO_VM
Protocol for messages to a virtual machine object.
Definition types.h:57
L4_PROTO_THREAD
@ L4_PROTO_THREAD
Protocol for messages to a thread object.
Definition types.h:53
L4_PROTO_VCPU_CONTEXT
@ L4_PROTO_VCPU_CONTEXT
Protocol for hardware vCPU contexts.
Definition types.h:66
L4_IPC_NEVER
#define L4_IPC_NEVER
never timeout
Definition __timeout.h:76
l4_utcb_t
struct l4_utcb_t l4_utcb_t
Opaque type for the UTCB.
Definition utcb.h:56
l4_utcb
l4_utcb_t * l4_utcb(void) L4_NOTHROW L4_PURE
Get the UTCB address.
Definition utcb.h:346
L4_NOTHROW
#define L4_NOTHROW
Mark a function declaration and definition as never throwing an exception.
Definition compiler.h:159
L4_INLINE
#define L4_INLINE
L4 Inline function attribute.
Definition compiler.h:51
types.h
Common L4 ABI Data Types.
l4_buf_regs_t
Encapsulation of the buffer-registers block in the UTCB.
Definition utcb.h:83
l4_buf_regs_t::br
l4_umword_t br[L4_UTCB_GENERIC_BUFFERS_SIZE]
Buffer registers.
Definition utcb.h:88
l4_buf_regs_t::bdr
l4_umword_t bdr
Buffer descriptor.
Definition utcb.h:85
l4_msgtag_t
Message tag data structure.
Definition types.h:153
l4_fpage_t
L4 flexpage type.
Definition __l4_fpage.h:76
l4_fpage_t::raw
l4_umword_t raw
Raw value.
Definition __l4_fpage.h:78
l4_msg_regs_t
Encapsulation of the message-register block in the UTCB.
Definition utcb.h:68
l4_msg_regs_t::mr
l4_umword_t mr[L4_UTCB_GENERIC_DATA_SIZE]
Message registers.
Definition utcb.h:69