Subversion Repositories HelenOS

Rev

Rev 2902 | Rev 3035 | 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. /** @addtogroup genericproc
  30.  * @{
  31.  */
  32.  
  33. /**
  34.  * @file
  35.  * @brief   Task management.
  36.  */
  37.  
  38. #include <main/uinit.h>
  39. #include <proc/thread.h>
  40. #include <proc/task.h>
  41. #include <proc/uarg.h>
  42. #include <mm/as.h>
  43. #include <mm/slab.h>
  44. #include <atomic.h>
  45. #include <synch/spinlock.h>
  46. #include <synch/waitq.h>
  47. #include <arch.h>
  48. #include <panic.h>
  49. #include <adt/avl.h>
  50. #include <adt/btree.h>
  51. #include <adt/list.h>
  52. #include <ipc/ipc.h>
  53. #include <security/cap.h>
  54. #include <memstr.h>
  55. #include <print.h>
  56. #include <lib/elf.h>
  57. #include <errno.h>
  58. #include <func.h>
  59. #include <syscall/copy.h>
  60.  
  61. #ifndef LOADED_PROG_STACK_PAGES_NO
  62. #define LOADED_PROG_STACK_PAGES_NO 1
  63. #endif
  64.  
  65. /** Spinlock protecting the tasks_tree AVL tree. */
  66. SPINLOCK_INITIALIZE(tasks_lock);
  67.  
  68. /** AVL tree of active tasks.
  69.  *
  70.  * The task is guaranteed to exist after it was found in the tasks_tree as
  71.  * long as:
  72.  * @li the tasks_lock is held,
  73.  * @li the task's lock is held when task's lock is acquired before releasing
  74.  *     tasks_lock or
  75.  * @li the task's refcount is greater than 0
  76.  *
  77.  */
  78. avltree_t tasks_tree;
  79.  
  80. static task_id_t task_counter = 0;
  81.  
  82. /** Initialize tasks
  83.  *
  84.  * Initialize kernel tasks support.
  85.  *
  86.  */
  87. void task_init(void)
  88. {
  89.     TASK = NULL;
  90.     avltree_create(&tasks_tree);
  91. }
  92.  
  93. /*
  94.  * The idea behind this walker is to remember a single task different from TASK.
  95.  */
  96. static bool task_done_walker(avltree_node_t *node, void *arg)
  97. {
  98.     task_t *t = avltree_get_instance(node, task_t, tasks_tree_node);
  99.     task_t **tp = (task_t **) arg;
  100.  
  101.     if (t != TASK) {
  102.         *tp = t;
  103.         return false;   /* stop walking */
  104.     }
  105.  
  106.     return true;    /* continue the walk */
  107. }
  108.  
  109. /** Kill all tasks except the current task.
  110.  *
  111.  */
  112. void task_done(void)
  113. {
  114.     task_t *t;
  115.     do { /* Repeat until there are any tasks except TASK */
  116.        
  117.         /* Messing with task structures, avoid deadlock */
  118.         ipl_t ipl = interrupts_disable();
  119.         spinlock_lock(&tasks_lock);
  120.        
  121.         t = NULL;
  122.         avltree_walk(&tasks_tree, task_done_walker, &t);
  123.        
  124.         if (t != NULL) {
  125.             task_id_t id = t->taskid;
  126.            
  127.             spinlock_unlock(&tasks_lock);
  128.             interrupts_restore(ipl);
  129.            
  130. #ifdef CONFIG_DEBUG
  131.             printf("Killing task %llu\n", id);
  132. #endif         
  133.             task_kill(id);
  134.             thread_usleep(10000);
  135.         } else {
  136.             spinlock_unlock(&tasks_lock);
  137.             interrupts_restore(ipl);
  138.         }
  139.        
  140.     } while (t != NULL);
  141. }
  142.  
  143. /** Create new task
  144.  *
  145.  * Create new task with no threads.
  146.  *
  147.  * @param as Task's address space.
  148.  * @param name Symbolic name.
  149.  *
  150.  * @return New task's structure
  151.  *
  152.  */
  153. task_t *task_create(as_t *as, char *name)
  154. {
  155.     ipl_t ipl;
  156.     task_t *ta;
  157.     int i;
  158.    
  159.     ta = (task_t *) malloc(sizeof(task_t), 0);
  160.  
  161.     task_create_arch(ta);
  162.  
  163.     spinlock_initialize(&ta->lock, "task_ta_lock");
  164.     list_initialize(&ta->th_head);
  165.     ta->as = as;
  166.     ta->name = name;
  167.     atomic_set(&ta->refcount, 0);
  168.     atomic_set(&ta->lifecount, 0);
  169.     ta->context = CONTEXT;
  170.  
  171.     ta->capabilities = 0;
  172.     ta->cycles = 0;
  173.  
  174.     /* Init debugging stuff */
  175.     udebug_task_init(&ta->udebug);
  176.  
  177.     /* Init kbox stuff */
  178.     ipc_answerbox_init(&ta->kernel_box, ta);
  179.     ta->kb_thread = NULL;
  180.     spinlock_initialize(&ta->kb_cleanup_lock, "task_kb_cleanup_lock");
  181.     ta->kb_finished = false;
  182.     waitq_initialize(&ta->kb_thread_shutdown_wq);
  183.  
  184.     ipc_answerbox_init(&ta->answerbox, ta);
  185.     for (i = 0; i < IPC_MAX_PHONES; i++)
  186.         ipc_phone_init(&ta->phones[i]);
  187.     if ((ipc_phone_0) && (context_check(ipc_phone_0->task->context,
  188.         ta->context)))
  189.         ipc_phone_connect(&ta->phones[0], ipc_phone_0);
  190.     atomic_set(&ta->active_calls, 0);
  191.  
  192.     mutex_initialize(&ta->futexes_lock);
  193.     btree_create(&ta->futexes);
  194.    
  195.     ipl = interrupts_disable();
  196.  
  197.     /*
  198.      * Increment address space reference count.
  199.      */
  200.     atomic_inc(&as->refcount);
  201.  
  202.     spinlock_lock(&tasks_lock);
  203.     ta->taskid = ++task_counter;
  204.     avltree_node_initialize(&ta->tasks_tree_node);
  205.     ta->tasks_tree_node.key = ta->taskid;
  206.     avltree_insert(&tasks_tree, &ta->tasks_tree_node);
  207.     spinlock_unlock(&tasks_lock);
  208.     interrupts_restore(ipl);
  209.  
  210.     return ta;
  211. }
  212.  
  213. /** Destroy task.
  214.  *
  215.  * @param t Task to be destroyed.
  216.  */
  217. void task_destroy(task_t *t)
  218. {
  219.     /*
  220.      * Remove the task from the task B+tree.
  221.      */
  222.     spinlock_lock(&tasks_lock);
  223.     avltree_delete(&tasks_tree, &t->tasks_tree_node);
  224.     spinlock_unlock(&tasks_lock);
  225.  
  226.     /*
  227.      * Perform architecture specific task destruction.
  228.      */
  229.     task_destroy_arch(t);
  230.  
  231.     /*
  232.      * Free up dynamically allocated state.
  233.      */
  234.     btree_destroy(&t->futexes);
  235.  
  236.     /*
  237.      * Drop our reference to the address space.
  238.      */
  239.     if (atomic_predec(&t->as->refcount) == 0)
  240.         as_destroy(t->as);
  241.    
  242.     free(t);
  243.     TASK = NULL;
  244. }
  245.  
  246. /** Create new task with 1 thread and run it
  247.  *
  248.  * @param program_addr Address of program executable image.
  249.  * @param name Program name.
  250.  *
  251.  * @return Task of the running program or NULL on error.
  252.  */
  253. task_t *task_run_program(void *program_addr, char *name)
  254. {
  255.     as_t *as;
  256.     as_area_t *a;
  257.     unsigned int rc;
  258.     thread_t *t;
  259.     task_t *task;
  260.     uspace_arg_t *kernel_uarg;
  261.  
  262.     as = as_create(0);
  263.     ASSERT(as);
  264.  
  265.     rc = elf_load((elf_header_t *) program_addr, as);
  266.     if (rc != EE_OK) {
  267.         as_destroy(as);
  268.         return NULL;
  269.     }
  270.    
  271.     kernel_uarg = (uspace_arg_t *) malloc(sizeof(uspace_arg_t), 0);
  272.     kernel_uarg->uspace_entry =
  273.         (void *) ((elf_header_t *) program_addr)->e_entry;
  274.     kernel_uarg->uspace_stack = (void *) USTACK_ADDRESS;
  275.     kernel_uarg->uspace_thread_function = NULL;
  276.     kernel_uarg->uspace_thread_arg = NULL;
  277.     kernel_uarg->uspace_uarg = NULL;
  278.    
  279.     task = task_create(as, name);
  280.     ASSERT(task);
  281.  
  282.     /*
  283.      * Create the data as_area.
  284.      */
  285.     a = as_area_create(as, AS_AREA_READ | AS_AREA_WRITE | AS_AREA_CACHEABLE,
  286.         LOADED_PROG_STACK_PAGES_NO * PAGE_SIZE, USTACK_ADDRESS,
  287.         AS_AREA_ATTR_NONE, &anon_backend, NULL);
  288.  
  289.     /*
  290.      * Create the main thread.
  291.      */
  292.     t = thread_create(uinit, kernel_uarg, task, THREAD_FLAG_USPACE,
  293.         "uinit", false);
  294.     ASSERT(t);
  295.    
  296.     thread_ready(t);
  297.  
  298.     return task;
  299. }
  300.  
  301. /** Syscall for reading task ID from userspace.
  302.  *
  303.  * @param uspace_task_id Userspace address of 8-byte buffer where to store
  304.  * current task ID.
  305.  *
  306.  * @return 0 on success or an error code from @ref errno.h.
  307.  */
  308. unative_t sys_task_get_id(task_id_t *uspace_task_id)
  309. {
  310.     /*
  311.      * No need to acquire lock on TASK because taskid
  312.      * remains constant for the lifespan of the task.
  313.      */
  314.     return (unative_t) copy_to_uspace(uspace_task_id, &TASK->taskid,
  315.         sizeof(TASK->taskid));
  316. }
  317.  
  318. /** Find task structure corresponding to task ID.
  319.  *
  320.  * The tasks_lock must be already held by the caller of this function
  321.  * and interrupts must be disabled.
  322.  *
  323.  * @param id Task ID.
  324.  *
  325.  * @return Task structure address or NULL if there is no such task ID.
  326.  */
  327. task_t *task_find_by_id(task_id_t id)
  328. {
  329.     avltree_node_t *node;
  330.    
  331.     node = avltree_search(&tasks_tree, (avltree_key_t) id);
  332.  
  333.     if (node)
  334.         return avltree_get_instance(node, task_t, tasks_tree_node);
  335.     return NULL;
  336. }
  337.  
  338. /** Get accounting data of given task.
  339.  *
  340.  * Note that task lock of 't' must be already held and
  341.  * interrupts must be already disabled.
  342.  *
  343.  * @param t Pointer to thread.
  344.  *
  345.  */
  346. uint64_t task_get_accounting(task_t *t)
  347. {
  348.     /* Accumulated value of task */
  349.     uint64_t ret = t->cycles;
  350.    
  351.     /* Current values of threads */
  352.     link_t *cur;
  353.     for (cur = t->th_head.next; cur != &t->th_head; cur = cur->next) {
  354.         thread_t *thr = list_get_instance(cur, thread_t, th_link);
  355.        
  356.         spinlock_lock(&thr->lock);
  357.         /* Process only counted threads */
  358.         if (!thr->uncounted) {
  359.             if (thr == THREAD) {
  360.                 /* Update accounting of current thread */
  361.                 thread_update_accounting();
  362.             }
  363.             ret += thr->cycles;
  364.         }
  365.         spinlock_unlock(&thr->lock);
  366.     }
  367.    
  368.     return ret;
  369. }
  370.  
  371. /** Kill task.
  372.  *
  373.  * This function is idempotent.
  374.  * It signals all the task's threads to bail it out.
  375.  *
  376.  * @param id ID of the task to be killed.
  377.  *
  378.  * @return 0 on success or an error code from errno.h
  379.  */
  380. int task_kill(task_id_t id)
  381. {
  382.     ipl_t ipl;
  383.     task_t *ta;
  384.     link_t *cur;
  385.  
  386.     if (id == 1)
  387.         return EPERM;
  388.    
  389.     ipl = interrupts_disable();
  390.     spinlock_lock(&tasks_lock);
  391.     if (!(ta = task_find_by_id(id))) {
  392.         spinlock_unlock(&tasks_lock);
  393.         interrupts_restore(ipl);
  394.         return ENOENT;
  395.     }
  396.     spinlock_unlock(&tasks_lock);
  397.    
  398.     /*
  399.      * Interrupt all threads except ktaskclnp.
  400.      */
  401.     spinlock_lock(&ta->lock);
  402.     for (cur = ta->th_head.next; cur != &ta->th_head; cur = cur->next) {
  403.         thread_t *thr;
  404.         bool sleeping = false;
  405.        
  406.         thr = list_get_instance(cur, thread_t, th_link);
  407.            
  408.         spinlock_lock(&thr->lock);
  409.         thr->interrupted = true;
  410.         if (thr->state == Sleeping)
  411.             sleeping = true;
  412.         spinlock_unlock(&thr->lock);
  413.        
  414.         if (sleeping)
  415.             waitq_interrupt_sleep(thr);
  416.     }
  417.     spinlock_unlock(&ta->lock);
  418.     interrupts_restore(ipl);
  419.    
  420.     return 0;
  421. }
  422.  
  423. static bool task_print_walker(avltree_node_t *node, void *arg)
  424. {
  425.     task_t *t = avltree_get_instance(node, task_t, tasks_tree_node);
  426.     int j;
  427.        
  428.     spinlock_lock(&t->lock);
  429.            
  430.     uint64_t cycles;
  431.     char suffix;
  432.     order(task_get_accounting(t), &cycles, &suffix);
  433.    
  434.     if (sizeof(void *) == 4)
  435.         printf("%-6llu %-10s %-3ld %#10zx %#10zx %9llu%c %7zd %6zd",
  436.             t->taskid, t->name, t->context, t, t->as, cycles, suffix,
  437.             t->refcount, atomic_get(&t->active_calls));
  438.     else
  439.         printf("%-6llu %-10s %-3ld %#18zx %#18zx %9llu%c %7zd %6zd",
  440.             t->taskid, t->name, t->context, t, t->as, cycles, suffix,
  441.             t->refcount, atomic_get(&t->active_calls));
  442.     for (j = 0; j < IPC_MAX_PHONES; j++) {
  443.         if (t->phones[j].callee)
  444.             printf(" %zd:%#zx", j, t->phones[j].callee);
  445.     }
  446.     printf("\n");
  447.            
  448.     spinlock_unlock(&t->lock);
  449.     return true;
  450. }
  451.  
  452. /** Print task list */
  453. void task_print_list(void)
  454. {
  455.     ipl_t ipl;
  456.    
  457.     /* Messing with task structures, avoid deadlock */
  458.     ipl = interrupts_disable();
  459.     spinlock_lock(&tasks_lock);
  460.    
  461.     if (sizeof(void *) == 4) {
  462.         printf("taskid name       ctx address    as         "
  463.             "cycles     threads calls  callee\n");
  464.         printf("------ ---------- --- ---------- ---------- "
  465.             "---------- ------- ------ ------>\n");
  466.     } else {
  467.         printf("taskid name       ctx address            as                 "
  468.             "cycles     threads calls  callee\n");
  469.         printf("------ ---------- --- ------------------ ------------------ "
  470.             "---------- ------- ------ ------>\n");
  471.     }
  472.  
  473.     avltree_walk(&tasks_tree, task_print_walker, NULL);
  474.  
  475.     spinlock_unlock(&tasks_lock);
  476.     interrupts_restore(ipl);
  477. }
  478.  
  479. /** @}
  480.  */
  481.