Make sampler_random_fract() actually obey its API contract.

tglsfdc · tglsfdc · commit d7c19d68550e · 2015-07-01T18:07:48.000-04:00
This function is documented to return a value in the range (0,1),
which is what its predecessor anl_random_fract() did.  However, the
new version depends on pg_erand48() which returns a value in [0,1).
The possibility of returning zero creates hazards of division by zero
or trying to compute log(0) at some call sites, and it might well
break third-party modules using anl_random_fract() too.  So let's
change it to never return zero.  Spotted by Coverity.

Michael Paquier, cosmetically adjusted by me
diff --git a/src/backend/utils/misc/sampling.c b/src/backend/utils/misc/sampling.c
@@ -237,7 +237,14 @@ sampler_random_init_state(long seed, SamplerRandomState randstate)
 double
 sampler_random_fract(SamplerRandomState randstate)
 {
-	return pg_erand48(randstate);
+	double		res;
+
+	/* pg_erand48 returns a value in [0.0 - 1.0), so we must reject 0 */
+	do
+	{
+		res = pg_erand48(randstate);
+	} while (res == 0.0);
+	return res;
 }
 
 

Original file line number	Diff line number	Diff line change
`@@ -237,7 +237,14 @@ sampler_random_init_state(long seed, SamplerRandomState randstate)`
`237`	`237`	`double`
`238`	`238`	`sampler_random_fract(SamplerRandomState randstate)`
`239`	`239`	`{`
`240`		`- return pg_erand48(randstate);`
	`240`	`+ double res;`
	`241`	`+`
	`242`	`+ /* pg_erand48 returns a value in [0.0 - 1.0), so we must reject 0 */`
	`243`	`+ do`
	`244`	`+ {`
	`245`	`+ res = pg_erand48(randstate);`
	`246`	`+ } while (res == 0.0);`
	`247`	`+ return res;`
`241`	`248`	`}`
`242`	`249`
`243`	`250`