Subversion Repositories shark

Rev

Rev 38 | Rev 328 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 pj 1
/*
2
 * Project: S.Ha.R.K.
3
 *
4
 * Coordinators:
5
 *   Giorgio Buttazzo    <giorgio@sssup.it>
6
 *   Paolo Gai           <pj@gandalf.sssup.it>
7
 *
8
 * Authors     :
9
 *   Paolo Gai           <pj@gandalf.sssup.it>
10
 *   Massimiliano Giorgi <massy@gandalf.sssup.it>
11
 *   Luca Abeni          <luca@gandalf.sssup.it>
12
 *   (see the web pages for full authors list)
13
 *
14
 * ReTiS Lab (Scuola Superiore S.Anna - Pisa - Italy)
15
 *
16
 * http://www.sssup.it
17
 * http://retis.sssup.it
18
 * http://shark.sssup.it
19
 */
20
 
21
 
22
/**
23
 ------------
79 pj 24
 CVS :        $Id: model.h,v 1.3 2003-03-13 13:36:28 pj Exp $
2 pj 25
 
26
 File:        $File$
79 pj 27
 Revision:    $Revision: 1.3 $
28
 Last update: $Date: 2003-03-13 13:36:28 $
2 pj 29
 ------------
30
 
31
 This file contains the definitions of the task and resource models.
32
 
33
**/
34
 
35
/*
36
 * Copyright (C) 2000 Paolo Gai
37
 *
38
 * This program is free software; you can redistribute it and/or modify
39
 * it under the terms of the GNU General Public License as published by
40
 * the Free Software Foundation; either version 2 of the License, or
41
 * (at your option) any later version.
42
 *
43
 * This program is distributed in the hope that it will be useful,
44
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
45
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
46
 * GNU General Public License for more details.
47
 *
48
 * You should have received a copy of the GNU General Public License
49
 * along with this program; if not, write to the Free Software
50
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
51
 *
52
 */
53
 
54
#ifndef __KERNEL_MODEL_H__
55
#define __KERNEL_MODEL_H__
56
 
57
#include "ll/ll.h"
38 pj 58
#include "kernel/types.h"
79 pj 59
#include "ll/sys/cdefs.h"
2 pj 60
 
79 pj 61
__BEGIN_DECLS
62
 
2 pj 63
/* -----------------------------------------------------------------------
64
   -----------------------------------------------------------------------
65
   -----------------------------------------------------------------------
66
   -----------------------------------------------------------------------
67
   TASK MODELS
68
   -----------------------------------------------------------------------
69
   -----------------------------------------------------------------------
70
   -----------------------------------------------------------------------
71
   ----------------------------------------------------------------------- */
72
 
73
 
74
/* -----------------------------------------------------------------------
75
   TASK_MODELS: the base struct
76
   ----------------------------------------------------------------------- */
77
 
