Allow userland to bind a process to specific CPUs. The initial
[dragonfly.git] / sys / sys / usched.h
1 /*
2  * SYS/USCHED.H
3  *
4  *      Userland scheduler API
5  * 
6  * $DragonFly: src/sys/sys/usched.h,v 1.11 2006/06/05 00:32:37 davidxu Exp $
7  */
8
9 #ifndef _SYS_USCHED_H_
10 #define _SYS_USCHED_H_
11
12 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
13
14 #ifndef _SYS_TYPES_H_
15 #include <sys/types.h>
16 #endif
17 #ifndef _SYS_QUEUE_H_
18 #include <sys/queue.h>
19 #endif
20 #ifndef _SYS_SYSTIMER_H_
21 #include <sys/systimer.h>
22 #endif
23
24 #define NAME_LENGTH 32
25
26 struct lwp;
27 struct proc;
28 struct globaldata;
29
30 struct usched {
31     TAILQ_ENTRY(usched) entry;
32     const char *name;
33     const char *desc;
34     void (*usched_register)(void);
35     void (*usched_unregister)(void);
36     void (*acquire_curproc)(struct lwp *);
37     void (*release_curproc)(struct lwp *);
38     void (*select_curproc)(struct globaldata *);
39     void (*setrunqueue)(struct lwp *);
40     void (*schedulerclock)(struct lwp *, sysclock_t, sysclock_t);
41     void (*recalculate)(struct lwp *);
42     void (*resetpriority)(struct lwp *);
43     void (*heuristic_forking)(struct lwp *, struct lwp *);
44     void (*heuristic_exiting)(struct lwp *, struct lwp *);
45     void (*setcpumask)(struct usched *, cpumask_t);
46 };
47
48 union usched_data {
49     /*
50      * BSD4 scheduler. 
51      */
52     struct {
53         short   priority;       /* lower is better */
54         char    unused01;       /* (currently not used) */
55         char    rqindex;
56         int     origcpu;
57         int     estcpu;         /* dynamic priority modification */
58         u_short rqtype;         /* protected copy of rtprio type */
59         u_short unused02;
60     } bsd4;
61
62     int         pad[4];         /* PAD for future expansion */
63 };
64
65 /*
66  * Flags for usched_ctl()
67  */
68 #define        USCH_ADD        0x00000001
69 #define        USCH_REM        0x00000010
70
71 #endif  /* _KERNEL || _KERNEL_STRUCTURES */
72
73 #define USCHED_SET_SCHEDULER    0
74 #define USCHED_SET_CPU          1
75 #define USCHED_ADD_CPU          2
76 #define USCHED_DEL_CPU          3
77
78 /*
79  * Kernel variables and procedures, or user system calls.
80  */
81 #ifdef _KERNEL
82
83 extern struct usched    usched_bsd4;
84 extern struct usched    usched_dummy;
85
86 int usched_ctl(struct usched *, int);
87 struct usched *usched_init(void);
88
89 #else
90
91 int usched_set(pid_t, int, void *, int);
92
93 #endif
94
95 #endif
96