Subversion Repositories shark

Rev

Rev 796 | Rev 878 | 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
 ------------
808 trimarchi 24
 CVS :        $Id: model.h,v 1.14 2004-09-03 13:26:05 trimarchi Exp $
2 pj 25
 
26
 File:        $File$
808 trimarchi 27
 Revision:    $Revision: 1.14 $
28
 Last update: $Date: 2004-09-03 13:26:05 $
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
671 giacomo 253
#define ELASTIC_PCLASS      5
2 pj 254
 
255
/* -----------------------------------------------------------------------
256
   Useful stuffs
257
   ----------------------------------------------------------------------- */
258
 
259
#define PERIODIC       0
260
#define APERIODIC      1
512 giacomo 261
#define INTDRIVE       2
2 pj 262
 
263
#define SAVE_ARRIVALS  0
264
#define SKIP_ARRIVALS  1
265
 
266
/* -----------------------------------------------------------------------
267
   DUMMY_TASK_MODEL: model used only for the dummy task
268
   ----------------------------------------------------------------------- */
269
 
270
/*+ the dummy task doesn't add any new field +*/
271
typedef TASK_MODEL DUMMY_TASK_MODEL;
272
 
273
#define dummy_task_default_model(m) task_default_model(m,DUMMY_PCLASS)
274
#define dummy_task_def_level(m,l)   task_def_level(m,l)
275
#define dummy_task_def_system(m)    task_def_system(m)
276
#define dummy_task_def_nokill(m)    task_def_nokill(m)
277
#define dummy_task_def_ctrl_jet(m)  task_def_ctrl_jet(m)
278
 
279
 
280
 
281
 
282
 
283
 
284
/* -----------------------------------------------------------------------
285
   HARD_TASK_MODEL: hard Tasks
286
   ----------------------------------------------------------------------- */
287
 
288
/*  A Hard Task model can be used to model periodic and sporadic tasks.
289
    These tasks are usually guaranteed basing on their minimum interarrival
657 anton 290
    time (mit) and wcet, and may have a relative deadline and a release
291
    offset.
2 pj 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;
657 anton 306
  TIME offset;
2 pj 307
} HARD_TASK_MODEL;
308
 
309
#define hard_task_default_model(m)                             \
310
                        task_default_model((m).t,HARD_PCLASS), \
311
                        (m).mit         = 0,                   \
312
                        (m).drel        = 0,                   \
313
                        (m).wcet        = 0,                   \
657 anton 314
                        (m).periodicity = PERIODIC,            \
315
                        (m).offset      = 0 
2 pj 316
#define hard_task_def_level(m,l)    task_def_level((m).t,l)
317
#define hard_task_def_arg(m,a)      task_def_arg((m).t,a)
318
#define hard_task_def_stack(m,s)    task_def_stack((m).t,s)
319
#define hard_task_def_stackaddr(m,s) task_def_stackaddr((m).t,s)
320
#define hard_task_def_group(m,g)    task_def_group((m).t,g)
321
#define hard_task_def_usemath(m)    task_def_usemath((m).t)
322
#define hard_task_def_system(m)     task_def_system((m).t)
323
#define hard_task_def_nokill(m)     task_def_nokill((m).t)
324
#define hard_task_def_ctrl_jet(m)   task_def_ctrl_jet((m).t)
325
#define hard_task_def_mit(m,p)      (m).mit = (p)
326
#define hard_task_def_drel(m,d)     (m).drel = (d)
327
#define hard_task_def_wcet(m,w)     (m).wcet = (w)
657 anton 328
#define hard_task_def_offset(m,o)   (m).offset = (o)
2 pj 329
#define hard_task_def_periodic(m)   (m).periodicity = PERIODIC
330
#define hard_task_def_aperiodic(m)  (m).periodicity = APERIODIC
512 giacomo 331
#define hard_task_def_interrupt(m)  (m).periodicity = INTDRIVE
2 pj 332
#define hard_task_def_joinable(m)   task_def_joinable((m).t)
333
#define hard_task_def_unjoinable(m) task_def_unjoinable((m).t)
334
#define hard_task_def_trace(m)      task_def_trace((m).t)
335
#define hard_task_def_notrace(m)    task_def_notrace((m).t)
336
 
337
 
338
 
339
/* -----------------------------------------------------------------------
340
   SOFT_TASK_MODEL: Soft Tasks
341
   ----------------------------------------------------------------------- */