78
/*+
79
 TASK_MODEL
80
 
81
 IMPORTANT: this structure shall not be used by the end-user!!!
82
 
83
 This structure is only used to group together a set of optional
84
 parameters describing the task model. This structure is passed
85
 to the task_create primitive.
86
 
87
 The control field is used to set special task processing
88
 functions.
89
 
90
 Currently it supports:
91
 
92
 - USE_FPU     bit
93
   If the hw architecture is not smart enough to allow automatic
94
   FPU context switch, this information is used at the VM level
95
   to perform transparently the preemption of a FPU-task
96
 
97
 - NO_KILL     bit
98
   If this bit is set, the task can't be killed via the task_kill
99
   function. To make a task unkillable for short periods of time,
100
   use the cancellability functions instead.
101
 
102
 - NO_PREEMPT  bit
103
   If this bit is set, the task can't be preempted. To set/reset it,
104
   use the primitive task_preempt/task_no_preempt
105
 
106
 - SYSTEM_TASK bit
107
   If this bit is set, the task is a system task. The whole system exit
108
   only when all the non-system tasks are terminated.
109
 
110
 - JET_ENABLED bit
111
   If this bit is set the Generic Kernel records the Job Execution Times
112
   for the task. See the jet_XXX functions...
113
 
114
 - TASK_JOINABLE bit
115
   If this bit is set the task is joinable with task_join, otherwise the
116
   task is detached...
117
 
118
 - STACKADDR_SPECIFIED bit
119
   This bit is set when the task was created if we specify in the model
120
   the stack address. When the task ends, if this bi is set, the stack
121
   is not freed.
122
 
123
 
124
 - KILL_*      bits
125
   These bits are used to memorize the cancelability state of the task.
126
 
127
 - CONTROL_CAP bit
128
   This flag has to be set in the scheduling modules (NOT by the end-user)
129
   only if the kernel has to check the capacity for the task. The kernel
130
   uses only the avail_time field of the process descriptor.
131
 
132
 - TASK_DOING_SIGNALS bit
133
   It is an internal flag used with signal handling. It is set only when
134
   the task is executing a signal handler
135
 
136
 - FREEZE_ACTIVATION
137
   If this bit is set, the task_activate primitive doesn't activate any task;
138
   instead, it increment a counter. See task_[un]block_activations in kern.c
139
 
140
 - WAIT_FOR_JOIN
141
   The flag is set when the task terminates; the descriptor is not
142
   freed because we wait a task_join
143
 
144
 - DESCRIPTOR_DISCARDED
145
   This bit is set when the task descriptor is discarded by task_createn
146
   (the wait_for_join flag is set and the task was inserted in the free
147
   queue by a scheduling level). The task will be reinserted into the
148
   free queue by task_join...
149
 
150
 All the models redefines the TASK_MODEL structure
151
 - adding new fields if needed
152
 - using a unique number in the pclass variable
153
 
154
 When the user wants to create a task, he must specify a task model.
155
 First, he have to define a XXX_TASK_MODEL, then he must initialize it with
156
 a XXX_task_default_model.
157
 
158
 Then, he can specify some attributes that characterize the model.
159
 
160
 Not all the fields of a task model are mandatory, but a scheduling level
161
 or an ahard server may require some of them.
162
 For example, if the user wants to create an ahard tasks, he may specify
163
 a wcet. The wcet is not required by a Deferrable Server, but it is mandatory
164
 for a TBS!!!.
165
 
166
+*/
167
 
168
 
169
typedef struct {
170
    WORD    pclass;
38 pj 171
    LEVEL   level;
2 pj 172
    size_t  stacksize;
173
    void    *stackaddr;
174
    WORD    group;
175
    void    *arg;
176
    DWORD   control;
177
} TASK_MODEL;
178
 
179
/*+ Value for the control field, It is set if +*/
180
#define USE_FPU              0x0001 /*+ the task use FPU registers +*/
181
#define NO_KILL              0x0002 /*+ the task isn't killable at all +*/
182
#define NO_PREEMPT           0x0004 /*+ the task isn't preemptable +*/
183
#define SYSTEM_TASK          0x0008 /*+ the task is a system task. +*/
184
#define JET_ENABLED          0x0010 /*+ execution time monitoring enabled +*/
185
#define TASK_JOINABLE        0x0020 /*+ the task is joinable (see task_join)+*/
186
#define STACKADDR_SPECIFIED  0x0040 /*+ the stackaddr was specified +*/
187
#define TRACE_TASK          0x20000 /*+ the task must be traced +*/
188
 
189
/*+ flags contained in the control field, usettables from the models: +*/
190
#define KILLED_ON_CONDITION  0x0080 /*+ the task is killed but it is waiting
191
                                        to die because it must reaquire
192
                                        the mutex +*/
193
#define KILL_ENABLED         0x0100 /*+ cancelability enabled +*/
194
#define KILL_DEFERRED        0x0200 /*+ cancelability type deferred/async. +*/
195
#define KILL_REQUEST         0x0400 /*+ kill issued but not executed +*/
196
#define CONTROL_CAP          0x0800 /*+ Capacity control enabled +*/
197
#define TASK_DOING_SIGNALS   0x1000 /*+ see kern_deliver_pending_signals
198
                                        in signal.c +*/
199
#define FREEZE_ACTIVATION    0x2000 /*+ see task_block_activation in kern.c +*/
200
 
201
/* flags used in the implementation of the task_join */
202
#define WAIT_FOR_JOIN        0x4000 /*+ the task is terminated, but the
203
                                        descriptor is not freed because we wait
