Spdk/lib/util/zipf.c
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier.
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

112 lines
2.4 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) Intel Corporation. All rights reserved.
* All rights reserved.
*/
#include "spdk/stdinc.h"
#include "spdk/util.h"
#include "spdk/zipf.h"
struct spdk_zipf {
uint64_t range;
double alpha;
double eta;
double theta;
double zetan;
double val1_limit;
uint32_t seed;
};
static double
zeta_increment(uint64_t n, double theta)
{
return pow((double) 1.0 / (n + 1), theta);
}
static double
zeta(uint64_t range, double theta)
{
double zetan = 0;
double inc1, inc2;
uint64_t i, calc, count;
const uint32_t ZIPF_MAX_ZETA_CALC = 10 * 1000 * 1000;
const uint32_t ZIPF_ZETA_ESTIMATE = 1 * 1000 * 1000;
/* Cumulate zeta discretely for the first ZIPF_MAX_ZETA_CALC
* entries in the range.
*/
calc = spdk_min(ZIPF_MAX_ZETA_CALC, range);
for (i = 0; i < calc; i++) {
zetan += zeta_increment(i, theta);
}
/* For the remaining values in the range, increment zetan
* with an approximation for every ZIPF_ZETA_ESTIMATE
* entries. We will take an average of the increment
* for (i) and (i + ZIPF_ZETA_ESTIMATE), and then multiply
* that by ZIPF_ZETA_ESTIMATE.
*
* Of course, we'll cap ZIPF_ZETA_ESTIMATE to something
* smaller if necessary at the end of the range.
*/
while (i < range) {
count = spdk_min(ZIPF_ZETA_ESTIMATE, range - i);
inc1 = zeta_increment(i, theta);
inc2 = zeta_increment(i + count, theta);
zetan += (inc1 + inc2) * count / 2;
i += count;
}
return zetan;
}
struct spdk_zipf *
spdk_zipf_create(uint64_t range, double theta, uint32_t seed)
{
struct spdk_zipf *zipf;
zipf = calloc(1, sizeof(*zipf));
if (zipf == NULL) {
return NULL;
}
zipf->range = range;
zipf->seed = seed;
zipf->theta = theta;
zipf->alpha = 1.0 / (1.0 - zipf->theta);
zipf->zetan = zeta(range, theta);
zipf->eta = (1.0 - pow(2.0 / zipf->range, 1.0 - zipf->theta)) /
(1.0 - zeta(2, theta) / zipf->zetan);
zipf->val1_limit = 1.0 + pow(0.5, zipf->theta);
return zipf;
}
void
spdk_zipf_free(struct spdk_zipf **zipfp)
{
assert(zipfp != NULL);
free(*zipfp);
*zipfp = NULL;
}
uint64_t
spdk_zipf_generate(struct spdk_zipf *zipf)
{
double randu, randz;
uint64_t val;
randu = (double)rand_r(&zipf->seed) / RAND_MAX;
randz = randu * zipf->zetan;
if (randz < 1.0) {
return 0;
} else if (randz < zipf->val1_limit) {
return 1;
} else {
val = zipf->range * pow(zipf->eta * (randu - 1.0) + 1.0, zipf->alpha);
return val % zipf->range;
}
}