Skip to contentSkip to conversation

rte_timer: Fix rte_timer_reset return value

RFC PATCH In review [email protected] 4 participants 14 messages Feb 3, 2015 – Feb 25, 2015 6 messages not in the archive

lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 rte_timer: Fix rte_timer_reset return value

From: Robert Sanford <[email protected]>

- API rte_timer_reset() should return -1 when the timer is in the RUNNING or CONFIG state. Instead, it ignores the return value of internal function __rte_timer_reset() and always returns 0. We change rte_timer_reset() to return the value returned by __rte_timer_reset().

- Change API rte_timer_reset_sync() to invoke rte_pause() while spin-waiting for rte_timer_reset() to succeed.

- Enhance timer stress test 2 to report how many timer reset collisions occur, i.e., how many times rte_timer_reset() fails due to a timer being in the CONFIG state.

---
 app/test/test_timer.c        |   25 ++++++++++++++++++++++---
 lib/librte_timer/rte_timer.c |    7 +++----
 2 files changed, 25 insertions(+), 7 deletions(-)
app/test/test_timer.c +22 -3
index 4b4800b..2f27f84 100644
@@ -247,12 +247,15 @@ static int
 timer_stress2_main_loop(__attribute__((unused)) void *arg)
 {
 	static struct rte_timer *timers;
-	int i;
+	int i, ret;
 	static volatile int ready = 0;
 	uint64_t delay = rte_get_timer_hz() / 4;
 	unsigned lcore_id = rte_lcore_id();
+	int32_t my_collisions = 0;
+	static rte_atomic32_t collisions = RTE_ATOMIC32_INIT(0);
 
 	if (lcore_id == rte_get_master_lcore()) {
+		cb_count = 0;
 		timers = rte_malloc(NULL, sizeof(*timers) * NB_STRESS2_TIMERS, 0);
 		if (timers == NULL) {
 			printf("Test Failed\n");
@@ -268,15 +271,24 @@ timer_stress2_main_loop(__attribute__((unused)) void *arg)
 	}
 
 	/* have all cores schedule all timers on master lcore */
-	for (i = 0; i < NB_STRESS2_TIMERS; i++)
-		rte_timer_reset(&timers[i], delay, SINGLE, rte_get_master_lcore(),
+	for (i = 0; i < NB_STRESS2_TIMERS; i++) {
+		ret = rte_timer_reset(&timers[i], delay, SINGLE, rte_get_master_lcore(),
 				timer_stress2_cb, NULL);
+		/* there will be collisions when multiple cores simultaneously
+		 * configure the same timers */
+		if (ret != 0)
+			my_collisions++;
+	}
+	if (my_collisions != 0)
+		rte_atomic32_add(&collisions, my_collisions);
 
 	ready = 0;
 	rte_delay_ms(500);
 
 	/* now check that we get the right number of callbacks */
 	if (lcore_id == rte_get_master_lcore()) {
+		if ((my_collisions = rte_atomic32_read(&collisions)) != 0)
+			printf("- %d timer reset collisions (OK)\n", my_collisions);
 		rte_timer_manage();
 		if (cb_count != NB_STRESS2_TIMERS) {
 			printf("Test Failed\n");
@@ -311,6 +323,13 @@ timer_stress2_main_loop(__attribute__((unused)) void *arg)
 	/* now check that we get the right number of callbacks */
 	if (lcore_id == rte_get_master_lcore()) {
 		rte_timer_manage();
+
+		/* clean up statics, in case we run again */
+		rte_free(timers);
+		timers = 0;
+		ready = 0;
+		rte_atomic32_set(&collisions, 0);
+
 		if (cb_count != NB_STRESS2_TIMERS) {
 			printf("Test Failed\n");
 			printf("- Stress test 2, part 2 failed\n");
lib/librte_timer/rte_timer.c +3 -4
index 269a992..d18abf5 100644
@@ -424,10 +424,8 @@ rte_timer_reset(struct rte_timer *tim, uint64_t ticks,
 	else
 		period = 0;
 
-	__rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
+	return __rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
 			  fct, arg, 0);
-
-	return 0;
 }
 
 /* loop until rte_timer_reset() succeed */
@@ -437,7 +435,8 @@ rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks,
 		     rte_timer_cb_t fct, void *arg)
 {
 	while (rte_timer_reset(tim, ticks, type, tim_lcore,
-			       fct, arg) != 0);
+			       fct, arg) != 0)
+		rte_pause();
 }
 
 /* Stop the timer associated with the timer handle tim */
Signature · 1 line
1.7.1

A message that is not in the archive (sent off-list or not yet received): 1422996127-64370-1-git-send-email-rsanford2-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org

#2 lore raw

Hi Robert,

Please see some comments below.

Quoted 57 lines · On 02/03/2015 09:42 PM, [email protected] wrote:

From: Robert Sanford <[email protected]>

- API rte_timer_reset() should return -1 when the timer is in the RUNNING or CONFIG state. Instead, it ignores the return value of internal function __rte_timer_reset() and always returns 0. We change rte_timer_reset() to return the value returned by __rte_timer_reset().

- Change API rte_timer_reset_sync() to invoke rte_pause() while spin-waiting for rte_timer_reset() to succeed.

- Enhance timer stress test 2 to report how many timer reset collisions occur, i.e., how many times rte_timer_reset() fails due to a timer being in the CONFIG state.

---
 app/test/test_timer.c        |   25 ++++++++++++++++++++++---
 lib/librte_timer/rte_timer.c |    7 +++----
 2 files changed, 25 insertions(+), 7 deletions(-)
app/test/test_timer.c +11 -3
index 4b4800b..2f27f84 100644
@@ -247,12 +247,15 @@ static int
 timer_stress2_main_loop(__attribute__((unused)) void *arg)
 {
 	static struct rte_timer *timers;
-	int i;
+	int i, ret;
 	static volatile int ready = 0;
 	uint64_t delay = rte_get_timer_hz() / 4;
 	unsigned lcore_id = rte_lcore_id();
+	int32_t my_collisions = 0;
+	static rte_atomic32_t collisions = RTE_ATOMIC32_INIT(0);
 
 	if (lcore_id == rte_get_master_lcore()) {
+		cb_count = 0;
 		timers = rte_malloc(NULL, sizeof(*timers) * NB_STRESS2_TIMERS, 0);
 		if (timers == NULL) {
 			printf("Test Failed\n");
@@ -268,15 +271,24 @@ timer_stress2_main_loop(__attribute__((unused)) void *arg)
 	}
 
 	/* have all cores schedule all timers on master lcore */
-	for (i = 0; i < NB_STRESS2_TIMERS; i++)
-		rte_timer_reset(&timers[i], delay, SINGLE, rte_get_master_lcore(),
+	for (i = 0; i < NB_STRESS2_TIMERS; i++) {
+		ret = rte_timer_reset(&timers[i], delay, SINGLE, rte_get_master_lcore(),
 				timer_stress2_cb, NULL);
+		/* there will be collisions when multiple cores simultaneously
+		 * configure the same timers */
+		if (ret != 0)
+			my_collisions++;
+	}

app/test/test_timer.c timer_stress2_main_loop(__attribute__((unused)) void *arg) · line 291

Quoted 10 lines
app/test/test_timer.c +4 -0
+	if (my_collisions != 0)
+		rte_atomic32_add(&collisions, my_collisions);
 
 	ready = 0;
 	rte_delay_ms(500);
 
 	/* now check that we get the right number of callbacks */
 	if (lcore_id == rte_get_master_lcore()) {
+		if ((my_collisions = rte_atomic32_read(&collisions)) != 0)
+			printf("- %d timer reset collisions (OK)\n", my_collisions);

That's not very important, but I think avoiding affectation + comparison at the same time is clearer:

  my_collisions = rte_atomic32_read(&collisions);
  if (my_collisions != 0) {
  	...

app/test/test_timer.c timer_stress2_main_loop(__attribute__((unused)) void *arg) · line 329

Quoted 11 lines
app/test/test_timer.c +4 -0
 		rte_timer_manage();
 		if (cb_count != NB_STRESS2_TIMERS) {
 			printf("Test Failed\n");
@@ -311,6 +323,13 @@ timer_stress2_main_loop(__attribute__((unused)) void *arg)
 	/* now check that we get the right number of callbacks */
 	if (lcore_id == rte_get_master_lcore()) {
 		rte_timer_manage();
+
+		/* clean up statics, in case we run again */
+		rte_free(timers);
+		timers = 0;

timers = NULL is better than timers = 0 as it's a pointer.

app/test/test_timer.c timer_stress2_main_loop(__attribute__((unused)) void *arg) · line 330

Quoted 1 line
app/test/test_timer.c +1 -0
+		ready = 0;

The lines above should go in another patch as it fixes another problem (+ a memory leek).
"testpmd: allow to restart timer stress tests"

Quoted 22 lines
app/test/test_timer.c +2 -0
+		rte_atomic32_set(&collisions, 0);
+
 		if (cb_count != NB_STRESS2_TIMERS) {
 			printf("Test Failed\n");
 			printf("- Stress test 2, part 2 failed\n");
lib/librte_timer/rte_timer.c +1 -3
index 269a992..d18abf5 100644
@@ -424,10 +424,8 @@ rte_timer_reset(struct rte_timer *tim, uint64_t ticks,
 	else
 		period = 0;
 
-	__rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
+	return __rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
 			  fct, arg, 0);
-
-	return 0;
 }
 
 /* loop until rte_timer_reset() succeed */

lib/librte_timer/rte_timer.c rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks, · line 440

Quoted 7 lines
lib/librte_timer/rte_timer.c +2 -1
@@ -437,7 +435,8 @@ rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks,
 		     rte_timer_cb_t fct, void *arg)
 {
 	while (rte_timer_reset(tim, ticks, type, tim_lcore,
-			       fct, arg) != 0);
+			       fct, arg) != 0)
+		rte_pause();
 }

Maybe the lines above could go to another patch too. "timers: relax cpu in rte_timer_reset_sync()"

Also, I think the commit log should highlight the fact that your patch also fixes rte_timer_reset_sync() that was not working at all.

Thanks!
Olivier

A message that is not in the archive (sent off-list or not yet received): [email protected]

#4 lore raw

Hi Olivier,

Thanks for reviewing this patch.
Please see my responses to your comments, below.

I also have one request for you. You probably use git almost every day. For people who only use git maybe once per year, could you please show us the exact sequence of commands that you run to prepare a patch series? We know there are man pages and online documents, etc, but it would be an extremely valuable jumpstart if you just give us a snippet of your shell history showing the exact commands that you run to prepare and email a patch series. I would much rather spend time getting the code right, and less time learning (by trial and error) the nuances of git apply, add, commit, format-patch, send-email, etc.

Quoted 4 lines
      /* now check that we get the right number of callbacks */

Review

Quoted 3 lines
      if (lcore_id == rte_get_master_lcore()) {
(quoted diff) +2 -0
+             if ((my_collisions = rte_atomic32_read(&collisions)) != 0)
+                     printf("- %d timer reset collisions (OK)\n",
Quoted 9 lines

my_collisions);

That's not very important, but I think avoiding affectation + comparison at the same time is clearer:

  my_collisions = rte_atomic32_read(&collisions);
  if (my_collisions != 0) {
        ...

Yes, I will change this.

Quoted 10 lines

Review timer_stress2_main_loop(__attribute__((unused))

Quoted 1 line
(quoted diff) +0 -0
@@ -311,6 +323,13 @@ timer_stress2_main_loop(__attribute__((unused))

void *arg)

app/test/test_timer.c timer_stress2_main_loop(__attribute__((unused)) void *arg) · line 329

Quoted 7 lines
app/test/test_timer.c +4 -0
      /* now check that we get the right number of callbacks */
      if (lcore_id == rte_get_master_lcore()) {
              rte_timer_manage();
+
+             /* clean up statics, in case we run again */
+             rte_free(timers);
+             timers = 0;
Quoted 2 lines

timers = NULL is better than timers = 0 as it's a pointer.

Yes, I will change this.

Quoted 6 lines

app/test/test_timer.c timer_stress2_main_loop(__attribute__((unused)) void *arg) · line 330

Quoted 1 line
app/test/test_timer.c +1 -0
+             ready = 0;

The lines above should go in another patch as it fixes another problem (+ a memory leek).
"testpmd: allow to restart timer stress tests"

Yes, I will split it into two patches: rte_timer and test_timer. But, I don't see much benefit in splitting test_timer.c changes into separate patches for each bug discovered.

Quoted 27 lines

lib/librte_timer/rte_timer.c rte_timer_reset(struct rte_timer *tim, uint64_t

Quoted 5 lines
lib/librte_timer/rte_timer.c +0 -0
index 269a992..d18abf5 100644
@@ -424,10 +424,8 @@ rte_timer_reset(struct rte_timer *tim, uint64_t

ticks,

lib/librte_timer/rte_timer.c rte_timer_reset_sync(struct rte_timer *tim, uint64_t

Quoted 12 lines
lib/librte_timer/rte_timer.c +1 -3
      else
              period = 0;
 
-     __rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
+     return __rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
                        fct, arg, 0);
-
-     return 0;
 }
 
 /* loop until rte_timer_reset() succeed */
@@ -437,7 +435,8 @@ rte_timer_reset_sync(struct rte_timer *tim, uint64_t

ticks,

lib/librte_timer/rte_timer.c rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks, · line 440

Quoted 7 lines
lib/librte_timer/rte_timer.c +2 -1
                   rte_timer_cb_t fct, void *arg)
 {
      while (rte_timer_reset(tim, ticks, type, tim_lcore,
-                            fct, arg) != 0);
+                            fct, arg) != 0)
+             rte_pause();
 }
Quoted 4 lines

Maybe the lines above could go to another patch too. "timers: relax cpu in rte_timer_reset_sync()"

If you mean that we should have one patch for rte_timer_reset() and one for rte_timer_reset_sync(), my response is: Come on, these are two one-line fixes in a pair of related and adjacent functions. Let's not go overboard by splitting them into two patches. :-)

Also, I think the commit log should highlight the fact that

Quoted 4 lines

your patch also fixes rte_timer_reset_sync() that was not working at all.

We said something to that effect: "Change API rte_timer_reset_sync() to invoke rte_pause() while spin-waiting for rte_timer_reset() to succeed." I can use different wording if you like.

Quoted 4 lines

Thanks!
Olivier

Thank you,
Robert

A message that is not in the archive (sent off-list or not yet received): CA+cr1coAamT1OkL-Ts6gWe+N_fuJf-uQunJeTqUg_ngDGM1Vfg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

#6 lore raw

Hi Robert,

Quoted 5 lines · Robert Sanford

Hi Olivier,

Thanks for reviewing this patch.
Please see my responses to your comments, below.

Quoted 9 lines

I also have one request for you. You probably use git almost every day. For people who only use git maybe once per year, could you please show us the exact sequence of commands that you run to prepare a patch series? We know there are man pages and online documents, etc, but it would be an extremely valuable jumpstart if you just give us a snippet of your shell history showing the exact commands that you run to prepare and email a patch series. I would much rather spend time getting the code right, and less time learning (by trial and error) the nuances of git apply, add, commit, format-patch, send-email, etc.

The following actions should work fine (please take the time to understand them before execute them):

# start in your workspace with your patch commit
# "git log -1" shows your timer commit
# remove the commit but keep the files unmodified
git reset HEAD^
# you can see the modified files with "git diff" and "git status"

# Now do the modifications we discussed in the mail in the files

##### first patch: relax cpu

# Once it's done we will add the first commit (relax cpu) # We will add it in the cache with "git add".
# '-p' means it will ask for each hunk.
git add -p lib/librte_timer/rte_timer.c

# so "n" to the first one, and "y" to the second (with the rte_pause)
# show the cache, it should show the content of the commit
git diff --cached
# add the commit log
git commit

##### second patch: first restarting

# same than above, we just want to commit a part of the diff
git add -p lib/librte_timer/rte_timer.c
# say "n" until you see the lines with "/* clean up statics, in case
# we run again */"
# Then say "e" (edit).

# In the editor, remove the line
# "+ rte_atomic32_set(&collisions, 0);"
# (we want to have it in the 3rd patch, not this one)

# then save and exit from your editor
# show the cache, it should show the content of the commit
git diff --cached
# add the commit log
git commit

#### 3rd patch, the rest

# easy here
git add app/test/test_timer.c lib/librte_timer/rte_timer.c
git commit

#### check compilation

git rebase -i HEAD~3

# replace all "pick" by "edit", then save and exit
# git stops at your first commit, check compilation, then:
git rebase --contine
# git stops at your 2nd commit, same...
git rebase --contine
# one last time
git rebase --contine

#### send the email

# prepare a directory with your 3 patches
git format-patch -3 --cover-letter \
  --output-directory=timer-patches
# edit the cover letter
${EDITOR} timer-patches/0000-cover-letter.patch
# send it
git send-email --to [email protected] --cc [email protected] \
 --in-reply-to="1422996127-64370-1-git-send-email-rsanford2-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org" \
 timer-patches

Here it is. This is one solution, but probably other people do differently.

The dpdk dev page http://dpdk.org/dev is simple but really useful to remember the commands. The man pages of git are long, but really well written, if you have a doubt, you can check there.

Quoted 10 lines
Quoted 1 line

+ ready = 0;

The lines above should go in another patch as it fixes another problem (+ a memory leek).
"testpmd: allow to restart timer stress tests"

Yes, I will split it into two patches: rte_timer and test_timer. But, I don't see much benefit in splitting test_timer.c changes into separate patches for each bug discovered.

There are several reasons why we want to split patches.

- Small patches are easier to understand (one problem -> one solution), it's easier to read for the reviewer, but also for all people that will browse the history later

- Smaller patches also reduce the risk to miss something, increasing code quality

- Some people may be maintaining their own stable dpdk branch. They can pick up only the patches they consider critical.

- When a developer takes time to present its patches properly, it's seen by the reviewers as a mark of respect by the reviewers, so they are happier to do the review.

Quoted 34 lines
Quoted 17 lines
lib/librte_timer/rte_timer.c +1 -3
index 269a992..d18abf5 100644
@@ -424,10 +424,8 @@ rte_timer_reset(struct rte_timer *tim, uint64_t ticks,
      else
              period = 0;
 
-     __rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
+     return __rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
                        fct, arg, 0);
-
-     return 0;
 }
 
 /* loop until rte_timer_reset() succeed */

lib/librte_timer/rte_timer.c rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks, · line 440

Quoted 7 lines
lib/librte_timer/rte_timer.c +2 -1
@@ -437,7 +435,8 @@ rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks,
                   rte_timer_cb_t fct, void *arg)
 {
      while (rte_timer_reset(tim, ticks, type, tim_lcore,
-                            fct, arg) != 0);
+                            fct, arg) != 0)
+             rte_pause();
 }

Maybe the lines above could go to another patch too. "timers: relax cpu in rte_timer_reset_sync()"

If you mean that we should have one patch for rte_timer_reset() and one for rte_timer_reset_sync(), my response is: Come on, these are two one-line fixes in a pair of related and adjacent functions. Let's not go overboard by splitting them into two patches. :-)

Quoted 8 lines

Also, I think the commit log should highlight the fact that your patch also fixes rte_timer_reset_sync() that was not working at all.

We said something to that effect: "Change API rte_timer_reset_sync() to invoke rte_pause() while spin-waiting for rte_timer_reset() to succeed." I can use different wording if you like.

This does not say that rte_timer_reset_sync() was not working, it says "change API"... and I don't really see where the API (the interface of the function) is changed.

Regards,
Olivier

#7 lore raw

v2 cover timer: fix rte_timer_reset

In reply to a message not in the archive

Changes in v2:
- split into multiple patches
- minor coding-style changes

Robert Sanford (3):
timer: fix return value of rte_timer_reset(),
insert rte_pause() into rte_timer_reset_sync() wait-loop
app/test: fix timer stress test to succeed on multiple runs,
display number of times that rte_timer_reset() fails (expected) due to races with other cores

app/test/test_timer.c | 26 +++++++++++++++++++++++---
lib/librte_timer/rte_timer.c | 7 +++----

2 files changed, 26 insertions(+), 7 deletions(-)

A message that is not in the archive (sent off-list or not yet received): 1424837389-56276-1-git-send-email-rsanford2-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org

Acked-by
#9 lore raw

Re: [PATCH v2 0/3] timer: fix rte_timer_reset

Hi Robert,

Quoted 11 lines · Robert Sanford

Changes in v2:
- split into multiple patches
- minor coding-style changes

Robert Sanford (3):
timer: fix return value of rte_timer_reset(),
insert rte_pause() into rte_timer_reset_sync() wait-loop
app/test: fix timer stress test to succeed on multiple runs,
display number of times that rte_timer_reset() fails (expected) due to races with other cores

Quoted 4 lines

app/test/test_timer.c | 26 +++++++++++++++++++++++---
lib/librte_timer/rte_timer.c | 7 +++----

2 files changed, 26 insertions(+), 7 deletions(-)

Series:

Thanks!

A message that is not in the archive (sent off-list or not yet received): [email protected]

#11 lore raw

Re: [PATCH v2 0/3] timer: fix rte_timer_reset

Quoted 11 lines
Quoted 10 lines

Changes in v2:
- split into multiple patches
- minor coding-style changes

Robert Sanford (3):
timer: fix return value of rte_timer_reset(),
insert rte_pause() into rte_timer_reset_sync() wait-loop
app/test: fix timer stress test to succeed on multiple runs,
display number of times that rte_timer_reset() fails (expected) due to races with other cores

Quoted 2 lines

Series:

Applied, thanks

Robert, as you well know rte_timer and you work on it, maybe you are interested in becoming maintainer?

#12 lore raw

Re: [PATCH v2 0/3] timer: fix rte_timer_reset

Hi Thomas,

Yes, I'm interested in becoming a maintainer of rte_timer. What are the responsibilities?

One question about lib rte_timer that's been troubling me for a while: How are skip lists better than BSD-style timer wheels?

--
Regards,
Robert

Quoted 19 lines · Thomas Monjalon
Quoted 11 lines
Quoted 10 lines

Changes in v2:
- split into multiple patches
- minor coding-style changes

Robert Sanford (3):
timer: fix return value of rte_timer_reset(),
insert rte_pause() into rte_timer_reset_sync() wait-loop
app/test: fix timer stress test to succeed on multiple runs,
display number of times that rte_timer_reset() fails (expected) due to races with other cores

Quoted 2 lines

Series:

Applied, thanks

Robert, as you well know rte_timer and you work on it, maybe you are interested in becoming maintainer?

A message that is not in the archive (sent off-list or not yet received): CA+cr1crDcQcdtJc9zaHbCL9DG40aV3a3ZF_fnNBx2h3WZP-quQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

#14 lore raw

Re: [PATCH v2 0/3] timer: fix rte_timer_reset

2015-02-25 06:02, Robert Sanford:

Quoted 4 lines

Hi Thomas,

Yes, I'm interested in becoming a maintainer of rte_timer. What are the responsibilities?

It means we know someone who can answer our questions about rte_timer. Having you email in the MAINTAINERS file helps to CC you.
And we expect from the maintainer he tried to review patches for its part. But reviews may be done by someone else.
In general, technical review from the maintainer is more trustable.

If you are still interested, please drop a patch like this one:

	http://dpdk.org/browse/dpdk/commit/?id=a7d7ece480093
#15 lore raw

Re: [PATCH v2 0/3] timer: fix rte_timer_reset

In reply to a message not in the archive
Quoted 10 lines · Robert Sanford

Hi Thomas,

Yes, I'm interested in becoming a maintainer of rte_timer. What are the responsibilities?

One question about lib rte_timer that's been troubling me for a while: How are skip lists better than BSD-style timer wheels?

--

The skip list may not be any better than a timer wheel - it's just what is used now, and it does give pretty good performance (insert O(log n) [up to a few million timers per core], expiry O(1)).
Originally in DPDK, the timers were maintained in a regular sorted linked list, but that suffered from scalability issues when starting timers, or stopped before expiry. The skip-list was therefore a big improvement on that, and gave us much greater scalability in timers, without any regressions in performance. I don't know if anyone has tried to implement and benchmark a timer-wheel based rte_timer library replacement. I'd be interested to see a performance comparison between the two implementations! :-)

Regards,
/Bruce

Quoted 26 lines

Regards,
Robert

Quoted 19 lines · Thomas Monjalon
Quoted 11 lines
Quoted 10 lines

Changes in v2:
- split into multiple patches
- minor coding-style changes

Robert Sanford (3):
timer: fix return value of rte_timer_reset(),
insert rte_pause() into rte_timer_reset_sync() wait-loop
app/test: fix timer stress test to succeed on multiple runs,
display number of times that rte_timer_reset() fails (expected) due to races with other cores

Quoted 2 lines

Series:

Applied, thanks

Robert, as you well know rte_timer and you work on it, maybe you are interested in becoming maintainer?

#16 lore raw

Re: [PATCH v2 0/3] timer: fix rte_timer_reset

Quoted 26 lines · Bruce Richardson
Quoted 2 lines · Robert Sanford

One question about lib rte_timer that's been troubling me for a while:

How

Quoted 3 lines

are skip lists better than BSD-style timer wheels?

--

The skip list may not be any better than a timer wheel - it's just what is used
now, and it does give pretty good performance (insert O(log n) [up to a few million timers per core], expiry O(1)).
Originally in DPDK, the timers were maintained in a regular sorted linked list,
but that suffered from scalability issues when starting timers, or stopped before
expiry. The skip-list was therefore a big improvement on that, and gave us much greater scalability in timers, without any regressions in performance. I
don't know if anyone has tried to implement and benchmark a timer-wheel based
rte_timer library replacement. I'd be interested to see a performance comparison
between the two implementations! :-)

Quoted 4 lines

Regards,
/Bruce

I've wanted to try out the timer-wheels since before the skip-list version, but it just hasn't made it to the top of my priority list.
The other thing that concerns me about the skip-list implementation is the extra cache line that all those pointers consume.

--
Thanks,
Robert

#17 lore raw

PATCH v2 1/3 timer: pause in rte_timer_reset_sync

In reply to a message not in the archive

In rte_timer_reset_sync(), insert rte_pause() into loop that waits for rte_timer_reset() to succeed.

---
lib/librte_timer/rte_timer.c | 3 ++-

1 files changed, 2 insertions(+), 1 deletions(-)
lib/librte_timer/rte_timer.c +2 -1
index 269a992..dae76cc 100644
@@ -437,7 +437,8 @@ rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks,
 		     rte_timer_cb_t fct, void *arg)
 {
 	while (rte_timer_reset(tim, ticks, type, tim_lcore,
-			       fct, arg) != 0);
+			       fct, arg) != 0)
+		rte_pause();
 }
 
 /* Stop the timer associated with the timer handle tim */
Signature · 1 line
1.7.1
#18 lore raw

PATCH v2 2/3 timer: fix stress test on multiple runs

In reply to a message not in the archive

Fix timer stress test to succeed on multiple runs.

---
app/test/test_timer.c | 7 +++++++

1 files changed, 7 insertions(+), 0 deletions(-)
app/test/test_timer.c +7 -0
index 4b4800b..070437a 100644
@@ -253,6 +253,7 @@ timer_stress2_main_loop(__attribute__((unused)) void *arg)
 	unsigned lcore_id = rte_lcore_id();
 
 	if (lcore_id == rte_get_master_lcore()) {
+		cb_count = 0;
 		timers = rte_malloc(NULL, sizeof(*timers) * NB_STRESS2_TIMERS, 0);
 		if (timers == NULL) {
 			printf("Test Failed\n");
@@ -311,6 +312,12 @@ timer_stress2_main_loop(__attribute__((unused)) void *arg)
 	/* now check that we get the right number of callbacks */
 	if (lcore_id == rte_get_master_lcore()) {
 		rte_timer_manage();
+
+		/* clean up statics, in case we run again */
+		rte_free(timers);
+		timers = NULL;
+		ready = 0;
+
 		if (cb_count != NB_STRESS2_TIMERS) {
 			printf("Test Failed\n");
 			printf("- Stress test 2, part 2 failed\n");
Signature · 1 line
1.7.1
#19 lore raw

PATCH v2 3/3 timer: fix rte_timer_reset return value

In reply to a message not in the archive

- API rte_timer_reset() should return -1 when the timer is in the RUNNING or CONFIG state. Instead, it ignores the return value of internal function __rte_timer_reset() and always returns 0. We change rte_timer_reset() to return the value returned by __rte_timer_reset().

- Enhance timer stress test 2 to report how many timer reset collisions occur, i.e., how many times rte_timer_reset() fails due to a timer being in the CONFIG state.

---
app/test/test_timer.c | 19 ++++++++++++++++---
lib/librte_timer/rte_timer.c | 4 +---

2 files changed, 17 insertions(+), 6 deletions(-)
app/test/test_timer.c +16 -3
index 070437a..79fa955 100644
@@ -247,10 +247,12 @@ static int
 timer_stress2_main_loop(__attribute__((unused)) void *arg)
 {
 	static struct rte_timer *timers;
-	int i;
+	int i, ret;
 	static volatile int ready = 0;
 	uint64_t delay = rte_get_timer_hz() / 4;
 	unsigned lcore_id = rte_lcore_id();
+	int32_t my_collisions = 0;
+	static rte_atomic32_t collisions = RTE_ATOMIC32_INIT(0);
 
 	if (lcore_id == rte_get_master_lcore()) {
 		cb_count = 0;
@@ -269,15 +271,25 @@ timer_stress2_main_loop(__attribute__((unused)) void *arg)
 	}
 
 	/* have all cores schedule all timers on master lcore */
-	for (i = 0; i < NB_STRESS2_TIMERS; i++)
-		rte_timer_reset(&timers[i], delay, SINGLE, rte_get_master_lcore(),
+	for (i = 0; i < NB_STRESS2_TIMERS; i++) {
+		ret = rte_timer_reset(&timers[i], delay, SINGLE, rte_get_master_lcore(),
 				timer_stress2_cb, NULL);
+		/* there will be collisions when multiple cores simultaneously
+		 * configure the same timers */
+		if (ret != 0)
+			my_collisions++;
+	}
+	if (my_collisions != 0)
+		rte_atomic32_add(&collisions, my_collisions);
 
 	ready = 0;
 	rte_delay_ms(500);
 
 	/* now check that we get the right number of callbacks */
 	if (lcore_id == rte_get_master_lcore()) {
+		my_collisions = rte_atomic32_read(&collisions);
+		if (my_collisions != 0)
+			printf("- %d timer reset collisions (OK)\n", my_collisions);
 		rte_timer_manage();
 		if (cb_count != NB_STRESS2_TIMERS) {
 			printf("Test Failed\n");
@@ -317,6 +329,7 @@ timer_stress2_main_loop(__attribute__((unused)) void *arg)
 		rte_free(timers);
 		timers = NULL;
 		ready = 0;
+		rte_atomic32_set(&collisions, 0);
 
 		if (cb_count != NB_STRESS2_TIMERS) {
 			printf("Test Failed\n");
lib/librte_timer/rte_timer.c +1 -3
index dae76cc..d18abf5 100644
@@ -424,10 +424,8 @@ rte_timer_reset(struct rte_timer *tim, uint64_t ticks,
 	else
 		period = 0;
 
-	__rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
+	return __rte_timer_reset(tim,  cur_time + ticks, period, tim_lcore,
 			  fct, arg, 0);
-
-	return 0;
 }
 
 /* loop until rte_timer_reset() succeed */
Signature · 1 line
1.7.1