File: benchmark_reflection_usage_compilation.sh

package info (click to toggle)
simdjson 4.2.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 27,936 kB
  • sloc: cpp: 171,612; ansic: 19,122; sh: 1,126; python: 842; makefile: 47; ruby: 25; javascript: 13
file content (618 lines) | stat: -rwxr-xr-x 25,668 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
#!/bin/bash

# JSON Parsing Compilation Benchmark: Reflection Usage vs Manual Parsing
# Compares compilation times when ACTUALLY USING reflection for parsing vs manual parsing
# This measures the compile-time cost of reflection-based automatic deserialization

set -e

echo "=== simdjson Reflection Usage Compilation Benchmark ==="
echo "Measuring compilation impact of ACTUALLY USING reflection for parsing"
echo "Starting at: $(date)"
echo
echo "╔════════════════════════════════════════════════════════════════════════════╗"
echo "║                              METHODOLOGY                                   ║"
echo "╠════════════════════════════════════════════════════════════════════════════╣"
echo "║                                                                            ║"
echo "║ FAIR COMPARISON STRATEGY:                                                  ║"
echo "║ This benchmark compares two DIFFERENT approaches to parsing the same JSON: ║"
echo "║                                                                            ║"
echo "║ • MANUAL PARSING: Traditional simdjson with explicit .get() calls          ║"
echo "║   - Uses doc[\"field\"].get(variable) for each field                         ║"
echo "║   - No reflection involved                                                 ║"
echo "║                                                                            ║"
echo "║ • REFLECTION PARSING: Automatic deserialization with reflection            ║"
echo "║   - Uses doc.get<MyStruct>() for automatic field mapping                   ║"
echo "║   - Relies on compile-time reflection to generate parsing code             ║"
echo "║                                                                            ║"
echo "║ WHAT WE'RE MEASURING:                                                      ║"
echo "║ • Compile-time cost of reflection-based automatic deserialization          ║"
echo "║ • Template instantiation overhead for reflection parsing                   ║"
echo "║ • Code generation complexity from using reflection features                ║"
echo "║                                                                            ║"
echo "║ TEST SCENARIOS:                                                            ║"
echo "║                                                                            ║"
echo "║ 1. SIMPLE STRUCT: Basic fields (string, int, bool)                         ║"
echo "║    - Measures baseline reflection overhead                                 ║"
echo "║                                                                            ║"
echo "║ 2. NESTED STRUCT: Multiple levels of nested objects                        ║"
echo "║    - Measures reflection complexity scaling                                ║"
echo "║                                                                            ║"
echo "║ 3. COMPLEX STRUCT: Arrays, optional fields, mixed types                    ║"
echo "║    - Measures real-world reflection usage impact                           ║"
echo "║                                                                            ║"
echo "║ WHY THIS IS MEANINGFUL:                                                    ║"
echo "║ • Shows actual cost of using reflection features                           ║"
echo "║ • Measures compile-time code generation overhead                           ║"
echo "║ • Helps developers understand reflection's compilation impact              ║"
echo "║ • Compares equivalent functionality implemented two different ways         ║"
echo "║                                                                            ║"
echo "╚════════════════════════════════════════════════════════════════════════════╝"
echo

# Configuration
ITERATIONS=10
JOBS=4

# ───────────────────────────── BOX-PRINT HELPER ────────────────────────────
BOX_WIDTH=74                               # characters between the pipes
print_box_line() {                         # usage: print_box_line "text"
  printf "║ %-*s ║\n" "${BOX_WIDTH}" "$1"
}