204
                                        a task_join +*/
205
#define DESCRIPTOR_DISCARDED 0x8000 /*+ the task descriptor is discarded by
206
                                        task_createn because the wait_for_join
207
                                        flag is set and it was inserted in the
208
                                        free queue by a scheduling level +*/
209
 
210
/* flag used in the implementation of the sig_timedwait */
211
#define SIGTIMEOUT_EXPIRED   0x10000 /*+ if the sigwait timer expires this
212
                                        flag is set... +*/
213
 
214
 
215
/* Some macros to set various task-model parameters */
216
#define task_default_model(m,p) (m).pclass = (p), \
38 pj 217
                                (m).level = 0; \
2 pj 218
                                (m).stacksize = 4096, \
219
                                (m).stackaddr = NULL, \
220
                                (m).group = 0, \
221
                                (m).arg = NULL,\
222
                                (m).control = 0
38 pj 223
#define task_def_level(m,l)     (m).level = (l)
2 pj 224
#define task_def_arg(m,a)       (m).arg = (a)
225
#define task_def_stack(m,s)     (m).stacksize = (s)
226
#define task_def_stackaddr(m,s) (m).stackaddr = (s)
227
#define task_def_group(m,g)     (m).group = (g)
228
#define task_def_usemath(m)     (m).control |= USE_FPU
229
#define task_def_system(m)      (m).control |= SYSTEM_TASK
230
#define task_def_nokill(m)      (m).control |= NO_KILL
231
#define task_def_ctrl_jet(m)    (m).control |= JET_ENABLED
232
#define task_def_joinable(m)    (m).control |= TASK_JOINABLE
233
#define task_def_unjoinable(m)  (m).control &= ~TASK_JOINABLE
234
#define task_def_trace(m)       (m).control |= TRACE_TASK
235
#define task_def_notrace(m)     (m).control &= ~TRACE_TASK
236
 
237
 
238
 
239
 
240
/* -----------------------------------------------------------------------
241
   PCLASS values
242
   ----------------------------------------------------------------------- */
243
 
38 pj 244
/* These are the value for the pclass field */
2 pj 245
 
38 pj 246
#define DUMMY_PCLASS        0
247
#define HARD_PCLASS         1
248
#define SOFT_PCLASS         2
249
#define NRT_PCLASS          3
250
#define JOB_PCLASS          4
2 pj 251
 
252
 
253
/* -----------------------------------------------------------------------
254
   Useful stuffs
255
   ----------------------------------------------------------------------- */
256
 
257
#define PERIODIC       0
258
#define APERIODIC      1
259
 
260
#define SAVE_ARRIVALS  0
261
#define SKIP_ARRIVALS  1
262
 
263
 
264
 
265
/* -----------------------------------------------------------------------
266
   DUMMY_TASK_MODEL: model used only for the dummy task
267
   ----------------------------------------------------------------------- */
268
 
269
/*+ the dummy task doesn't add any new field +*/
270
typedef TASK_MODEL DUMMY_TASK_MODEL;
271
 
272
#define dummy_task_default_model(m) task_default_model(m,DUMMY_PCLASS)
273
#define dummy_task_def_level(m,l)   task_def_level(m,l)
274
#define dummy_task_def_system(m)    task_def_system(m)
275
#define dummy_task_def_nokill(m)    task_def_nokill(m)
276
#define dummy_task_def_ctrl_jet(m)  task_def_ctrl_jet(m)
277
 
278
 
279
 
280
 
281
 
282
 
283
/* -----------------------------------------------------------------------
284
   HARD_TASK_MODEL: hard Tasks
285
   ----------------------------------------------------------------------- */
286
 
287
/*  A Hard Task model can be used to model periodic and sporadic tasks.
288
    These tasks are usually guaranteed basing on their minimum interarrival
289
    time (mit) and wcet, and may have a relative deadline.
290
 
291
    A hard task can raise these exceptions:
292
    XDEADLINE_MISS XWCET_VIOLATION XACTIVATION
293
 
294
    The default model sets wcet, mit and relative deadline to 0, and
295
    the periodicity to PERIODIC.
296
*/
297
 
298
typedef struct {
299
  TASK_MODEL t;
300
  TIME mit;
301
  TIME drel;
302
  TIME wcet;
303
  int periodicity;
304
} HARD_TASK_MODEL;
305
 
