Subversion Repositories shark

Rev

Rev 79 | Rev 657 | 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
 ------------
328 giacomo 24
 CVS :        $Id: model.h,v 1.4 2003-11-13 08:58:21 giacomo Exp $
2 pj 25
 
26
 File:        $File$
328 giacomo 27
 Revision:    $Revision: 1.4 $
28
 Last update: $Date: 2003-11-13 08:58:21 $
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
 
328 giacomo 214
/* flag to avoid task_makefree called 2 times */
215
#define TASK_MAKEFREE       0x100000
2 pj 216
 
217
/* Some macros to set various task-model parameters */
218
#define task_default_model(m,p) (m).pclass = (p), \
38 pj 219
                                (m).level = 0; \
2 pj 220
                                (m).stacksize = 4096, \
221
                                (m).stackaddr = NULL, \
222
                                (m).group = 0, \
223
                                (m).arg = NULL,\
224
                                (m).control = 0
38 pj 225
#define task_def_level(m,l)     (m).level = (l)
2 pj 226
#define task_def_arg(m,a)       (m).arg = (a)
227
#define task_def_stack(m,s)     (m).stacksize = (s)
228
#define task_def_stackaddr(m,s) (m).stackaddr = (s)
229
#define task_def_group(m,g)     (m).group = (g)
230
#define task_def_usemath(m)     (m).control |= USE_FPU
231
#define task_def_system(m)      (m).control |= SYSTEM_TASK
232
#define task_def_nokill(m)      (m).control |= NO_KILL
233
#define task_def_ctrl_jet(m)    (m).control |= JET_ENABLED
234
#define task_def_joinable(m)    (m).control |= TASK_JOINABLE
235
#define task_def_unjoinable(m)  (m).control &= ~TASK_JOINABLE
236
#define task_def_trace(m)       (m).control |= TRACE_TASK
237
#define task_def_notrace(m)     (m).control &= ~TRACE_TASK
238
 
239
 
240
 
241
 
242
/* -----------------------------------------------------------------------
243
   PCLASS values
244
   ----------------------------------------------------------------------- */
245
 
38 pj 246
/* These are the value for the pclass field */
2 pj 247
 
38 pj 248
#define DUMMY_PCLASS        0
249
#define HARD_PCLASS         1
250
#define SOFT_PCLASS         2
251
#define NRT_PCLASS          3
252
#define JOB_PCLASS          4
2 pj 253
 
254
 
255
/* -----------------------------------------------------------------------
256
   Useful stuffs
257
   ----------------------------------------------------------------------- */
258
 
259
#define PERIODIC       0
260
#define APERIODIC      1
261
 
262
#define SAVE_ARRIVALS  0
263
#define SKIP_ARRIVALS  1
264
 
265
 
266
 
267
/* -----------------------------------------------------------------------
268
   DUMMY_TASK_MODEL: model used only for the dummy task
269
   ----------------------------------------------------------------------- */
270
 
271
/*+ the dummy task doesn't add any new field +*/
272
typedef TASK_MODEL DUMMY_TASK_MODEL;
273
 
274
#define dummy_task_default_model(m) task_default_model(m,DUMMY_PCLASS)
275
#define dummy_task_def_level(m,l)   task_def_level(m,l)
276
#define dummy_task_def_system(m)    task_def_system(m)
277
#define dummy_task_def_nokill(m)    task_def_nokill(m)
278
#define dummy_task_def_ctrl_jet(m)  task_def_ctrl_jet(m)
279
 
280
 
281
 
282
 
283
 
284
 
285
/* -----------------------------------------------------------------------
286
   HARD_TASK_MODEL: hard Tasks
287
   ----------------------------------------------------------------------- */
288
 
289
/*  A Hard Task model can be used to model periodic and sporadic tasks.
290
    These tasks are usually guaranteed basing on their minimum interarrival
291
    time (mit) and wcet, and may have a relative deadline.
292
 
293
    A hard task can raise these exceptions:
294
    XDEADLINE_MISS XWCET_VIOLATION XACTIVATION
295
 
296
    The default model sets wcet, mit and relative deadline to 0, and
297
    the periodicity to PERIODIC.
298
*/
299
 
