Skip to content

Commit 45c9525

Browse files
committed
bench: add C benchmarks
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent aebe53b commit 45c9525

File tree

2 files changed

+352
-0
lines changed

2 files changed

+352
-0
lines changed
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2025 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
# VARIABLES #
20+
21+
ifndef VERBOSE
22+
QUIET := @
23+
else
24+
QUIET :=
25+
endif
26+
27+
# Determine the OS ([1][1], [2][2]).
28+
#
29+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
30+
# [2]: http://stackoverflow.com/a/27776822/2225624
31+
OS ?= $(shell uname)
32+
ifneq (, $(findstring MINGW,$(OS)))
33+
OS := WINNT
34+
else
35+
ifneq (, $(findstring MSYS,$(OS)))
36+
OS := WINNT
37+
else
38+
ifneq (, $(findstring CYGWIN,$(OS)))
39+
OS := WINNT
40+
else
41+
ifneq (, $(findstring Windows_NT,$(OS)))
42+
OS := WINNT
43+
endif
44+
endif
45+
endif
46+
endif
47+
48+
# Define the program used for compiling C source files:
49+
ifdef C_COMPILER
50+
CC := $(C_COMPILER)
51+
else
52+
CC := gcc
53+
endif
54+
55+
# Define the command-line options when compiling C files:
56+
CFLAGS ?= \
57+
-std=c99 \
58+
-O3 \
59+
-Wall \
60+
-pedantic
61+
62+
# Determine whether to generate position independent code ([1][1], [2][2]).
63+
#
64+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
65+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
66+
ifeq ($(OS), WINNT)
67+
fPIC ?=
68+
else
69+
fPIC ?= -fPIC
70+
endif
71+
72+
# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
73+
INCLUDE ?=
74+
75+
# List of source files:
76+
SOURCE_FILES ?=
77+
78+
# List of libraries (e.g., `-lopenblas -lpthread`):
79+
LIBRARIES ?=
80+
81+
# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
82+
LIBPATH ?=
83+
84+
# List of C targets:
85+
c_targets := benchmark.length.out
86+
87+
88+
# RULES #
89+
90+
#/
91+
# Compiles source files.
92+
#
93+
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
94+
# @param {string} [CFLAGS] - C compiler options
95+
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
96+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
97+
# @param {string} [SOURCE_FILES] - list of source files
98+
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
99+
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
100+
#
101+
# @example
102+
# make
103+
#
104+
# @example
105+
# make all
106+
#/
107+
all: $(c_targets)
108+
109+
.PHONY: all
110+
111+
#/
112+
# Compiles C source files.
113+
#
114+
# @private
115+
# @param {string} CC - C compiler (e.g., `gcc`)
116+
# @param {string} CFLAGS - C compiler options
117+
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
118+
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
119+
# @param {string} SOURCE_FILES - list of source files
120+
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
121+
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
122+
#/
123+
$(c_targets): %.out: %.c
124+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)
125+
126+
#/
127+
# Runs compiled benchmarks.
128+
#
129+
# @example
130+
# make run
131+
#/
132+
run: $(c_targets)
133+
$(QUIET) ./$<
134+
135+
.PHONY: run
136+
137+
#/
138+
# Removes generated files.
139+
#
140+
# @example
141+
# make clean
142+
#/
143+
clean:
144+
$(QUIET) -rm -f *.o *.out
145+
146+
.PHONY: clean
Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#include "stdlib/blas/base/dger.h"
20+
#include "stdlib/blas/base/shared.h"
21+
#include <stdlib.h>
22+
#include <stdio.h>
23+
#include <math.h>
24+
#include <time.h>
25+
#include <sys/time.h>
26+
27+
#define NAME "dger"
28+
#define ITERATIONS 10000000
29+
#define REPEATS 3
30+
#define MIN 1
31+
#define MAX 6
32+
33+
/**
34+
* Prints the TAP version.
35+
*/
36+
static void print_version( void ) {
37+
printf( "TAP version 13\n" );
38+
}
39+
40+
/**
41+
* Prints the TAP summary.
42+
*
43+
* @param total total number of tests
44+
* @param passing total number of passing tests
45+
*/
46+
static void print_summary( int total, int passing ) {
47+
printf( "#\n" );
48+
printf( "1..%d\n", total ); // TAP plan
49+
printf( "# total %d\n", total );
50+
printf( "# pass %d\n", passing );
51+
printf( "#\n" );
52+
printf( "# ok\n" );
53+
}
54+
55+
/**
56+
* Prints benchmarks results.
57+
*
58+
* @param iterations number of iterations
59+
* @param elapsed elapsed time in seconds
60+
*/
61+
static void print_results( int iterations, double elapsed ) {
62+
double rate = (double)iterations / elapsed;
63+
printf( " ---\n" );
64+
printf( " iterations: %d\n", iterations );
65+
printf( " elapsed: %0.9f\n", elapsed );
66+
printf( " rate: %0.9f\n", rate );
67+
printf( " ...\n" );
68+
}
69+
70+
/**
71+
* Returns a clock time.
72+
*
73+
* @return clock time
74+
*/
75+
static double tic( void ) {
76+
struct timeval now;
77+
gettimeofday( &now, NULL );
78+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
79+
}
80+
81+
/**
82+
* Generates a random number on the interval [0,1).
83+
*
84+
* @return random number
85+
*/
86+
static double rand_double( void ) {
87+
int r = rand();
88+
return (double)r / ( (double)RAND_MAX + 1.0 );
89+
}
90+
91+
/**
92+
* Runs a benchmark.
93+
*
94+
* @param iterations number of iterations
95+
* @param N array dimension size
96+
* @return elapsed time in seconds
97+
*/
98+
static double benchmark1( int iterations, int N ) {
99+
double elapsed;
100+
double A[ N*N ];
101+
double x[ N ];
102+
double y[ N ];
103+
double t;
104+
int i;
105+
int j;
106+
107+
for ( i = 0, j = 0; i < N; i++, j += 2 ) {
108+
x[ i ] = ( rand_double()*20.0 ) - 10.0;
109+
y[ i ] = ( rand_double()*20.0 ) - 10.0;
110+
A[ j ] = ( rand_double()*20.0 ) - 10.0;
111+
A[ j+1 ] = ( rand_double()*20.0 ) - 10.0;
112+
}
113+
t = tic();
114+
for ( i = 0; i < iterations; i++ ) {
115+
// cppcheck-suppress uninitvar
116+
c_dger( CblasRowMajor, N, N, 1.0, x, 1, y, 1, A, N );
117+
if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) {
118+
printf( "should not return NaN\n" );
119+
break;
120+
}
121+
}
122+
elapsed = tic() - t;
123+
if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) {
124+
printf( "should not return NaN\n" );
125+
}
126+
return elapsed;
127+
}
128+
129+
/**
130+
* Runs a benchmark.
131+
*
132+
* @param iterations number of iterations
133+
* @param N array dimension size
134+
* @return elapsed time in seconds
135+
*/
136+
static double benchmark2( int iterations, int N ) {
137+
double elapsed;
138+
double A[ N*N ];
139+
double x[ N ];
140+
double y[ N ];
141+
double t;
142+
int i;
143+
int j;
144+
145+
for ( i = 0, j = 0; i < N; i++, j += 2 ) {
146+
x[ i ] = ( rand_double()*20.0 ) - 10.0;
147+
y[ i ] = ( rand_double()*20.0 ) - 10.0;
148+
A[ j ] = ( rand_double()*20.0 ) - 10.0;
149+
A[ j+1 ] = ( rand_double()*20.0 ) - 10.0;
150+
}
151+
t = tic();
152+
for ( i = 0; i < iterations; i++ ) {
153+
// cppcheck-suppress uninitvar
154+
c_dger_ndarray( N, N, 1.0, x, 1, 0, y, 1, 0, A, N, 1, 0 );
155+
if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) {
156+
printf( "should not return NaN\n" );
157+
break;
158+
}
159+
}
160+
elapsed = tic() - t;
161+
if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) {
162+
printf( "should not return NaN\n" );
163+
}
164+
return elapsed;
165+
}
166+
167+
/**
168+
* Main execution sequence.
169+
*/
170+
int main( void ) {
171+
double elapsed;
172+
int count;
173+
int iter;
174+
int N;
175+
int i;
176+
int j;
177+
178+
// Use the current time to seed the random number generator:
179+
srand( time( NULL ) );
180+
181+
print_version();
182+
count = 0;
183+
for ( i = MIN; i <= MAX; i++ ) {
184+
N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
185+
iter = ITERATIONS / pow( 10, i-1 );
186+
for ( j = 0; j < REPEATS; j++ ) {
187+
count += 1;
188+
printf( "# c::%s:size=%d\n", NAME, N*N );
189+
elapsed = benchmark1( iter, N );
190+
print_results( iter, elapsed );
191+
printf( "ok %d benchmark finished\n", count );
192+
}
193+
}
194+
for ( i = MIN; i <= MAX; i++ ) {
195+
N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
196+
iter = ITERATIONS / pow( 10, i-1 );
197+
for ( j = 0; j < REPEATS; j++ ) {
198+
count += 1;
199+
printf( "# c::%s:ndarray:size=%d\n", NAME, N*N );
200+
elapsed = benchmark2( iter, N );
201+
print_results( iter, elapsed );
202+
printf( "ok %d benchmark finished\n", count );
203+
}
204+
}
205+
print_summary( count, count );
206+
}

0 commit comments

Comments
 (0)