342
 
343
/*  A Soft Task model can be used to model periodic and aperiodic tasks
344
    usually not guaranteed or guaranteed basing on their period and mean
345
    execution time (met). A Soft task can also record pending activations if
346
    the arrivals are set to SAVE.
347
 
348
    A wcet field is also present for those servers that need if (i.e., TBS)
349
 
350
    The default model sets met, period and wcet to 0, the periodicity to
351
    PERIODIC and the arrivals to SAVE.
352
 
353
    A Soft Task don't raise any exception.
354
*/
355
 
356
typedef struct {
357
  TASK_MODEL t;
358
  TIME period;
359
  TIME met;
360
  TIME wcet;
361
  int periodicity;
362
  int arrivals;
363
} SOFT_TASK_MODEL;
364
 
365
#define soft_task_default_model(m)                             \
366
                        task_default_model((m).t,SOFT_PCLASS), \
367
                        (m).period      = 0,                   \
368
                        (m).met         = 0,                   \
369
                        (m).wcet        = 0,                   \
370
                        (m).periodicity = PERIODIC,            \
371
                        (m).arrivals    = SAVE_ARRIVALS
372
#define soft_task_def_level(m,l)       task_def_level((m).t,l)
373
#define soft_task_def_arg(m,a)         task_def_arg((m).t,a)
374
#define soft_task_def_stack(m,s)       task_def_stack((m).t,s)
375
#define soft_task_def_stackaddr(m,s)   task_def_stackaddr((m).t,s)
376
#define soft_task_def_group(m,g)       task_def_group((m).t,g)
377
#define soft_task_def_usemath(m)       task_def_usemath((m).t)
378
#define soft_task_def_system(m)        task_def_system((m).t)
379
#define soft_task_def_nokill(m)        task_def_nokill((m).t)
380
#define soft_task_def_ctrl_jet(m)      task_def_ctrl_jet((m).t)
381
#define soft_task_def_period(m,p)      (m).period = (p)
382
#define soft_task_def_met(m,d)         (m).met = (d)
383
#define soft_task_def_wcet(m,w)        (m).wcet = (w)
384
#define soft_task_def_periodic(m)      (m).periodicity = PERIODIC
385
#define soft_task_def_aperiodic(m)     (m).periodicity = APERIODIC
386
#define soft_task_def_save_arrivals(m) (m).arrivals    = SAVE_ARRIVALS
387
#define soft_task_def_skip_arrivals(m) (m).arrivals    = SKIP_ARRIVALS
388
#define soft_task_def_joinable(m)      task_def_joinable((m).t)
389
#define soft_task_def_unjoinable(m)    task_def_unjoinable((m).t)
390
#define soft_task_def_trace(m)         task_def_trace((m).t)
391
#define soft_task_def_notrace(m)       task_def_notrace((m).t)
392
 
393
/* -----------------------------------------------------------------------
394
   NRT_TASK_MODEL: Non Realtime Tasks
395
   ----------------------------------------------------------------------- */
396
 
397
/* A NRT task has a weight and a time slice, plus  a policy attribute.
398
   It can be used to model Round Robin, Proportional Share, POSIX,
399
   and Priority tasks.
400
 
401
   Policy and inherit is inserted in the model to support posix
402
   compliant scheduling...
403
 
404
   The default model set weight and slice to 0, policy to RR, and inherit
405
   to explicit.
406
*/
407
 
408
#define NRT_RR_POLICY   0
409
#define NRT_FIFO_POLICY 1
410
 
411
#define NRT_INHERIT_SCHED  0
412
#define NRT_EXPLICIT_SCHED 1
413
 