306
#define hard_task_default_model(m)                             \
307
                        task_default_model((m).t,HARD_PCLASS), \
308
                        (m).mit         = 0,                   \
309
                        (m).drel        = 0,                   \
310
                        (m).wcet        = 0,                   \
311
                        (m).periodicity = PERIODIC
312
#define hard_task_def_level(m,l)    task_def_level((m).t,l)
313
#define hard_task_def_arg(m,a)      task_def_arg((m).t,a)
314
#define hard_task_def_stack(m,s)    task_def_stack((m).t,s)
315
#define hard_task_def_stackaddr(m,s) task_def_stackaddr((m).t,s)
316
#define hard_task_def_group(m,g)    task_def_group((m).t,g)
317
#define hard_task_def_usemath(m)    task_def_usemath((m).t)
318
#define hard_task_def_system(m)     task_def_system((m).t)
319
#define hard_task_def_nokill(m)     task_def_nokill((m).t)
320
#define hard_task_def_ctrl_jet(m)   task_def_ctrl_jet((m).t)
321
#define hard_task_def_mit(m,p)      (m).mit = (p)
322
#define hard_task_def_drel(m,d)     (m).drel = (d)
323
#define hard_task_def_wcet(m,w)     (m).wcet = (w)
324
#define hard_task_def_periodic(m)   (m).periodicity = PERIODIC
325
#define hard_task_def_aperiodic(m)  (m).periodicity = APERIODIC
326
#define hard_task_def_joinable(m)   task_def_joinable((m).t)
327
#define hard_task_def_unjoinable(m) task_def_unjoinable((m).t)
328
#define hard_task_def_trace(m)      task_def_trace((m).t)
329
#define hard_task_def_notrace(m)    task_def_notrace((m).t)
330
 
331
 
332
 
333
/* -----------------------------------------------------------------------
334
   SOFT_TASK_MODEL: Soft Tasks
335
   ----------------------------------------------------------------------- */
336
 
337
/*  A Soft Task model can be used to model periodic and aperiodic tasks
338
    usually not guaranteed or guaranteed basing on their period and mean
339
    execution time (met). A Soft task can also record pending activations if
340
    the arrivals are set to SAVE.
341
 
342
    A wcet field is also present for those servers that need if (i.e., TBS)
343
 
344
    The default model sets met, period and wcet to 0, the periodicity to
345
    PERIODIC and the arrivals to SAVE.
346
 
347
    A Soft Task don't raise any exception.
348
*/
349
 
350
typedef struct {
351
  TASK_MODEL t;
352
  TIME period;
353
  TIME met;
354
  TIME wcet;
355
  int periodicity;
356
  int arrivals;
357
} SOFT_TASK_MODEL;
358
 
359
#define soft_task_default_model(m)                             \
360
                        task_default_model((m).t,SOFT_PCLASS), \
361
                        (m).period      = 0,                   \
362
                        (m).met         = 0,                   \
363
                        (m).wcet        = 0,                   \
364
                        (m).periodicity = PERIODIC,            \
365
                        (m).arrivals    = SAVE_ARRIVALS
366
#define soft_task_def_level(m,l)       task_def_level((m).t,l)
367
#define soft_task_def_arg(m,a)         task_def_arg((m).t,a)
368
#define soft_task_def_stack(m,s)       task_def_stack((m).t,s)
369
#define soft_task_def_stackaddr(m,s)   task_def_stackaddr((m).t,s)
370
#define soft_task_def_group(m,g)       task_def_group((m).t,g)
371
#define soft_task_def_usemath(m)       task_def_usemath((m).t)
372
#define soft_task_def_system(m)        task_def_system((m).t)
373
#define soft_task_def_nokill(m)        task_def_nokill((m).t)
374
#define soft_task_def_ctrl_jet(m)      task_def_ctrl_jet((m).t)
375
#define soft_task_def_period(m,p)      (m).period = (p)
376
#define soft_task_def_met(m,d)         (m).met = (d)
377
#define soft_task_def_wcet(m,w)        (m).wcet = (w)
378
#define soft_task_def_periodic(m)      (m).periodicity = PERIODIC
379
#define soft_task_def_aperiodic(m)     (m).periodicity = APERIODIC
380
#define soft_task_def_save_arrivals(m) (m).arrivals    = SAVE_ARRIVALS
381
#define soft_task_def_skip_arrivals(m) (m).arrivals    = SKIP_ARRIVALS
382
#define soft_task_def_joinable(m)      task_def_joinable((m).t)
383
#define soft_task_def_unjoinable(m)    task_def_unjoinable((m).t)
384
#define soft_task_def_trace(m)         task_def_trace((m).t)
385
#define soft_task_def_notrace(m)       task_def_notrace((m).t)
386
 
