tf_fuzz/tfz-cpp/template/template_line.hpp

/*
 * Copyright (c) 2019-2024, Arm Limited. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */

/* Objects typed to subclasses of the these classes are constructed and filled in by
   the parser as it parses test-template lines.  There is not necessarily a one-to-one
   correspondence between the template lines and either the PSA commands generated nor
   PSA assets they manipulate.  PSA assets (which persist through the test) and PSA
   commands are therefore tracked in separate objects, but referenced here. */

#ifndef TEMPLATE_LINE_HPP
#define TEMPLATE_LINE_HPP

#include <stdint.h>
#include <string>

#include "data_blocks.hpp"
#include "find_or_create_asset.hpp"

class psa_call;
class tf_fuzz_info;

using namespace std;

class template_line
{
public:
    // Data members:  // low value to hide these behind setters and getters
        // Everything about the test -- accumulated PSA commands, assets, etc.:
        tf_fuzz_info *test_state;
        /* Note:  The following are pointers to the psa_asset and psa_call currently
           being worked with.  These objects these are first placed on the appropriate
           vector in test_state of such objects, and then referenced here. */
        expect_info expect;  // everything about expected results
        set_data_info set_data;  // everything about setting PSA-asset data
        asset_name_id_info asset_info;  // everything about the asset(s) for this line
        string asset_2_name;  // if there's a 2nd asset, then this is its name
        string asset_3_name;  // if there's a 3rd asset, then this is its name
        string target_barrier;
            /* asset to tell the psa_call objects to set and search barrier to when
               re-ordering PSA calls.  For key policies, this is not necessarily the
               nominal asset of that call.  For a policy call, it is that policy asset,
               so that later re-settings of the same policy don't pollute the current
               setting of that policy.  However, for key sets and reads, it is not the
               key asset, but its policy. */
        key_policy_info policy_info;  // specific to crypto, but must be in base class
        long call_ser_no;  // unique identifer for psa_call tracker object
        psa_asset_usage random_asset;
            /* if asked to use some random asset from active or deleted, this says
               which.  psa_asset_usage::all if not using this feature. */
        bool assign_data_var_specified;  // asset data to or from a named variable
        string assign_data_var;  // name of variable to dump (assign) data into
        bool print_data;  // true to print asset data to test log
        bool hash_data;  // true to hash data for later comparison
        /* Vectors of asset names or IDs.  These are used to create several similar
           PSA calls from a single template line. */
        bool is_remove;  // true if this template line is to remove an asset
    // Methods (mostly for calling from within yyparse()):
        virtual bool copy_template_to_call (psa_call *the_call) = 0;
        virtual void setup_call (set_data_info set_data, bool random_data,
                                 bool fill_in_template, bool create_call,
                                 template_line *temLin, tf_fuzz_info *rsrc) = 0;
        template_line (tf_fuzz_info *resources);  // (constructor)
        virtual ~template_line (void);

protected:  // a lot simpler to just let subclasses access these directly
    // Data members:
        // Parallel vectors of PSA-asset info, by asset identified:
        /* Not all template lines involve expected data, but all that do use it,
           use it the same, so include it here. */
        string asset_name;  // parsed from template, assigned to psa_asset object
    // Methods:

private:
    // Data members:
    // Methods:
};


/* Note:  The following are sub-classed from template_line (above), and then further
          subclassed in sst_template_line.*pp, crypto_template_line.*pp, etc.  Concep-
          tually, these subclasses might be more logically put in those sub-classing
          files, but this gives a more-even balance of file size and complexity. */


class sst_template_line : public template_line
{
public:
    // Data members:
        // SST-asset info:
        // PSA-call info:
    // Methods:
        bool copy_template_to_call (psa_call *the_call);
        sst_template_line (tf_fuzz_info *resources);  // (constructor)
        ~sst_template_line (void);

protected:
    // Data members:
    // Methods:

private:
    // Data members:
    // Methods:
};


class key_template_line : public template_line
{
public:
    // Data members:
    // Methods:
        bool copy_template_to_call (psa_call *the_call);
        string make_id_based_name (uint64_t id_n, string &name);
            // create ID-based asset name
        key_template_line (tf_fuzz_info *resources);  // (constructor)
        ~key_template_line (void);

protected:
    // Data members:
    // Methods:

private:
    // Data members:
    // Methods:
};

class policy_template_line : public template_line
{
public:
    // Data members:
    // Methods:
        bool copy_template_to_call (psa_call *the_call);
        policy_template_line (tf_fuzz_info *resources);  // (constructor)
        ~policy_template_line (void);

protected:
    // Data members:
    // Methods:

private:
    // Data members:
    // Methods:
        string make_id_based_name (uint64_t id_n, string &name);
            // create ID-based asset name
};


class security_template_line : public template_line
{
public:
    // Data members:  // low value to hide these behind setters and getters
        // Everything about the test -- accumulated PSA commands, assets, etc.:
    // Methods (for calling from within yyparse()):
        security_template_line (tf_fuzz_info *resources);  // (constructor)
        ~security_template_line (void);

protected:  // a lot simpler to just let subclasses access these directly
    // Data members:
    // Methods:

private:
    // Data members:
    // Methods:
};


#endif  // TEMPLATE_LINE_HPP