300
typedef struct {
301
  TASK_MODEL t;
302
  TIME mit;
303
  TIME drel;
304
  TIME wcet;
305
  int periodicity;
306
} HARD_TASK_MODEL;
307
 
308
#define hard_task_default_model(m)                             \
309
                        task_default_model((m).t,HARD_PCLASS), \
310
                        (m).mit         = 0,                   \
311
                        (m).drel        = 0,                   \
312
                        (m).wcet        = 0,                   \
313
                        (m).periodicity = PERIODIC
314
#define hard_task_def_level(m,l)    task_def_level((m).t,l)
315
#define hard_task_def_arg(m,a)      task_def_arg((m).t,a)
316
#define hard_task_def_stack(m,s)    task_def_stack((m).t,s)
317
#define hard_task_def_stackaddr(m,s) task_def_stackaddr((m).t,s)
318
#define hard_task_def_group(m,g)    task_def_group((m).t,g)
319
#define hard_task_def_usemath(m)    task_def_usemath((m).t)
320
#define hard_task_def_system(m)     task_def_system((m).t)
321
#define hard_task_def_nokill(m)     task_def_nokill((m).t)
322
#define hard_task_def_ctrl_jet(m)   task_def_ctrl_jet((m).t)
323
#define hard_task_def_mit(m,p)      (m).mit = (p)
324
#define hard_task_def_drel(m,d)     (m).drel = (d)
325
#define hard_task_def_wcet(m,w)     (m).wcet = (w)
326
#define hard_task_def_periodic(m)   (m).periodicity = PERIODIC
327
#define hard_task_def_aperiodic(m)  (m).periodicity = APERIODIC
328
#define hard_task_def_joinable(m)   task_def_joinable((m).t)
329
#define hard_task_def_unjoinable(m) task_def_unjoinable((m).t)
330
#define hard_task_def_trace(m)      task_def_trace((m).t)
331
#define hard_task_def_notrace(m)    task_def_notrace((m).t)
332
 
333
 
334
 
335
/* -----------------------------------------------------------------------
336
   SOFT_TASK_MODEL: Soft Tasks
337
   ----------------------------------------------------------------------- */
338
 
339
/*  A Soft Task model can be used to model periodic and aperiodic tasks
340
    usually not guaranteed or guaranteed basing on their period and mean
341
    execution time (met). A Soft task can also record pending activations if
342
    the arrivals are set to SAVE.
343
 
344
    A wcet field is also present for those servers that need if (i.e., TBS)
345
 
346
    The default model sets met, period and wcet to 0, the periodicity to
347
    PERIODIC and the arrivals to SAVE.
348
 
349
    A Soft Task don't raise any exception.
350
*/
351
 
352
typedef struct {
353
  TASK_MODEL t;
354
  TIME period;
355
  TIME met;
356
  TIME wcet;
357
  int periodicity;
358
  int arrivals;
359
} SOFT_TASK_MODEL;
360
 
361
#define soft_task_default_model(m)                             \
362
                        task_default_model((m).t,SOFT_PCLASS), \
363
                        (m).period      = 0,                   \
364
                        (m).met         = 0,                   \
365
                        (m).wcet        = 0,                   \
366
                        (m).periodicity = PERIODIC,            \
367
                        (m).arrivals    = SAVE_ARRIVALS
368
#define soft_task_def_level(m,l)       task_def_level((m).t,l)
369
#define soft_task_def_arg(m,a)         task_def_arg((m).t,a)
370
#define soft_task_def_stack(m,s)       task_def_stack((m).t,s)
371
#define soft_task_def_stackaddr(m,s)   task_def_stackaddr((m).t,s)
372
#define soft_task_def_group(m,g)       task_def_group((m).t,g)
373
#define soft_task_def_usemath(m)       task_def_usemath((m).t)
374
#define soft_task_def_system(m)        task_def_system((m).t)
375
#define soft_task_def_nokill(m)        task_def_nokill((m).t)
376
#define soft_task_def_ctrl_jet(m)      task_def_ctrl_jet((m).t)
377
#define soft_task_def_period(m,p)      (m).period = (p)
378
#define soft_task_def_met(m,d)         (m).met = (d)
379
#define soft_task_def_wcet(m,w)        (m).wcet = (w)
380
#define soft_task_def_periodic(m)      (m).periodicity = PERIODIC
381
#define soft_task_def_aperiodic(m)     (m).periodicity = APERIODIC
382
#define soft_task_def_save_arrivals(m) (m).arrivals    = SAVE_ARRIVALS
383
#define soft_task_def_skip_arrivals(m) (m).arrivals    = SKIP_ARRIVALS
384
#define soft_task_def_joinable(m)      task_def_joinable((m).t)
385
#define soft_task_def_unjoinable(m)    task_def_unjoinable((m).t)
386
#define soft_task_def_trace(m)         task_def_trace((m).t)
387
#define soft_task_def_notrace(m)       task_def_notrace((m).t)
388
 