414
typedef struct {
415
  TASK_MODEL t;
416
  int weight;
417
  TIME slice;
418
  int arrivals;
419
  int policy;
420
  int inherit;
421
} NRT_TASK_MODEL;
422
 
423
#define nrt_task_default_model(m) task_default_model((m).t,NRT_PCLASS), \
424
                                      (m).weight   = 0,                 \
425
                                      (m).slice    = 0,                 \
426
                                      (m).arrivals = SAVE_ARRIVALS,     \
427
                                      (m).policy   = NRT_RR_POLICY,     \
428
                                      (m).inherit  = NRT_EXPLICIT_SCHED
429
#define nrt_task_def_level(m,l)       task_def_level((m).t,l)
430
#define nrt_task_def_arg(m,a)         task_def_arg((m).t,a)
431
#define nrt_task_def_stack(m,s)       task_def_stack((m).t,s)
432
#define nrt_task_def_stackaddr(m,s)   task_def_stackaddr((m).t,s)
433
#define nrt_task_def_group(m,g)       task_def_group((m).t,g)
434
#define nrt_task_def_usemath(m)       task_def_usemath((m).t)
435
#define nrt_task_def_system(m)        task_def_system((m).t)
436
#define nrt_task_def_nokill(m)        task_def_nokill((m).t)
437
#define nrt_task_def_ctrl_jet(m)      task_def_ctrl_jet((m).t)
438
#define nrt_task_def_joinable(m)      task_def_joinable((m).t)
439
#define nrt_task_def_unjoinable(m)    task_def_unjoinable((m).t)
440
#define nrt_task_def_weight(m,w)      (m).weight = (w)
441
#define nrt_task_def_slice(m,s)       (m).slice = (s)
442
#define nrt_task_def_save_arrivals(m) (m).arrivals    = SAVE_ARRIVALS
443
#define nrt_task_def_skip_arrivals(m) (m).arrivals    = SKIP_ARRIVALS
444
#define nrt_task_def_policy(m,p)      (m).policy = (p)
445
#define nrt_task_def_inherit(m,i)     (m).inherit = (i)
446
#define nrt_task_def_trace(m)         task_def_trace((m).t)
447
#define nrt_task_def_notrace(m)       task_def_notrace((m).t)
448
 
449
 
450
/* -----------------------------------------------------------------------
451
   JOB_TASK_MODEL: Job Task
452
   ----------------------------------------------------------------------- */
453
 
454
/*  This model implements a Job with an optional period and a starting
455
    deadline (for the first activation).
456
 
457
    A Job task can raise a XDEADLINE_MISS exception;
458
    if the flag noraiseexc is != 0, the exception is not raised.
459
 
460
    It represent a SINGLE job activation. Typically, a task with this
461
    model NEVER call a task_sleep or task_endcycle. Why? because it is
462
    a single activation.
463
 
464
    In fact, this model is normally used with aperiodic
465
    servers: the aperiodic server insert a guest task in another level
466
    with that model; then, when the current activation is ended (e.g. a
467
    task_sleep() is called) the level, into the XXX_task_sleep, calls
468
    the XXX_guest_end to terminate the actual activation.
469
 
470
    Note that there is no capacity control on this model.
471
    Note that the task that accept this task DOESN'T reactivate the
472
    task after a period... There is NOT a guest_endcycle defined
473
    for this model...
474
 
475
    The default model set noraiseexc and period to 0, and accept a deadline
476
*/
477
 
691 anton 478
 
2 pj 479
typedef struct {
480
  TASK_MODEL t;
481
  TIME period;
482
  struct timespec deadline;
483
  int noraiseexc;
484
} JOB_TASK_MODEL;
485
 
486
#define job_task_default_model(m,dl)                     \
487
                  task_default_model((m).t,JOB_PCLASS),  \
488
                  (m).period = 0,                        \
489
                  TIMESPEC_ASSIGN(&((m).deadline),&(dl)),\
490
                  (m).noraiseexc = 0
