Revamped event interfaces (XCC)
[akaros.git] / kern / include / ros / event.h
1 /* Copyright (c) 2010-2011 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Kernel interface for event/notification delivery and preemption. */
6
7 #ifndef ROS_INC_EVENT_H
8 #define ROS_INC_EVENT_H
9
10 #include <ros/common.h>
11 #include <ros/atomic.h>
12 #include <ros/bcq_struct.h>
13 #include <ros/arch/trapframe.h>
14
15 /* Event Delivery Flags. */
16 #define EVENT_IPI                               0x001   /* IPI the core */
17 #define EVENT_NOMSG                             0x002   /* just send the bit, not the msg */
18 #define EVENT_ROUNDROBIN                0x004   /* pick a vcore, RR style */
19 #define EVENT_VCORE_APPRO               0x008   /* send to where the kernel wants */
20
21 /* Event Message Types */
22 #define EV_NONE                                  0
23 #define EV_PREEMPT_PENDING               1
24 #define EV_GANG_PREMPT_PENDING   2
25 #define EV_VCORE_REVOKE                  3
26 #define EV_GANG_RETURN                   4
27 #define EV_USER_IPI                              5
28 #define EV_PAGE_FAULT                    6
29 #define EV_ALARM                                 7
30 #define EV_EVENT                                 8
31 #define EV_FREE_APPLE_PIE                9
32 #define NR_EVENT_TYPES                  10 /* keep me last */
33
34 /* Will probably have dynamic notifications later */
35 #define MAX_NR_DYN_EVENT                25
36 #define MAX_NR_EVENT                    (NR_EVENT_TYPES + MAX_NR_DYN_EVENT)
37
38 /* Want to keep this small and generic, but add items as you need them.  One
39  * item some will need is an expiration time, which ought to be put in the 64
40  * bit arg.  Will need tweaking / thought as we come up with events.  These are
41  * what get put on the per-core queue in procdata. */
42 struct event_msg {
43         uint16_t                                        ev_type;
44         uint16_t                                        ev_arg1;
45         uint32_t                                        ev_arg2;
46         void                                            *ev_arg3;
47         uint64_t                                        ev_arg4;
48 };
49
50 /* Random numbers */
51 #define NR_BCQ_EVENTS 10                /* nr events in a bcq */
52 #define NR_BCQ_EV_LOOPS 4               /* how many loops to try to enqueue */
53
54 DEFINE_BCQ_TYPES(event_msg, struct event_msg, NR_BCQ_EVENTS);
55
56 /* Structure for storing / receiving event messages.  An overflow causes the
57  * bit of the event to get set in the bitmap.  You can also have just the bit
58  * sent (and no message). */
59 struct event_mbox {
60         struct event_msg_bcq            ev_msgs;
61         uint8_t                                         ev_bitmap[(MAX_NR_EVENT - 1) / 8 + 1];
62         unsigned int                            ev_overflows;
63 };
64
65 /* The kernel sends messages to this structure, which describes how and where
66  * to receive messages, including optional IPIs. */
67 struct event_queue {
68         struct event_mbox                       *ev_mbox;
69         int                                                     ev_flags;
70         uint32_t                                        ev_vcore;
71         void                                            (*ev_handler)(struct event_queue *);
72 };
73
74 /* Big version, contains storage space for the ev_mbox.  Never access the
75  * internal mbox directly. */
76 struct event_queue_big {
77         struct event_mbox                       *ev_mbox;
78         int                                                     ev_flags;
79         uint32_t                                        ev_vcore;
80         void                                            (*ev_handler)(struct event_queue *);
81         struct event_mbox                       ev_imbox;
82 };
83
84 /* Per-core data about preemptions and notifications */
85 struct preempt_data {
86         struct user_trapframe           preempt_tf;
87         struct ancillary_state          preempt_anc;
88         struct user_trapframe           notif_tf;
89         uintptr_t                                       transition_stack;       /* advertised by the user */
90         bool                                            notif_enabled;          /* vcore willing to recv */
91         bool                                            notif_pending;          /* notif k_msg on the way */
92         seq_ctr_t                                       preempt_tf_valid;
93         struct event_mbox                       ev_mbox;
94 };
95
96 /* Structs for different types of events that need parameters. */
97 // TODO: think about this a bit.  And don't want to make them til we need them.
98
99 /* Example: want the vcoreid of what was lost. */
100 struct ev_vcore_revoke {
101         uint16_t                                        type;
102         uint16_t                                        pad1;
103         uint32_t                                        vcoreid;
104         void                                            *pad3;
105         uint64_t                                        pad4;
106 };
107
108 #endif /* ROS_INC_EVENT_H */