389
/* -----------------------------------------------------------------------
390
   NRT_TASK_MODEL: Non Realtime Tasks
391
   ----------------------------------------------------------------------- */
392
 
393
/* A NRT task has a weight and a time slice, plus  a policy attribute.
394
   It can be used to model Round Robin, Proportional Share, POSIX,
395
   and Priority tasks.
396
 
397
   Policy and inherit is inserted in the model to support posix
398
   compliant scheduling...
399
 
400
   The default model set weight and slice to 0, policy to RR, and inherit
401
   to explicit.
402
*/
403
 
404
#define NRT_RR_POLICY   0
405
#define NRT_FIFO_POLICY 1
406
 
407
#define NRT_INHERIT_SCHED  0
408
#define NRT_EXPLICIT_SCHED 1
409
 
410
typedef struct {
411
  TASK_MODEL t;
412
  int weight;
413
  TIME slice;
414
  int arrivals;
415
  int policy;
416
  int inherit;
417
} NRT_TASK_MODEL;
418
 
419
#define nrt_task_default_model(m) task_default_model((m).t,NRT_PCLASS), \
420
                                      (m).weight   = 0,                 \
421
                                      (m).slice    = 0,                 \
422
                                      (m).arrivals = SAVE_ARRIVALS,     \
423
                                      (m).policy   = NRT_RR_POLICY,     \
424
                                      (m).inherit  = NRT_EXPLICIT_SCHED
425
#define nrt_task_def_level(m,l)       task_def_level((m).t,l)
426
#define nrt_task_def_arg(m,a)         task_def_arg((m).t,a)
427
#define nrt_task_def_stack(m,s)       task_def_stack((m).t,s)
428
#define nrt_task_def_stackaddr(m,s)   task_def_stackaddr((m).t,s)
429
#define nrt_task_def_group(m,g)       task_def_group((m).t,g)
430
#define nrt_task_def_usemath(m)       task_def_usemath((m).t)
431
#define nrt_task_def_system(m)        task_def_system((m).t)
432
#define nrt_task_def_nokill(m)        task_def_nokill((m).t)
433
#define nrt_task_def_ctrl_jet(m)      task_def_ctrl_jet((m).t)
434
#define nrt_task_def_joinable(m)      task_def_joinable((m).t)
435
#define nrt_task_def_unjoinable(m)    task_def_unjoinable((m).t)
436
#define nrt_task_def_weight(m,w)      (m).weight = (w)
437
#define nrt_task_def_slice(m,s)       (m).slice = (s)
438
#define nrt_task_def_save_arrivals(m) (m).arrivals    = SAVE_ARRIVALS
439
#define nrt_task_def_skip_arrivals(m) (m).arrivals    = SKIP_ARRIVALS
440
#define nrt_task_def_policy(m,p)      (m).policy = (p)
441
#define nrt_task_def_inherit(m,i)     (m).inherit = (i)
442
#define nrt_task_def_trace(m)         task_def_trace((m).t)
443
#define nrt_task_def_notrace(m)       task_def_notrace((m).t)
444
 
445
 
446
/* -----------------------------------------------------------------------
447
   JOB_TASK_MODEL: Job Task
448
   ----------------------------------------------------------------------- */
449
 