387
/* -----------------------------------------------------------------------
388
   NRT_TASK_MODEL: Non Realtime Tasks
389
   ----------------------------------------------------------------------- */
390
 
391
/* A NRT task has a weight and a time slice, plus  a policy attribute.
392
   It can be used to model Round Robin, Proportional Share, POSIX,
393
   and Priority tasks.
394
 
395
   Policy and inherit is inserted in the model to support posix
396
   compliant scheduling...
397
 
398
   The default model set weight and slice to 0, policy to RR, and inherit
399
   to explicit.
400
*/
401
 
402
#define NRT_RR_POLICY   0
403
#define NRT_FIFO_POLICY 1
404
 
405
#define NRT_INHERIT_SCHED  0
406
#define NRT_EXPLICIT_SCHED 1
407
 
408
typedef struct {
409
  TASK_MODEL t;
410
  int weight;
411
  TIME slice;
412
  int arrivals;
413
  int policy;
414
  int inherit;
415
} NRT_TASK_MODEL;
416
 
417
#define nrt_task_default_model(m) task_default_model((m).t,NRT_PCLASS), \
418
                                      (m).weight   = 0,                 \
419
                                      (m).slice    = 0,                 \
420
                                      (m).arrivals = SAVE_ARRIVALS,     \
421
                                      (m).policy   = NRT_RR_POLICY,     \
422
                                      (m).inherit  = NRT_EXPLICIT_SCHED
423
#define nrt_task_def_level(m,l)       task_def_level((m).t,l)
424
#define nrt_task_def_arg(m,a)         task_def_arg((m).t,a)
425
#define nrt_task_def_stack(m,s)       task_def_stack((m).t,s)
426
#define nrt_task_def_stackaddr(m,s)   task_def_stackaddr((m).t,s)
427
#define nrt_task_def_group(m,g)       task_def_group((m).t,g)
428
#define nrt_task_def_usemath(m)       task_def_usemath((m).t)
429
#define nrt_task_def_system(m)        task_def_system((m).t)
430
#define nrt_task_def_nokill(m)        task_def_nokill((m).t)
431
#define nrt_task_def_ctrl_jet(m)      task_def_ctrl_jet((m).t)
432
#define nrt_task_def_joinable(m)      task_def_joinable((m).t)
433
#define nrt_task_def_unjoinable(m)    task_def_unjoinable((m).t)
434
#define nrt_task_def_weight(m,w)      (m).weight = (w)
435
#define nrt_task_def_slice(m,s)       (m).slice = (s)
436
#define nrt_task_def_save_arrivals(m) (m).arrivals    = SAVE_ARRIVALS
437
#define nrt_task_def_skip_arrivals(m) (m).arrivals    = SKIP_ARRIVALS
438
#define nrt_task_def_policy(m,p)      (m).policy = (p)
439
#define nrt_task_def_inherit(m,i)     (m).inherit = (i)
440
#define nrt_task_def_trace(m)         task_def_trace((m).t)
441
#define nrt_task_def_notrace(m)       task_def_notrace((m).t)
442
 
443
 
444
/* -----------------------------------------------------------------------
445
   JOB_TASK_MODEL: Job Task
446
   ----------------------------------------------------------------------- */
447
 
