Don't return the next element if the queue is full
[platform/upstream/libevdev.git] / libevdev / libevdev-int.h
1 /*
2  * Copyright © 2013 Red Hat, Inc.
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and its
5  * documentation for any purpose is hereby granted without fee, provided that
6  * the above copyright notice appear in all copies and that both that copyright
7  * notice and this permission notice appear in supporting documentation, and
8  * that the name of the copyright holders not be used in advertising or
9  * publicity pertaining to distribution of the software without specific,
10  * written prior permission.  The copyright holders make no representations
11  * about the suitability of this software for any purpose.  It is provided "as
12  * is" without express or implied warranty.
13  *
14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20  * OF THIS SOFTWARE.
21  */
22
23 #ifndef libevdev_INT_H
24 #define libevdev_INT_H
25
26 #include <config.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <errno.h>
30 #include "libevdev.h"
31
32 #define LONG_BITS (sizeof(long) * 8)
33 #define NLONGS(x) (((x) + LONG_BITS - 1) / LONG_BITS)
34 #define ARRAY_LENGTH(a) (sizeof(a) / (sizeof((a)[0])))
35 #define MAX_NAME 256
36 #define MAX_SLOTS 32
37 #define ABS_MT_MIN ABS_MT_SLOT
38 #define ABS_MT_MAX ABS_MT_TOOL_Y
39 #define ABS_MT_CNT (ABS_MT_MAX - ABS_MT_MIN + 1)
40
41 #undef min
42 #undef max
43 #define min(a,b) \
44                 ({ __typeof__ (a) _a = (a); \
45                   __typeof__ (b) _b = (b); \
46                 _a > _b ? _b : _a; \
47                 })
48 #define max(a,b) \
49                 ({ __typeof__ (a) _a = (a); \
50                   __typeof__ (b) _b = (b); \
51                 _a > _b ? _a : _b; \
52                 })
53
54 struct libevdev {
55         int fd;
56         libevdev_log_func_t log;
57
58         char *name;
59         char *phys;
60         char *uniq;
61         struct input_id ids;
62         int driver_version;
63         unsigned long bits[NLONGS(EV_CNT)];
64         unsigned long props[NLONGS(INPUT_PROP_CNT)];
65         unsigned long key_bits[NLONGS(KEY_CNT)];
66         unsigned long rel_bits[NLONGS(REL_CNT)];
67         unsigned long abs_bits[NLONGS(ABS_CNT)];
68         unsigned long led_bits[NLONGS(LED_CNT)];
69         unsigned long msc_bits[NLONGS(MSC_CNT)];
70         unsigned long sw_bits[NLONGS(SW_CNT)];
71         unsigned long rep_bits[NLONGS(REP_CNT)]; /* convenience, always 1 */
72         unsigned long ff_bits[NLONGS(FF_CNT)];
73         unsigned long snd_bits[NLONGS(SND_CNT)];
74         unsigned long key_values[NLONGS(KEY_CNT)];
75         struct input_absinfo abs_info[ABS_CNT];
76         unsigned int mt_slot_vals[MAX_SLOTS][ABS_MT_CNT];
77         int num_slots; /**< valid slots in mt_slot_vals */
78         int current_slot;
79         int rep_values[2];
80
81         int need_sync;
82         int grabbed;
83
84         struct input_event *queue;
85         size_t queue_size; /**< size of queue in elements */
86         size_t queue_next; /**< next event index */
87         size_t queue_nsync; /**< number of sync events */
88
89         struct timeval last_event_time;
90 };
91
92 /**
93  * @return a pointer to the next element in the queue, or NULL if the queue
94  * is full.
95  */
96 static inline struct input_event*
97 queue_push(struct libevdev *dev)
98 {
99         if (dev->queue_next >= dev->queue_size)
100                 return NULL;
101
102         return &dev->queue[dev->queue_next++];
103 }
104
105 /**
106  * Set ev to the last element in the queue, removing it from the queue.
107  *
108  * @return 0 on success, 1 if the queue is empty.
109  */
110 static inline int
111 queue_pop(struct libevdev *dev, struct input_event *ev)
112 {
113         if (dev->queue_next == 0)
114                 return 1;
115
116         *ev = dev->queue[--dev->queue_next];
117
118         return 0;
119 }
120
121 static inline int
122 queue_peek(struct libevdev *dev, size_t idx, struct input_event *ev)
123 {
124         if (idx > dev->queue_next)
125                 return 1;
126         *ev = dev->queue[idx];
127         return 0;
128 }
129
130
131 /**
132  * Shift the first n elements into ev and return the number of elements
133  * shifted.
134  * ev must be large enough to store n elements.
135  *
136  * @param ev The buffer to copy into, or NULL
137  * @return The number of elements in ev.
138  */
139 static inline int
140 queue_shift_multiple(struct libevdev *dev, size_t n, struct input_event *ev)
141 {
142         size_t i;
143
144         if (dev->queue_next == 0)
145                 return 0;
146
147         n = min(n, dev->queue_next);
148
149         if (ev) {
150                 for (i = 0; i < n; i++)
151                         ev[i] = dev->queue[i];
152         }
153
154         for (i = 0; i < dev->queue_next - n; i++)
155                 dev->queue[i] = dev->queue[n + i];
156
157         dev->queue_next -= n;
158         return n;
159 }
160
161 /**
162  * Set ev to the first element in the queue, shifting everything else
163  * forward by one.
164  *
165  * @return 0 on success, 1 if the queue is empty.
166  */
167 static inline int
168 queue_shift(struct libevdev *dev, struct input_event *ev)
169 {
170         return queue_shift_multiple(dev, 1, ev) == 1 ? 0 : 1;
171 }
172
173 static inline int
174 queue_alloc(struct libevdev *dev, size_t size)
175 {
176         if (size == 0)
177                 return -ENOSPC;
178
179         dev->queue = calloc(size, sizeof(struct input_event));
180         if (!dev->queue)
181                 return -ENOSPC;
182
183         dev->queue_size = size;
184         dev->queue_next = 0;
185         return 0;
186 }
187
188 static inline void
189 queue_free(struct libevdev *dev)
190 {
191         free(dev->queue);
192         dev->queue_size = 0;
193         dev->queue_next = 0;
194 }
195
196 static inline size_t
197 queue_num_elements(struct libevdev *dev)
198 {
199         return dev->queue_next;
200 }
201
202 static inline size_t
203 queue_size(struct libevdev *dev)
204 {
205         return dev->queue_size;
206 }
207
208 static inline size_t
209 queue_num_free_elements(struct libevdev *dev)
210 {
211         return dev->queue_size - dev->queue_next - 1;
212 }
213
214 static inline struct input_event *
215 queue_next_element(struct libevdev *dev)
216 {
217         if (dev->queue_next == dev->queue_size)
218                 return NULL;
219
220         return &dev->queue[dev->queue_next];
221 }
222
223 static inline int
224 queue_set_num_elements(struct libevdev *dev, size_t nelem)
225 {
226         if (nelem > dev->queue_size)
227                 return 1;
228
229         dev->queue_next = nelem;
230
231         return 0;
232 }
233 #endif
234