# Function to test if a compiler supports reflection with debug output
test_reflection_support() {
    local compiler="$1"
    echo "  → Testing compiler: $compiler"

    if [ ! -x "$compiler" ] && ! command -v "$compiler" >/dev/null 2>&1; then
        echo "  → Compiler not found or not executable"
        return 1
    fi

    # Check compiler version first
    echo "  → Compiler version: $("$compiler" --version 2>/dev/null | head -n1 || echo "version check failed")"

    # Simple test: check if compiler accepts reflection flags
    local test_file=$(mktemp /tmp/reflection_test_XXXXXX.cpp)
    cat > "$test_file" << 'EOF'
int main() {
    return 0;
}
EOF

    echo "  → Testing basic reflection flags..."
    local test_exe=$(mktemp /tmp/reflection_test_XXXXXX)
    local basic_result=$("$compiler" -freflection -fexpansion-statements -std=c++26 "$test_file" -o "$test_exe" 2>&1)
    local basic_exit_code=$?

    if [ $basic_exit_code -ne 0 ]; then
        echo "  → Basic flags FAILED with exit code $basic_exit_code"
        echo "  → Error output: $basic_result"
        rm -f "$test_file" "$test_exe"
        return 1
    fi
    echo "  → Basic flags: OK"
    rm -f "$test_exe"

    # Test reflection syntax
    echo "  → Testing reflection syntax..."
    cat > "$test_file" << 'EOF'
struct Test {
    int x;
};

int main() {
    auto refl = ^^Test;
    return 0;
}
EOF

    local syntax_result=$("$compiler" -freflection -fexpansion-statements -std=c++26 "$test_file" -o "$test_exe" 2>&1)
    local syntax_exit_code=$?

    if [ $syntax_exit_code -eq 0 ]; then
        echo "  → Reflection syntax: OK"
        echo "  → ✓ REFLECTION SUPPORT CONFIRMED"
        rm -f "$test_file" "$test_exe"
        return 0
    else
        echo "  → Reflection syntax FAILED with exit code $syntax_exit_code"
        echo "  → Error output: $syntax_result"
        rm -f "$test_file" "$test_exe"
        return 1
    fi
}

# Find a compiler with reflection support
echo "Searching for clang++ with reflection support..."

REFLECTION_CXX=""
REFLECTION_CC=""

# List of potential clang++ locations to check
POTENTIAL_COMPILERS=(
    "/usr/local/bin/clang++"
    "/opt/clang/bin/clang++"
    "/usr/bin/clang++"
    "clang++"
)

# If CXX is already set, test it first
if [ -n "$CXX" ]; then
    echo "Testing user-specified compiler: $CXX"
    if test_reflection_support "$CXX"; then
        REFLECTION_CXX="$CXX"
        echo "✓ User-specified compiler supports reflection: $CXX"
    else
        echo "✗ User-specified compiler does not support reflection: $CXX"
        echo "Will search for alternative..."
    fi
fi

# If we don't have a working compiler yet, search for one
if [ -z "$REFLECTION_CXX" ]; then
    for compiler in "${POTENTIAL_COMPILERS[@]}"; do
        echo "Testing: $compiler"
        if test_reflection_support "$compiler"; then
            REFLECTION_CXX="$compiler"
            echo "✓ Found reflection-enabled compiler: $compiler"
            break
        else
            echo "✗ No reflection support: $compiler"
        fi
    done
fi

# Check if we found a working compiler
if [ -z "$REFLECTION_CXX" ]; then
    echo
    echo "╔════════════════════════════════════════════════════════════════════════════╗"
    echo "║                                 ERROR                                      ║"
    echo "╠════════════════════════════════════════════════════════════════════════════╣"
    echo "║                                                                            ║"
    echo "║ No clang++ compiler with reflection support found!                        ║"
    echo "║                                                                            ║"
    echo "║ This benchmark requires a compiler that supports C++26 reflection.        ║"
    echo "║                                                                            ║"
    echo "║ Options:                                                                   ║"
    echo "║ 1. Use the Docker container: ./p2996/run_docker.sh                        ║"
    echo "║ 2. Build clang with reflection from: https://github.com/bloomberg/clang-p2996 ║"
    echo "║ 3. Set CXX environment variable to point to reflection-enabled clang++    ║"
    echo "║                                                                            ║"
    echo "║ Example: CXX=/path/to/reflection-clang++ ./benchmark_script.sh            ║"
    echo "║                                                                            ║"
    echo "╚════════════════════════════════════════════════════════════════════════════╝"
    exit 1
fi

# Set the compilers
export CXX="$REFLECTION_CXX"

# Find corresponding C compiler
if [ -n "$CC" ]; then
    REFLECTION_CC="$CC"
elif [ "$REFLECTION_CXX" = "/usr/local/bin/clang++" ]; then
    REFLECTION_CC="/usr/local/bin/clang"
elif [ "$REFLECTION_CXX" = "/opt/clang/bin/clang++" ]; then
    REFLECTION_CC="/opt/clang/bin/clang"
elif [ "$REFLECTION_CXX" = "/usr/bin/clang++" ]; then
    REFLECTION_CC="/usr/bin/clang"
else
    REFLECTION_CC="clang"
fi

export CC="$REFLECTION_CC"

