f53050e81b915f516f48a087653cc740cf0b20db
[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/arch/trapframe.h>
13 /* #include <ros/ucq.h> included below */
14
15 /* Event Delivery Flags from the process to the kernel */
16 #define EVENT_IPI                               0x001   /* IPI the vcore (usually with INDIR) */
17 #define EVENT_INDIR                             0x002   /* send an indirection event to vcore */
18 #define EVENT_FALLBACK                  0x004   /* pick another vcore if it's offline */
19 #define EVENT_NOMSG                             0x008   /* just send the bit, not the msg */
20 #define EVENT_ROUNDROBIN                0x010   /* pick a vcore, RR style */
21 #define EVENT_VCORE_APPRO               0x020   /* send to where the kernel wants */
22 /* Flags from the program to the 2LS */
23 #define EVENT_JUSTHANDLEIT              0x100   /* 2LS should handle the ev_q */
24 #define EVENT_THREAD                    0x200   /* spawn thread to handle ev_q */
25
26 /* Event Message Types */
27 #define EV_NONE                                  0
28 #define EV_PREEMPT_PENDING               1
29 #define EV_GANG_PREMPT_PENDING   2
30 #define EV_VCORE_REVOKE                  3
31 #define EV_GANG_RETURN                   4
32 #define EV_USER_IPI                              5
33 #define EV_PAGE_FAULT                    6
34 #define EV_ALARM                                 7
35 #define EV_EVENT                                 8
36 #define EV_FREE_APPLE_PIE                9
37 #define EV_SYSCALL                              10
38 #define NR_EVENT_TYPES                  11 /* keep me last */
39
40 /* Will probably have dynamic notifications later */
41 #define MAX_NR_DYN_EVENT                25
42 #define MAX_NR_EVENT                    (NR_EVENT_TYPES + MAX_NR_DYN_EVENT)
43
44 /* Want to keep this small and generic, but add items as you need them.  One
45  * item some will need is an expiration time, which ought to be put in the 64
46  * bit arg.  Will need tweaking / thought as we come up with events.  These are
47  * what get put on the per-core queue in procdata. */
48 struct event_msg {
49         uint16_t                                        ev_type;
50         uint16_t                                        ev_arg1;
51         uint32_t                                        ev_arg2;
52         void                                            *ev_arg3;
53         uint64_t                                        ev_arg4;
54 };
55
56 /* Including here since ucq.h needs to know about struct event_msg */
57 #include <ros/ucq.h>
58
59 /* Structure for storing / receiving event messages.  An overflow causes the
60  * bit of the event to get set in the bitmap.  You can also have just the bit
61  * sent (and no message). */
62 struct event_mbox {
63         struct ucq                                      ev_msgs;
64         uint8_t                                         ev_bitmap[(MAX_NR_EVENT - 1) / 8 + 1];
65 };
66
67 /* The kernel sends messages to this structure, which describes how and where
68  * to receive messages, including optional IPIs. */
69 struct event_queue {
70         struct event_mbox                       *ev_mbox;
71         int                                                     ev_flags;
72         uint32_t                                        ev_vcore;
73         void                                            (*ev_handler)(struct event_queue *);
74 };
75
76 /* Big version, contains storage space for the ev_mbox.  Never access the
77  * internal mbox directly. */
78 struct event_queue_big {
79         struct event_mbox                       *ev_mbox;
80         int                                                     ev_flags;
81         uint32_t                                        ev_vcore;
82         void                                            (*ev_handler)(struct event_queue *);
83         struct event_mbox                       ev_imbox;
84 };
85
86 /* Per-core data about preemptions and notifications */
87 struct preempt_data {
88         struct user_trapframe           preempt_tf;
89         struct ancillary_state          preempt_anc;
90         struct user_trapframe           notif_tf;
91         uintptr_t                                       transition_stack;       /* advertised by the user */
92         bool                                            notif_enabled;          /* vcore willing to recv */
93         bool                                            notif_pending;          /* notif k_msg on the way */
94         seq_ctr_t                                       preempt_tf_valid;
95         struct event_mbox                       ev_mbox;
96 };
97
98 #endif /* ROS_INC_EVENT_H */