Subversion Repositories HelenOS

Rev

Rev 2131 | 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 time
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #ifndef KERN_TIMEOUT_H_
  36. #define KERN_TIMEOUT_H_
  37.  
  38. #include <arch/types.h>
  39. #ifdef CONFIG_TIMEOUT_EXTAVL_TREE
  40. #include <adt/extavl.h>
  41. #endif
  42. #include <adt/list.h>
  43. #include <cpu.h>
  44.  
  45. typedef void (* timeout_handler_t)(void *arg);
  46.  
  47. #ifdef CONFIG_TIMEOUT_EXTAVL_TREE
  48.  
  49. typedef struct {
  50.     SPINLOCK_DECLARE(lock);
  51.    
  52.     /**
  53.      * Extended AVL tree node structure holds information
  54.      * about connections with other timeouts.
  55.      */
  56.     extavltree_node_t node;
  57.     /** Function that will be called on timeout activation. */
  58.     timeout_handler_t handler;
  59.     /** Argument to be passed to handler() function. */
  60.     void *arg;
  61.     /** On which processor is this timeout registered. */
  62.     cpu_t *cpu;
  63. } timeout_t;
  64.  
  65. #else
  66.  
  67. typedef struct {
  68.     SPINLOCK_DECLARE(lock);
  69.  
  70.     /** Link to the list of active timeouts on THE->cpu */
  71.     link_t link;
  72.     /** Timeout will be activated in this amount of clock() ticks. */  
  73.     uint64_t ticks;
  74.     /** Function that will be called on timeout activation. */
  75.     timeout_handler_t handler;
  76.     /** Argument to be passed to handler() function. */
  77.     void *arg;
  78.     /** On which processor is this timeout registered. */
  79.     cpu_t *cpu;
  80. } timeout_t;
  81.  
  82. #endif
  83.  
  84. #define us2ticks(us)    ((uint64_t) (((uint32_t) (us) / (1000000 / HZ))))
  85.  
  86. extern void timeout_init(void);
  87. extern void timeout_initialize(timeout_t *t);
  88. extern void timeout_reinitialize(timeout_t *t);
  89. extern void timeout_register(timeout_t *t, uint64_t usec, timeout_handler_t f,
  90.     void *arg);
  91. extern bool timeout_unregister(timeout_t *t);
  92.  
  93. #endif
  94.  
  95. /** @}
  96.  */
  97.