450
/*  This model implements a Job with an optional period and a starting
451
    deadline (for the first activation).
452
 
453
    A Job task can raise a XDEADLINE_MISS exception;
454
    if the flag noraiseexc is != 0, the exception is not raised.
455
 
456
    It represent a SINGLE job activation. Typically, a task with this
457
    model NEVER call a task_sleep or task_endcycle. Why? because it is
458
    a single activation.
459
 
460
    In fact, this model is normally used with aperiodic
461
    servers: the aperiodic server insert a guest task in another level
462
    with that model; then, when the current activation is ended (e.g. a
463
    task_sleep() is called) the level, into the XXX_task_sleep, calls
464
    the XXX_guest_end to terminate the actual activation.
465
 
466
    Note that there is no capacity control on this model.
467
    Note that the task that accept this task DOESN'T reactivate the
468
    task after a period... There is NOT a guest_endcycle defined
469
    for this model...
470
 
471
    The default model set noraiseexc and period to 0, and accept a deadline
472
*/
473
 
474
typedef struct {
475
  TASK_MODEL t;
476
  TIME period;
477
  struct timespec deadline;
478
  int noraiseexc;
479
} JOB_TASK_MODEL;
480
 
481
#define job_task_default_model(m,dl)                     \
482
                  task_default_model((m).t,JOB_PCLASS),  \
483
                  (m).period = 0,                        \
484
                  TIMESPEC_ASSIGN(&((m).deadline),&(dl)),\
485
                  (m).noraiseexc = 0
486
#define job_task_def_level(m,l)     task_def_level((m).t,l)
487
#define job_task_def_arg(m,a)       task_def_arg((m).t,a)
488
#define job_task_def_stack(m,s)     task_def_stack((m).t,s)
489
#define job_task_def_stackaddr(m,s) task_def_stackaddr((m).t,s)
490
#define job_task_def_group(m,g)     task_def_group((m).t,g)
491
#define job_task_def_usemath(m)     task_def_usemath((m).t)
492
#define job_task_def_system(m)      task_def_system((m).t)
493
#define job_task_def_nokill(m)      task_def_nokill((m).t)
494
#define job_task_def_ctrl_jet(m)    task_def_ctrl_jet((m).t)
495
#define job_task_def_period(m,per)  (m).period = (per)
496
#define job_task_def_deadline(m,dl) TIMESPEC_ASSIGN(&((m).deadline),&(dl))
497
#define job_task_def_noexc(m)       (m).noraiseexc = 1
498
#define job_task_def_yesexc(m)      (m).noraiseexc = 0
499
#define job_task_def_joinable(m)    task_def_joinable((m).t)
500
#define job_task_def_unjoinable(m)  task_def_unjoinable((m).t)
501
#define job_task_def_trace(m)       task_def_trace((m).t)
502
#define job_task_def_notrace(m)     task_def_notrace((m).t)
503
 
504
 
505
 
506
 
507
 
508
 
509
 
510
 
511
 
512
 
513
 
514
/* -----------------------------------------------------------------------
515
   -----------------------------------------------------------------------
516
   -----------------------------------------------------------------------
517
   -----------------------------------------------------------------------
518
   RESOURCE MODELS
519
   -----------------------------------------------------------------------
520
   -----------------------------------------------------------------------
521
   -----------------------------------------------------------------------
522
   ----------------------------------------------------------------------- */
523
 
524
 
525
 
526
 
527
 
528
 
529
 
530
/* -----------------------------------------------------------------------
531
   RTYPE values
532
   ----------------------------------------------------------------------- */
533
 
534
/* These are the values for the rtype field of a resource descriptor.
535
   The value in the rtype field is used to distinguish the interface really
536
   implemented by the resource object.
537
 
538
   For example, a mutex resource descriptor "inherit" from a resource_des
539
   and implements also all the mutex functions as "virtual", so a type field
540
   is added to the resource descriptor to distinguish witch interface is
541
   really added. +*/
542
 
543
#define DEFAULT_RTYPE     0  /*+ no fields added to resource_des +*/
544
#define MUTEX_RTYPE       1  /*+ the structure implements a mutex
545
                                 protocol, so a cast to mutex_resource_des
546
                                 is legal +*/
547
 
548
 
549
 
550
/* -----------------------------------------------------------------------
551
   RES_MODEL - the base struct
552
   ----------------------------------------------------------------------- */
553
 
554
/*+
555
 RES_MODEL
556
 
557
 This structure is used like the TASK_MODEL.
558
 It groups together a set of optional parameters describing
559
 the resource model used by a task.
560
 
561
 It contains only a field; the others are model-dependent.
562
+*/
563
 