491
#define job_task_def_level(m,l)     task_def_level((m).t,l)
492
#define job_task_def_arg(m,a)       task_def_arg((m).t,a)
493
#define job_task_def_stack(m,s)     task_def_stack((m).t,s)
494
#define job_task_def_stackaddr(m,s) task_def_stackaddr((m).t,s)
495
#define job_task_def_group(m,g)     task_def_group((m).t,g)
496
#define job_task_def_usemath(m)     task_def_usemath((m).t)
497
#define job_task_def_system(m)      task_def_system((m).t)
498
#define job_task_def_nokill(m)      task_def_nokill((m).t)
499
#define job_task_def_ctrl_jet(m)    task_def_ctrl_jet((m).t)
500
#define job_task_def_period(m,per)  (m).period = (per)
501
#define job_task_def_deadline(m,dl) TIMESPEC_ASSIGN(&((m).deadline),&(dl))
502
#define job_task_def_noexc(m)       (m).noraiseexc = 1
503
#define job_task_def_yesexc(m)      (m).noraiseexc = 0
504
#define job_task_def_joinable(m)    task_def_joinable((m).t)
505
#define job_task_def_unjoinable(m)  task_def_unjoinable((m).t)
506
#define job_task_def_trace(m)       task_def_trace((m).t)
507
#define job_task_def_notrace(m)     task_def_notrace((m).t)
508
 
691 anton 509
 
510
/* -----------------------------------------------------------------------
511
   ELASTIC_TASK_MODEL: Elastic Task
512
   ----------------------------------------------------------------------- */
513
 
514
/*  This model implements an elastic task. An elastic task is described by
515
    the following attributes:
516
 
517
    Tmin   - The nominal (minimum) period. This is the period the task
518
             wants to execute at whenever there are enough resources.
519
 
520
    Tmax   - The maximum tolerable period. The elastic model will never
521
             force the task to execute at a longer period than this.
522
 
523
    C      - The declared worst-case execution time. By default,
524
             an exception will be raised if the wcet is violated.
525
 
526
    E      - The elasticity coefficient. A coefficient of 0 means
527
             that its utilization cannot be changed by the elastic
528
             algorithm. A large number means that the task is very
529
             elastic. The default value is 0.
530
 
531
    beta  -  This parameter determines how the elastic scaling is done.
532
             PERIOD_SCALING means that the period will be changed, while
533
             WCET_SCALING means that the wcet will be changed. The
534
             default is PERIOD_SCALING.
535
*/
536
 
537
 
671 giacomo 538
/* Elastic Task */
2 pj 539
 
691 anton 540
#define PERIOD_SCALING 0   
541
#define WCET_SCALING   1
542
 
543
 
671 giacomo 544
typedef struct {
545
  TASK_MODEL t;
546
  TIME Tmin;
547
  TIME Tmax;
691 anton 548
  TIME C;
549
  int  E;
671 giacomo 550
  int  beta;
551
  int  arrivals;
552
} ELASTIC_TASK_MODEL;
553
 
672 giacomo 554
#define elastic_task_default_model(m)                        \
671 giacomo 555
                  task_default_model((m).t,ELASTIC_PCLASS),  \
556
                  (m).Tmin = 0,                        \
557
                  (m).Tmax = 0,                        \
691 anton 558
                  (m).C = 0,                           \
559
                  (m).E = 0,                           \
560
                  (m).beta = PERIOD_SCALING,           \
671 giacomo 561
                  (m).arrivals = SKIP_ARRIVALS
562
#define elastic_task_def_level(m,l)     task_def_level((m).t,l)
563
#define elastic_task_def_arg(m,a)       task_def_arg((m).t,a)
564
#define elastic_task_def_stack(m,s)     task_def_stack((m).t,s)
565
#define elastic_task_def_stackaddr(m,s) task_def_stackaddr((m).t,s)
566
#define elastic_task_def_group(m,g)     task_def_group((m).t,g)
567
#define elastic_task_def_usemath(m)     task_def_usemath((m).t)
568
#define elastic_task_def_system(m)      task_def_system((m).t)
569
#define elastic_task_def_nokill(m)      task_def_nokill((m).t)
570
#define elastic_task_def_ctrl_jet(m)    task_def_ctrl_jet((m).t)
677 giacomo 571
#define elastic_task_def_period(m,min,max)  (m).Tmin = (min),\
572
                                              (m).Tmax = (max)