448
/*  This model implements a Job with an optional period and a starting
449
    deadline (for the first activation).
450
 
451
    A Job task can raise a XDEADLINE_MISS exception;
452
    if the flag noraiseexc is != 0, the exception is not raised.
453
 
454
    It represent a SINGLE job activation. Typically, a task with this
455
    model NEVER call a task_sleep or task_endcycle. Why? because it is
456
    a single activation.
457
 
458
    In fact, this model is normally used with aperiodic
459
    servers: the aperiodic server insert a guest task in another level
460
    with that model; then, when the current activation is ended (e.g. a
461
    task_sleep() is called) the level, into the XXX_task_sleep, calls
462
    the XXX_guest_end to terminate the actual activation.
463
 
464
    Note that there is no capacity control on this model.
465
    Note that the task that accept this task DOESN'T reactivate the
466
    task after a period... There is NOT a guest_endcycle defined
467
    for this model...
468
 
469
    The default model set noraiseexc and period to 0, and accept a deadline
470
*/
471
 
472
typedef struct {
473
  TASK_MODEL t;
474
  TIME period;
475
  struct timespec deadline;
476
  int noraiseexc;
477
} JOB_TASK_MODEL;
478
 
479
#define job_task_default_model(m,dl)                     \
480
                  task_default_model((m).t,JOB_PCLASS),  \
481
                  (m).period = 0,                        \
482
                  TIMESPEC_ASSIGN(&((m).deadline),&(dl)),\
483
                  (m).noraiseexc = 0
484
#define job_task_def_level(m,l)     task_def_level((m).t,l)
485
#define job_task_def_arg(m,a)       task_def_arg((m).t,a)
486
#define job_task_def_stack(m,s)     task_def_stack((m).t,s)
487
#define job_task_def_stackaddr(m,s) task_def_stackaddr((m).t,s)
488
#define job_task_def_group(m,g)     task_def_group((m).t,g)
489
#define job_task_def_usemath(m)     task_def_usemath((m).t)
490
#define job_task_def_system(m)      task_def_system((m).t)
491
#define job_task_def_nokill(m)      task_def_nokill((m).t)
492
#define job_task_def_ctrl_jet(m)    task_def_ctrl_jet((m).t)
493
#define job_task_def_period(m,per)  (m).period = (per)
494
#define job_task_def_deadline(m,dl) TIMESPEC_ASSIGN(&((m).deadline),&(dl))
495
#define job_task_def_noexc(m)       (m).noraiseexc = 1
496
#define job_task_def_yesexc(m)      (m).noraiseexc = 0
497
#define job_task_def_joinable(m)    task_def_joinable((m).t)
498
#define job_task_def_unjoinable(m)  task_def_unjoinable((m).t)
499
#define job_task_def_trace(m)       task_def_trace((m).t)
500
#define job_task_def_notrace(m)     task_def_notrace((m).t)
501
 
502
 
503
 
504
 
505
 
506
 
507
 
508
 
509
 
510
 
511
 
512
/* -----------------------------------------------------------------------
513
   -----------------------------------------------------------------------
514
   -----------------------------------------------------------------------
515
   -----------------------------------------------------------------------
516
   RESOURCE MODELS
517
   -----------------------------------------------------------------------
518
   -----------------------------------------------------------------------
519
   -----------------------------------------------------------------------
520
   ----------------------------------------------------------------------- */
521
 
522
 
523
 
524
 
525
 
526
 
527
 
528
/* -----------------------------------------------------------------------
529
   RTYPE values
530
   ----------------------------------------------------------------------- */
531
 
532
/* These are the values for the rtype field of a resource descriptor.
533
   The value in the rtype field is used to distinguish the interface really
534
   implemented by the resource object.
535
 
536
   For example, a mutex resource descriptor "inherit" from a resource_des
537
   and implements also all the mutex functions as "virtual", so a type field
538
   is added to the resource descriptor to distinguish witch interface is
539
   really added. +*/
540
 
541
#define DEFAULT_RTYPE     0  /*+ no fields added to resource_des +*/
542
#define MUTEX_RTYPE       1  /*+ the structure implements a mutex
543
                                 protocol, so a cast to mutex_resource_des
544
                                 is legal +*/
545
 
546
 
547
 
548
/* -----------------------------------------------------------------------
549
   RES_MODEL - the base struct
550
   ----------------------------------------------------------------------- */
551
 
552
/*+
553
 RES_MODEL
554
 
555
 This structure is used like the TASK_MODEL.
556
 It groups together a set of optional parameters describing
557
 the resource model used by a task.
558
 
559
 It contains only a field; the others are model-dependent.
560
+*/
561
 
