Split ev_mbox into a union of mbox types (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/trapframe.h>
13 /* #include <ros/ucq.h> included below */
14 /* #include <ros/evbitmap.h> included below */
15
16 /* Event Delivery Flags from the process to the kernel */
17 #define EVENT_IPI                               0x00001 /* IPI the vcore (usually with INDIR) */
18 #define EVENT_NOMSG                             0x00002 /* just send the bit, not the msg */
19 #define EVENT_SPAM_PUBLIC               0x00004 /* spam the msg to public vcpd mboxes */
20 #define EVENT_INDIR                             0x00008 /* send an indirection event to vcore */
21 #define EVENT_VCORE_PRIVATE             0x00010 /* Will go to the private VCPD mbox */
22 #define EVENT_SPAM_INDIR                0x00020 /* spam INDIRs if the vcore's offline */
23 #define EVENT_VCORE_MUST_RUN    0x00040 /* spams go to a vcore that will run */
24 #define EVENT_NOTHROTTLE                0x00080 /* send all INDIRs (no throttling) */
25 #define EVENT_ROUNDROBIN                0x00100 /* pick a vcore, RR style */
26 #define EVENT_VCORE_APPRO               0x00200 /* send to where the kernel wants */
27 #define EVENT_WAKEUP                    0x00400 /* wake up the process after sending */
28
29 /* Event Message Types */
30 #define EV_NONE                                  0
31 #define EV_PREEMPT_PENDING               1
32 #define EV_GANG_PREMPT_PENDING   2
33 #define EV_VCORE_PREEMPT                 3
34 #define EV_GANG_RETURN                   4
35 #define EV_USER_IPI                              5
36 #define EV_PAGE_FAULT                    6
37 #define EV_ALARM                                 7
38 #define EV_EVENT                                 8
39 #define EV_FREE_APPLE_PIE                9
40 #define EV_SYSCALL                              10
41 #define EV_CHECK_MSGS                   11
42 #define EV_POSIX_SIGNAL                 12
43 #define NR_EVENT_TYPES                  25 /* keep me last (and 1 > the last one) */
44
45 /* Will probably have dynamic notifications later */
46 #define MAX_NR_DYN_EVENT                25
47 #define MAX_NR_EVENT                    (NR_EVENT_TYPES + MAX_NR_DYN_EVENT)
48
49 /* Want to keep this small and generic, but add items as you need them.  One
50  * item some will need is an expiration time, which ought to be put in the 64
51  * bit arg.  Will need tweaking / thought as we come up with events.  These are
52  * what get put on the per-core queue in procdata. */
53 struct event_msg {
54         uint16_t                                        ev_type;
55         uint16_t                                        ev_arg1;
56         uint32_t                                        ev_arg2;
57         void                                            *ev_arg3;
58         uint64_t                                        ev_arg4;
59 };
60
61 /* Include here since the mboxes need to know event.h basics (e.g. event_msg) */
62 #include <ros/ucq.h>
63 #include <ros/evbitmap.h>
64
65 #define EV_MBOX_UCQ                             1
66 #define EV_MBOX_BITMAP                  2
67
68 /* Structure for storing / receiving event messages.  An overflow causes the
69  * bit of the event to get set in the bitmap.  You can also have just the bit
70  * sent (and no message). */
71 struct event_mbox {
72         int                                             type;
73         union {
74                 struct ucq                              ucq;
75                 struct evbitmap                 evbm;
76         };
77 };
78
79 /* The kernel sends messages to this structure, which describes how and where
80  * to receive messages, including optional IPIs. */
81 struct event_queue {
82         struct event_mbox                       *ev_mbox;
83         int                                                     ev_flags;
84         bool                                            ev_alert_pending;
85         uint32_t                                        ev_vcore;
86         void                                            (*ev_handler)(struct event_queue *);
87         void                                            *ev_udata;
88 };
89
90 /* Big version, contains storage space for the ev_mbox.  Never access the
91  * internal mbox directly. */
92 struct event_queue_big {
93         struct event_mbox                       *ev_mbox;
94         int                                                     ev_flags;
95         bool                                            ev_alert_pending;
96         uint32_t                                        ev_vcore;
97         void                                            (*ev_handler)(struct event_queue *);
98         void                                            *ev_udata;
99         struct event_mbox                       ev_imbox;
100 };
101
102 /* Vcore state flags.  K_LOCK means the kernel is writing */
103 #define VC_K_LOCK                               0x001                           /* CASing with the kernel */
104 #define VC_PREEMPTED                    0x002                           /* VC is preempted */
105 #define VC_CAN_RCV_MSG                  0x004                           /* someone will get msg */
106 #define VC_UTHREAD_STEALING             0x008                           /* Uthread being stolen */
107 #define VC_SCP_NOVCCTX                  0x010                           /* can't go into vc ctx */
108
109 /* Racy flags, where we don't need the atomics */
110 #define VC_FPU_SAVED                    0x1000                          /* valid FPU state in anc */
111
112 /* Per-core data about preemptions and notifications */
113 struct preempt_data {
114         struct user_context                     vcore_ctx;                      /* for preemptions */
115         struct ancillary_state          preempt_anc;
116         struct user_context                     uthread_ctx;            /* for preempts or notifs */
117         uintptr_t                                       vcore_entry;            /* advertised by the user */
118         uintptr_t                                       vcore_stack;            /* advertised by the user */
119         uintptr_t                                       vcore_tls_desc;         /* advertised by the user */
120         atomic_t                                        flags;
121         int                                                     rflags;                         /* racy flags */
122         bool                                            notif_disabled;         /* vcore unwilling to recv*/
123         bool                                            notif_pending;          /* notif k_msg on the way */
124         struct event_mbox                       ev_mbox_public;         /* can be read remotely */
125         struct event_mbox                       ev_mbox_private;        /* for this vcore only */
126 };
127
128 #endif /* ROS_INC_EVENT_H */