echo
echo "Using reflection-enabled compiler: $($CXX --version | head -n1)"
echo "Using C compiler: $($CC --version | head -n1)"
echo

# Function to create manual parsing test
create_manual_parsing_test() {
    local test_name="$1"
    local struct_complexity="$2"

    cat > "${test_name}_manual.cpp" << 'EOF'
#include <simdjson.h>
#include <iostream>
#include <string>
#include <vector>
#include <optional>

// Test structures
struct Person {
    std::string name;
    int age;
    bool active;
};

struct Address {
    std::string street;
    std::string city;
    int zipcode;
};

struct Employee {
    Person person;
    Address address;
    std::vector<std::string> skills;
    std::optional<std::string> department;
    double salary;
};

// Manual parsing functions
bool parse_person_manual(simdjson::ondemand::value& val, Person& person) {
    auto obj = val.get_object();
    if (obj.error()) return false;

    for (auto field : obj) {
        std::string_view key = field.unescaped_key();
        if (key == "name") {
            std::string_view name_val;
            if (field.value().get(name_val)) return false;
            person.name = name_val;
        } else if (key == "age") {
            if (field.value().get(person.age)) return false;
        } else if (key == "active") {
            if (field.value().get(person.active)) return false;
        }
    }
    return true;
}

bool parse_address_manual(simdjson::ondemand::value& val, Address& address) {
    auto obj = val.get_object();
    if (obj.error()) return false;

    for (auto field : obj) {
        std::string_view key = field.unescaped_key();
        if (key == "street") {
            std::string_view street_val;
            if (field.value().get(street_val)) return false;
            address.street = street_val;
        } else if (key == "city") {
            std::string_view city_val;
            if (field.value().get(city_val)) return false;
            address.city = city_val;
        } else if (key == "zipcode") {
            if (field.value().get(address.zipcode)) return false;
        }
    }
    return true;
}

bool parse_employee_manual(simdjson::ondemand::document& doc, Employee& employee) {
    auto obj = doc.get_object();
    if (obj.error()) return false;

    for (auto field : obj) {
        std::string_view key = field.unescaped_key();
        if (key == "person") {
            auto person_val = field.value();
            if (!parse_person_manual(person_val, employee.person)) return false;
        } else if (key == "address") {
            auto addr_val = field.value();
            if (!parse_address_manual(addr_val, employee.address)) return false;
        } else if (key == "skills") {
            auto skills_array = field.value().get_array();
            if (skills_array.error()) return false;
            for (auto skill : skills_array) {
                std::string_view skill_val;
                if (skill.get(skill_val)) return false;
                employee.skills.emplace_back(skill_val);
            }
        } else if (key == "department") {
            std::string_view dept_val;
            if (!field.value().get(dept_val)) {
                employee.department = dept_val;
            }
        } else if (key == "salary") {
            if (field.value().get(employee.salary)) return false;
        }
    }
    return true;
}

int main() {
    simdjson::ondemand::parser parser;
    std::string json_str = R"({
        "person": {
            "name": "John Doe",
            "age": 30,
            "active": true
        },
        "address": {
            "street": "123 Main St",
            "city": "Anytown",
            "zipcode": 12345
        },
        "skills": ["C++", "JSON", "Programming"],
        "department": "Engineering",
        "salary": 85000.50
    })";

    simdjson::ondemand::document doc;
    auto error = parser.iterate(simdjson::pad(json_str)).get(doc);
    if (error) {
        std::cerr << "Parse error" << std::endl;
        return 1;
    }

    Employee employee;
    if (!parse_employee_manual(doc, employee)) {
        std::cerr << "Manual parsing failed" << std::endl;
        return 1;
    }

    std::cout << "Manual parsing successful: " << employee.person.name
              << ", age " << employee.person.age << std::endl;
    return 0;
}
EOF
}

