bytecode.cpp

Go to the documentation of this file.

#include "barretenberg/avm_fuzzer/mutations/bytecode.hpp"
 
#include "barretenberg/avm_fuzzer/fuzz_lib/constants.hpp"
#include "barretenberg/avm_fuzzer/mutations/basic_types/field.hpp"
#include "barretenberg/crypto/poseidon2/poseidon2.hpp"
#include "barretenberg/vm2/common/aztec_constants.hpp"
#include "barretenberg/vm2/common/aztec_types.hpp"
#include "barretenberg/vm2/common/field.hpp"
#include "barretenberg/vm2/simulation/lib/contract_crypto.hpp"
 
extern "C" size_t LLVMFuzzerMutate(uint8_t* Data, size_t Size, size_t MaxSize);
 
namespace {
 
avm2::Fq random_fq_scalar(std::mt19937_64& rng)
{
    std::uniform_int_distribution<uint64_t> dist(0, std::numeric_limits<uint64_t>::max());
 
    std::array<uint64_t, 4> limbs;
    for (size_t i = 0; i < 4; ++i) {
        limbs[i] = dist(rng);
    }
 
    return avm2::Fq(limbs[0], limbs[1], limbs[2], limbs[3]);
}
 
void mutate_point(AffinePoint& point, std::mt19937_64& rng)
{
    // Generates a new valid on-curve point via scalar multiplication of the generator
    // We make some assumptions for this point mutation:
    // - The point is not at infinity
    // - The point is valid (on curve)
 
    // Generate scalar
    Fq scalar = random_fq_scalar(rng);
    point = grumpkin::g1::affine_element::one() * scalar;
}
 
} // namespace
 
