Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to support VS 2017 builds for Win64 bench-marking. #38

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Changes to support VS 2017 builds for Win64 bench-marking. #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
823a89d
Changes to support VS 2017 builds for Win32 benchmarking.
JakeKirk Aug 21, 2018
0b2220b
On Win32 (and possibly other platforms).
JakeKirk Aug 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,11 @@ DATA = \

all: data.csv

# for the *.xz dependencies found, keep the source, decompress, using the xz codec
%:: %.xz
squash -kdc xz $^ $@

benchmark: benchmark.c timer.c
benchmark: benchmark.c timer.c parg.c
$(CC) -Wall -Wextra -g -o benchmark $^ `pkg-config --libs --cflags squash-0.8`

data.csv: benchmark $(DATA)
Expand Down
229 changes: 161 additions & 68 deletions benchmark.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,42 @@
#include <sys/syscall.h>
#endif

#if !defined(_MSC_VER)
#include <unistd.h>
#include <strings.h>
#include <sys/wait.h>
#else // _MSC_VER
#define _CRT_SECURE_NO_WARNINGS // disable microsoft complaints about usage of non-secure CRT functions.
// https://docs.microsoft.com/en-us/cpp/c-runtime-library/security-features-in-the-crt
#endif

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <strings.h>
#include <assert.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <sys/wait.h>

#ifdef _MSC_VER
#include "Windows.h" // GetTempFileNameA()
#include <io.h> // _open(), _write(), _read(), _close(), _umask()

#define open _open // avoid VS error C4996: "The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name."
#define write _write // These might be converted, then removed upon confirming that other compilers are happy with the same naming.
#define read _read
#define close _close
#define umask _umask
#define strdup _strdup
#define unlink _unlink

#define strtok_r strtok_s // an equivalent
#endif

#include <squash.h>
#include "timer.h"
#include "parg.h" // a cross platform "getopts"


static double min_exec_time = 5.0;

Expand All @@ -62,6 +85,15 @@ squash_tmpfile (const char* name) {
#endif
}

const struct
parg_option squash_bench_options[] = {
{ "help", PARG_NOARG, NULL, 'h' },
{ "codec", PARG_NOARG, NULL, 'c' },
{ "outfile", PARG_REQARG, NULL, 'o' },
{ "time", PARG_NOARG, NULL, 't' },
{ NULL, 0, NULL, 0 }
};

