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
|
/*
* Copyright (c) 2017-2018 Richard Braun.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*
* Minimalist publish-subscribe mechanism.
*/
#ifndef KERN_BULLETIN_H
#define KERN_BULLETIN_H
#include <stdint.h>
#include <kern/macros.h>
#include <kern/work.h>
/*
* Type for bulletin notification functions.
*
* The value is passed from the publisher unmodified, and can safely be
* cast into a pointer. Notification functions run in the context of the
* publisher.
*/
typedef void (*bulletin_notif_fn_t)(uintptr_t value, void *arg);
#include <kern/bulletin_i.h>
struct bulletin;
/*
* Bulletin subscriber.
*/
struct bulletin_sub;
void bulletin_init(struct bulletin *bulletin);
/*
* Subscribe to a bulletin.
*
* Once subscribed, the notification function is called with its argument
* each time the bulletin is published.
*/
void bulletin_subscribe(struct bulletin *bulletin, struct bulletin_sub *sub,
bulletin_notif_fn_t notif_fn, void *arg);
/*
* Unsubscribe from a bulletin.
*
* On return, the subscriber notification function may not be called any more.
*
* This function synchronizes with RCU.
*/
void bulletin_unsubscribe(struct bulletin *bulletin, struct bulletin_sub *sub);
/*
* Publish a bulletin.
*
* All subscribers are notified by calling their notification function, with
* the given value passed unmodified.
*/
void bulletin_publish(struct bulletin *bulletin, uintptr_t value);
#endif /* KERN_BULLETIN_H */
|
