struct syscall's flags is now an atomic_t (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 from the process to the kernel */
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 /* Flags from the program to the 2LS */
21 #define EVENT_JUSTHANDLEIT              0x00c   /* 2LS should handle the ev_q */
22 #define EVENT_THREAD                    0x010   /* spawn thread to handle ev_q */
23
24 /* Event Message Types */
25 #define EV_NONE                                  0
26 #define EV_PREEMPT_PENDING               1
27 #define EV_GANG_PREMPT_PENDING   2
28 #define EV_VCORE_REVOKE                  3
29 #define EV_GANG_RETURN                   4
30 #define EV_USER_IPI                              5
31 #define EV_PAGE_FAULT                    6
32 #define EV_ALARM                                 7
33 #define EV_EVENT                                 8
34 #define EV_FREE_APPLE_PIE                9
35 #define EV_SYSCALL                              10
36 #define NR_EVENT_TYPES                  11 /* keep me last */
37
38 /* Will probably have dynamic notifications later */
39 #define MAX_NR_DYN_EVENT                25
40 #define MAX_NR_EVENT                    (NR_EVENT_TYPES + MAX_NR_DYN_EVENT)
41
42 /* Want to keep this small and generic, but add items as you need them.  One
43  * item some will need is an expiration time, which ought to be put in the 64
44  * bit arg.  Will need tweaking / thought as we come up with events.  These are
45  * what get put on the per-core queue in procdata. */
46 struct event_msg {
47         uint16_t                                        ev_type;
48         uint16_t                                        ev_arg1;
49         uint32_t                                        ev_arg2;
50         void                                            *ev_arg3;
51         uint64_t                                        ev_arg4;
52 };
53
54 /* Random numbers */
55 #define NR_BCQ_EVENTS 10                /* nr events in a bcq */
56 #define NR_BCQ_EV_LOOPS 4               /* how many loops to try to enqueue */
57
58 DEFINE_BCQ_TYPES(event_msg, struct event_msg, NR_BCQ_EVENTS);
59
60 /* Structure for storing / receiving event messages.  An overflow causes the
61  * bit of the event to get set in the bitmap.  You can also have just the bit
62  * sent (and no message). */
63 struct event_mbox {
64         struct event_msg_bcq            ev_msgs;
65         uint8_t                                         ev_bitmap[(MAX_NR_EVENT - 1) / 8 + 1];
66         unsigned int                            ev_overflows;
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         uint32_t                                        ev_vcore;
75         void                                            (*ev_handler)(struct event_queue *);
76 };
77
78 /* Big version, contains storage space for the ev_mbox.  Never access the
79  * internal mbox directly. */
80 struct event_queue_big {
81         struct event_mbox                       *ev_mbox;
82         int                                                     ev_flags;
83         uint32_t                                        ev_vcore;
84         void                                            (*ev_handler)(struct event_queue *);
85         struct event_mbox                       ev_imbox;
86 };
87
88 /* Per-core data about preemptions and notifications */
89 struct preempt_data {
90         struct user_trapframe           preempt_tf;
91         struct ancillary_state          preempt_anc;
92         struct user_trapframe           notif_tf;
93         uintptr_t                                       transition_stack;       /* advertised by the user */
94         bool                                            notif_enabled;          /* vcore willing to recv */
95         bool                                            notif_pending;          /* notif k_msg on the way */
96         seq_ctr_t                                       preempt_tf_valid;
97         struct event_mbox                       ev_mbox;
98 };
99
100 /* Structs for different types of events that need parameters. */
101 // TODO: think about this a bit.  And don't want to make them til we need them.
102
103 /* Example: want the vcoreid of what was lost. */
104 struct ev_vcore_revoke {
105         uint16_t                                        type;
106         uint16_t                                        pad1;
107         uint32_t                                        vcoreid;
108         void                                            *pad3;
109         uint64_t                                        pad4;
110 };
111
112 #endif /* ROS_INC_EVENT_H */