timer: add limitation note for sync stop and reset
authorErik Gabriel Carrillo <erik.g.carrillo@intel.com>
Wed, 9 Sep 2020 14:41:14 +0000 (09:41 -0500)
committerDavid Marchand <david.marchand@redhat.com>
Thu, 8 Oct 2020 07:43:57 +0000 (09:43 +0200)
commit0875ec4dd55a548a1f8a27674b1c136c0800d73d
treedacad585e138565a807a1b6d710d680bb4b93921
parent1fb6301ccbb845f344f276ea2db64dda882e196d
timer: add limitation note for sync stop and reset

If a timer's callback function calls rte_timer_reset_sync() or
rte_timer_stop_sync() on another timer that is in the RUNNING state and
owned by the current lcore, the *_sync() calls will loop indefinitely.

Relatedly, if a timer's callback function calls *_sync() on another
timer that is in the RUNNING state and is owned by a different lcore,
but a timer callback function runs on that different lcore and calls
*_sync() on a timer that is in the RUNNING state and owned by the
current lcore, the two lcores will loop indefinitely.

Add a note in the rte_timer_stop_sync and rte_timer_reset_sync
documentation that indicates that these APIs should not be used inside
timer callback functions in order to avoid the hangs described above,
and suggests an alternative.

Bugzilla ID: 491
Cc: stable@dpdk.org
Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
lib/librte_timer/rte_timer.h