Split ev_mbox into a union of mbox types (XCC)
[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 <ros/common.h>
14
15 __BEGIN_DECLS
16
17 /********* Event_q Setup / Registration  ***********/
18 struct event_queue *get_big_event_q_raw(void);
19 struct event_queue *get_big_event_q(void);
20 void event_mbox_init(struct event_mbox *ev_mbox, int mbox_type);
21 void put_big_event_q_raw(struct event_queue *ev_q);
22 void put_big_event_q(struct event_queue *ev_q);
23 void event_mbox_cleanup(struct event_mbox *ev_mbox);
24 struct event_queue *get_event_q(void);
25 struct event_queue *get_event_q_vcpd(uint32_t vcoreid, int ev_flags);
26 void put_event_q(struct event_queue *ev_q);
27 void register_kevent_q(struct event_queue *ev_q, unsigned int ev_type);
28 struct event_queue *clear_kevent_q(unsigned int ev_type);
29 void enable_kevent(unsigned int ev_type, uint32_t vcoreid, int ev_flags);
30 struct event_queue *disable_kevent(unsigned int ev_type);
31
32 /********* Event Handling / Reception ***********/
33 unsigned int get_event_type(struct event_mbox *ev_mbox);
34
35 typedef void (*handle_event_t)(struct event_msg *ev_msg, unsigned int ev_type,
36                                void *data);
37 struct ev_handler {
38         struct ev_handler                       *next;
39         handle_event_t                          func;
40         void                                            *data;
41 };
42 int register_ev_handler(unsigned int ev_type, handle_event_t handler,
43                         void *data);
44 int deregister_ev_handler(unsigned int ev_type, handle_event_t handler,
45                           void *data);
46
47 /* Default event handlers */
48 void handle_ev_ev(struct event_msg *ev_msg, unsigned int ev_type, void *data);
49
50 int handle_events(uint32_t vcoreid);
51 void handle_event_q(struct event_queue *ev_q);
52 bool extract_one_mbox_msg(struct event_mbox *ev_mbox, struct event_msg *ev_msg);
53 int handle_one_mbox_msg(struct event_mbox *ev_mbox);
54 int handle_mbox(struct event_mbox *ev_mbox);
55 bool mbox_is_empty(struct event_mbox *ev_mbox);
56 void send_self_vc_msg(struct event_msg *ev_msg);
57 void handle_vcpd_mbox(uint32_t rem_vcoreid);
58 void try_handle_remote_mbox(void);
59
60 /* Event handler helpers */
61 bool ev_might_not_return(void);
62 void ev_we_returned(bool were_handling_remotes);
63
64 /* Debugging */
65 void print_ev_msg(struct event_msg *msg);
66
67 /* Uthreads blocking on event queues.  M uthreads can block on subsets of N
68  * event queues.  The structs and details are buried in event.c.  We can move
69  * some of them here if users need greater control over their evqs. */
70 void evq_attach_wakeup_ctlr(struct event_queue *ev_q);
71 void evq_remove_wakeup_ctlr(struct event_queue *ev_q);
72 /* Handler, attaches to the ev_q.  Most people won't need this directly. */
73 void evq_wakeup_handler(struct event_queue *ev_q);
74 void uth_blockon_evqs_arr(struct event_msg *ev_msg,
75                           struct event_queue **which_evq,
76                           struct event_queue *evqs[], size_t nr_evqs);
77 void uth_blockon_evqs(struct event_msg *ev_msg, struct event_queue **which_evq,
78                       size_t nr_evqs, ...);
79 bool uth_check_evqs(struct event_msg *ev_msg, struct event_queue **which_evq,
80                     size_t nr_evqs, ...);
81
82 __END_DECLS
83
84 #endif /* PARLIB_EVENT_H */