summaryrefslogtreecommitdiff
path: root/src/sw.c
blob: fc253a4dff363a7f7066eabd5b67b04cc30bf9f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
/*
 * Copyright (c) 2017 Richard Braun.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 *
 * Stopwatch demo application.
 */

#include <assert.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>

#include <lib/macros.h>
#include <lib/shell.h>

#include "condvar.h"
#include "mutex.h"
#include "panic.h"
#include "sw.h"
#include "thread.h"
#include "timer.h"

/*
 * Display interval, in seconds.
 */
#define SW_DISPLAY_INTERVAL 5

/*
 * Maximum wait time for the sw_wait command.
 */
#define SW_MAX_WAIT 30

/*
 * Stopwatch type.
 *
 * The mutex must be locked before accessing any member.
 */
struct sw {
    struct mutex mutex;
    struct condvar cv;
    struct timer timer;
    unsigned long ticks;
    bool timer_scheduled;
    bool thread_waiting;
    unsigned long wait_ticks;
};

/*
 * Singleton instance.
 */
static struct sw *sw_instance;

static struct sw *
sw_get_instance(void)
{
    assert(sw_instance);
    return sw_instance;
}

static void
sw_timer_run(void *arg)
{
    struct sw *sw;

    sw = arg;

    mutex_lock(&sw->mutex);

    if (!sw->timer_scheduled) {
        goto out;
    }

    sw->ticks++;

    if ((sw->ticks % (THREAD_SCHED_FREQ * SW_DISPLAY_INTERVAL)) == 0) {
        printf("%lu\n", sw->ticks);
    }

    if (sw->thread_waiting && timer_ticks_occurred(sw->wait_ticks, sw->ticks)) {
        sw->thread_waiting = false;
        condvar_signal(&sw->cv);
    }

    timer_schedule(&sw->timer, timer_get_time(&sw->timer) + 1);

out:
    mutex_unlock(&sw->mutex);
}

static struct sw *
sw_create(void)
{
    struct sw *sw;

    sw = malloc(sizeof(*sw));

    if (!sw) {
        return NULL;
    }

    mutex_init(&sw->mutex);
    condvar_init(&sw->cv);
    timer_init(&sw->timer, sw_timer_run, sw);
    sw->timer_scheduled = false;
    sw->thread_waiting = false;
    return sw;
}

static void
sw_schedule(struct sw *sw)
{
    if (sw->timer_scheduled) {
        return;
    }

    sw->timer_scheduled = true;
    timer_schedule(&sw->timer, timer_now() + 1);
}

static void
sw_start(struct sw *sw)
{
    mutex_lock(&sw->mutex);
    sw->ticks = 0;
    sw_schedule(sw);
    mutex_unlock(&sw->mutex);
}

static void
sw_stop(struct sw *sw)
{
    mutex_lock(&sw->mutex);
    sw->timer_scheduled = false;
    mutex_unlock(&sw->mutex);
}

static void
sw_resume(struct sw *sw)
{
    mutex_lock(&sw->mutex);
    sw_schedule(sw);
    mutex_unlock(&sw->mutex);
}

static unsigned long
sw_read(struct sw *sw)
{
    unsigned long ticks;

    mutex_lock(&sw->mutex);
    ticks = sw->ticks;
    mutex_unlock(&sw->mutex);

    return ticks;
}

static void
sw_wait(struct sw *sw, unsigned long seconds)
{
    mutex_lock(&sw->mutex);

    if (!sw->timer_scheduled) {
        printf("sw_wait: error: stopwatch disabled\n");
        goto out;
    } else if (sw->thread_waiting) {
        printf("sw_wait: error: thread already waiting\n");
        goto out;
    }

    sw->thread_waiting = true;
    sw->wait_ticks = sw->ticks + (seconds * THREAD_SCHED_FREQ);

    do {
        condvar_wait(&sw->cv, &sw->mutex);
    } while (sw->thread_waiting);

out:
    mutex_unlock(&sw->mutex);
}

static void
sw_shell_start(int argc, char **argv)
{
    (void)argc;
    (void)argv;

    sw_start(sw_get_instance());
}

static void
sw_shell_stop(int argc, char **argv)
{
    (void)argc;
    (void)argv;

    sw_stop(sw_get_instance());
}

static void
sw_shell_resume(int argc, char **argv)
{
    (void)argc;
    (void)argv;

    sw_resume(sw_get_instance());
}

static void
sw_shell_read(int argc, char **argv)
{
    (void)argc;
    (void)argv;

    printf("%lu\n", sw_read(sw_get_instance()));
}

static void
sw_shell_wait(int argc, char **argv)
{
    unsigned long seconds;
    int ret;

    if (argc != 2) {
        goto error;
    }

    ret = sscanf(argv[1], "%lu", &seconds);

    if ((ret != 1) || (seconds > SW_MAX_WAIT)) {
        goto error;
    }

    sw_wait(sw_get_instance(), seconds);
    return;

error:
    printf("sw_wait: error: invalid arguments\n");
}

static struct shell_cmd shell_cmds[] = {
    SHELL_CMD_INITIALIZER("sw_start", sw_shell_start,
        "sw_start",
        "start the stopwatch"),
    SHELL_CMD_INITIALIZER("sw_stop", sw_shell_stop,
        "sw_stop",
        "stop the stopwatch"),
    SHELL_CMD_INITIALIZER("sw_resume", sw_shell_resume,
        "sw_resume",
        "resume the stopwatch"),
    SHELL_CMD_INITIALIZER("sw_read", sw_shell_read,
        "sw_read",
        "read the stopwatch time"),
    SHELL_CMD_INITIALIZER("sw_wait", sw_shell_wait,
        "sw_wait <seconds>",
        "wait for up to " QUOTE(SW_MAX_WAIT) " seconds"),
};

void
sw_setup(void)
{
    int error;

    sw_instance = sw_create();

    if (!sw_instance) {
        panic("sw: error: unable to create stopwatch");
    }

    for (size_t i = 0; i < ARRAY_SIZE(shell_cmds); i++) {
        error = shell_cmd_register(&shell_cmds[i]);

        if (error) {
            panic("unable to register shell command");
        }
    }
}