562
typedef struct {
38 pj 563
  int rclass;        /* protocol */
564
  RLEVEL level;          /* level */
2 pj 565
} RES_MODEL;
566
 
38 pj 567
#define res_default_model(r, p)      (r).rclass = (p), (r).level = 0
568
#define res_def_level(r,l)           (r).level = (l)
2 pj 569
 
570
 
571
 
572
/* -----------------------------------------------------------------------
573
   RCLASS values
574
   ----------------------------------------------------------------------- */
575
 
576
/*+ These are the values for the type field in the resource models
577
    a resource level l that accept a resource model with rclass r
578
    accept also the alias pclass (p | l)
579
    => the LSByte MUST be 0 (256 levels maximum) (as for PCLASS!!!) +*/
580
 
581
#define PC_RCLASS    0x0100
582
#define SRP_RCLASS   0x0200
583
#define SRP2_RCLASS  0x0300
584
 
585
#define BDEDF_RCLASS   0x0400
586
#define BDPSCAN_RCLASS 0x0500
587
 
588
/* -----------------------------------------------------------------------
589
   PC_RES_MODEL: BlockDevice EDF resource model
590
   ----------------------------------------------------------------------- */
591
 
592
typedef struct {
593
  RES_MODEL r;
594
  TIME dl;
595
} BDEDF_RES_MODEL;
596
 
597
#define BDEDF_res_default_model(res) \
598
  res_default_model((res).r,BDEDF_RCLASS); \
599
  (res).dl=0     
600
#define BDEDF_res_def_level(res,l)  res_def_level((res).r,l)     
601
#define BDEDF_res_def_dl(res,reldl)  (res).dl=reldl
602
 
603
/* -----------------------------------------------------------------------
604
   PC_RES_MODEL: BlockDevice PSCAN resource model
605
   ----------------------------------------------------------------------- */
606
 
607
typedef struct {
608
  RES_MODEL r;
609
  int priority;
610
} BDPSCAN_RES_MODEL;
611
 
612
#define BDPSCAN_res_default_model(res) \
613
  res_default_model((res).r,BDPSCAN_RCLASS); \
614
  (res).priority=255     
615
#define BDPSCAN_res_def_level(res,l)  res_def_level((res).r,l)     
616
#define BDPSCAN_res_def_priority(res,pri)  (res).priority=pri
617
 
618
/* -----------------------------------------------------------------------
619
   PC_RES_MODEL: Priority ceiling resource model
620
   ----------------------------------------------------------------------- */
621
 
622
/* the tasks created without using this resource models are assumed to have
623
   priority = MAX_DWORD (the lowest). */
624
 
625
typedef struct {
626
  RES_MODEL r;
627
  DWORD priority;
628
} PC_RES_MODEL;
629
 
630
#define PC_res_default_model(res, prio) \
631
                                 res_default_model((res).r, PC_RCLASS); \
632
                                 (res).priority = (prio)
633
#define PC_res_def_level(res,l)  res_def_level(res,l)
634
 
635
/* -----------------------------------------------------------------------
636
   SRP_RES_MODEL: Stack Resource Policy resource model
637
   ----------------------------------------------------------------------- */
638
 
639
/* the tasks created without using this resource model are not allowed to
640
   lock any SRP mutex. if two of this models are passed to the task_create,
641
   one of them is chosen, in a nondeterministic way, so use only one of
642
   this resource model per task!!!
643
 
644
   The First SRP version uses another resource model that is embedded into
645
   the mutex structure. refer to kernel/modules/srp.c. this second resource
646
   model has the SRP2_RCLASS
647
*/
648
 
649
typedef struct {
650
  RES_MODEL r;
651
  DWORD preempt;  /* the preemption level of a task */
652
} SRP_RES_MODEL;
653
 
654
#define SRP_res_default_model(res, pre) \
655
                                 res_default_model((res).r, SRP_RCLASS); \
656
                                 (res).preempt = (pre)
657
#define SRP_res_def_level(res,l) res_def_level(res,l)
658
 
659
 
660
/* -----------------------------------------------------------------------
661
   MUTEX Attributes
662
   ----------------------------------------------------------------------- */
