Subversion Repositories HelenOS

Rev

Rev 1581 | Rev 1589 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (C) 2001-2004 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /**
  30.  * @file    thread.c
  31.  * @brief   Thread management functions.
  32.  */
  33.  
  34. #include <proc/scheduler.h>
  35. #include <proc/thread.h>
  36. #include <proc/task.h>
  37. #include <proc/uarg.h>
  38. #include <mm/frame.h>
  39. #include <mm/page.h>
  40. #include <arch/asm.h>
  41. #include <arch.h>
  42. #include <synch/synch.h>
  43. #include <synch/spinlock.h>
  44. #include <synch/waitq.h>
  45. #include <synch/rwlock.h>
  46. #include <cpu.h>
  47. #include <func.h>
  48. #include <context.h>
  49. #include <adt/btree.h>
  50. #include <adt/list.h>
  51. #include <typedefs.h>
  52. #include <time/clock.h>
  53. #include <config.h>
  54. #include <arch/interrupt.h>
  55. #include <smp/ipi.h>
  56. #include <arch/faddr.h>
  57. #include <atomic.h>
  58. #include <memstr.h>
  59. #include <print.h>
  60. #include <mm/slab.h>
  61. #include <debug.h>
  62. #include <main/uinit.h>
  63. #include <syscall/copy.h>
  64. #include <errno.h>
  65.  
  66.  
  67. /** Thread states */
  68. char *thread_states[] = {
  69.     "Invalid",
  70.     "Running",
  71.     "Sleeping",
  72.     "Ready",
  73.     "Entering",
  74.     "Exiting",
  75.     "Undead"
  76. };
  77.  
  78. /** Lock protecting threads_head list. For locking rules, see declaration thereof. */
  79. SPINLOCK_INITIALIZE(threads_lock);
  80. btree_t threads_btree;          /**< B+tree of all threads. */
  81.  
  82. SPINLOCK_INITIALIZE(tidlock);
  83. __u32 last_tid = 0;
  84.  
  85. static slab_cache_t *thread_slab;
  86. #ifdef ARCH_HAS_FPU
  87. slab_cache_t *fpu_context_slab;
  88. #endif
  89.  
  90. /** Thread wrapper
  91.  *
  92.  * This wrapper is provided to ensure that every thread
  93.  * makes a call to thread_exit() when its implementing
  94.  * function returns.
  95.  *
  96.  * interrupts_disable() is assumed.
  97.  *
  98.  */
  99. static void cushion(void)
  100. {
  101.     void (*f)(void *) = THREAD->thread_code;
  102.     void *arg = THREAD->thread_arg;
  103.  
  104.     /* this is where each thread wakes up after its creation */
  105.     spinlock_unlock(&THREAD->lock);
  106.     interrupts_enable();
  107.  
  108.     f(arg);
  109.     thread_exit();
  110.     /* not reached */
  111. }
  112.  
  113. /** Initialization and allocation for thread_t structure */
  114. static int thr_constructor(void *obj, int kmflags)
  115. {
  116.     thread_t *t = (thread_t *)obj;
  117.     pfn_t pfn;
  118.     int status;
  119.  
  120.     spinlock_initialize(&t->lock, "thread_t_lock");
  121.     link_initialize(&t->rq_link);
  122.     link_initialize(&t->wq_link);
  123.     link_initialize(&t->th_link);
  124.    
  125. #ifdef ARCH_HAS_FPU
  126. #  ifdef CONFIG_FPU_LAZY
  127.     t->saved_fpu_context = NULL;
  128. #  else
  129.     t->saved_fpu_context = slab_alloc(fpu_context_slab,kmflags);
  130.     if (!t->saved_fpu_context)
  131.         return -1;
  132. #  endif
  133. #endif 
  134.  
  135.     pfn = frame_alloc_rc(STACK_FRAMES, FRAME_KA | kmflags,&status);
  136.     if (status) {
  137. #ifdef ARCH_HAS_FPU
  138.         if (t->saved_fpu_context)
  139.             slab_free(fpu_context_slab,t->saved_fpu_context);
  140. #endif
  141.         return -1;
  142.     }
  143.     t->kstack = (__u8 *)PA2KA(PFN2ADDR(pfn));
  144.  
  145.     return 0;
  146. }
  147.  
  148. /** Destruction of thread_t object */
  149. static int thr_destructor(void *obj)
  150. {
  151.     thread_t *t = (thread_t *)obj;
  152.  
  153.     frame_free(ADDR2PFN(KA2PA(t->kstack)));
  154. #ifdef ARCH_HAS_FPU
  155.     if (t->saved_fpu_context)
  156.         slab_free(fpu_context_slab,t->saved_fpu_context);
  157. #endif
  158.     return 1; /* One page freed */
  159. }
  160.  
  161. /** Initialize threads
  162.  *
  163.  * Initialize kernel threads support.
  164.  *
  165.  */
  166. void thread_init(void)
  167. {
  168.     THREAD = NULL;
  169.     atomic_set(&nrdy,0);
  170.     thread_slab = slab_cache_create("thread_slab",
  171.                     sizeof(thread_t),0,
  172.                     thr_constructor, thr_destructor, 0);
  173. #ifdef ARCH_HAS_FPU
  174.     fpu_context_slab = slab_cache_create("fpu_slab",
  175.                          sizeof(fpu_context_t),
  176.                          FPU_CONTEXT_ALIGN,
  177.                          NULL, NULL, 0);
  178. #endif
  179.  
  180.     btree_create(&threads_btree);
  181. }
  182.  
  183. /** Make thread ready
  184.  *
  185.  * Switch thread t to the ready state.
  186.  *
  187.  * @param t Thread to make ready.
  188.  *
  189.  */
  190. void thread_ready(thread_t *t)
  191. {
  192.     cpu_t *cpu;
  193.     runq_t *r;
  194.     ipl_t ipl;
  195.     int i, avg;
  196.  
  197.     ipl = interrupts_disable();
  198.  
  199.     spinlock_lock(&t->lock);
  200.  
  201.     ASSERT(! (t->state == Ready));
  202.  
  203.     i = (t->priority < RQ_COUNT -1) ? ++t->priority : t->priority;
  204.    
  205.     cpu = CPU;
  206.     if (t->flags & X_WIRED) {
  207.         cpu = t->cpu;
  208.     }
  209.     t->state = Ready;
  210.     spinlock_unlock(&t->lock);
  211.    
  212.     /*
  213.      * Append t to respective ready queue on respective processor.
  214.      */
  215.     r = &cpu->rq[i];
  216.     spinlock_lock(&r->lock);
  217.     list_append(&t->rq_link, &r->rq_head);
  218.     r->n++;
  219.     spinlock_unlock(&r->lock);
  220.  
  221.     atomic_inc(&nrdy);
  222.     avg = atomic_get(&nrdy) / config.cpu_active;
  223.     atomic_inc(&cpu->nrdy);
  224.  
  225.     interrupts_restore(ipl);
  226. }
  227.  
  228. /** Destroy thread memory structure
  229.  *
  230.  * Detach thread from all queues, cpus etc. and destroy it.
  231.  *
  232.  * Assume thread->lock is held!!
  233.  */
  234. void thread_destroy(thread_t *t)
  235. {
  236.     bool destroy_task = false; 
  237.  
  238.     ASSERT(t->state == Exiting || t->state == Undead);
  239.     ASSERT(t->task);
  240.     ASSERT(t->cpu);
  241.  
  242.     spinlock_lock(&t->cpu->lock);
  243.     if(t->cpu->fpu_owner==t)
  244.         t->cpu->fpu_owner=NULL;
  245.     spinlock_unlock(&t->cpu->lock);
  246.  
  247.     spinlock_unlock(&t->lock);
  248.  
  249.     spinlock_lock(&threads_lock);
  250.     btree_remove(&threads_btree, (btree_key_t) ((__address ) t), NULL);
  251.     spinlock_unlock(&threads_lock);
  252.  
  253.     /*
  254.      * Detach from the containing task.
  255.      */
  256.     spinlock_lock(&t->task->lock);
  257.     list_remove(&t->th_link);
  258.     if (--t->task->refcount == 0) {
  259.         t->task->accept_new_threads = false;
  260.         destroy_task = true;
  261.     }
  262.     spinlock_unlock(&t->task->lock);   
  263.    
  264.     if (destroy_task)
  265.         task_destroy(t->task);
  266.    
  267.     slab_free(thread_slab, t);
  268. }
  269.  
  270. /** Create new thread
  271.  *
  272.  * Create a new thread.
  273.  *
  274.  * @param func  Thread's implementing function.
  275.  * @param arg   Thread's implementing function argument.
  276.  * @param task  Task to which the thread belongs.
  277.  * @param flags Thread flags.
  278.  * @param name  Symbolic name.
  279.  *
  280.  * @return New thread's structure on success, NULL on failure.
  281.  *
  282.  */
  283. thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name)
  284. {
  285.     thread_t *t;
  286.     ipl_t ipl;
  287.    
  288.     t = (thread_t *) slab_alloc(thread_slab, 0);
  289.     if (!t)
  290.         return NULL;
  291.  
  292.     thread_create_arch(t);
  293.    
  294.     /* Not needed, but good for debugging */
  295.     memsetb((__address)t->kstack, THREAD_STACK_SIZE * 1<<STACK_FRAMES, 0);
  296.    
  297.     ipl = interrupts_disable();
  298.     spinlock_lock(&tidlock);
  299.     t->tid = ++last_tid;
  300.     spinlock_unlock(&tidlock);
  301.     interrupts_restore(ipl);
  302.    
  303.     context_save(&t->saved_context);
  304.     context_set(&t->saved_context, FADDR(cushion), (__address) t->kstack, THREAD_STACK_SIZE);
  305.    
  306.     the_initialize((the_t *) t->kstack);
  307.    
  308.     ipl = interrupts_disable();
  309.     t->saved_context.ipl = interrupts_read();
  310.     interrupts_restore(ipl);
  311.    
  312.     memcpy(t->name, name, THREAD_NAME_BUFLEN);
  313.    
  314.     t->thread_code = func;
  315.     t->thread_arg = arg;
  316.     t->ticks = -1;
  317.     t->priority = -1;       /* start in rq[0] */
  318.     t->cpu = NULL;
  319.     t->flags = 0;
  320.     t->state = Entering;
  321.     t->call_me = NULL;
  322.     t->call_me_with = NULL;
  323.    
  324.     timeout_initialize(&t->sleep_timeout);
  325.     t->sleep_interruptible = false;
  326.     t->sleep_queue = NULL;
  327.     t->timeout_pending = 0;
  328.  
  329.     t->in_copy_from_uspace = false;
  330.     t->in_copy_to_uspace = false;
  331.  
  332.     t->interrupted = false;
  333.     t->detached = false;
  334.     waitq_initialize(&t->join_wq);
  335.    
  336.     t->rwlock_holder_type = RWLOCK_NONE;
  337.        
  338.     t->task = task;
  339.    
  340.     t->fpu_context_exists = 0;
  341.     t->fpu_context_engaged = 0;
  342.    
  343.     /*
  344.      * Attach to the containing task.
  345.      */
  346.     spinlock_lock(&task->lock);
  347.     if (!task->accept_new_threads) {
  348.         spinlock_unlock(&task->lock);
  349.         slab_free(thread_slab, t);
  350.         return NULL;
  351.     }
  352.     list_append(&t->th_link, &task->th_head);
  353.     if (task->refcount++ == 0)
  354.         task->main_thread = t;
  355.     spinlock_unlock(&task->lock);
  356.  
  357.     /*
  358.      * Register this thread in the system-wide list.
  359.      */
  360.     ipl = interrupts_disable();
  361.     spinlock_lock(&threads_lock);
  362.     btree_insert(&threads_btree, (btree_key_t) ((__address) t), (void *) t, NULL);
  363.     spinlock_unlock(&threads_lock);
  364.    
  365.     interrupts_restore(ipl);
  366.    
  367.     return t;
  368. }
  369.  
  370. /** Make thread exiting
  371.  *
  372.  * End current thread execution and switch it to the exiting
  373.  * state. All pending timeouts are executed.
  374.  *
  375.  */
  376. void thread_exit(void)
  377. {
  378.     ipl_t ipl;
  379.  
  380. restart:
  381.     ipl = interrupts_disable();
  382.     spinlock_lock(&THREAD->lock);
  383.     if (THREAD->timeout_pending) { /* busy waiting for timeouts in progress */
  384.         spinlock_unlock(&THREAD->lock);
  385.         interrupts_restore(ipl);
  386.         goto restart;
  387.     }
  388.     THREAD->state = Exiting;
  389.     spinlock_unlock(&THREAD->lock);
  390.     scheduler();
  391. }
  392.  
  393.  
  394. /** Thread sleep
  395.  *
  396.  * Suspend execution of the current thread.
  397.  *
  398.  * @param sec Number of seconds to sleep.
  399.  *
  400.  */
  401. void thread_sleep(__u32 sec)
  402. {
  403.     thread_usleep(sec*1000000);
  404. }
  405.  
  406. /** Wait for another thread to exit.
  407.  *
  408.  * @param t Thread to join on exit.
  409.  * @param usec Timeout in microseconds.
  410.  * @param flags Mode of operation.
  411.  *
  412.  * @return An error code from errno.h or an error code from synch.h.
  413.  */
  414. int thread_join_timeout(thread_t *t, __u32 usec, int flags)
  415. {
  416.     ipl_t ipl;
  417.     int rc;
  418.  
  419.     if (t == THREAD)
  420.         return EINVAL;
  421.  
  422.     /*
  423.      * Since thread join can only be called once on an undetached thread,
  424.      * the thread pointer is guaranteed to be still valid.
  425.      */
  426.    
  427.     ipl = interrupts_disable();
  428.     spinlock_lock(&t->lock);
  429.  
  430.     ASSERT(!t->detached);
  431.    
  432.     (void) waitq_sleep_prepare(&t->join_wq);
  433.     spinlock_unlock(&t->lock);
  434.    
  435.     rc = waitq_sleep_timeout_unsafe(&t->join_wq, usec, flags);
  436.    
  437.     waitq_sleep_finish(&t->join_wq, rc, ipl);
  438.    
  439.     return rc; 
  440. }
  441.  
  442. /** Detach thread.
  443.  *
  444.  * Mark the thread as detached, if the thread is already in the Undead state,
  445.  * deallocate its resources.
  446.  *
  447.  * @param t Thread to be detached.
  448.  */
  449. void thread_detach(thread_t *t)
  450. {
  451.     ipl_t ipl;
  452.  
  453.     /*
  454.      * Since the thread is expected to not be already detached,
  455.      * pointer to it must be still valid.
  456.      */
  457.    
  458.     ipl = interrupts_disable();
  459.     spinlock_lock(&t->lock);
  460.     ASSERT(!t->detached);
  461.     if (t->state == Undead) {
  462.         thread_destroy(t);  /* unlocks &t->lock */
  463.         interrupts_restore(ipl);
  464.         return;
  465.     } else {
  466.         t->detached = true;
  467.     }
  468.     spinlock_unlock(&t->lock);
  469.     interrupts_restore(ipl);
  470. }
  471.  
  472. /** Thread usleep
  473.  *
  474.  * Suspend execution of the current thread.
  475.  *
  476.  * @param usec Number of microseconds to sleep.
  477.  *
  478.  */
  479. void thread_usleep(__u32 usec)
  480. {
  481.     waitq_t wq;
  482.                  
  483.     waitq_initialize(&wq);
  484.  
  485.     (void) waitq_sleep_timeout(&wq, usec, SYNCH_FLAGS_NON_BLOCKING);
  486. }
  487.  
  488. /** Register thread out-of-context invocation
  489.  *
  490.  * Register a function and its argument to be executed
  491.  * on next context switch to the current thread.
  492.  *
  493.  * @param call_me      Out-of-context function.
  494.  * @param call_me_with Out-of-context function argument.
  495.  *
  496.  */
  497. void thread_register_call_me(void (* call_me)(void *), void *call_me_with)
  498. {
  499.     ipl_t ipl;
  500.    
  501.     ipl = interrupts_disable();
  502.     spinlock_lock(&THREAD->lock);
  503.     THREAD->call_me = call_me;
  504.     THREAD->call_me_with = call_me_with;
  505.     spinlock_unlock(&THREAD->lock);
  506.     interrupts_restore(ipl);
  507. }
  508.  
  509. /** Print list of threads debug info */
  510. void thread_print_list(void)
  511. {
  512.     link_t *cur;
  513.     ipl_t ipl;
  514.    
  515.     /* Messing with thread structures, avoid deadlock */
  516.     ipl = interrupts_disable();
  517.     spinlock_lock(&threads_lock);
  518.  
  519.     for (cur = threads_btree.leaf_head.next; cur != &threads_btree.leaf_head; cur = cur->next) {
  520.         btree_node_t *node;
  521.         int i;
  522.  
  523.         node = list_get_instance(cur, btree_node_t, leaf_link);
  524.         for (i = 0; i < node->keys; i++) {
  525.             thread_t *t;
  526.        
  527.             t = (thread_t *) node->value[i];
  528.             printf("%s: address=%#zX, tid=%zd, state=%s, task=%#zX, code=%#zX, stack=%#zX, cpu=",
  529.                 t->name, t, t->tid, thread_states[t->state], t->task, t->thread_code, t->kstack);
  530.             if (t->cpu)
  531.                 printf("cpu%zd", t->cpu->id);
  532.             else
  533.                 printf("none");
  534.             if (t->state == Sleeping) {
  535.                 printf(", kst=%#zX", t->kstack);
  536.                 printf(", wq=%#zX", t->sleep_queue);
  537.             }
  538.             printf("\n");
  539.         }
  540.     }
  541.  
  542.     spinlock_unlock(&threads_lock);
  543.     interrupts_restore(ipl);
  544. }
  545.  
  546. /** Check whether thread exists.
  547.  *
  548.  * Note that threads_lock must be already held and
  549.  * interrupts must be already disabled.
  550.  *
  551.  * @param t Pointer to thread.
  552.  *
  553.  * @return True if thread t is known to the system, false otherwise.
  554.  */
  555. bool thread_exists(thread_t *t)
  556. {
  557.     btree_node_t *leaf;
  558.    
  559.     return btree_search(&threads_btree, (btree_key_t) ((__address) t), &leaf) != NULL;
  560. }
  561.  
  562. /** Process syscall to create new thread.
  563.  *
  564.  */
  565. __native sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name)
  566. {
  567.     thread_t *t;
  568.     char namebuf[THREAD_NAME_BUFLEN];
  569.     uspace_arg_t *kernel_uarg;
  570.     __u32 tid;
  571.     int rc;
  572.  
  573.     rc = copy_from_uspace(namebuf, uspace_name, THREAD_NAME_BUFLEN);
  574.     if (rc != 0)
  575.         return (__native) rc;
  576.  
  577.     kernel_uarg = (uspace_arg_t *) malloc(sizeof(uspace_arg_t), 0);
  578.     rc = copy_from_uspace(kernel_uarg, uspace_uarg, sizeof(uspace_arg_t));
  579.     if (rc != 0) {
  580.         free(kernel_uarg);
  581.         return (__native) rc;
  582.     }
  583.  
  584.     if ((t = thread_create(uinit, kernel_uarg, TASK, 0, namebuf))) {
  585.         tid = t->tid;
  586.         thread_ready(t);
  587.         return (__native) tid;
  588.     } else {
  589.         free(kernel_uarg);
  590.     }
  591.  
  592.     return (__native) ENOMEM;
  593. }
  594.  
  595. /** Process syscall to terminate thread.
  596.  *
  597.  */
  598. __native sys_thread_exit(int uspace_status)
  599. {
  600.     thread_exit();
  601.     /* Unreachable */
  602.     return 0;
  603. }
  604.