691 anton 573
#define elastic_task_def_wcet(m,w)      (m).C = (w)
739 giacomo 574
#define elastic_task_def_param(m,e,b)   (m).E = (e), \
677 giacomo 575
                                        (m).beta = (b)
671 giacomo 576
#define elastic_task_def_save_arrivals(m) (m).arrivals    = SAVE_ARRIVALS
577
#define elastic_task_def_skip_arrivals(m) (m).arrivals    = SKIP_ARRIVALS
578
#define elastic_task_def_joinable(m)    task_def_joinable((m).t)
579
#define elastic_task_def_unjoinable(m)  task_def_unjoinable((m).t)
580
#define elastic_task_def_trace(m)       task_def_trace((m).t)
581
#define elastic_task_def_notrace(m)     task_def_notrace((m).t)
2 pj 582
 
583
 
584
 
585
 
586
 
587
 
588
 
589
 
590
 
671 giacomo 591
 
2 pj 592
/* -----------------------------------------------------------------------
593
   -----------------------------------------------------------------------
594
   -----------------------------------------------------------------------
595
   -----------------------------------------------------------------------
596
   RESOURCE MODELS
597
   -----------------------------------------------------------------------
598
   -----------------------------------------------------------------------
599
   -----------------------------------------------------------------------
600
   ----------------------------------------------------------------------- */
601
 
602
 
603
 
604
 
605
 
606
 
607
 
608
/* -----------------------------------------------------------------------
609
   RTYPE values
610
   ----------------------------------------------------------------------- */
611
 
612
/* These are the values for the rtype field of a resource descriptor.
613
   The value in the rtype field is used to distinguish the interface really
614
   implemented by the resource object.
615
 
616
   For example, a mutex resource descriptor "inherit" from a resource_des
617
   and implements also all the mutex functions as "virtual", so a type field
618
   is added to the resource descriptor to distinguish witch interface is
619
   really added. +*/
620
 
621
#define DEFAULT_RTYPE     0  /*+ no fields added to resource_des +*/
622
#define MUTEX_RTYPE       1  /*+ the structure implements a mutex
623
                                 protocol, so a cast to mutex_resource_des
624
                                 is legal +*/
625
 
626
 
627
 
628
/* -----------------------------------------------------------------------
629
   RES_MODEL - the base struct
630
   ----------------------------------------------------------------------- */
631
 
632
/*+
633
 RES_MODEL
634
 
635
 This structure is used like the TASK_MODEL.
636
 It groups together a set of optional parameters describing
637
 the resource model used by a task.
638
 
639
 It contains only a field; the others are model-dependent.
640
+*/
641
 
642
typedef struct {
38 pj 643
  int rclass;        /* protocol */
644
  RLEVEL level;          /* level */
2 pj 645
} RES_MODEL;
646
 
38 pj 647
#define res_default_model(r, p)      (r).rclass = (p), (r).level = 0
648
#define res_def_level(r,l)           (r).level = (l)
2 pj 649
 
650
 
651
 
652
/* -----------------------------------------------------------------------
653
   RCLASS values
654
   ----------------------------------------------------------------------- */
655
 
656
/*+ These are the values for the type field in the resource models
657
    a resource level l that accept a resource model with rclass r
658
    accept also the alias pclass (p | l)
659
    => the LSByte MUST be 0 (256 levels maximum) (as for PCLASS!!!) +*/
660
 
661
#define PC_RCLASS    0x0100
662
#define SRP_RCLASS   0x0200
663
#define SRP2_RCLASS  0x0300
664
 
665
#define BDEDF_RCLASS   0x0400
666
#define BDPSCAN_RCLASS 0x0500
667
 