static void
print_help_and_exit (const char* executable, int exit_code) {
fprintf (stdout, "Usage: %s [OPTION]... FILE...\n", executable);
Expand All @@ -71,7 +103,7 @@ print_help_and_exit (const char* executable, int exit_code) {
fprintf (stdout, "\t-h Print this help screen and exit.\n");
fprintf (stdout, "\t-c codec Benchmark the specified codec and exit.\n");
fprintf (stdout, "\t-o outfile CSV output file.\n");
fprintf (stdout, "\t-t time Minumum execution time in seconds(default: 5.0)\n");
fprintf (stdout, "\t-t time Minimum execution time in seconds(default: 5.0)\n");

exit (exit_code);
}
Expand All @@ -91,6 +123,71 @@ typedef struct {
double decompress_wall;
} SquashBenchmarkResult;

// moves the codec compression/decompression results contained in fifo_name to the User specified CSV output file.
// @pre: fifo_name exists and contains compression results data.
// @post fifo_name, the temp file for codec results output, is deleted after the results are transferred to the CSV
static bool
append_csv_benchmark(char * fifo_name, struct BenchmarkContext* context, const int level, SquashCodec* codec)
{
bool success = false;
SquashBenchmarkResult result = { 0, 0.0, 0.0, 0.0, 0.0 };

#if !defined(SQUASH_BENCHMARK_NO_FORK)
int in_descriptor = open(fifo_name, O_RDONLY | O_BINARY);
if (in_descriptor == -1)
perror("Open failed to read fifo_name");
#else
int in_descriptor = descriptors[0];
#endif

size_t bytes_read = read(in_descriptor, &result, sizeof(SquashBenchmarkResult));


#if !defined(_WIN32)
wait (NULL);
#endif

if (bytes_read == sizeof(SquashBenchmarkResult)) {
if (context->csv != NULL) {
if (level >= 0) {
fprintf(context->csv, "%s,%s,%s,%d,%ld,%ld,%f,%f,%f,%f\r\n",
context->input_name,
squash_plugin_get_name(squash_codec_get_plugin(codec)),
squash_codec_get_name(codec),
level,
context->input_size,
result.compressed_size,
result.compress_cpu,
result.compress_wall,
result.decompress_cpu,
result.decompress_wall);
}
else {
fprintf(context->csv, "%s,%s,%s,,%ld,%ld,%f,%f,%f,%f\r\n",
context->input_name,
squash_plugin_get_name(squash_codec_get_plugin(codec)),
squash_codec_get_name(codec),
context->input_size,
result.compressed_size,
result.compress_cpu,
result.compress_wall,
result.decompress_cpu,
result.decompress_wall);
}
}

success = true;
} else {
fprintf(stderr, "append_csv_benchmark failed to read [%zd] bytes_read. Error: %s\n", bytes_read, strerror(errno));
}

close(in_descriptor);
#if !defined(SQUASH_BENCHMARK_NO_FORK)
unlink(fifo_name);
#endif
return success;
}

static bool
benchmark_codec_with_options (struct BenchmarkContext* context, SquashCodec* codec, SquashOptions* opts) {
SquashBenchmarkResult result = { 0, 0.0, 0.0, 0.0, 0.0 };
Expand All @@ -99,17 +196,36 @@ benchmark_codec_with_options (struct BenchmarkContext* context, SquashCodec* cod
const int level = squash_options_get_int (opts, codec, "level");

#if !defined(SQUASH_BENCHMARK_NO_FORK)
char fifo_name[] = ".squash-benchmark-fifo-XXXXXX";

char fifo_name[FILENAME_MAX] = ".squash-benchmark-fifo-XXXXXX";
#if !defined(_WIN32)
assert (mkfifo (mktemp (fifo_name), 0600) == 0);

if (fork () == 0) {
int out_descriptor = open (fifo_name, O_WRONLY);
if (fork() == 0) {
#else
char tempFile[FILENAME_MAX]; // note: Win32 mktemp() has a 26 unique file name 'a'-'z' limit and issues if for some reason file pre-exists.
char directory[] = { "." }; // in the current directory
char prefix[] = { "squ" }; // note: api uses only 3 characters max

bool bProcess = GetTempFileNameA(
directory,
prefix,
0, // ==0, creates filenames based upon time (65,535 unique file names before roll over)
tempFile
);
assert(bProcess);
strcpy(fifo_name, tempFile);

if (bProcess) {
#endif // _WIN32

int out_descriptor = open(fifo_name, O_WRONLY | O_BINARY);
if (out_descriptor == -1)
perror("Open failed on fifo_name");
#else
int descriptors[2];
assert (pipe (descriptors) == 0);
int out_descriptor = descriptors[1];
#endif
#endif // SQUASH_BENCHMARK_NO_FORK

FILE* compressed = squash_tmpfile ("squash-benchmark-compressed");
FILE* decompressed = squash_tmpfile ("squash-benchmark-decompressed");
SquashTimer* timer = squash_timer_new ();
Expand Down Expand Up @@ -137,7 +253,7 @@ benchmark_codec_with_options (struct BenchmarkContext* context, SquashCodec* cod
rewind (context->input);

if (res != SQUASH_OK) {
fprintf (stderr, "ERROR: %s (%d) squash_splice_with_options (%s, compress, %p, %p, 0, %p)\n", squash_status_to_string (res), res, squash_codec_get_name (codec), compressed, context->input, opts);
fprintf (stderr, "ERROR: %s (%d) squash_splice_with_options (%s, compress, %p, %p, 0, %p)\n", squash_status_to_string (res), res, squash_codec_get_name (codec), compressed, context->input, opts);
break;
}
}
Expand All @@ -157,17 +273,17 @@ benchmark_codec_with_options (struct BenchmarkContext* context, SquashCodec* cod
result.compressed_size);

for ( iterations = 0 ; squash_timer_get_elapsed_cpu (timer) < min_exec_time ; iterations++ ) {
fseek (compressed, 0, SEEK_SET);
fseek (decompressed, 0, SEEK_SET);
fseek (compressed, 0, SEEK_SET);
fseek (decompressed, 0, SEEK_SET);

squash_timer_start (timer);
res = squash_splice_with_options (codec, SQUASH_STREAM_DECOMPRESS, decompressed, compressed, 0, opts);
squash_timer_stop (timer);
rewind (compressed);
squash_timer_start (timer);
res = squash_splice_with_options (codec, SQUASH_STREAM_DECOMPRESS, decompressed, compressed, 0, opts);
squash_timer_stop (timer);
rewind (compressed);

if (res != SQUASH_OK) {
break;
}
if (res != SQUASH_OK) {
break;
}
}

if (res != SQUASH_OK) {
Expand Down Expand Up @@ -197,48 +313,19 @@ benchmark_codec_with_options (struct BenchmarkContext* context, SquashCodec* cod

close (out_descriptor);
#if !defined(SQUASH_BENCHMARK_NO_FORK)
#if !defined(_WIN32)
exit (0);
} else {
int in_descriptor = open (fifo_name, O_RDONLY);
#else
int in_descriptor = descriptors[0];
#endif
size_t bytes_read = read (in_descriptor, &result, sizeof (SquashBenchmarkResult));
wait (NULL);
if (bytes_read == sizeof (SquashBenchmarkResult)) {
if (context->csv != NULL) {
if (level >= 0) {
fprintf (context->csv, "%s,%s,%s,%d,%ld,%ld,%f,%f,%f,%f\r\n",
context->input_name,
squash_plugin_get_name (squash_codec_get_plugin (codec)),
squash_codec_get_name (codec),
level,
context->input_size,
result.compressed_size,
result.compress_cpu,
result.compress_wall,
result.decompress_cpu,
result.decompress_wall);
} else {
fprintf (context->csv, "%s,%s,%s,,%ld,%ld,%f,%f,%f,%f\r\n",
context->input_name,
squash_plugin_get_name (squash_codec_get_plugin (codec)),
squash_codec_get_name (codec),
context->input_size,
result.compressed_size,
result.compress_cpu,
result.compress_wall,
result.decompress_cpu,
result.decompress_wall);
}
}

success = true;
}
close (in_descriptor);
#if !defined(SQUASH_BENCHMARK_NO_FORK)
unlink (fifo_name);
}
#endif
}
#if !defined(_WIN32)
else {
// note: fork() parent is responsible for reporting.
success = append_csv_benchmark(fifo_name, context, level, codec);
}
#else
// no fork()ing on Win32, done inline upon being completed above
success = append_csv_benchmark(fifo_name, context, level, codec);
#endif

return success;
Expand All @@ -252,7 +339,7 @@ benchmark_codec (SquashCodec* codec, void* data) {
char level_s[4];
bool have_results = false;

umask (0100);
umask (S_IEXEC); // using constants: S_IEXEC == 0x0040 == 0100 Octal. Execute/Search permission.

fprintf (stdout, " %s:%s\n",
squash_plugin_get_name (squash_codec_get_plugin (codec)),
Expand Down Expand Up @@ -334,6 +421,8 @@ benchmark_parse_codec (const char* str, SquashOptions** options) {
}

int main (int argc, char** argv) {
struct parg_state ps;
int optend;
struct BenchmarkContext context = { NULL, NULL, NULL, 0 };
int opt;
int optc = 0;
Expand All @@ -342,44 +431,48 @@ int main (int argc, char** argv) {

setvbuf (stdout, NULL, _IONBF, 0);

while ( (opt = getopt(argc, argv, "hc:o:t:")) != -1 ) {
optend = parg_reorder(argc, argv, "hc:o:t:", squash_bench_options);
parg_init(&ps);

while ( (opt = parg_getopt_long(&ps, optend, argv, "hc:o:t:", squash_bench_options, NULL)) != -1 ) {
switch ( opt ) {
case 'h':
print_help_and_exit (argv[0], 0);
break;
case 'o':
context.csv = fopen (optarg, "w+b");
context.csv = fopen (ps.optarg, "w+b");
if (context.csv == NULL) {
perror ("Unable to open output file");
return -1;
}
setbuf (context.csv, NULL);
break;
case 'c':
codec = benchmark_parse_codec (optarg, &opts);
codec = benchmark_parse_codec (ps.optarg, &opts);
if (codec == NULL) {
fprintf (stderr, "Unable to find codec.\n");
return -1;
}
break;
case 't':
min_exec_time = strtod (optarg, NULL);
min_exec_time = strtod (ps.optarg, NULL);
break;
}

optc++;
}

if ( optind >= argc ) {
if ( ps.optind >= argc ) {
fputs ("No input files specified.\n", stderr);
return -1;
}

if (context.csv != NULL)
fprintf (context.csv, "dataset,plugin,codec,level,raw_size,compressed_size,compress_cpu,compress_wall,decompress_cpu,decompress_wall\r\n");

while ( optind < argc ) {
context.input_name = argv[optind];
// loop over the input dataset files, processing them:
while ( ps.optind < argc ) {
context.input_name = argv[ps.optind];
context.input = fopen (context.input_name, "rb");
if (context.input == NULL) {
perror ("Unable to open input data");
Expand All @@ -402,7 +495,7 @@ int main (int argc, char** argv) {
benchmark_codec (codec, &context);
}

optind++;
ps.optind++;
}

if (context.csv != NULL) {
Expand Down
Loading