#4403 closed defect (fixed)

rtems_timer_fire_when() returns wrong status code when wall_time argument is NULL

Reported by: Frank Kuehndel Owned by: Sebastian Huber
Priority: normal Milestone: 6.1
Component: rtems Version: 6
Severity: trivial Keywords: rtems_timer_fire_when, RTEMS_INVALID_CLOCK, wall_time
Cc: Blocked By:


The RTEMS Classic API Guide (https://docs.rtems.org/branches/master/c-user/timer/directives.html#rtems-timer-fire-when) elaborates for rtems_timer_fire_when():


The wall_time parameter was NULL.


The time of day was invalid.

Yet, calling rtems_timer_fire_when() with wall_time = NULL and all other parameters valid results in RTEMS_INVALID_CLOCK. Have a look into cpukit/rtems/src/timercreate.c function _Timer_Fire_when() to see the cause for this behavior.

I attach two patches:

  • sptimer_err01.patch -- extends an existing test to reproduce this issue
  • timercreate.patch -- fixes the issue

There are at least two ways to handle this bug and I do not want to decide which way to choose:

  1. Change the documentation
  2. Change the code

For the records:

RTEMS_VERSION    = 6.0.0
remote origin    = git://git.rtems.org/rtems.git
commit HEAD      = 2c5199bb049efe8e29cd12461dc57bd6e30388e8  (HEAD -> master, origin/master, origin/HEAD)
config.ini       =
    RTEMS_DEBUG = True
    RTEMS_SMP = True
    BUILD_TESTS = True
SOURCE_BUILDER   = Set Builder, 6 (5e449fb5c2cb)
GCC_VERSION      = arm-rtems6-gcc (GCC) 10.2.1 20210309 (RTEMS 6, RSB 5e449fb5c2cb6812a238f9f9764fd339cbbf05c2, Newlib d10d0d9)

Attachments (2)

sptimer_err01.patch (801 bytes) - added by Frank Kuehndel on 05/06/21 at 14:18:12.
Extends existing test to reproduce the issue.
timercreate.patch (430 bytes) - added by Frank Kuehndel on 05/06/21 at 14:19:12.
Patch which fixes the issue.

Download all attachments as: .zip

Change History (3)

Changed on 05/06/21 at 14:18:12 by Frank Kuehndel

Attachment: sptimer_err01.patch added

Extends existing test to reproduce the issue.

Changed on 05/06/21 at 14:19:12 by Frank Kuehndel

Attachment: timercreate.patch added

Patch which fixes the issue.

comment:1 Changed on 05/12/21 at 04:41:26 by Frank Kühndel <frank.kuehndel@…>

Resolution: fixed
Status: assignedclosed

In 3af2dc7/rtems:

_TOD_Validate(): Fix incorrect return code

This patch fixes bug #4403. Directives

  • rtems_timer_fire_when()
  • rtems_timer_server_fire_when()
  • rtems_task_wake_when()

are documented to return RTEMS_INVALID_ADDRESS when their time-of-day
argument is NULL. But actually they return RTEMS_INVALID_CLOCK. To fix
the issue this patch changes _TOD_Validate() to return a
status code instead of just true/false.

Close #4403

Note: See TracTickets for help on using tickets.