668
/* -----------------------------------------------------------------------
669
   PC_RES_MODEL: BlockDevice EDF resource model
670
   ----------------------------------------------------------------------- */
671
 
672
typedef struct {
673
  RES_MODEL r;
674
  TIME dl;
675
} BDEDF_RES_MODEL;
676
 
677
#define BDEDF_res_default_model(res) \
678
  res_default_model((res).r,BDEDF_RCLASS); \
679
  (res).dl=0     
680
#define BDEDF_res_def_level(res,l)  res_def_level((res).r,l)     
681
#define BDEDF_res_def_dl(res,reldl)  (res).dl=reldl
682
 
683
/* -----------------------------------------------------------------------
684
   PC_RES_MODEL: BlockDevice PSCAN resource model
685
   ----------------------------------------------------------------------- */
686
 
687
typedef struct {
688
  RES_MODEL r;
689
  int priority;
690
} BDPSCAN_RES_MODEL;
691
 
692
#define BDPSCAN_res_default_model(res) \
693
  res_default_model((res).r,BDPSCAN_RCLASS); \
694
  (res).priority=255     
695
#define BDPSCAN_res_def_level(res,l)  res_def_level((res).r,l)     
696
#define BDPSCAN_res_def_priority(res,pri)  (res).priority=pri
697
 
698
/* -----------------------------------------------------------------------
699
   PC_RES_MODEL: Priority ceiling resource model
700
   ----------------------------------------------------------------------- */
701
 
702
/* the tasks created without using this resource models are assumed to have
703
   priority = MAX_DWORD (the lowest). */
704
 
705
typedef struct {
706
  RES_MODEL r;
707
  DWORD priority;
708
} PC_RES_MODEL;
709
 
710
#define PC_res_default_model(res, prio) \
711
                                 res_default_model((res).r, PC_RCLASS); \
712
                                 (res).priority = (prio)
713
#define PC_res_def_level(res,l)  res_def_level(res,l)
714
 
715
/* -----------------------------------------------------------------------
716
   SRP_RES_MODEL: Stack Resource Policy resource model
717
   ----------------------------------------------------------------------- */
718
 
719
/* the tasks created without using this resource model are not allowed to
720
   lock any SRP mutex. if two of this models are passed to the task_create,
721
   one of them is chosen, in a nondeterministic way, so use only one of
722
   this resource model per task!!!
723
 
724
   The First SRP version uses another resource model that is embedded into
725
   the mutex structure. refer to kernel/modules/srp.c. this second resource
726
   model has the SRP2_RCLASS
727
*/
728
 
729
typedef struct {
730
  RES_MODEL r;
731
  DWORD preempt;  /* the preemption level of a task */
732
} SRP_RES_MODEL;
733
 
734
#define SRP_res_default_model(res, pre) \
735
                                 res_default_model((res).r, SRP_RCLASS); \
736
                                 (res).preempt = (pre)
737
#define SRP_res_def_level(res,l) res_def_level(res,l)
738
 
739
 
740
/* -----------------------------------------------------------------------
741
   MUTEX Attributes
742
   ----------------------------------------------------------------------- */
743
 
744
/*+
745
  MUTEX ATTRIBUTES
746
 
747
  A mutexattr object act as the task model for the tasks in the system:
748
  It specifies the particular options used by a protocol.
749
 
750
  From this basic attribute object many other objects can be derived
751
  as done for the TASK_MODEL. These objects are used to initialize a mutex
752
  with a specified protocol.
753
+*/
754
typedef struct {
755
  int mclass;      /* the protocol type... */
756
} mutexattr_t;
757
 
758
#define mutexattr_default(a, c)  (a).mclass = (c)
759
 
760
 
761
/* -----------------------------------------------------------------------
762
   MCLASS values
763
   ----------------------------------------------------------------------- */
764
 
765
/*+ These are the value for the mclass field;
766
    a mutex level l that accept a task model with mclass m
767
    accept also the alias mclass (m | l)
768
    => the LSByte MUST be 0 (256 levels maximum) +*/