# Function to create reflection parsing test
create_reflection_parsing_test() {
    local test_name="$1"
    local struct_complexity="$2"

    cat > "${test_name}_reflection.cpp" << 'EOF'
#include <simdjson.h>
#include <iostream>
#include <string>
#include <vector>
#include <optional>

// Test structures (same as manual version)
struct Person {
    std::string name;
    int age;
    bool active;
};

struct Address {
    std::string street;
    std::string city;
    int zipcode;
};

struct Employee {
    Person person;
    Address address;
    std::vector<std::string> skills;
    std::optional<std::string> department;
    double salary;
};

int main() {
    simdjson::ondemand::parser parser;
    std::string json_str = R"({
        "person": {
            "name": "John Doe",
            "age": 30,
            "active": true
        },
        "address": {
            "street": "123 Main St",
            "city": "Anytown",
            "zipcode": 12345
        },
        "skills": ["C++", "JSON", "Programming"],
        "department": "Engineering",
        "salary": 85000.50
    })";

    simdjson::ondemand::document doc;
    auto error = parser.iterate(simdjson::pad(json_str)).get(doc);
    if (error) {
        std::cerr << "Parse error" << std::endl;
        return 1;
    }

    // Use reflection-based automatic deserialization
    Employee employee;
    auto result = doc.get<Employee>();
    if (result.error()) {
        std::cerr << "Reflection parsing failed" << std::endl;
        return 1;
    }
    employee = result.value();

    std::cout << "Reflection parsing successful: " << employee.person.name
              << ", age " << employee.person.age << std::endl;
    return 0;
}
EOF
}

# Function to time compilation of parsing approach
time_parsing_compilation() {
    local description="$1"
    local test_file="$2"
    local use_reflection="$3"
    local iteration="$4"

    echo "[$iteration] $description"

    # Clean build
    rm -rf build_parsing_test
    mkdir build_parsing_test
    cd build_parsing_test

    # Copy test file
    cp "../$test_file" .

    echo "  Configuring..."
    if [ "$use_reflection" = "true" ]; then
        cmake -DCMAKE_CXX_COMPILER="$CXX" \
              -DSIMDJSON_DEVELOPER_MODE=ON \
              -DSIMDJSON_STATIC_REFLECTION=ON \
              -DBUILD_SHARED_LIBS=OFF \
              ../.. >/dev/null 2>&1
    else
        cmake -DCMAKE_CXX_COMPILER="$CXX" \
              -DSIMDJSON_DEVELOPER_MODE=ON \
              -DSIMDJSON_STATIC_REFLECTION=OFF \
              -DBUILD_SHARED_LIBS=OFF \
              ../.. >/dev/null 2>&1
    fi

    echo "  Building simdjson..."
    cmake --build . --target simdjson >/dev/null 2>&1

    echo "  Compiling parsing test..."
    # Time just the test compilation
    start_time=$(date +%s.%N)

    "$CXX" -std=c++17 -I../../include "$test_file" -L. -lsimdjson -o parsing_test >/dev/null 2>&1

    end_time=$(date +%s.%N)

    # Calculate time duration
    time_taken=$(echo "$end_time $start_time" | awk '{printf "%.3f", $1 - $2}')
    echo "  Completed in: ${time_taken}s"

    cd ..
    rm -rf build_parsing_test

    echo "$time_taken"
}

# Create test files
echo "Creating test files..."
create_manual_parsing_test "complex" "complex"
create_reflection_parsing_test "complex" "complex"

# Arrays to store times
times_manual=""
times_reflection=""

echo
echo "=== MANUAL PARSING COMPILATION ==="
echo "Testing traditional simdjson parsing with explicit .get() calls"
echo

for i in $(seq 1 $ITERATIONS); do
    time_result=$(time_parsing_compilation "Compiling manual parsing test" "complex_manual.cpp" "false" "$i" | tail -n1)
    times_manual="$times_manual $time_result"
done

echo
echo "=== REFLECTION PARSING COMPILATION ==="
echo "Testing automatic deserialization with doc.get<Struct>()"
echo

for i in $(seq 1 $ITERATIONS); do
    time_result=$(time_parsing_compilation "Compiling reflection parsing test" "complex_reflection.cpp" "true" "$i" | tail -n1)
    times_reflection="$times_reflection $time_result"
done

echo
echo "╔════════════════════════════════════════════════════════════════════════════╗"
echo "║           REFLECTION USAGE COMPILATION RESULTS                             ║"
echo "╠════════════════════════════════════════════════════════════════════════════╣"
echo "║                                                                            ║"
echo "║ MANUAL PARSING (explicit .get() calls):                                    ║"
count=1
for t in $times_manual; do
    if [[ "$t" =~ ^[0-9]+\.?[0-9]*$ ]]; then
        line=$(printf "Run %2d: %7.3f seconds" "$count" "$t")
        print_box_line "$line"
        count=$((count + 1))
    fi
