Add parlib/common.h
[akaros.git] / user / parlib / include / event.h
1 /* Copyright (c) 2011-2014 The Regents of the University of California
2  * Copyright (c) 2015 Google Inc
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * See LICENSE for details.
5  *
6  * Userspace utility functions for receiving events and notifications (IPIs).
7  * Some are higher level than others; just use what you need. */ 
8
9 #ifndef PARLIB_EVENT_H
10 #define PARLIB_EVENT_H
11
12 #include <ros/event.h>
13 #include <parlib/common.h>
14
15 __BEGIN_DECLS
16
17 /********* Event_q Setup / Registration  ***********/
18 struct event_queue *get_eventq(int mbox_type);
19 struct event_queue *get_eventq_raw(void);
20 struct event_queue *get_eventq_slim(void);
21 struct event_queue *get_eventq_vcpd(uint32_t vcoreid, int ev_flags);
22 void put_eventq(struct event_queue *ev_q);
23 void put_eventq_raw(struct event_queue *ev_q);
24 void put_eventq_slim(struct event_queue *ev_q);
25 void put_eventq_vcpd(struct event_queue *ev_q);
26
27 void event_mbox_init(struct event_mbox *ev_mbox, int mbox_type);
28 void event_mbox_cleanup(struct event_mbox *ev_mbox);
29
30 void register_kevent_q(struct event_queue *ev_q, unsigned int ev_type);
31 struct event_queue *clear_kevent_q(unsigned int ev_type);
32 void enable_kevent(unsigned int ev_type, uint32_t vcoreid, int ev_flags);
33 struct event_queue *disable_kevent(unsigned int ev_type);
34
35 /********* Event Handling / Reception ***********/
36 unsigned int get_event_type(struct event_mbox *ev_mbox);
37
38 typedef void (*handle_event_t)(struct event_msg *ev_msg, unsigned int ev_type,
39                                void *data);
40 struct ev_handler {
41         struct ev_handler                       *next;
42         handle_event_t                          func;
43         void                                            *data;
44 };
45 int register_ev_handler(unsigned int ev_type, handle_event_t handler,
46                         void *data);
47 int deregister_ev_handler(unsigned int ev_type, handle_event_t handler,
48                           void *data);
49
50 /* Default event handlers */
51 void handle_ev_ev(struct event_msg *ev_msg, unsigned int ev_type, void *data);
52
53 int handle_events(uint32_t vcoreid);
54 void handle_event_q(struct event_queue *ev_q);
55 bool extract_one_mbox_msg(struct event_mbox *ev_mbox, struct event_msg *ev_msg);
56 int handle_one_mbox_msg(struct event_mbox *ev_mbox);
57 int handle_mbox(struct event_mbox *ev_mbox);
58 bool mbox_is_empty(struct event_mbox *ev_mbox);
59 void send_self_vc_msg(struct event_msg *ev_msg);
60 void handle_vcpd_mbox(uint32_t rem_vcoreid);
61 void try_handle_remote_mbox(void);
62
63 /* Event handler helpers */
64 bool ev_might_not_return(void);
65 void ev_we_returned(bool were_handling_remotes);
66
67 /* Debugging */
68 void print_ev_msg(struct event_msg *msg);
69
70 /* Uthreads blocking on event queues.  M uthreads can block on subsets of N
71  * event queues.  The structs and details are buried in event.c.  We can move
72  * some of them here if users need greater control over their evqs. */
73 void evq_attach_wakeup_ctlr(struct event_queue *ev_q);
74 void evq_remove_wakeup_ctlr(struct event_queue *ev_q);
75 /* Handler, attaches to the ev_q.  Most people won't need this directly. */
76 void evq_wakeup_handler(struct event_queue *ev_q);
77 void uth_blockon_evqs_arr(struct event_msg *ev_msg,
78                           struct event_queue **which_evq,
79                           struct event_queue *evqs[], size_t nr_evqs);
80 void uth_blockon_evqs(struct event_msg *ev_msg, struct event_queue **which_evq,
81                       size_t nr_evqs, ...);
82 bool uth_check_evqs(struct event_msg *ev_msg, struct event_queue **which_evq,
83                     size_t nr_evqs, ...);
84
85 __END_DECLS
86
87 #endif /* PARLIB_EVENT_H */