564
typedef struct {
38 pj 565
  int rclass;        /* protocol */
566
  RLEVEL level;          /* level */
2 pj 567
} RES_MODEL;
568
 
38 pj 569
#define res_default_model(r, p)      (r).rclass = (p), (r).level = 0
570
#define res_def_level(r,l)           (r).level = (l)
2 pj 571
 
572
 
573
 
574
/* -----------------------------------------------------------------------
575
   RCLASS values
576
   ----------------------------------------------------------------------- */
577
 
578
/*+ These are the values for the type field in the resource models
579
    a resource level l that accept a resource model with rclass r
580
    accept also the alias pclass (p | l)
581
    => the LSByte MUST be 0 (256 levels maximum) (as for PCLASS!!!) +*/
582
 
583
#define PC_RCLASS    0x0100
584
#define SRP_RCLASS   0x0200
585
#define SRP2_RCLASS  0x0300
586
 
587
#define BDEDF_RCLASS   0x0400
588
#define BDPSCAN_RCLASS 0x0500
589
 
590
/* -----------------------------------------------------------------------
591
   PC_RES_MODEL: BlockDevice EDF resource model
592
   ----------------------------------------------------------------------- */
593
 
594
typedef struct {
595
  RES_MODEL r;
596
  TIME dl;
597
} BDEDF_RES_MODEL;
598
 
599
#define BDEDF_res_default_model(res) \
600
  res_default_model((res).r,BDEDF_RCLASS); \
601
  (res).dl=0     
602
#define BDEDF_res_def_level(res,l)  res_def_level((res).r,l)     
603
#define BDEDF_res_def_dl(res,reldl)  (res).dl=reldl
604
 
605
/* -----------------------------------------------------------------------
606
   PC_RES_MODEL: BlockDevice PSCAN resource model
607
   ----------------------------------------------------------------------- */
608
 
609
typedef struct {
610
  RES_MODEL r;
611
  int priority;
612
} BDPSCAN_RES_MODEL;
613
 
614
#define BDPSCAN_res_default_model(res) \
615
  res_default_model((res).r,BDPSCAN_RCLASS); \
616
  (res).priority=255     
617
#define BDPSCAN_res_def_level(res,l)  res_def_level((res).r,l)     
618
#define BDPSCAN_res_def_priority(res,pri)  (res).priority=pri
619
 
620
/* -----------------------------------------------------------------------
621
   PC_RES_MODEL: Priority ceiling resource model
622
   ----------------------------------------------------------------------- */
623
 
624
/* the tasks created without using this resource models are assumed to have
625
   priority = MAX_DWORD (the lowest). */
626
 
627
typedef struct {
628
  RES_MODEL r;
629
  DWORD priority;
630
} PC_RES_MODEL;
631
 
632
#define PC_res_default_model(res, prio) \
633
                                 res_default_model((res).r, PC_RCLASS); \
634
                                 (res).priority = (prio)
635
#define PC_res_def_level(res,l)  res_def_level(res,l)
636
 
637
/* -----------------------------------------------------------------------
638
   SRP_RES_MODEL: Stack Resource Policy resource model
639
   ----------------------------------------------------------------------- */
640
 
641
/* the tasks created without using this resource model are not allowed to
642
   lock any SRP mutex. if two of this models are passed to the task_create,
643
   one of them is chosen, in a nondeterministic way, so use only one of
644
   this resource model per task!!!
645
 
646
   The First SRP version uses another resource model that is embedded into
647
   the mutex structure. refer to kernel/modules/srp.c. this second resource
648
   model has the SRP2_RCLASS
649
*/
650
 
651
typedef struct {
652
  RES_MODEL r;
653
  DWORD preempt;  /* the preemption level of a task */
654
} SRP_RES_MODEL;
655
 
656
#define SRP_res_default_model(res, pre) \
657
                                 res_default_model((res).r, SRP_RCLASS); \
658
                                 (res).preempt = (pre)
659
#define SRP_res_def_level(res,l) res_def_level(res,l)
660
 
661
 
662
/* -----------------------------------------------------------------------
663
   MUTEX Attributes
664
   ----------------------------------------------------------------------- */
