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