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