done
echo "║                                                                            ║"
echo "║ REFLECTION PARSING (automatic doc.get<Struct>()):                          ║"
count=1
for t in $times_reflection; do
    if [[ "$t" =~ ^[0-9]+\.?[0-9]*$ ]]; then
        line=$(printf "Run %2d: %7.3f seconds" "$count" "$t")
        print_box_line "$line"
        count=$((count + 1))
    fi
done
echo "╚════════════════════════════════════════════════════════════════════════════╝"

echo
echo "╔════════════════════════════════════════════════════════════════════════════╗"
echo "║                              ANALYSIS SUMMARY                              ║"
echo "╠════════════════════════════════════════════════════════════════════════════╣"
echo "║                                                                            ║"

# Calculate averages and percentages - filter to only numeric values first
manual_numbers=""
reflection_numbers=""

for t in $times_manual; do
    if [[ "$t" =~ ^[0-9]+\.?[0-9]*$ ]]; then
        manual_numbers="$manual_numbers $t"
    fi
done

for t in $times_reflection; do
    if [[ "$t" =~ ^[0-9]+\.?[0-9]*$ ]]; then
        reflection_numbers="$reflection_numbers $t"
    fi
done

if [ -n "$manual_numbers" ] && [ -n "$reflection_numbers" ]; then
    manual_avg=$(echo "$manual_numbers" | awk '{sum=0; for(i=1;i<=NF;i++) sum+=$i; print sum/NF}')
    reflection_avg=$(echo "$reflection_numbers" | awk '{sum=0; for(i=1;i<=NF;i++) sum+=$i; print sum/NF}')
    overhead=$(echo "$reflection_avg $manual_avg" | awk '{printf "%.3f", $1 - $2}')

    if [ $(echo "$manual_avg > 0" | awk '{print ($1 > 0)}') -eq 1 ]; then
        percent=$(echo "$reflection_avg $manual_avg" | awk '{printf "%.1f", ($1 - $2) / $2 * 100}')
    else
        percent="0"
    fi

    print_box_line "MANUAL PARSING RESULTS:"
    print_box_line "$(printf "Average compilation time: %.3fs" "$manual_avg")"
    print_box_line ""
    print_box_line "REFLECTION PARSING RESULTS:"
    print_box_line "$(printf "Average compilation time: %.3fs" "$reflection_avg")"
    print_box_line ""
    print_box_line "REFLECTION OVERHEAD:"
    print_box_line "$(printf "Additional time: %.3fs (%+.1f%%)" "$overhead" "$percent")"
    print_box_line ""
else
    echo "║ ERROR: Could not extract valid timing data                                 ║"
    echo "║ Manual times: $times_manual"
    echo "║ Reflection times: $times_reflection"
    echo "║                                                                            ║"
fi

echo "╠════════════════════════════════════════════════════════════════════════════╣"
echo "║                              INTERPRETATION                                ║"
echo "╠════════════════════════════════════════════════════════════════════════════╣"
echo "║                                                                            ║"
echo "║ WHAT THESE RESULTS SHOW:                                                   ║"
echo "║                                                                            ║"
echo "║ • COMPILE-TIME COST: How much longer reflection parsing takes to compile   ║"
echo "║   - Higher % = more expensive template instantiation and codegen           ║"
echo "║                                                                            ║"
echo "║ • CODE GENERATION OVERHEAD: Reflection creates parsing code at compile     ║"
echo "║   time, which requires more template processing than manual parsing        ║"
echo "║                                                                            ║"
echo "║ • DEVELOPER TRADE-OFF: Reflection provides automatic deserialization       ║"
echo "║   but at the cost of increased compilation time                            ║"
echo "║                                                                            ║"
echo "║ EVALUATION:                                                                ║"
echo "║ • Low overhead (0-20%): Reflection is compile-time efficient               ║"
echo "║ • Medium overhead (20-50%): Noticeable but potentially acceptable          ║"
echo "║ • High overhead (50%+): Significant compilation cost for reflection        ║"
echo "║                                                                            ║"
echo "║ REAL-WORLD IMPACT:                                                         ║"
echo "║ • Small projects: Absolute time matters more than percentage               ║"
echo "║ • Large projects: Percentage overhead compounds across many files          ║"
echo "║ • CI/CD pipelines: Longer builds affect development velocity               ║"
echo "║                                                                            ║"
echo "╚════════════════════════════════════════════════════════════════════════════╝"

# Clean up test files
rm -f complex_manual.cpp complex_reflection.cpp

echo
echo "Completed at: $(date)"