Subversion Repositories HelenOS

Rev

Rev 2336 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1 jermar 1 
/*
2071 jermar 2 
 * Copyright (c) 2001-2004 Jakub Jermar
1 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 
 
1731 jermar 29 
/** @addtogroup time
1702 cejka 30 
 * @{
31 
 */
32 
/** @file
33 
 */
34 
 
1881 jermar 35 
#ifndef KERN_TIMEOUT_H_
36 
#define KERN_TIMEOUT_H_
1 jermar 37 
 
38 
#include <arch/types.h>
2416 mencl 39 
#if defined CONFIG_TIMEOUT_AVL_TREE
40 
#include <adt/avl.h>
41 
#elif defined CONFIG_TIMEOUT_EXTAVL_TREE
2336 mencl 42 
#include <adt/extavl.h>
2416 mencl 43 
#elif defined CONFIG_TIMEOUT_EXTAVLREL_TREE
44 
#include <adt/extavlrel.h>
45 
#else
46 
#include <adt/list.h>
2336 mencl 47 
#endif
2103 decky 48 
#include <cpu.h>
1 jermar 49 
 
2103 decky 50 
typedef void (* timeout_handler_t)(void *arg);
51 
 
2336 mencl 52 
 
2416 mencl 53 
#if defined CONFIG_TIMEOUT_AVL_TREE
54 
 
2103 decky 55 
typedef struct {
56 
    SPINLOCK_DECLARE(lock);
2336 mencl 57 
 
58 
    /**
2416 mencl 59 
     * AVL tree node structure holds information
60 
     * about connections with other timeouts.
61 
     */
62 
    avltree_node_t node;
63 
    /** Function that will be called on timeout activation. */
64 
    timeout_handler_t handler;
65 
    /** Argument to be passed to handler() function. */
66 
    void *arg;
67 
    /** On which processor is this timeout registered. */
68 
    cpu_t *cpu;
69 
} timeout_t;
70 
 
71 
#elif defined CONFIG_TIMEOUT_EXTAVL_TREE
72 
 
73 
typedef struct {
74 
    SPINLOCK_DECLARE(lock);
75 
 
76 
    /**
2336 mencl 77 
     * Extended AVL tree node structure holds information
78 
     * about connections with other timeouts.
79 
     */
80 
    extavltree_node_t node;
81 
    /** Function that will be called on timeout activation. */
82 
    timeout_handler_t handler;
83 
    /** Argument to be passed to handler() function. */
84 
    void *arg;
85 
    /** On which processor is this timeout registered. */
86 
    cpu_t *cpu;
87 
} timeout_t;
2103 decky 88 
 
2416 mencl 89 
#elif defined CONFIG_TIMEOUT_EXTAVLREL_TREE
90 
 
91 
typedef struct {
92 
    SPINLOCK_DECLARE(lock);
93 
 
94 
    /**
95 
     * Extended AVL tree with relative keys node structure holds information
96 
     * about connections with other timeouts.
97 
     */
98 
    extavlreltree_node_t node;
99 
    /** Function that will be called on timeout activation. */
100 
    timeout_handler_t handler;
101 
    /** Argument to be passed to handler() function. */
102 
    void *arg;
103 
    /** On which processor is this timeout registered. */
104 
    cpu_t *cpu;
105 
} timeout_t;
106 
 
2336 mencl 107 
#else
108 
 
109 
typedef struct {
110 
    SPINLOCK_DECLARE(lock);
111 
 
2106 jermar 112 
    /** Link to the list of active timeouts on THE->cpu */
113 
    link_t link;
114 
    /** Timeout will be activated in this amount of clock() ticks. */  
115 
    uint64_t ticks;
116 
    /** Function that will be called on timeout activation. */
117 
    timeout_handler_t handler;
118 
    /** Argument to be passed to handler() function. */
119 
    void *arg;
120 
    /** On which processor is this timeout registered. */
121 
    cpu_t *cpu;
2103 decky 122 
} timeout_t;
123 
 
2336 mencl 124 
#endif
125 
 
2089 decky 126 
#define us2ticks(us)    ((uint64_t) (((uint32_t) (us) / (1000000 / HZ))))
1 jermar 127 
 
128 
extern void timeout_init(void);
129 
extern void timeout_initialize(timeout_t *t);
130 
extern void timeout_reinitialize(timeout_t *t);
2106 jermar 131 
extern void timeout_register(timeout_t *t, uint64_t usec, timeout_handler_t f,
132 
    void *arg);
411 jermar 133 
extern bool timeout_unregister(timeout_t *t);
1 jermar 134 
 
135 
#endif
1702 cejka 136 
 
1731 jermar 137 
/** @}
1702 cejka 138 
 */