665
 
666
/*+
667
  MUTEX ATTRIBUTES
668
 
669
  A mutexattr object act as the task model for the tasks in the system:
670
  It specifies the particular options used by a protocol.
671
 
672
  From this basic attribute object many other objects can be derived
673
  as done for the TASK_MODEL. These objects are used to initialize a mutex
674
  with a specified protocol.
675
+*/
676
typedef struct {
677
  int mclass;      /* the protocol type... */
678
} mutexattr_t;
679
 
680
#define mutexattr_default(a, c)  (a).mclass = (c)
681
 
682
 
683
/* -----------------------------------------------------------------------
684
   MCLASS values
685
   ----------------------------------------------------------------------- */
686
 
687
/*+ These are the value for the mclass field;
688
    a mutex level l that accept a task model with mclass m
689
    accept also the alias mclass (m | l)
690
    => the LSByte MUST be 0 (256 levels maximum) +*/
691
 
692
#define NPP_MCLASS      0x0100
693
#define PI_MCLASS       0x0200
694
#define PC_MCLASS       0x0300
695
#define SRP_MCLASS      0x0400
696
#define NOP_MCLASS      0x0500
697
#define NOPM_MCLASS     0x0600
698
 
699
/* -----------------------------------------------------------------------
700
   PI_mutexattr_t: Priority Inheritance Mutex Attribute
701
   ----------------------------------------------------------------------- */
702
 
703
typedef mutexattr_t PI_mutexattr_t;
704
 
705
#define PI_MUTEXATTR_INITIALIZER {PI_MCLASS}
706
#define PI_mutexattr_default(a)  mutexattr_default(a, PI_MCLASS)
707
 
708
/* -----------------------------------------------------------------------
709
   NPP_mutexattr_t: Non Preemptive Protocol Mutex Attribute
710
   ----------------------------------------------------------------------- */
711
 
712
typedef mutexattr_t NPP_mutexattr_t;
713
 
714
#define NPP_MUUEXATTR_INITIALIZER {NPP_MCLASS}
715
#define NPP_mutexattr_default(a)  mutexattr_default(a, NPP_MCLASS)
716
 
717
/* -----------------------------------------------------------------------
718
   PC_mutexattr_t: Priority Ceiling Mutex Attribute
719
   ----------------------------------------------------------------------- */
720
 
721
typedef struct {
722
  mutexattr_t a;
723
  DWORD ceiling;
724
} PC_mutexattr_t;
725
 
726
#define PC_MUTEXATTR_INITIALIZER {{PC_MCLASS},MAX_DWORD}
727
#define PC_mutexattr_default(at,c)  mutexattr_default((at).a, PC_MCLASS); \
728
                                    (at).ceiling = (c)
729
 
730
/* -----------------------------------------------------------------------
731
   SRP_mutexattr_t: Stack Resource Policy Mutex Attribute
732
   ----------------------------------------------------------------------- */
733
 
734
typedef mutexattr_t SRP_mutexattr_t;
735
 
736
#define SRP_MUTEXATTR_INITIALIZER {SRP_MCLASS}
737
#define SRP_mutexattr_default(a)  mutexattr_default(a, SRP_MCLASS)
738
 
739
/* -----------------------------------------------------------------------
740
   NOP_mutexattr_t: No Protocol Mutex Attribute
741
   ----------------------------------------------------------------------- */
742
 
743
typedef mutexattr_t NOP_mutexattr_t;
744
 
745
#define NOP_MUTEXATTR_INITIALIZER {NOP_MCLASS}
746
#define NOP_mutexattr_default(a)  mutexattr_default(a, NOP_MCLASS)
747
 
748
/* -----------------------------------------------------------------------
749
   NOPM_mutexattr_t: No Protocol Multiple lock Mutex Attribute
750
   ----------------------------------------------------------------------- */
751
 
752
typedef mutexattr_t NOPM_mutexattr_t;
753
 
754
#define NOPM_MUTEXATTR_INITIALIZER {NOPM_MCLASS}
755
#define NOPM_mutexattr_default(a)  mutexattr_default(a, NOPM_MCLASS)
756
 
79 pj 757
__END_DECLS
2 pj 758
#endif /* __MODEL_H__ */
759