663
 
664
/*+
665
  MUTEX ATTRIBUTES
666
 
667
  A mutexattr object act as the task model for the tasks in the system:
668
  It specifies the particular options used by a protocol.
669
 
670
  From this basic attribute object many other objects can be derived
671
  as done for the TASK_MODEL. These objects are used to initialize a mutex
672
  with a specified protocol.
673
+*/
674
typedef struct {
675
  int mclass;      /* the protocol type... */
676
} mutexattr_t;
677
 
678
#define mutexattr_default(a, c)  (a).mclass = (c)
679
 
680
 
681
/* -----------------------------------------------------------------------
682
   MCLASS values
683
   ----------------------------------------------------------------------- */
684
 
685
/*+ These are the value for the mclass field;
686
    a mutex level l that accept a task model with mclass m
687
    accept also the alias mclass (m | l)
688
    => the LSByte MUST be 0 (256 levels maximum) +*/
689
 
690
#define NPP_MCLASS      0x0100
691
#define PI_MCLASS       0x0200
692
#define PC_MCLASS       0x0300
693
#define SRP_MCLASS      0x0400
694
#define NOP_MCLASS      0x0500
695
#define NOPM_MCLASS     0x0600
696
 
697
/* -----------------------------------------------------------------------
698
   PI_mutexattr_t: Priority Inheritance Mutex Attribute
699
   ----------------------------------------------------------------------- */
700
 
701
typedef mutexattr_t PI_mutexattr_t;
702
 
703
#define PI_MUTEXATTR_INITIALIZER {PI_MCLASS}
704
#define PI_mutexattr_default(a)  mutexattr_default(a, PI_MCLASS)
705
 
706
/* -----------------------------------------------------------------------
707
   NPP_mutexattr_t: Non Preemptive Protocol Mutex Attribute
708
   ----------------------------------------------------------------------- */
709
 
710
typedef mutexattr_t NPP_mutexattr_t;
711
 
712
#define NPP_MUUEXATTR_INITIALIZER {NPP_MCLASS}
713
#define NPP_mutexattr_default(a)  mutexattr_default(a, NPP_MCLASS)
714
 
715
/* -----------------------------------------------------------------------
716
   PC_mutexattr_t: Priority Ceiling Mutex Attribute
717
   ----------------------------------------------------------------------- */
718
 
719
typedef struct {
720
  mutexattr_t a;
721
  DWORD ceiling;
722
} PC_mutexattr_t;
723
 
724
#define PC_MUTEXATTR_INITIALIZER {{PC_MCLASS},MAX_DWORD}
725
#define PC_mutexattr_default(at,c)  mutexattr_default((at).a, PC_MCLASS); \
726
                                    (at).ceiling = (c)
727
 
728
/* -----------------------------------------------------------------------
729
   SRP_mutexattr_t: Stack Resource Policy Mutex Attribute
730
   ----------------------------------------------------------------------- */
731
 
732
typedef mutexattr_t SRP_mutexattr_t;
733
 
734
#define SRP_MUTEXATTR_INITIALIZER {SRP_MCLASS}
735
#define SRP_mutexattr_default(a)  mutexattr_default(a, SRP_MCLASS)
736
 
737
/* -----------------------------------------------------------------------
738
   NOP_mutexattr_t: No Protocol Mutex Attribute
739
   ----------------------------------------------------------------------- */
740
 
741
typedef mutexattr_t NOP_mutexattr_t;
742
 
743
#define NOP_MUTEXATTR_INITIALIZER {NOP_MCLASS}
744
#define NOP_mutexattr_default(a)  mutexattr_default(a, NOP_MCLASS)
745
 
746
/* -----------------------------------------------------------------------
747
   NOPM_mutexattr_t: No Protocol Multiple lock Mutex Attribute
748
   ----------------------------------------------------------------------- */
749
 
750
typedef mutexattr_t NOPM_mutexattr_t;
751
 
752
#define NOPM_MUTEXATTR_INITIALIZER {NOPM_MCLASS}
753
#define NOPM_mutexattr_default(a)  mutexattr_default(a, NOPM_MCLASS)
754
 
79 pj 755
__END_DECLS
2 pj 756
#endif /* __MODEL_H__ */
757