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