namespace bb::avm2::fuzzer {
 
void mutate_bytecode(std::vector<ContractClassWithCommitment>& contract_classes,
                     std::vector<ContractInstance>& contract_instances,
                     const std::vector<AztecAddress>& contract_addresses,
                     std::vector<bb::crypto::merkle_tree::PublicDataLeafValue>& public_data_writes,
                     std::mt19937_64& rng)
{
    using Poseidon2 = crypto::Poseidon2<crypto::Poseidon2Bn254ScalarFieldParams>;
 
    // Skip if no contracts to mutate
    if (contract_classes.empty()) {
        return;
    }
 
    // Select a random contract
    size_t idx = std::uniform_int_distribution<size_t>(0, contract_classes.size() - 1)(rng);
 
    ContractClassWithCommitment& klass = contract_classes[idx];
    ContractInstance& instance = contract_instances[idx];
    const AztecAddress& address = contract_addresses[idx];
 
    // Copy bytecode and mutate it, we allow the default byte-wise fuzzing strategy to modify the
    // bytecode, including expanding or shrinking it.
    std::vector<uint8_t> bytecode = klass.packed_bytecode;
    size_t original_size = bytecode.size();
    size_t max_size = original_size * 2; // Allow growth up to 2x original size
    // We have to resize before calling LLVMFuzzerMutate to ensure there's enough space without writing OOB
    // We have to resize after so that the vector's metadata is correct
    // LLVMFuzzerMutate is a C function that operates on raw pointers
    bytecode.resize(max_size);
    size_t new_size = LLVMFuzzerMutate(bytecode.data(), original_size, max_size);
    bytecode.resize(new_size); // We need to resize here in case it shrunk
 
    // Compute new bytecode commitment and class ID
    FF new_bytecode_commitment = simulation::compute_public_bytecode_commitment(bytecode);
    FF new_class_id = simulation::compute_contract_class_id(
        klass.artifact_hash, klass.private_functions_root, new_bytecode_commitment);
 
    // Store original class ID before modifications
    FF original_class_id = instance.original_contract_class_id;
 
    // Copy into NEW contract class with updated bytecode and id, we don't modify the existing one in case
    // other instances refer to it
    ContractClassWithCommitment new_class = klass;
    new_class.id = new_class_id;
    new_class.packed_bytecode = std::move(bytecode);
    new_class.public_bytecode_commitment = new_bytecode_commitment;
 
    // Update instance's current class ID to point to the newly upgraded-to class
    fuzz_info("Contract at address ", address, ", upgraded from ", original_class_id, " -> ", new_class_id);
    instance.current_contract_class_id = new_class_id;
 
    // Add the new contract class to the vector (for serialization to TS)
    contract_classes.push_back(new_class);
 
    // Compute public data tree writes for UpdateCheck to pass
    FF delayed_public_mutable_slot =
        Poseidon2::hash({ FF(DOM_SEP__PUBLIC_STORAGE_MAP_SLOT), FF(UPDATED_CLASS_IDS_SLOT), address });
 
    // Build preimage
    // todo(ilyas): make this somewhat random but also take into account the mutation on global variables.timestamp
    FF metadata = 0; // The lower 32 bits are the timestamp_of_change, we set to 0 so it has "taken effect"
    FF hash = Poseidon2::hash({ metadata, original_class_id, new_class_id });
 
    std::array<FF, 4> values = { metadata, original_class_id, new_class_id, hash };
 
    for (size_t i = 0; i < 4; i++) {
        FF storage_slot = delayed_public_mutable_slot + i;
        FF leaf_slot = Poseidon2::hash(
            { FF(DOM_SEP__PUBLIC_LEAF_SLOT), FF(CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS), storage_slot });
        public_data_writes.push_back(bb::crypto::merkle_tree::PublicDataLeafValue{ leaf_slot, values[i] });
    }
}
 
void mutate_contract_classes(std::vector<ContractClassWithCommitment>& contract_classes,
                             std::vector<ContractInstance>& contract_instances,
                             std::vector<AztecAddress>& contract_addresses,
                             std::mt19937_64& rng)
{
    // Skip if no contracts to mutate
    if (contract_classes.empty()) {
        return;
    }
 
    // Select a random contract
    size_t idx = std::uniform_int_distribution<size_t>(0, contract_classes.size() - 1)(rng);
 
    ContractClassWithCommitment& klass = contract_classes[idx];
 
    // We don't mutate the packed bytecode here, only some metadata fields
    // We also do not mutate the class id directly such that it may fail.
    // The fuzzer (and AVM) asserts that class IDs are correctly derived in class_id_derivation.cpp
    auto choice = std::uniform_int_distribution<int>(0, 1)(rng);
    switch (choice) {
    case 0:
        // Mutate artifact hash
        mutate_field(klass.artifact_hash, rng, BASIC_FIELD_MUTATION_CONFIGURATION);
        break;
    case 1:
        // Mutate private functions root
        mutate_field(klass.private_functions_root, rng, BASIC_FIELD_MUTATION_CONFIGURATION);
        break;
    default:
        break;
    }
 
    auto new_class_id = simulation::compute_contract_class_id(
        klass.artifact_hash, klass.private_functions_root, klass.public_bytecode_commitment);
 
    for (size_t i = 0; i < contract_instances.size(); i++) {
        // Check if an original instance (i.e. it has address nullifier) refers to this class
        if (contract_instances[i].original_contract_class_id == klass.id) {
            fuzz_info("Mutated original contract class ", klass.id, " at address ", contract_addresses[i]);
            // Since this is an original instance, we also need to update the address nullifier
            auto original_address = simulation::compute_contract_address(contract_instances[i]);
            // Update instance's current class ID to point to the mutated class
            contract_instances[i].current_contract_class_id = new_class_id;
            contract_instances[i].original_contract_class_id = new_class_id;
            auto contract_addr = std::ranges::find_if(
                contract_addresses, [&](const AztecAddress& addr) { return addr == original_address; });
            *contract_addr = simulation::compute_contract_address(contract_instances[i]);
        }
        // Check if an upgraded instance refers to this class
        if (contract_instances[i].current_contract_class_id == klass.id) {
            fuzz_info("Mutated current contract class ", klass.id, " at address ", contract_addresses[i]);
            // Update instance's current class ID to point to the mutated class
            contract_instances[i].current_contract_class_id = new_class_id;
            // No need to update address as it depends on original class ID only
        }
    }
    // Update class ID
    klass.id = new_class_id;
}
 
void mutate_contract_instances(std::vector<ContractInstance>& contract_instances,
                               std::vector<AztecAddress>& contract_addresses,
                               std::mt19937_64& rng)
{
    // Skip if no contracts to mutate
    if (contract_instances.empty()) {
        return;
    }
 
    // Select a random contract
    size_t idx = std::uniform_int_distribution<size_t>(0, contract_instances.size() - 1)(rng);
 
    ContractInstance& instance = contract_instances[idx];
    auto original_address = simulation::compute_contract_address(instance);
 
    // We don't mutate the class IDs here, only the other fields
    constexpr size_t num_mutable_fields = 7;
    auto choice = std::uniform_int_distribution<int>(0, num_mutable_fields - 1)(rng);
    switch (choice) {
    case 0:
        // Mutate salt
        mutate_field(instance.salt, rng, BASIC_FIELD_MUTATION_CONFIGURATION);
        break;
    case 1:
        // Mutate deployer
        mutate_field(instance.deployer, rng, BASIC_FIELD_MUTATION_CONFIGURATION);
        break;
    case 2:
        // Mutate initialization hash
        mutate_field(instance.initialization_hash, rng, BASIC_FIELD_MUTATION_CONFIGURATION);
        break;
    case 3:
        // Mutate nullifier key
        mutate_point(instance.public_keys.nullifier_key, rng);
        break;
    case 4:
        // Mutate incoming viewing key
        mutate_point(instance.public_keys.incoming_viewing_key, rng);
        break;
    case 5:
        // Mutate outgoing viewing key
        mutate_point(instance.public_keys.outgoing_viewing_key, rng);
        break;
    case 6:
        // Mutate tagging key
        mutate_point(instance.public_keys.tagging_key, rng);
        break;
    default:
        break;
    }
 
    auto new_address = simulation::compute_contract_address(instance);
 
    // This should always find a contract address, since we are mutating an existing instance
    auto contract_address =
        std::ranges::find_if(contract_addresses, [&](const AztecAddress& addr) { return addr == original_address; });
    *contract_address = new_address;
}
 
} // namespace bb::avm2::fuzzer