769
 
770
#define NPP_MCLASS      0x0100
771
#define PI_MCLASS       0x0200
772
#define PC_MCLASS       0x0300
773
#define SRP_MCLASS      0x0400
774
#define NOP_MCLASS      0x0500
775
#define NOPM_MCLASS     0x0600
796 trimarchi 776
#define PISTAR_MCLASS   0x0700
2 pj 777
 
778
/* -----------------------------------------------------------------------
779
   PI_mutexattr_t: Priority Inheritance Mutex Attribute
780
   ----------------------------------------------------------------------- */
781
 
782
typedef mutexattr_t PI_mutexattr_t;
783
 
784
#define PI_MUTEXATTR_INITIALIZER {PI_MCLASS}
785
#define PI_mutexattr_default(a)  mutexattr_default(a, PI_MCLASS)
786
 
787
/* -----------------------------------------------------------------------
796 trimarchi 788
   PISTAR_mutexattr_t: Priority Inheritance Mutex Attribute for server
789
   ----------------------------------------------------------------------- */
790
 
808 trimarchi 791
typedef mutexattr_t PISTAR_mutexattr_t;
796 trimarchi 792
 
793
#define PISTAR_MUTEXATTR_INITIALIZER {PISTAR_MCLASS}
808 trimarchi 794
#define PISTAR_mutexattr_default(a)  mutexattr_default(a, PISTAR_MCLASS); 
796 trimarchi 795
 
796
/* -----------------------------------------------------------------------
2 pj 797
   NPP_mutexattr_t: Non Preemptive Protocol Mutex Attribute
798
   ----------------------------------------------------------------------- */
799
 
800
typedef mutexattr_t NPP_mutexattr_t;
801
 
802
#define NPP_MUUEXATTR_INITIALIZER {NPP_MCLASS}
803
#define NPP_mutexattr_default(a)  mutexattr_default(a, NPP_MCLASS)
804
 
805
/* -----------------------------------------------------------------------
806
   PC_mutexattr_t: Priority Ceiling Mutex Attribute
807
   ----------------------------------------------------------------------- */
808
 
809
typedef struct {
810
  mutexattr_t a;
811
  DWORD ceiling;
812
} PC_mutexattr_t;
813
 
814
#define PC_MUTEXATTR_INITIALIZER {{PC_MCLASS},MAX_DWORD}
815
#define PC_mutexattr_default(at,c)  mutexattr_default((at).a, PC_MCLASS); \
816
                                    (at).ceiling = (c)
817
 
818
/* -----------------------------------------------------------------------
819
   SRP_mutexattr_t: Stack Resource Policy Mutex Attribute
820
   ----------------------------------------------------------------------- */
821
 
822
typedef mutexattr_t SRP_mutexattr_t;
823
 
824
#define SRP_MUTEXATTR_INITIALIZER {SRP_MCLASS}
825
#define SRP_mutexattr_default(a)  mutexattr_default(a, SRP_MCLASS)
826
 
827
/* -----------------------------------------------------------------------
828
   NOP_mutexattr_t: No Protocol Mutex Attribute
829
   ----------------------------------------------------------------------- */
830
 
831
typedef mutexattr_t NOP_mutexattr_t;
832
 
833
#define NOP_MUTEXATTR_INITIALIZER {NOP_MCLASS}
834
#define NOP_mutexattr_default(a)  mutexattr_default(a, NOP_MCLASS)
835
 
836
/* -----------------------------------------------------------------------
837
   NOPM_mutexattr_t: No Protocol Multiple lock Mutex Attribute
838
   ----------------------------------------------------------------------- */
839
 
840
typedef mutexattr_t NOPM_mutexattr_t;
841
 
842
#define NOPM_MUTEXATTR_INITIALIZER {NOPM_MCLASS}
843
#define NOPM_mutexattr_default(a)  mutexattr_default(a, NOPM_MCLASS)
844
 
79 pj 845
__END_DECLS
2 pj 846
#endif /* __MODEL_H__ */
847