[ac7d5ef0] | 1 | /* |
---|
| 2 | * Rate Monotonic Manager |
---|
| 3 | * |
---|
| 4 | * |
---|
| 5 | * COPYRIGHT (c) 1989, 1990, 1991, 1992, 1993, 1994. |
---|
| 6 | * On-Line Applications Research Corporation (OAR). |
---|
| 7 | * All rights assigned to U.S. Government, 1994. |
---|
| 8 | * |
---|
| 9 | * This material may be reproduced by or for the U.S. Government pursuant |
---|
| 10 | * to the copyright license under the clause at DFARS 252.227-7013. This |
---|
| 11 | * notice must appear in all copies of this file and its derivatives. |
---|
| 12 | * |
---|
| 13 | * $Id$ |
---|
| 14 | */ |
---|
| 15 | |
---|
| 16 | #include <rtems/system.h> |
---|
[3a4ae6c] | 17 | #include <rtems/rtems/status.h> |
---|
| 18 | #include <rtems/rtems/support.h> |
---|
[5e9b32b] | 19 | #include <rtems/score/isr.h> |
---|
| 20 | #include <rtems/score/object.h> |
---|
[3a4ae6c] | 21 | #include <rtems/rtems/ratemon.h> |
---|
[5e9b32b] | 22 | #include <rtems/score/thread.h> |
---|
[ac7d5ef0] | 23 | |
---|
| 24 | /*PAGE |
---|
| 25 | * |
---|
| 26 | * _Rate_monotonic_Manager_initialization |
---|
| 27 | * |
---|
| 28 | * This routine initializes all Rate Monotonic Manager related |
---|
| 29 | * data structures. |
---|
| 30 | * |
---|
| 31 | * Input parameters: |
---|
| 32 | * maximum_periods - number of periods timers to initialize |
---|
| 33 | * |
---|
| 34 | * Output parameters: NONE |
---|
| 35 | * |
---|
| 36 | * NOTE: The Rate Monotonic Manager is built on top of the Watchdog |
---|
| 37 | * Handler. |
---|
| 38 | */ |
---|
| 39 | |
---|
| 40 | void _Rate_monotonic_Manager_initialization( |
---|
| 41 | unsigned32 maximum_periods |
---|
| 42 | ) |
---|
| 43 | { |
---|
| 44 | _Objects_Initialize_information( |
---|
[3235ad9] | 45 | &_Rate_monotonic_Information, |
---|
| 46 | OBJECTS_RTEMS_PERIODS, |
---|
| 47 | FALSE, |
---|
| 48 | maximum_periods, |
---|
| 49 | sizeof( Rate_monotonic_Control ), |
---|
| 50 | FALSE, |
---|
[5250ff39] | 51 | RTEMS_MAXIMUM_NAME_LENGTH, |
---|
| 52 | FALSE |
---|
[ac7d5ef0] | 53 | ); |
---|
| 54 | } |
---|
| 55 | |
---|
| 56 | /*PAGE |
---|
| 57 | * |
---|
| 58 | * rtems_rate_monotonic_create |
---|
| 59 | * |
---|
| 60 | * This directive creates a rate monotonic timer and performs |
---|
| 61 | * some initialization. |
---|
| 62 | * |
---|
| 63 | * Input parameters: |
---|
| 64 | * name - name of period |
---|
| 65 | * id - pointer to rate monotonic id |
---|
| 66 | * |
---|
| 67 | * Output parameters: |
---|
| 68 | * id - rate monotonic id |
---|
| 69 | * RTEMS_SUCCESSFUL - if successful |
---|
| 70 | * error code - if unsuccessful |
---|
| 71 | */ |
---|
| 72 | |
---|
| 73 | rtems_status_code rtems_rate_monotonic_create( |
---|
[3235ad9] | 74 | rtems_name name, |
---|
[ac7d5ef0] | 75 | Objects_Id *id |
---|
| 76 | ) |
---|
| 77 | { |
---|
| 78 | Rate_monotonic_Control *the_period; |
---|
| 79 | |
---|
[3235ad9] | 80 | if ( !rtems_is_name_valid( name ) ) |
---|
[3a4ae6c] | 81 | return RTEMS_INVALID_NAME; |
---|
[ac7d5ef0] | 82 | |
---|
| 83 | _Thread_Disable_dispatch(); /* to prevent deletion */ |
---|
| 84 | |
---|
| 85 | the_period = _Rate_monotonic_Allocate(); |
---|
| 86 | |
---|
| 87 | if ( !the_period ) { |
---|
| 88 | _Thread_Enable_dispatch(); |
---|
[3a4ae6c] | 89 | return RTEMS_TOO_MANY; |
---|
[ac7d5ef0] | 90 | } |
---|
| 91 | |
---|
| 92 | the_period->owner = _Thread_Executing; |
---|
| 93 | the_period->state = RATE_MONOTONIC_INACTIVE; |
---|
| 94 | |
---|
[3235ad9] | 95 | _Objects_Open( &_Rate_monotonic_Information, &the_period->Object, &name ); |
---|
[ac7d5ef0] | 96 | |
---|
| 97 | *id = the_period->Object.id; |
---|
| 98 | _Thread_Enable_dispatch(); |
---|
[3a4ae6c] | 99 | return RTEMS_SUCCESSFUL; |
---|
[ac7d5ef0] | 100 | } |
---|
| 101 | |
---|
| 102 | /*PAGE |
---|
| 103 | * |
---|
| 104 | * rtems_rate_monotonic_ident |
---|
| 105 | * |
---|
| 106 | * This directive returns the system ID associated with |
---|
| 107 | * the rate monotonic period name. |
---|
| 108 | * |
---|
| 109 | * Input parameters: |
---|
| 110 | * name - user defined period name |
---|
| 111 | * id - pointer to period id |
---|
| 112 | * |
---|
| 113 | * Output parameters: |
---|
| 114 | * *id - region id |
---|
| 115 | * RTEMS_SUCCESSFUL - if successful |
---|
| 116 | * error code - if unsuccessful |
---|
| 117 | */ |
---|
| 118 | |
---|
| 119 | rtems_status_code rtems_rate_monotonic_ident( |
---|
[3235ad9] | 120 | rtems_name name, |
---|
[ac7d5ef0] | 121 | Objects_Id *id |
---|
| 122 | ) |
---|
| 123 | { |
---|
[3a4ae6c] | 124 | Objects_Name_to_id_errors status; |
---|
| 125 | |
---|
| 126 | status = _Objects_Name_to_id( |
---|
[ac7d5ef0] | 127 | &_Rate_monotonic_Information, |
---|
[3235ad9] | 128 | &name, |
---|
[3a4ae6c] | 129 | OBJECTS_SEARCH_LOCAL_NODE, |
---|
[ac7d5ef0] | 130 | id |
---|
| 131 | ); |
---|
[3a4ae6c] | 132 | |
---|
| 133 | return _Status_Object_name_errors_to_status[ status ]; |
---|
[ac7d5ef0] | 134 | } |
---|
| 135 | |
---|
| 136 | /*PAGE |
---|
| 137 | * |
---|
| 138 | * rtems_rate_monotonic_cancel |
---|
| 139 | * |
---|
| 140 | * This directive allows a thread to cancel a rate monotonic timer. |
---|
| 141 | * |
---|
| 142 | * Input parameters: |
---|
| 143 | * id - rate monotonic id |
---|
| 144 | * |
---|
| 145 | * Output parameters: |
---|
| 146 | * RTEMS_SUCCESSFUL - if successful and caller is not the owning thread |
---|
| 147 | * error code - if unsuccessful |
---|
| 148 | */ |
---|
| 149 | |
---|
| 150 | rtems_status_code rtems_rate_monotonic_cancel( |
---|
| 151 | Objects_Id id |
---|
| 152 | ) |
---|
| 153 | { |
---|
| 154 | Rate_monotonic_Control *the_period; |
---|
| 155 | Objects_Locations location; |
---|
| 156 | |
---|
| 157 | the_period = _Rate_monotonic_Get( id, &location ); |
---|
| 158 | switch ( location ) { |
---|
| 159 | case OBJECTS_ERROR: |
---|
[3a4ae6c] | 160 | return RTEMS_INVALID_ID; |
---|
| 161 | case OBJECTS_REMOTE: |
---|
| 162 | return RTEMS_INTERNAL_ERROR; /* should never return this */ |
---|
[ac7d5ef0] | 163 | case OBJECTS_LOCAL: |
---|
| 164 | if ( !_Thread_Is_executing( the_period->owner ) ) { |
---|
| 165 | _Thread_Enable_dispatch(); |
---|
[3a4ae6c] | 166 | return RTEMS_NOT_OWNER_OF_RESOURCE; |
---|
[ac7d5ef0] | 167 | } |
---|
| 168 | (void) _Watchdog_Remove( &the_period->Timer ); |
---|
| 169 | the_period->state = RATE_MONOTONIC_INACTIVE; |
---|
| 170 | _Thread_Enable_dispatch(); |
---|
[3a4ae6c] | 171 | return RTEMS_SUCCESSFUL; |
---|
[ac7d5ef0] | 172 | } |
---|
| 173 | |
---|
[3a4ae6c] | 174 | return RTEMS_INTERNAL_ERROR; /* unreached - only to remove warnings */ |
---|
[ac7d5ef0] | 175 | } |
---|
| 176 | |
---|
| 177 | /*PAGE |
---|
| 178 | * |
---|
| 179 | * rtems_rate_monotonic_delete |
---|
| 180 | * |
---|
| 181 | * This directive allows a thread to delete a rate monotonic timer. |
---|
| 182 | * |
---|
| 183 | * Input parameters: |
---|
| 184 | * id - rate monotonic id |
---|
| 185 | * |
---|
| 186 | * Output parameters: |
---|
| 187 | * RTEMS_SUCCESSFUL - if successful |
---|
| 188 | * error code - if unsuccessful |
---|
| 189 | */ |
---|
| 190 | |
---|
| 191 | rtems_status_code rtems_rate_monotonic_delete( |
---|
| 192 | Objects_Id id |
---|
| 193 | ) |
---|
| 194 | { |
---|
| 195 | Rate_monotonic_Control *the_period; |
---|
| 196 | Objects_Locations location; |
---|
| 197 | |
---|
| 198 | the_period = _Rate_monotonic_Get( id, &location ); |
---|
| 199 | switch ( location ) { |
---|
| 200 | case OBJECTS_ERROR: |
---|
[3a4ae6c] | 201 | return RTEMS_INVALID_ID; |
---|
[ac7d5ef0] | 202 | case OBJECTS_REMOTE: /* should never return this */ |
---|
[3a4ae6c] | 203 | return RTEMS_INTERNAL_ERROR; |
---|
[ac7d5ef0] | 204 | case OBJECTS_LOCAL: |
---|
| 205 | _Objects_Close( &_Rate_monotonic_Information, &the_period->Object ); |
---|
| 206 | (void) _Watchdog_Remove( &the_period->Timer ); |
---|
| 207 | the_period->state = RATE_MONOTONIC_INACTIVE; |
---|
| 208 | _Rate_monotonic_Free( the_period ); |
---|
| 209 | _Thread_Enable_dispatch(); |
---|
[3a4ae6c] | 210 | return RTEMS_SUCCESSFUL; |
---|
[ac7d5ef0] | 211 | } |
---|
| 212 | |
---|
[3a4ae6c] | 213 | return RTEMS_INTERNAL_ERROR; /* unreached - only to remove warnings */ |
---|
[ac7d5ef0] | 214 | } |
---|
| 215 | |
---|
[113ef9fc] | 216 | /*PAGE |
---|
| 217 | * |
---|
| 218 | * rtems_rate_monotonic_get_status |
---|
| 219 | * |
---|
| 220 | * This directive allows a thread to obtain status information on a |
---|
| 221 | * period. |
---|
| 222 | * |
---|
| 223 | * Input parameters: |
---|
| 224 | * id - rate monotonic id |
---|
| 225 | * status - pointer to status control block |
---|
| 226 | * |
---|
| 227 | * Output parameters: |
---|
| 228 | * RTEMS_SUCCESSFUL - if successful |
---|
| 229 | * error code - if unsuccessful |
---|
| 230 | * |
---|
| 231 | */ |
---|
| 232 | |
---|
| 233 | rtems_status_code rtems_rate_monotonic_get_status( |
---|
| 234 | Objects_Id id, |
---|
| 235 | rtems_rate_monotonic_period_status *status |
---|
| 236 | ) |
---|
| 237 | { |
---|
| 238 | Objects_Locations location; |
---|
| 239 | Rate_monotonic_Control *the_period; |
---|
| 240 | |
---|
| 241 | the_period = _Rate_monotonic_Get( id, &location ); |
---|
| 242 | switch ( location ) { |
---|
| 243 | case OBJECTS_ERROR: |
---|
| 244 | return RTEMS_INVALID_ID; |
---|
| 245 | case OBJECTS_REMOTE: /* should never return this */ |
---|
| 246 | return RTEMS_INTERNAL_ERROR; |
---|
| 247 | case OBJECTS_LOCAL: |
---|
| 248 | status->state = the_period->state; |
---|
| 249 | |
---|
| 250 | if ( status->state == RATE_MONOTONIC_INACTIVE ) { |
---|
| 251 | status->ticks_since_last_period = 0; |
---|
| 252 | status->ticks_executed_since_last_period = 0; |
---|
| 253 | } else { |
---|
| 254 | status->ticks_since_last_period = |
---|
| 255 | _Watchdog_Ticks_since_boot - the_period->time_at_period; |
---|
| 256 | |
---|
| 257 | status->ticks_executed_since_last_period = |
---|
| 258 | the_period->owner->ticks_executed - |
---|
| 259 | the_period->owner_ticks_executed_at_period; |
---|
| 260 | } |
---|
| 261 | |
---|
| 262 | _Thread_Enable_dispatch(); |
---|
| 263 | return RTEMS_SUCCESSFUL; |
---|
| 264 | } |
---|
| 265 | |
---|
| 266 | return RTEMS_INTERNAL_ERROR; /* unreached - only to remove warnings */ |
---|
| 267 | } |
---|
| 268 | |
---|
| 269 | |
---|
[ac7d5ef0] | 270 | /*PAGE |
---|
| 271 | * |
---|
| 272 | * rtems_rate_monotonic_period |
---|
| 273 | * |
---|
| 274 | * This directive allows a thread to manipulate a rate monotonic timer. |
---|
| 275 | * |
---|
| 276 | * Input parameters: |
---|
| 277 | * id - rate monotonic id |
---|
| 278 | * length - length of period (in ticks) |
---|
| 279 | * |
---|
| 280 | * Output parameters: |
---|
| 281 | * RTEMS_SUCCESSFUL - if successful |
---|
| 282 | * error code - if unsuccessful |
---|
| 283 | */ |
---|
| 284 | |
---|
| 285 | rtems_status_code rtems_rate_monotonic_period( |
---|
| 286 | Objects_Id id, |
---|
[3a4ae6c] | 287 | rtems_interval length |
---|
[ac7d5ef0] | 288 | ) |
---|
| 289 | { |
---|
[113ef9fc] | 290 | Rate_monotonic_Control *the_period; |
---|
| 291 | Objects_Locations location; |
---|
| 292 | rtems_status_code return_value; |
---|
| 293 | rtems_rate_monotonic_period_states local_state; |
---|
| 294 | ISR_Level level; |
---|
[ac7d5ef0] | 295 | |
---|
| 296 | the_period = _Rate_monotonic_Get( id, &location ); |
---|
| 297 | switch ( location ) { |
---|
| 298 | case OBJECTS_ERROR: |
---|
[3a4ae6c] | 299 | return RTEMS_INVALID_ID; |
---|
[ac7d5ef0] | 300 | case OBJECTS_REMOTE: /* should never return this */ |
---|
[3a4ae6c] | 301 | return RTEMS_INTERNAL_ERROR; |
---|
[ac7d5ef0] | 302 | case OBJECTS_LOCAL: |
---|
| 303 | if ( !_Thread_Is_executing( the_period->owner ) ) { |
---|
| 304 | _Thread_Enable_dispatch(); |
---|
[3a4ae6c] | 305 | return RTEMS_NOT_OWNER_OF_RESOURCE; |
---|
[ac7d5ef0] | 306 | } |
---|
| 307 | |
---|
| 308 | if ( length == RTEMS_PERIOD_STATUS ) { |
---|
| 309 | switch ( the_period->state ) { |
---|
| 310 | case RATE_MONOTONIC_INACTIVE: |
---|
| 311 | return_value = RTEMS_NOT_DEFINED; |
---|
| 312 | break; |
---|
| 313 | case RATE_MONOTONIC_ACTIVE: |
---|
| 314 | return_value = RTEMS_SUCCESSFUL; |
---|
| 315 | break; |
---|
| 316 | case RATE_MONOTONIC_EXPIRED: |
---|
| 317 | return_value = RTEMS_TIMEOUT; |
---|
| 318 | break; |
---|
| 319 | default: /* unreached -- only to remove warnings */ |
---|
| 320 | return_value = RTEMS_INTERNAL_ERROR; |
---|
| 321 | break; |
---|
| 322 | } |
---|
| 323 | _Thread_Enable_dispatch(); |
---|
| 324 | return( return_value ); |
---|
| 325 | } |
---|
| 326 | |
---|
[11ab74e] | 327 | _ISR_Disable( level ); |
---|
[ac7d5ef0] | 328 | switch ( the_period->state ) { |
---|
| 329 | case RATE_MONOTONIC_INACTIVE: |
---|
[11ab74e] | 330 | _ISR_Enable( level ); |
---|
[ac7d5ef0] | 331 | the_period->state = RATE_MONOTONIC_ACTIVE; |
---|
| 332 | _Watchdog_Initialize( |
---|
| 333 | &the_period->Timer, |
---|
| 334 | _Rate_monotonic_Timeout, |
---|
| 335 | id, |
---|
| 336 | NULL |
---|
| 337 | ); |
---|
[113ef9fc] | 338 | |
---|
| 339 | the_period->owner_ticks_executed_at_period = |
---|
| 340 | _Thread_Executing->ticks_executed; |
---|
| 341 | |
---|
| 342 | the_period->time_at_period = _Watchdog_Ticks_since_boot; |
---|
| 343 | |
---|
[8d0b7d96] | 344 | _Watchdog_Insert_ticks( &the_period->Timer, length ); |
---|
[ac7d5ef0] | 345 | _Thread_Enable_dispatch(); |
---|
[3a4ae6c] | 346 | return RTEMS_SUCCESSFUL; |
---|
[ac7d5ef0] | 347 | |
---|
| 348 | case RATE_MONOTONIC_ACTIVE: |
---|
[11ab74e] | 349 | /* |
---|
| 350 | * This tells the _Rate_monotonic_Timeout that this task is |
---|
| 351 | * in the process of blocking on the period. |
---|
| 352 | */ |
---|
| 353 | |
---|
| 354 | the_period->state = RATE_MONOTONIC_OWNER_IS_BLOCKING; |
---|
| 355 | _ISR_Enable( level ); |
---|
| 356 | |
---|
| 357 | _Thread_Executing->Wait.id = the_period->Object.id; |
---|
| 358 | _Thread_Set_state( _Thread_Executing, STATES_WAITING_FOR_PERIOD ); |
---|
| 359 | |
---|
| 360 | /* |
---|
| 361 | * Did the watchdog timer expire while we were actually blocking |
---|
| 362 | * on it? |
---|
| 363 | */ |
---|
| 364 | |
---|
| 365 | _ISR_Disable( level ); |
---|
| 366 | local_state = the_period->state; |
---|
| 367 | the_period->state = RATE_MONOTONIC_ACTIVE; |
---|
| 368 | _ISR_Enable( level ); |
---|
| 369 | |
---|
| 370 | /* |
---|
| 371 | * If it did, then we want to unblock ourself and continue as |
---|
| 372 | * if nothing happen. The period was reset in the timeout routine. |
---|
| 373 | */ |
---|
| 374 | |
---|
| 375 | if ( local_state == RATE_MONOTONIC_EXPIRED_WHILE_BLOCKING ) |
---|
| 376 | _Thread_Clear_state( _Thread_Executing, STATES_WAITING_FOR_PERIOD ); |
---|
| 377 | |
---|
| 378 | _Thread_Enable_dispatch(); |
---|
| 379 | return RTEMS_SUCCESSFUL; |
---|
| 380 | break; |
---|
| 381 | |
---|
[ac7d5ef0] | 382 | case RATE_MONOTONIC_EXPIRED: |
---|
[11ab74e] | 383 | _ISR_Enable( level ); |
---|
[ac7d5ef0] | 384 | the_period->state = RATE_MONOTONIC_ACTIVE; |
---|
[113ef9fc] | 385 | the_period->owner_ticks_executed_at_period = |
---|
| 386 | _Thread_Executing->ticks_executed; |
---|
| 387 | the_period->time_at_period = _Watchdog_Ticks_since_boot; |
---|
| 388 | |
---|
[8d0b7d96] | 389 | _Watchdog_Insert_ticks( &the_period->Timer, length ); |
---|
[ac7d5ef0] | 390 | _Thread_Enable_dispatch(); |
---|
[3a4ae6c] | 391 | return RTEMS_TIMEOUT; |
---|
[11ab74e] | 392 | |
---|
| 393 | case RATE_MONOTONIC_OWNER_IS_BLOCKING: |
---|
| 394 | case RATE_MONOTONIC_EXPIRED_WHILE_BLOCKING: |
---|
| 395 | /* |
---|
| 396 | * These should never happen. |
---|
| 397 | */ |
---|
| 398 | break; |
---|
[ac7d5ef0] | 399 | } |
---|
| 400 | } |
---|
| 401 | |
---|
[3a4ae6c] | 402 | return RTEMS_INTERNAL_ERROR; /* unreached - only to remove warnings */ |
---|
[ac7d5ef0] | 403 | } |
---|
| 404 | |
---|
| 405 | /*PAGE |
---|
| 406 | * |
---|
| 407 | * _Rate_monotonic_Timeout |
---|
| 408 | * |
---|
| 409 | * This routine processes a period ending. If the owning thread |
---|
| 410 | * is waiting for the period, that thread is unblocked and the |
---|
| 411 | * period reinitiated. Otherwise, the period is expired. |
---|
| 412 | * This routine is called by the watchdog handler. |
---|
| 413 | * |
---|
| 414 | * Input parameters: |
---|
| 415 | * id - period id |
---|
| 416 | * |
---|
| 417 | * Output parameters: NONE |
---|
| 418 | */ |
---|
| 419 | |
---|
| 420 | void _Rate_monotonic_Timeout( |
---|
| 421 | Objects_Id id, |
---|
| 422 | void *ignored |
---|
| 423 | ) |
---|
| 424 | { |
---|
| 425 | Rate_monotonic_Control *the_period; |
---|
[11ab74e] | 426 | Objects_Locations location; |
---|
[ac7d5ef0] | 427 | Thread_Control *the_thread; |
---|
| 428 | |
---|
| 429 | the_period = _Rate_monotonic_Get( id, &location ); |
---|
| 430 | switch ( location ) { |
---|
| 431 | case OBJECTS_ERROR: |
---|
| 432 | case OBJECTS_REMOTE: /* impossible */ |
---|
| 433 | break; |
---|
| 434 | case OBJECTS_LOCAL: |
---|
| 435 | the_thread = the_period->owner; |
---|
| 436 | if ( _States_Is_waiting_for_period( the_thread->current_state ) && |
---|
| 437 | the_thread->Wait.id == the_period->Object.id ) { |
---|
| 438 | _Thread_Unblock( the_thread ); |
---|
[113ef9fc] | 439 | the_period->owner_ticks_executed_at_period = |
---|
| 440 | the_thread->ticks_executed; |
---|
| 441 | |
---|
| 442 | the_period->time_at_period = _Watchdog_Ticks_since_boot; |
---|
| 443 | |
---|
[ac7d5ef0] | 444 | _Watchdog_Reset( &the_period->Timer ); |
---|
[11ab74e] | 445 | } else if ( the_period->state == RATE_MONOTONIC_OWNER_IS_BLOCKING ) { |
---|
| 446 | the_period->state = RATE_MONOTONIC_EXPIRED_WHILE_BLOCKING; |
---|
[113ef9fc] | 447 | the_period->owner_ticks_executed_at_period = |
---|
| 448 | the_thread->ticks_executed; |
---|
| 449 | |
---|
| 450 | the_period->time_at_period = _Watchdog_Ticks_since_boot; |
---|
[11ab74e] | 451 | _Watchdog_Reset( &the_period->Timer ); |
---|
| 452 | } else |
---|
[ac7d5ef0] | 453 | the_period->state = RATE_MONOTONIC_EXPIRED; |
---|
| 454 | _Thread_Unnest_dispatch(); |
---|
| 455 | break; |
---|
| 456 | } |
---|
| 457 | } |
---|
| 458 | |
---|