l4/pkg/l4sys/include/thread.h

   1 /**
   2  * \file
   3  * \brief Common thread related definitions.
   4  */
   5 /*
   6  * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
   7  *               Alexander Warg <warg@os.inf.tu-dresden.de>,
   8  *               Björn Döbel <doebel@os.inf.tu-dresden.de>,
   9  *               Torsten Frenzel <frenzel@os.inf.tu-dresden.de>
  10  *     economic rights: Technische Universität Dresden (Germany)
  11  *
  12  * This file is part of TUD:OS and distributed under the terms of the
  13  * GNU General Public License 2.
  14  * Please see the COPYING-GPL-2 file for details.
  15  *
  16  * As a special exception, you may use this file as part of a free software
  17  * library without restriction.  Specifically, if other files instantiate
  18  * templates or use macros or inline functions from this file, or you compile
  19  * this file and link it with other files to produce an executable, this
  20  * file does not by itself cause the resulting executable to be covered by
  21  * the GNU General Public License.  This exception does not however
  22  * invalidate any other reasons why the executable file might be covered by
  23  * the GNU General Public License.
  24  */
  25 #pragma once
  26
  27 #include <l4/sys/types.h>
  28 #include <l4/sys/utcb.h>
  29 #include <l4/sys/ipc.h>
  30
  31 /**
  32  * \defgroup l4_thread_api Thread
  33  * \ingroup  l4_kernel_object_api
  34  * \brief Thread object.
  35  *
  36  * <c>\#include <l4/sys/thread.h></c>
  37  *
  38  * The thread class defines a thread of execution in the L4 context.
  39  * Usually user-level and kernel threads are mapped 1:1 to each other.
  40  * Thread kernel objects are created using a Factory, see \ref l4_factory_api
  41  * (l4_factory_create_thread()).
  42  *
  43  * An L4 thread encapsulates:
  44  * - CPU state
  45  *   - General-purpose registers
  46  *   - Program counter
  47  *   - Stack pointer
  48  * - FPU state
  49  * - Scheduling parameters
  50  *   - CPU-set
  51  *   - Priority (0-255)
  52  *   - Time slice length
  53  * - Execution state
  54  *   - Blocked, Runnable, Running
  55  *
  56  * Thread objects provide an API for
  57  * - Thread configuration and manipulation
  58  * - Thread switching.
  59  *
  60  * The thread control functions are used to control various aspects of a
  61  * thread. See l4_thread_control_start() for more information.
  62  */
  63
  64
  65 /**
  66  * \brief Exchange basic thread registers.
  67  * \ingroup l4_thread_api
  68  *
  69  * \param thread Thread to manipulate
  70  * \param ip     New instruction pointer, use ~0UL to leave the
  71  *               instruction pointer unchanged
  72  * \param sp     New stack pointer, use ~0UL to leave the stack
  73  *               pointer unchanged
  74  * \param flags  Ex-regs flags, see #L4_thread_ex_regs_flags
  75  *
  76  * \return System call return tag
  77  *
  78  * This method allows to manipulate and start a thread. The basic
  79  * functionality is to set the instruction pointer and the stack pointer of a
  80  * thread. Additionally, this method allows also to cancel ongoing IPC
  81  * operations and to force the thread to raise an artificial exception (see \a
  82  * flags).
  83  *
  84  */
  85 L4_INLINE l4_msgtag_t
  86 l4_thread_ex_regs(l4_cap_idx_t thread, l4_addr_t ip, l4_addr_t sp,
  87                   l4_umword_t flags) L4_NOTHROW;
  88
  89 /**
  90  * \internal
  91  * \ingroup l4_thread_api
  92  */
  93 L4_INLINE l4_msgtag_t
  94 l4_thread_ex_regs_u(l4_cap_idx_t thread, l4_addr_t ip, l4_addr_t sp,
  95                     l4_umword_t flags, l4_utcb_t *utcb) L4_NOTHROW;
  96
  97 /**
  98  * \brief Exchange basic thread registers and return previous values.
  99  * \ingroup l4_thread_api
 100  *
 101  * \param[in]     thread Thread to manipulate
 102  * \param[in,out] ip     New instruction pointer, use ~0UL to leave the
 103  *                       instruction pointer unchanged, return previous
 104  *                       instruction pointer
 105  * \param[in,out] sp     New stack pointer, use ~0UL to leave the stack
 106  *                       pointer unchanged, returns previous stack pointer
 107  * \param[in,out] flags  Ex-regs flags, see #L4_thread_ex_regs_flags, return
 108  *                       previous CPU flags of the thread.
 109  *
 110  * \return System call return tag
 111  *
 112  * This method allows to manipulate and start a thread. The basic
 113  * functionality is to set the instruction pointer and the stack pointer of a
 114  * thread. Additionally, this method allows also to cancel ongoing IPC
 115  * operations and to force the thread to raise an artificial exception (see \a
 116  * flags).
 117  *
 118  * Returned values are valid only if function returns successfully.
 119  */
 120 L4_INLINE l4_msgtag_t
 121 l4_thread_ex_regs_ret(l4_cap_idx_t thread, l4_addr_t *ip, l4_addr_t *sp,
 122                       l4_umword_t *flags) L4_NOTHROW;
 123
 124 /**
 125  * \internal
 126  * \ingroup l4_thread_api
 127  */
 128 L4_INLINE l4_msgtag_t
 129 l4_thread_ex_regs_ret_u(l4_cap_idx_t thread, l4_addr_t *ip, l4_addr_t *sp,
 130                         l4_umword_t *flags, l4_utcb_t *utcb) L4_NOTHROW;
 131
 132
 133
 134 /**
 135  * \defgroup l4_thread_control_api Thread control
 136  * \ingroup l4_thread_api
 137  *
 138  * \brief API for Thread Control method.
 139  *
 140  *
 141  * The thread control API provides access to almost any parameter of a thread
 142  * object. The API is based on a single invocation of the thread object.
 143  * However, because of the huge amount of parameters, the API provides a set
 144  * of functions to set specific parameters of a thread and a commit function
 145  * to commit the thread control call (see l4_thread_control_commit()).
 146  *
 147  * A thread control operation must always start with l4_thread_control_start()
 148  * and be committed with l4_thread_control_commit().  All other thread control
 149  * parameter setter functions must be called between these two functions.
 150  *
 151  * An example for a sequence of thread control API calls can be found below.
 152  *
 153  *  l4_utcb_t *u = l4_utcb(); <br>
 154  *  \link l4_thread_control_start() l4_thread_control_start(u)\endlink; <br>
 155  *  \link l4_thread_control_pager() l4_thread_control_pager(u, pager_cap)\endlink; <br>
 156  *  \link l4_thread_control_bind() l4_thread_control_bind (u, thread_utcb, task)\endlink; <br>
 157  *  \link l4_thread_control_commit() l4_thread_control_commit(u, thread_cap)\endlink; <br>
 158  *
 159  */
 160
 161 /**
 162  * \brief Start a thread control API sequence.
 163  * \ingroup l4_thread_control_api
 164  *
 165  * This function starts a sequence of thread control API functions.
 166  * After this functions any of following functions may be called in any order.
 167  * - l4_thread_control_pager()
 168  * - l4_thread_control_exc_handler()
 169  * - l4_thread_control_bind()
 170  * - l4_thread_control_alien()
 171  * - l4_thread_control_ux_host_syscall() (Fiasco-UX only)
 172  *
 173  * To commit the changes to the thread l4_thread_control_commit() must be
 174  * called in the end.
 175  *
 176  * \note The thread control API calls store the parameters for the thread in
 177  *       the UTCB of the caller, this means between l4_thread_control_start()
 178  *       and l4_thread_control_commit() no functions that modify the UTCB
 179  *       contents must be called.
 180  */
 181 L4_INLINE void
 182 l4_thread_control_start(void) L4_NOTHROW;
 183
 184 /**
 185  * \internal
 186  * \ingroup l4_thread_control_api
 187  */
 188 L4_INLINE void
 189 l4_thread_control_start_u(l4_utcb_t *utcb) L4_NOTHROW;
 190
 191 /**
 192  * \brief Set the pager.
 193  * \ingroup l4_thread_control_api
 194  *
 195  * \param pager     Capability selector invoked to send a page-fault IPC.
 196  *
 197  * \note The pager capability selector is interpreted in the task the thread
 198  *       is bound to (executes in).
 199  */
 200 L4_INLINE void
 201 l4_thread_control_pager(l4_cap_idx_t pager) L4_NOTHROW;
 202
 203 /**
 204  * \internal
 205  * \ingroup l4_thread_control_api
 206  */
 207 L4_INLINE void
 208 l4_thread_control_pager_u(l4_cap_idx_t pager, l4_utcb_t *utcb) L4_NOTHROW;
 209
 210 /**
 211  * \brief Set the exception handler.
 212  * \ingroup l4_thread_control_api
 213  *
 214  * \param exc_handler  Capability selector invoked to send an exception IPC.
 215  *
 216  * \note The exception-handler capability selector is interpreted in the task
 217  *       the thread is bound to (executes in).
 218  */
 219 L4_INLINE void
 220 l4_thread_control_exc_handler(l4_cap_idx_t exc_handler) L4_NOTHROW;
 221
 222 /**
 223  * \internal
 224  * \ingroup l4_thread_control_api
 225  */
 226 L4_INLINE void
 227 l4_thread_control_exc_handler_u(l4_cap_idx_t exc_handler,
 228                                 l4_utcb_t *utcb) L4_NOTHROW;
 229
 230 /**
 231  * \brief Bind the thread to a task.
 232  * \ingroup l4_thread_control_api
 233  *
 234  * \param thread_utcb The address of the UTCB in the target task.
 235  * \param task        The target task of the thread.
 236  *
 237  * Binding a thread to a task has the effect that the thread
 238  * afterwards executes code within that task and has access to the
 239  * resources visible within that task.
 240  *
 241  * \note There should not be more than one thread use a UTCB to prevent
 242  *       data corruption.
 243  *
 244  */
 245 L4_INLINE void
 246 l4_thread_control_bind(l4_utcb_t *thread_utcb,
 247                        l4_cap_idx_t task) L4_NOTHROW;
 248
 249 /**
 250  * \internal
 251  * \ingroup l4_thread_control_api
 252  */
 253 L4_INLINE void
 254 l4_thread_control_bind_u(l4_utcb_t *thread_utcb,
 255                          l4_cap_idx_t task, l4_utcb_t *utcb) L4_NOTHROW;
 256
 257 /**
 258  * \brief Enable alien mode.
 259  * \ingroup l4_thread_control_api
 260  * \param   on    Boolean value defining the state of the feature.
 261  *
 262  * Alien mode means the thread is not allowed to invoke L4 kernel objects
 263  * directly and it is also not allowed to allocate FPU state. All those
 264  * operations result in an exception IPC that gets sent through the pager
 265  * capability. The responsible pager can then selectively allow an object
 266  * invocation or allocate FPU state for the thread.
 267  *
 268  * This feature can be used to attach a debugger to a thread and trace all
 269  * object invocations.
 270  */
 271 L4_INLINE void
 272 l4_thread_control_alien(int on) L4_NOTHROW;
 273
 274 /**
 275  * \internal
 276  * \ingroup l4_thread_control_api
 277  */
 278 L4_INLINE void
 279 l4_thread_control_alien_u(l4_utcb_t *utcb, int on) L4_NOTHROW;
 280
 281 /**
 282  * \brief Enable pass through of native host (Linux) system calls.
 283  * \ingroup l4_thread_control_api
 284  * \param   on    Boolean value defining the state of the feature.
 285  *
 286  * \pre Running on Fiasco-UX
 287  *
 288  * This enables the thread to do host system calls. This feature is only
 289  * available in Fiasco-UX and ignored in other environments.
 290  */
 291 L4_INLINE void
 292 l4_thread_control_ux_host_syscall(int on) L4_NOTHROW;
 293
 294 /**
 295  * \internal
 296  * \ingroup l4_thread_control_api
 297  */
 298 L4_INLINE void
 299 l4_thread_control_ux_host_syscall_u(l4_utcb_t *utcb, int on) L4_NOTHROW;
 300
 301
 302
 303 /**
 304  * \brief Commit the thread control parameters.
 305  * \ingroup l4_thread_control_api
 306  *
 307  * \param thread  Capability selector of target thread to commit to.
 308  * \return system call return tag
 309  */
 310 L4_INLINE l4_msgtag_t
 311 l4_thread_control_commit(l4_cap_idx_t thread) L4_NOTHROW;
 312
 313 /**
 314  * \internal
 315  * \ingroup l4_thread_control_api
 316  */
 317 L4_INLINE l4_msgtag_t
 318 l4_thread_control_commit_u(l4_cap_idx_t thread, l4_utcb_t *utcb) L4_NOTHROW;
 319
 320 /**
 321  * \brief Yield current time slice.
 322  * \ingroup l4_thread_api
 323  *
 324  * \return system call return tag
 325  */
 326 L4_INLINE l4_msgtag_t
 327 l4_thread_yield(void) L4_NOTHROW;
 328
 329 /**
 330  * \brief Switch to another thread (and donate the remaining time slice).
 331  * \ingroup l4_thread_api
 332  *
 333  * \param to_thread   The thread to switch to.
 334  *
 335  * \return system call return tag
 336  */
 337 L4_INLINE l4_msgtag_t
 338 l4_thread_switch(l4_cap_idx_t to_thread) L4_NOTHROW;
 339
 340 /**
 341  * \internal
 342  * \ingroup l4_thread_api
 343  */
 344 L4_INLINE l4_msgtag_t
 345 l4_thread_switch_u(l4_cap_idx_t to_thread, l4_utcb_t *utcb) L4_NOTHROW;
 346
 347
 348
 349 /**
 350  * \brief Get consumed timed of thread in µs.
 351  * \ingroup l4_thread_api
 352  * \param thread Thread to get the consumed time from.
 353  *
 354  * The consumed time is returned as l4_kernel_clock_t at UTCB message
 355  * register 0.
 356  */
 357 L4_INLINE l4_msgtag_t
 358 l4_thread_stats_time(l4_cap_idx_t thread) L4_NOTHROW;
 359
 360 /**
 361  * \internal
 362  * \ingroup l4_thread_api
 363  */
 364 L4_INLINE l4_msgtag_t
 365 l4_thread_stats_time_u(l4_cap_idx_t thread, l4_utcb_t *utcb) L4_NOTHROW;
 366
 367
 368 /**
 369  * \brief vCPU return from event handler.
 370  * \ingroup l4_thread_api
 371  *
 372  * \return Message tag to be used for l4_sndfpage_add() and
 373  *         l4_thread_vcpu_commit()
 374  *
 375  * The vCPU resume functionality is split in multiple functions to allow the
 376  * specification of additional send-flex-pages using l4_sndfpage_add().
 377  */
 378 L4_INLINE l4_msgtag_t
 379 l4_thread_vcpu_resume_start(void) L4_NOTHROW;
 380
 381 /**
 382  * \internal
 383  * \ingroup l4_thread_api
 384  */
 385 L4_INLINE l4_msgtag_t
 386 l4_thread_vcpu_resume_start_u(l4_utcb_t *utcb) L4_NOTHROW;
 387
 388 /**
 389  * \brief Commit vCPU resume.
 390  * \ingroup l4_thread_api
 391  *
 392  * \param thread    Thread to be resumed, using the invalid cap can be used
 393  *                  for the current thread.
 394  * \param tag       Tag to use, returned by l4_thread_vcpu_resume_start()
 395  *
 396  * \return System call result message tag. In extended vCPU mode and when
 397  * the virtual interrupts are cleared, the return code 1 flags an incoming
 398  * IPC message, whereas 0 indicates a VM exit.
 399  *
 400  * To resume into another address space the capability to the target task
 401  * must be set in the vCPU-state. The task needs to be set only once,
 402  * consecutive resumes to the same address space should use an invalid
 403  * capability. The kernel resets the field to #L4_INVALID_CAP. To release a
 404  * task use a different task or use an invalid capability with
 405  * the #L4_SYSF_REPLY flag set.
 406  *
 407  * \see l4_vcpu_state_t
 408  */
 409 L4_INLINE l4_msgtag_t
 410 l4_thread_vcpu_resume_commit(l4_cap_idx_t thread,
 411                              l4_msgtag_t tag) L4_NOTHROW;
 412
 413 /**
 414  * \internal
 415  * \ingroup l4_thread_api
 416  */
 417 L4_INLINE l4_msgtag_t
 418 l4_thread_vcpu_resume_commit_u(l4_cap_idx_t thread,
 419                                l4_msgtag_t tag, l4_utcb_t *utcb) L4_NOTHROW;
 420
 421
 422 /**
 423  * \brief Enable or disable the vCPU feature for the thread.
 424  * \ingroup l4_thread_api
 425  *
 426  * \param thread The thread for which the vCPU feature shall be enabled or
 427  *               disabled.
 428  * \param vcpu_state The virtual address where the kernel shall store the vCPU
 429  *                   state in case of vCPU exits. The address must be a valid
 430  *                   kernel-user-memory address.
 431  * \return Systemcall result message tag.
 432  *
 433  * This function enables the vCPU feature of the \a thread if \a vcpu_state
 434  * is set to a valid kernel-user-memory address, or disables the vCPU feature
 435  * if \a vcpu_state is 0.
 436  *
 437  */
 438 L4_INLINE l4_msgtag_t
 439 l4_thread_vcpu_control(l4_cap_idx_t thread, l4_addr_t vcpu_state) L4_NOTHROW;
 440
 441 /**
 442  * \internal
 443  * \ingroup l4_thread_api
 444  */
 445 L4_INLINE l4_msgtag_t
 446 l4_thread_vcpu_control_u(l4_cap_idx_t thread, l4_addr_t vcpu_state,
 447                          l4_utcb_t *utcb) L4_NOTHROW;
 448
 449 /**
 450  * \brief Enable or disable the extended vCPU feature for the thread.
 451  * \ingroup l4_thread_api
 452  *
 453  * \param thread The thread for which the extended vCPU feature shall be
 454  *               enabled or disabled.
 455  * \param vcpu_state The virtual address where the kernel shall store the vCPU
 456  *                   state in case of vCPU exits. The address must be a valid
 457  *                   kernel-user-memory address.
 458  * \return Systemcall result message tag.
 459  *
 460  * The extended vCPU feature allows the use of hardware-virtualization
 461  * features such as Intel's VT or AMD's SVM.
 462  *
 463  * This function enables the extended vCPU feature of the \a thread
 464  * if \a vcpu_state is set to a valid kernel-user-memory address, or disables
 465  * the vCPU feature if \a vcpu_state is 0.
 466  *
 467  */
 468 L4_INLINE l4_msgtag_t
 469 l4_thread_vcpu_control_ext(l4_cap_idx_t thread, l4_addr_t ext_vcpu_state) L4_NOTHROW;
 470
 471 /**
 472  * \internal
 473  * \ingroup l4_thread_api
 474  */
 475 L4_INLINE l4_msgtag_t
 476 l4_thread_vcpu_control_ext_u(l4_cap_idx_t thread, l4_addr_t ext_vcpu_state,
 477                              l4_utcb_t *utcb) L4_NOTHROW;
 478
 479
 480 /**
 481  * \brief Register an IRQ that will trigger upon deletion events.
 482  * \ingroup l4_thread_api
 483  *
 484  * \param thread    Thread to register IRQ for.
 485  * \param irq       Irq to register.
 486  *
 487  * \return System call result message tag.
 488  */
 489 L4_INLINE l4_msgtag_t
 490 l4_thread_register_del_irq(l4_cap_idx_t thread, l4_cap_idx_t irq) L4_NOTHROW;
 491
 492 /**
 493  * \internal
 494  * \ingroup l4_thread_api
 495  */
 496 L4_INLINE l4_msgtag_t
 497 l4_thread_register_del_irq_u(l4_cap_idx_t thread, l4_cap_idx_t irq,
 498                              l4_utcb_t *utcb) L4_NOTHROW;
 499
 500 /**
 501  * \brief Start a thread sender modifiction sequence.
 502  * \ingroup l4_thread_api
 503  *
 504  * Add modification rules with l4_thread_modify_sender_add() and commit with
 505  * l4_thread_modify_sender_commit(). Do not touch the UTCB between
 506  * l4_thread_modify_sender_start() and l4_thread_modify_sender_commit().
 507  *
 508  * \see l4_thread_modify_sender_add
 509  * \see l4_thread_modify_sender_commit
 510  */
 511 L4_INLINE l4_msgtag_t
 512 l4_thread_modify_sender_start(void) L4_NOTHROW;
 513
 514 /**
 515  * \internal
 516  * \ingroup l4_thread_api
 517  */
 518 L4_INLINE l4_msgtag_t
 519 l4_thread_modify_sender_start_u(l4_utcb_t *u) L4_NOTHROW;
 520
 521 /**
 522  * \brief Add a modification pattern to a sender modification sequence.
 523  * \ingroup l4_thread_api
 524  *
 525  * \param tag        Tag received from l4_thread_modify_sender_start() or
 526  *                   previous l4_thread_modify_sender_add() calls from
 527  *                   the same sequence.
 528  * \param match_mask Bitmask of bits to match the label.
 529  * \param match      Bitmask that must be equal to the label after applying
 530  *                   match_mask.
 531  * \param del_bits   Bits to be deleted from the label.
 532  * \param add_bits   Bits to be added to the label.
 533  *
 534  * \return 0 on sucess, <0 on error
 535  *
 536  * In pseudo code:
 537  *   if ((sender_label & match_mask) == match)
 538  *     { label = (label & ~del_bits) | add_bits; }
 539  *
 540  * Only the first match is applied.
 541  *
 542  * \see l4_thread_modify_sender_start
 543  * \see l4_thread_modify_sender_commit
 544  */
 545 L4_INLINE int
 546 l4_thread_modify_sender_add(l4_umword_t match_mask,
 547                             l4_umword_t match,
 548                             l4_umword_t del_bits,
 549                             l4_umword_t add_bits,
 550                             l4_msgtag_t *tag) L4_NOTHROW;
 551
 552 /**
 553  * \internal
 554  * \ingroup l4_thread_api
 555  */
 556 L4_INLINE int
 557 l4_thread_modify_sender_add_u(l4_umword_t match_mask,
 558                               l4_umword_t match,
 559                               l4_umword_t del_bits,
 560                               l4_umword_t add_bits,
 561                               l4_msgtag_t *tag, l4_utcb_t *u) L4_NOTHROW;
 562
 563 /**
 564  * \brief Apply (commit) a sender modification sequence.
 565  * \ingroup l4_thread_api
 566  *
 567  * \see l4_thread_modify_sender_start
 568  * \see l4_thread_modify_sender_add
 569  */
 570 L4_INLINE l4_msgtag_t
 571 l4_thread_modify_sender_commit(l4_cap_idx_t thread, l4_msgtag_t tag) L4_NOTHROW;
 572
 573 /**
 574  * \internal
 575  * \ingroup l4_thread_api
 576  */
 577 L4_INLINE l4_msgtag_t
 578 l4_thread_modify_sender_commit_u(l4_cap_idx_t thread, l4_msgtag_t tag,
 579                                  l4_utcb_t *u) L4_NOTHROW;
 580
 581 /**
 582  * \brief Operations on thread objects.
 583  * \ingroup l4_thread_api
 584  * \hideinitializer
 585  * \internal
 586  */
 587 enum L4_thread_ops
 588 {
 589   L4_THREAD_CONTROL_OP             = 0UL,    /**< Control operation */
 590   L4_THREAD_EX_REGS_OP             = 1UL,    /**< Exchange registers operation */
 591   L4_THREAD_SWITCH_OP              = 2UL,    /**< Do a thread switch */
 592   L4_THREAD_STATS_OP               = 3UL,    /**< Thread statistics */
 593   L4_THREAD_VCPU_RESUME_OP         = 4UL,    /**< VCPU resume */
 594   L4_THREAD_REGISTER_DELETE_IRQ_OP = 5UL,    /**< Register an IPC-gate deletion IRQ */
 595   L4_THREAD_MODIFY_SENDER_OP       = 6UL,    /**< Modify all senders IDs that match the given pattern */
 596   L4_THREAD_VCPU_CONTROL_OP        = 7UL,    /**< Enable / disable VCPU feature */
 597   L4_THREAD_VCPU_CONTROL_EXT_OP    = L4_THREAD_VCPU_CONTROL_OP | 0x10000,
 598   L4_THREAD_GDT_X86_OP             = 0x10UL, /**< Gdt */
 599   L4_THREAD_SET_FS_AMD64_OP        = 0x12UL, /**< Set FS/TLS */
 600   L4_THREAD_OPCODE_MASK            = 0xffff, /**< Mask for opcodes */
 601 };
 602
 603 /**
 604  * \brief Flags for the thread control operation.
 605  * \ingroup l4_thread_api
 606  * \hideinitializer
 607  * \internal
 608  *
 609  * Values for the enabled flags need to be given in their appropriate field
 610  * in the UTCB,
 611  * \see l4_thread_control
 612  */
 613 enum L4_thread_control_flags
 614 {
 615   /** The pager will be given. */
 616   L4_THREAD_CONTROL_SET_PAGER       = 0x0010000,
 617   /** The task to bind the thread to will be given. */
 618   L4_THREAD_CONTROL_BIND_TASK       = 0x0200000,
 619   /** Alien state of the thread is set. */
 620   L4_THREAD_CONTROL_ALIEN           = 0x0400000,
 621   /** Fiasco-UX only: pass-through of host system calls is set. */
 622   L4_THREAD_CONTROL_UX_NATIVE       = 0x0800000,
 623   /** The exception handler of the thread will be given. */
 624   L4_THREAD_CONTROL_SET_EXC_HANDLER = 0x1000000,
 625 };
 626
 627 /**
 628  * \brief Indices for the values in the message register for thread control.
 629  * \ingroup l4_thread_api
 630  * \hideinitializer
 631  * \internal
 632  *
 633  * The values indicate the index in the message registers during
 634  * thread-control operation.
 635  */
 636 enum L4_thread_control_mr_indices
 637 {
 638   L4_THREAD_CONTROL_MR_IDX_FLAGS       = 0, /**< \see #L4_thread_control_flags. */
 639   L4_THREAD_CONTROL_MR_IDX_PAGER       = 1, /**< Index for pager cap */
 640   L4_THREAD_CONTROL_MR_IDX_EXC_HANDLER = 2, /**< Index for exception handler */
 641   L4_THREAD_CONTROL_MR_IDX_FLAG_VALS   = 4, /**< Index for feature values */
 642   L4_THREAD_CONTROL_MR_IDX_BIND_UTCB   = 5, /**< Index for UTCB address for bind */
 643   L4_THREAD_CONTROL_MR_IDX_BIND_TASK   = 6, /**< Index for task flex-page for bind */
 644 };
 645
 646 /**
 647  * \brief Flags for the thread ex-regs operation.
 648  * \ingroup l4_thread_api
 649  * \hideinitializer
 650  */
 651 enum L4_thread_ex_regs_flags
 652 {
 653   L4_THREAD_EX_REGS_CANCEL            = 0x10000UL, /**< Cancel ongoing IPC in the thread. */
 654   L4_THREAD_EX_REGS_TRIGGER_EXCEPTION = 0x20000UL, /**< Trigger artificial exception in thread. */
 655 };
 656
 657
 658 /* IMPLEMENTATION -----------------------------------------------------------*/
 659
 660 #include <l4/sys/ipc.h>
 661 #include <l4/sys/types.h>
 662
 663 L4_INLINE l4_msgtag_t
 664 l4_thread_ex_regs_u(l4_cap_idx_t thread, l4_addr_t ip, l4_addr_t sp,
 665                     l4_umword_t flags, l4_utcb_t *utcb) L4_NOTHROW
 666 {
 667   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 668   v->mr[0] = L4_THREAD_EX_REGS_OP | flags;
 669   v->mr[1] = ip;
 670   v->mr[2] = sp;
 671   return l4_ipc_call(thread, utcb, l4_msgtag(L4_PROTO_THREAD, 3, 0, 0), L4_IPC_NEVER);
 672 }
 673
 674 L4_INLINE l4_msgtag_t
 675 l4_thread_ex_regs_ret_u(l4_cap_idx_t thread, l4_addr_t *ip, l4_addr_t *sp,
 676                         l4_umword_t *flags, l4_utcb_t *utcb) L4_NOTHROW
 677 {
 678   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 679   l4_msgtag_t ret = l4_thread_ex_regs_u(thread, *ip, *sp, *flags, utcb);
 680   if (l4_error_u(ret, utcb))
 681     return ret;
 682
 683   *flags = v->mr[0];
 684   *ip    = v->mr[1];
 685   *sp    = v->mr[2];
 686   return ret;
 687 }
 688
 689 L4_INLINE void
 690 l4_thread_control_start_u(l4_utcb_t *utcb) L4_NOTHROW
 691 {
 692   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 693   v->mr[L4_THREAD_CONTROL_MR_IDX_FLAGS] = L4_THREAD_CONTROL_OP;
 694 }
 695
 696 L4_INLINE void
 697 l4_thread_control_pager_u(l4_cap_idx_t pager, l4_utcb_t *utcb) L4_NOTHROW
 698 {
 699   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 700   v->mr[L4_THREAD_CONTROL_MR_IDX_FLAGS] |= L4_THREAD_CONTROL_SET_PAGER;
 701   v->mr[L4_THREAD_CONTROL_MR_IDX_PAGER]  = pager;
 702 }
 703
 704 L4_INLINE void
 705 l4_thread_control_exc_handler_u(l4_cap_idx_t exc_handler,
 706                                 l4_utcb_t *utcb) L4_NOTHROW
 707 {
 708   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 709   v->mr[L4_THREAD_CONTROL_MR_IDX_FLAGS]       |= L4_THREAD_CONTROL_SET_EXC_HANDLER;
 710   v->mr[L4_THREAD_CONTROL_MR_IDX_EXC_HANDLER]  = exc_handler;
 711 }
 712
 713 L4_INLINE void
 714 l4_thread_control_bind_u(l4_utcb_t *thread_utcb, l4_cap_idx_t task,
 715                          l4_utcb_t *utcb) L4_NOTHROW
 716 {
 717   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 718   v->mr[L4_THREAD_CONTROL_MR_IDX_FLAGS]         |= L4_THREAD_CONTROL_BIND_TASK;
 719   v->mr[L4_THREAD_CONTROL_MR_IDX_BIND_UTCB]      = (l4_addr_t)thread_utcb;
 720   v->mr[L4_THREAD_CONTROL_MR_IDX_BIND_TASK]      = L4_ITEM_MAP;
 721   v->mr[L4_THREAD_CONTROL_MR_IDX_BIND_TASK + 1]  = l4_obj_fpage(task, 0, L4_FPAGE_RWX).raw;
 722 }
 723
 724 L4_INLINE void
 725 l4_thread_control_alien_u(l4_utcb_t *utcb, int on) L4_NOTHROW
 726 {
 727   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 728   v->mr[L4_THREAD_CONTROL_MR_IDX_FLAGS]     |= L4_THREAD_CONTROL_ALIEN;
 729   v->mr[L4_THREAD_CONTROL_MR_IDX_FLAG_VALS] |= on ? L4_THREAD_CONTROL_ALIEN : 0;
 730 }
 731
 732 L4_INLINE void
 733 l4_thread_control_ux_host_syscall_u(l4_utcb_t *utcb, int on) L4_NOTHROW
 734 {
 735   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 736   v->mr[L4_THREAD_CONTROL_MR_IDX_FLAGS]     |= L4_THREAD_CONTROL_UX_NATIVE;
 737   v->mr[L4_THREAD_CONTROL_MR_IDX_FLAG_VALS] |= on ? L4_THREAD_CONTROL_UX_NATIVE : 0;
 738 }
 739
 740 L4_INLINE l4_msgtag_t
 741 l4_thread_control_commit_u(l4_cap_idx_t thread, l4_utcb_t *utcb) L4_NOTHROW
 742 {
 743   int items = 0;
 744   if (l4_utcb_mr_u(utcb)->mr[L4_THREAD_CONTROL_MR_IDX_FLAGS] & L4_THREAD_CONTROL_BIND_TASK)
 745     items = 1;
 746   return l4_ipc_call(thread, utcb, l4_msgtag(L4_PROTO_THREAD, 6, items, 0), L4_IPC_NEVER);
 747 }
 748
 749
 750 L4_INLINE l4_msgtag_t
 751 l4_thread_yield(void) L4_NOTHROW
 752 {
 753   l4_ipc_receive(L4_INVALID_CAP, NULL, L4_IPC_BOTH_TIMEOUT_0);
 754   return l4_msgtag(0, 0, 0, 0);
 755 }
 756
 757 /* Preliminary, to be changed */
 758 L4_INLINE l4_msgtag_t
 759 l4_thread_switch_u(l4_cap_idx_t to_thread, l4_utcb_t *utcb) L4_NOTHROW
 760 {
 761   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 762   v->mr[0] = L4_THREAD_SWITCH_OP;
 763   return l4_ipc_call(to_thread, utcb, l4_msgtag(L4_PROTO_THREAD, 1, 0, 0), L4_IPC_NEVER);
 764 }
 765
 766
 767 L4_INLINE l4_msgtag_t
 768 l4_thread_stats_time_u(l4_cap_idx_t thread, l4_utcb_t *utcb) L4_NOTHROW
 769 {
 770   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 771   v->mr[0] = L4_THREAD_STATS_OP;
 772   return l4_ipc_call(thread, utcb, l4_msgtag(L4_PROTO_THREAD, 1, 0, 0), L4_IPC_NEVER);
 773 }
 774
 775 L4_INLINE l4_msgtag_t
 776 l4_thread_vcpu_resume_start_u(l4_utcb_t *utcb) L4_NOTHROW
 777 {
 778   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 779   v->mr[0] = L4_THREAD_VCPU_RESUME_OP;
 780   return l4_msgtag(L4_PROTO_THREAD, 1, 0, 0);
 781 }
 782
 783 L4_INLINE l4_msgtag_t
 784 l4_thread_vcpu_resume_commit_u(l4_cap_idx_t thread,
 785                                l4_msgtag_t tag, l4_utcb_t *utcb) L4_NOTHROW
 786 {
 787   return l4_ipc_call(thread, utcb, tag, L4_IPC_NEVER);
 788 }
 789
 790 L4_INLINE l4_msgtag_t
 791 l4_thread_ex_regs(l4_cap_idx_t thread, l4_addr_t ip, l4_addr_t sp,
 792                     l4_umword_t flags) L4_NOTHROW
 793 {
 794   return l4_thread_ex_regs_u(thread, ip, sp, flags, l4_utcb());
 795 }
 796
 797 L4_INLINE l4_msgtag_t
 798 l4_thread_ex_regs_ret(l4_cap_idx_t thread, l4_addr_t *ip, l4_addr_t *sp,
 799                       l4_umword_t *flags) L4_NOTHROW
 800 {
 801   return l4_thread_ex_regs_ret_u(thread, ip, sp, flags, l4_utcb());
 802 }
 803
 804 L4_INLINE void
 805 l4_thread_control_start(void) L4_NOTHROW
 806 {
 807   l4_thread_control_start_u(l4_utcb());
 808 }
 809
 810 L4_INLINE void
 811 l4_thread_control_pager(l4_cap_idx_t pager) L4_NOTHROW
 812 {
 813   l4_thread_control_pager_u(pager, l4_utcb());
 814 }
 815
 816 L4_INLINE void
 817 l4_thread_control_exc_handler(l4_cap_idx_t exc_handler) L4_NOTHROW
 818 {
 819   l4_thread_control_exc_handler_u(exc_handler, l4_utcb());
 820 }
 821
 822
 823 L4_INLINE void
 824 l4_thread_control_bind(l4_utcb_t *thread_utcb, l4_cap_idx_t task) L4_NOTHROW
 825 {
 826   l4_thread_control_bind_u(thread_utcb, task, l4_utcb());
 827 }
 828
 829 L4_INLINE void
 830 l4_thread_control_alien(int on) L4_NOTHROW
 831 {
 832   l4_thread_control_alien_u(l4_utcb(), on);
 833 }
 834
 835 L4_INLINE void
 836 l4_thread_control_ux_host_syscall(int on) L4_NOTHROW
 837 {
 838   l4_thread_control_ux_host_syscall_u(l4_utcb(), on);
 839 }
 840
 841 L4_INLINE l4_msgtag_t
 842 l4_thread_control_commit(l4_cap_idx_t thread) L4_NOTHROW
 843 {
 844   return l4_thread_control_commit_u(thread, l4_utcb());
 845 }
 846
 847
 848
 849
 850 L4_INLINE l4_msgtag_t
 851 l4_thread_switch(l4_cap_idx_t to_thread) L4_NOTHROW
 852 {
 853   return l4_thread_switch_u(to_thread, l4_utcb());
 854 }
 855
 856
 857
 858
 859 L4_INLINE l4_msgtag_t
 860 l4_thread_stats_time(l4_cap_idx_t thread) L4_NOTHROW
 861 {
 862   return l4_thread_stats_time_u(thread, l4_utcb());
 863 }
 864
 865 L4_INLINE l4_msgtag_t
 866 l4_thread_vcpu_resume_start(void) L4_NOTHROW
 867 {
 868   return l4_thread_vcpu_resume_start_u(l4_utcb());
 869 }
 870
 871 L4_INLINE l4_msgtag_t
 872 l4_thread_vcpu_resume_commit(l4_cap_idx_t thread,
 873                              l4_msgtag_t tag) L4_NOTHROW
 874 {
 875   return l4_thread_vcpu_resume_commit_u(thread, tag, l4_utcb());
 876 }
 877
 878
 879 L4_INLINE l4_msgtag_t
 880 l4_thread_register_del_irq_u(l4_cap_idx_t thread, l4_cap_idx_t irq,
 881                              l4_utcb_t *u) L4_NOTHROW
 882 {
 883   l4_msg_regs_t *m = l4_utcb_mr_u(u);
 884   m->mr[0] = L4_THREAD_REGISTER_DELETE_IRQ_OP;
 885   m->mr[1] = l4_map_obj_control(0,0);
 886   m->mr[2] = l4_obj_fpage(irq, 0, L4_CAP_FPAGE_RWS).raw;
 887   return l4_ipc_call(thread, u, l4_msgtag(L4_PROTO_THREAD, 1, 1, 0), L4_IPC_NEVER);
 888
 889 }
 890
 891 L4_INLINE l4_msgtag_t
 892 l4_thread_register_del_irq(l4_cap_idx_t thread, l4_cap_idx_t irq) L4_NOTHROW
 893 {
 894   return l4_thread_register_del_irq_u(thread, irq, l4_utcb());
 895 }
 896
 897
 898 L4_INLINE l4_msgtag_t
 899 l4_thread_vcpu_control_u(l4_cap_idx_t thread, l4_addr_t vcpu_state,
 900                          l4_utcb_t *utcb) L4_NOTHROW
 901 {
 902   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 903   v->mr[0] = L4_THREAD_VCPU_CONTROL_OP;
 904   v->mr[1] = vcpu_state;
 905   return l4_ipc_call(thread, utcb, l4_msgtag(L4_PROTO_THREAD, 2, 0, 0), L4_IPC_NEVER);
 906 }
 907
 908 L4_INLINE l4_msgtag_t
 909 l4_thread_vcpu_control(l4_cap_idx_t thread, l4_addr_t vcpu_state) L4_NOTHROW
 910 { return l4_thread_vcpu_control_u(thread, vcpu_state, l4_utcb()); }
 911
 912
 913 L4_INLINE l4_msgtag_t
 914 l4_thread_vcpu_control_ext_u(l4_cap_idx_t thread, l4_addr_t ext_vcpu_state,
 915                              l4_utcb_t *utcb) L4_NOTHROW
 916 {
 917   l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
 918   v->mr[0] = L4_THREAD_VCPU_CONTROL_EXT_OP;
 919   v->mr[1] = ext_vcpu_state;
 920   return l4_ipc_call(thread, utcb, l4_msgtag(L4_PROTO_THREAD, 2, 0, 0), L4_IPC_NEVER);
 921 }
 922
 923 L4_INLINE l4_msgtag_t
 924 l4_thread_vcpu_control_ext(l4_cap_idx_t thread, l4_addr_t ext_vcpu_state) L4_NOTHROW
 925 { return l4_thread_vcpu_control_ext_u(thread, ext_vcpu_state, l4_utcb()); }
 926
 927 L4_INLINE l4_msgtag_t
 928 l4_thread_modify_sender_start_u(l4_utcb_t *u) L4_NOTHROW
 929 {
 930   l4_msg_regs_t *m = l4_utcb_mr_u(u);
 931   m->mr[0] = L4_THREAD_MODIFY_SENDER_OP;
 932   return l4_msgtag(L4_PROTO_THREAD, 1, 0, 0);
 933 }
 934
 935 L4_INLINE int
 936 l4_thread_modify_sender_add_u(l4_umword_t match_mask,
 937                               l4_umword_t match,
 938                               l4_umword_t del_bits,
 939                               l4_umword_t add_bits,
 940                               l4_msgtag_t *tag, l4_utcb_t *u) L4_NOTHROW
 941 {
 942   l4_msg_regs_t *m = l4_utcb_mr_u(u);
 943   unsigned w = l4_msgtag_words(*tag);
 944   if (w >= L4_UTCB_GENERIC_DATA_SIZE - 4)
 945     return -L4_ENOMEM;
 946
 947   m->mr[w]   = match_mask;
 948   m->mr[w+1] = match;
 949   m->mr[w+2] = del_bits;
 950   m->mr[w+3] = add_bits;
 951
 952   *tag = l4_msgtag(l4_msgtag_label(*tag), w + 4, 0, 0);
 953
 954   return 0;
 955 }
 956
 957 L4_INLINE l4_msgtag_t
 958 l4_thread_modify_sender_commit_u(l4_cap_idx_t thread, l4_msgtag_t tag,
 959                                  l4_utcb_t *u) L4_NOTHROW
 960 {
 961   return l4_ipc_call(thread, u, tag, L4_IPC_NEVER);
 962 }
 963
 964 L4_INLINE l4_msgtag_t
 965 l4_thread_modify_sender_start(void) L4_NOTHROW
 966 {
 967   return l4_thread_modify_sender_start_u(l4_utcb());
 968 }
 969
 970 L4_INLINE int
 971 l4_thread_modify_sender_add(l4_umword_t match_mask,
 972                             l4_umword_t match,
 973                             l4_umword_t del_bits,
 974                             l4_umword_t add_bits,
 975                             l4_msgtag_t *tag) L4_NOTHROW
 976 {
 977   return l4_thread_modify_sender_add_u(match_mask, match,
 978                                        del_bits, add_bits, tag, l4_utcb());
 979 }
 980
 981 L4_INLINE l4_msgtag_t
 982 l4_thread_modify_sender_commit(l4_cap_idx_t thread, l4_msgtag_t tag) L4_NOTHROW
 983 {
 984   return l4_thread_modify_sender_commit_u(thread, tag, l4_utcb());
 985 }