Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
4588 mejdrech 1 
/*
2 
 * Copyright (c) 2009 Lukas Mejdrech
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 net
30 
 *  @{
31 
 */
32 
 
33 
/** @file
4704 mejdrech 34 
 *  Dynamic first in first out positive integer queue.
35 
 *  Possitive integer values only.
4588 mejdrech 36 
 */
37 
 
38 
#ifndef __NET_DYNAMIC_FIFO_H__
39 
#define __NET_DYNAMIC_FIFO_H__
40 
 
4704 mejdrech 41 
/** Type definition of the dynamic fifo queue.
42 
 *  @see dyn_fifo
43 
 */
44 
typedef struct dyn_fifo dyn_fifo_t;
4588 mejdrech 45 
 
4704 mejdrech 46 
/** Type definition of the dynamic fifo queue pointer.
47 
 *  @see dyn_fifo
48 
 */
4588 mejdrech 49 
typedef dyn_fifo_t *    dyn_fifo_ref;
50 
 
4704 mejdrech 51 
/** Dynamic first in first out positive integer queue.
52 
 *  Possitive integer values only.
53 
 *  The queue automatically resizes if needed.
54 
 */
4588 mejdrech 55 
struct dyn_fifo{
4704 mejdrech 56 
    /** Stored item field.
57 
     */
4588 mejdrech 58 
    int *   items;
4704 mejdrech 59 
    /** Actual field size.
60 
     */
4588 mejdrech 61 
    int     size;
4704 mejdrech 62 
    /** First item in the queue index.
63 
     */
4588 mejdrech 64 
    int     head;
4704 mejdrech 65 
    /** Last item in the queue index.
66 
     */
4588 mejdrech 67 
    int     tail;
4704 mejdrech 68 
    /** Consistency check magic value.
69 
     */
4588 mejdrech 70 
    int     magic_value;
71 
};
72 
 
4704 mejdrech 73 
/** Initializes the dynamic queue.
74 
 *  @param fifo The dynamic queue. Input/output parameter.
75 
 *  @param size The initial queue size. Input parameter.
76 
 *  @returns EOK on success.
77 
 *  @returns EINVAL if the queue is not valid.
78 
 *  @returns EBADMEM if the fifo parameter is NULL.
79 
 *  @returns ENOMEM if there is not enough memory left.
80 
 */
4588 mejdrech 81 
int dyn_fifo_initialize( dyn_fifo_ref fifo, int size );
82 
 
4704 mejdrech 83 
/** Appends a new item to the queue end.
84 
 *  @param fifo The dynamic queue. Input/output parameter.
85 
 *  @param value The new item value. Should be positive. Input parameter.
86 
 *  @param max_size The maximum queue size. The queue is not resized beyound this limit. May be zero or negative (<=0) to indicate no limit. Input parameter.
87 
 *  @returns EOK on success.
88 
 *  @returns EINVAL if the queue is not valid.
89 
 *  @returns ENOMEM if there is not enough memory left.
90 
 */
4588 mejdrech 91 
int dyn_fifo_push( dyn_fifo_ref fifo, int value, int max_size );
92 
 
4704 mejdrech 93 
/** Returns and excludes the first item in the queue.
94 
 *  @param fifo The dynamic queue. Input/output parameter.
95 
 *  @returns Value of the first item in the queue.
96 
 *  @returns EINVAL if the queue is not valid.
97 
 *  @returns ENOENT if the queue is empty.
98 
 */
4588 mejdrech 99 
int dyn_fifo_pop( dyn_fifo_ref fifo );
100 
 
4704 mejdrech 101 
/** Returns and keeps the first item in the queue.
102 
 *  @param fifo The dynamic queue. Input/output parameter.
103 
 *  @returns Value of the first item in the queue.
104 
 *  @returns EINVAL if the queue is not valid.
105 
 *  @returns ENOENT if the queue is empty.
106 
 */
4588 mejdrech 107 
int dyn_fifo_value( dyn_fifo_ref fifo );
108 
 
4704 mejdrech 109 
/** Clears and destroys the queue.
110 
 *  @param fifo The dynamic queue. Input/output parameter.
111 
 *  @returns EOK on success.
112 
 *  @returns EINVAL if the queue is not valid.
113 
 */
4588 mejdrech 114 
int dyn_fifo_destroy( dyn_fifo_ref fifo );
115 
 
116 
#endif
117 
 
118 
/** @}
119 
 */