L4Re – L4 Runtime Environment
thread
Go to the documentation of this file.
1 // vi:set ft=cpp: -*- Mode: C++ -*-
6 /*
7  * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
8  * Alexander Warg <warg@os.inf.tu-dresden.de>
9  * economic rights: Technische Universität Dresden (Germany)
10  *
11  * This file is part of TUD:OS and distributed under the terms of the
12  * GNU General Public License 2.
13  * Please see the COPYING-GPL-2 file for details.
14  *
15  * As a special exception, you may use this file as part of a free software
16  * library without restriction. Specifically, if other files instantiate
17  * templates or use macros or inline functions from this file, or you compile
18  * this file and link it with other files to produce an executable, this
19  * file does not by itself cause the resulting executable to be covered by
20  * the GNU General Public License. This exception does not however
21  * invalidate any other reasons why the executable file might be covered by
22  * the GNU General Public License.
23  */
24 
25 #pragma once
26 
27 #include <l4/sys/capability>
28 #include <l4/sys/thread.h>
29 
30 namespace L4 {
31 
58 class Thread :
59  public Kobject_t<Thread, Kobject, L4_PROTO_THREAD,
60  Type_info::Demand_t<1> >
61 {
62 public:
86  l4_umword_t flags,
87  l4_utcb_t *utcb = l4_utcb()) noexcept
88  { return l4_thread_ex_regs_u(cap(), ip, sp, flags, utcb); }
89 
112  l4_umword_t *flags,
113  l4_utcb_t *utcb = l4_utcb()) noexcept
114  { return l4_thread_ex_regs_ret_u(cap(), ip, sp, flags, utcb); }
115 
116 
129  class Attr
130  {
131  private:
132  friend class L4::Thread;
133  l4_utcb_t *_u;
134 
135  public:
142  explicit Attr(l4_utcb_t *utcb = l4_utcb()) noexcept : _u(utcb)
143  { l4_thread_control_start_u(utcb); }
144 
152  void pager(Cap<void> const &pager) noexcept
153  { l4_thread_control_pager_u(pager.cap(), _u); }
154 
161  Cap<void> pager() noexcept
162  { return Cap<void>(l4_utcb_mr_u(_u)->mr[1]); }
163 
171  void exc_handler(Cap<void> const &exc_handler) noexcept
172  { l4_thread_control_exc_handler_u(exc_handler.cap(), _u); }
173 
181  { return Cap<void>(l4_utcb_mr_u(_u)->mr[2]); }
182 
202  void bind(l4_utcb_t *thread_utcb, Cap<Task> const &task) noexcept
203  { l4_thread_control_bind_u(thread_utcb, task.cap(), _u); }
204 
208  void alien(int on) noexcept
209  { l4_thread_control_alien_u(_u, on); }
210 
216  void ux_host_syscall(int on) noexcept
217  { l4_thread_control_ux_host_syscall_u(_u, on); }
218 
219  };
220 
226  l4_msgtag_t control(Attr const &attr) noexcept
227  { return l4_thread_control_commit_u(cap(), attr._u); }
228 
237  { return l4_thread_switch_u(cap(), utcb); }
238 
248  l4_utcb_t *utcb = l4_utcb()) noexcept
249  { return l4_thread_stats_time_u(cap(), us, utcb); }
250 
257  { return l4_thread_vcpu_resume_start_u(utcb); }
258 
265  l4_utcb_t *utcb = l4_utcb()) noexcept
266  { return l4_thread_vcpu_resume_commit_u(cap(), tag, utcb); }
267 
284  noexcept
285  { return l4_thread_vcpu_control_u(cap(), vcpu_state, utcb); }
286 
308  l4_utcb_t *utcb = l4_utcb()) noexcept
309  { return l4_thread_vcpu_control_ext_u(cap(), ext_vcpu_state, utcb); }
310 
325  { return l4_thread_register_del_irq_u(cap(), irq.cap(), u); }
326 
335  {
336  private:
337  friend class Thread;
338  l4_utcb_t *utcb;
339  unsigned cnt;
340 
341  public:
342  explicit Modify_senders(l4_utcb_t *u = l4_utcb()) noexcept
343  : utcb(u), cnt(1)
344  {
345  l4_utcb_mr_u(utcb)->mr[0] = L4_THREAD_MODIFY_SENDER_OP;
346  }
347 
367  int add(l4_umword_t match_mask, l4_umword_t match,
368  l4_umword_t del_bits, l4_umword_t add_bits) noexcept
369  {
370  l4_msg_regs_t *m = l4_utcb_mr_u(utcb);
371  if (cnt >= L4_UTCB_GENERIC_DATA_SIZE - 4)
372  return -L4_ENOMEM;
373  m->mr[cnt++] = match_mask;
374  m->mr[cnt++] = match;
375  m->mr[cnt++] = del_bits;
376  m->mr[cnt++] = add_bits;
377  return 0;
378  }
379  };
380 
395  {
396  return l4_ipc_call(cap(), todo.utcb, l4_msgtag(L4_PROTO_THREAD, todo.cnt, 0, 0), L4_IPC_NEVER);
397  }
398 };
399 }
L4::Cap related definitions.
l4_cap_idx_t cap() const noexcept
Return capability selector.
Definition: capability.h:52
C++ interface for capabilities.
Definition: capability.h:219
Helper class to create an L4Re interface class that is derived from a single base class.
Definition: __typeinfo.h:760
l4_cap_idx_t cap() const noexcept
Return capability selector.
Definition: kobject:79
Thread attributes used for control_commit().
Definition: thread:130
Cap< void > exc_handler() noexcept
Get the capability selector used for exception messages.
Definition: thread:180
void pager(Cap< void > const &pager) noexcept
Set the pager capability selector.
Definition: thread:152
void exc_handler(Cap< void > const &exc_handler) noexcept
Set the exception-handler capability selector.
Definition: thread:171
Attr(l4_utcb_t *utcb=l4_utcb()) noexcept
Create a thread-attribute object with the given UTCB.
Definition: thread:142
void ux_host_syscall(int on) noexcept
Allow host system calls on Fiasco-UX.
Definition: thread:216
Cap< void > pager() noexcept
Get the capability selector used for page-fault messages.
Definition: thread:161
void bind(l4_utcb_t *thread_utcb, Cap< Task > const &task) noexcept
Bind the thread to a task.
Definition: thread:202
void alien(int on) noexcept
Set the thread to alien mode.
Definition: thread:208
Wrapper class for modifying senders.
Definition: thread:335
int add(l4_umword_t match_mask, l4_umword_t match, l4_umword_t del_bits, l4_umword_t add_bits) noexcept
Add a rule.
Definition: thread:367
C++ L4 kernel thread interface.
Definition: thread:61
l4_msgtag_t control(Attr const &attr) noexcept
Commit the given thread-attributes object.
Definition: thread:226
l4_msgtag_t register_del_irq(Cap< Irq > irq, l4_utcb_t *u=l4_utcb()) noexcept
Register an IRQ that will trigger upon deletion events.
Definition: thread:324
l4_msgtag_t vcpu_resume_commit(l4_msgtag_t tag, l4_utcb_t *utcb=l4_utcb()) noexcept
vCPU resume, commit.
Definition: thread:264
l4_msgtag_t switch_to(l4_utcb_t *utcb=l4_utcb()) noexcept
Switch execution to this thread.
Definition: thread:236
l4_msgtag_t stats_time(l4_kernel_clock_t *us, l4_utcb_t *utcb=l4_utcb()) noexcept
Get consumed time of thread in us.
Definition: thread:247
l4_msgtag_t vcpu_control(l4_addr_t vcpu_state, l4_utcb_t *utcb=l4_utcb()) noexcept
Enable or disable the vCPU feature for the thread.
Definition: thread:283
l4_msgtag_t modify_senders(Modify_senders const &todo) noexcept
Apply sender modification rules.
Definition: thread:394
l4_msgtag_t ex_regs(l4_addr_t ip, l4_addr_t sp, l4_umword_t flags, l4_utcb_t *utcb=l4_utcb()) noexcept
Exchange basic thread registers.
Definition: thread:85
l4_msgtag_t vcpu_control_ext(l4_addr_t ext_vcpu_state, l4_utcb_t *utcb=l4_utcb()) noexcept
Enable or disable the extended vCPU feature for the thread.
Definition: thread:307
l4_msgtag_t vcpu_resume_start(l4_utcb_t *utcb=l4_utcb()) noexcept
vCPU resume, start.
Definition: thread:256
l4_msgtag_t ex_regs(l4_addr_t *ip, l4_addr_t *sp, l4_umword_t *flags, l4_utcb_t *utcb=l4_utcb()) noexcept
Exchange basic thread registers and return previous values.
Definition: thread:111
unsigned long l4_umword_t
Unsigned machine word.
Definition: l4int.h:52
unsigned long l4_addr_t
Address type.
Definition: l4int.h:45
l4_uint64_t l4_kernel_clock_t
Kernel clock type.
Definition: l4int.h:65
@ L4_ENOMEM
No memory.
Definition: err.h:50
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:448
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:408
@ L4_PROTO_THREAD
Protocol for messages to a thread object.
Definition: types.h:64
@ L4_THREAD_MODIFY_SENDER_OP
Modify all senders IDs that match the given pattern.
Definition: thread.h:629
l4_msgtag_t l4_thread_vcpu_control_ext_u(l4_cap_idx_t thread, l4_addr_t ext_vcpu_state, l4_utcb_t *utcb) L4_NOTHROW
Enable or disable the extended vCPU feature for the thread.
Definition: thread.h:961
l4_msgtag_t l4_thread_ex_regs_ret_u(l4_cap_idx_t thread, l4_addr_t *ip, l4_addr_t *sp, l4_umword_t *flags, l4_utcb_t *utcb) L4_NOTHROW
Exchange basic thread registers and return previous values.
Definition: thread.h:711
l4_msgtag_t l4_thread_vcpu_control_u(l4_cap_idx_t thread, l4_addr_t vcpu_state, l4_utcb_t *utcb) L4_NOTHROW
Enable or disable the vCPU feature for the thread.
Definition: thread.h:946
l4_msgtag_t l4_thread_ex_regs_u(l4_cap_idx_t thread, l4_addr_t ip, l4_addr_t sp, l4_umword_t flags, l4_utcb_t *utcb) L4_NOTHROW
Exchange basic thread registers.
Definition: thread.h:700
@ L4_UTCB_GENERIC_DATA_SIZE
Total number of message register (MRs) available.
Definition: utcb.h:47
struct l4_utcb_t l4_utcb_t
Opaque type for the UTCB.
Definition: utcb.h:67
l4_utcb_t * l4_utcb(void) L4_NOTHROW L4_PURE
Get the UTCB address.
Definition: utcb.h:340
L4 low-level kernel interface.
Message tag data structure.
Definition: types.h:160
Encapsulation of the message-register block in the UTCB.
Definition: utcb.h:79
l4_umword_t mr[L4_UTCB_GENERIC_DATA_SIZE]
Message registers.
Definition: utcb.h:80