21849135008

Committed 10 Feb 2026 02:21AM UTC coverage: 55.709% (+0.09%) from 55.624%

Build # 21849135008

Build Type

Pull #2016

github

Committed by

web-flow

Commit Message

Merge c90850b1a into d49130d35

Pull Request Pull Request #2016: better support set_cycle in drgroup

Run Details

75 of 93 new or added lines in 1 file covered. (80.65%)

4 existing lines in 2 files now uncovered.

12573 of 22569 relevant lines covered (55.71%)

321147.65 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.86

/trick_source/sim_services/DataRecord/DataRecordGroup.cpp


#include <algorithm>
#include <string>
#include <iostream>
#include <sstream>
#include <string.h>
#include <stdlib.h>
#include <iomanip>
#include <math.h>

#ifdef __GNUC__
#include <cxxabi.h>
#endif

#include "trick/DataRecordGroup.hh"
#include "trick/command_line_protos.h"
#include "trick/exec_proto.h"
#include "trick/reference.h"
#include "trick/memorymanager_c_intf.h"
#include "trick/message_proto.h"
#include "trick/message_type.h"

/**
@details
-# The recording group is enabled
-# The recording group is set to always record data (not changes only)
-# The recording group is set to allocate a maximum of 100,000 records in memory
-# The recording group is set to record at a cycle period of 0.1 seconds.
-# The first recording parameter is assigned to simulation time.  The name of
   the parmeter is named "sys.exec.out.time" to preserve backwards compatibility
   with older %Trick releases.
-# The call_function and call_function_double functions inherited from the SimObject
   are populated.  The data_record function is added as a job for this SimObject.

A sim object is created named @c data_record_group<n> where <n> is a unique group number. A
data_record class job within this sim object is also created that will write the group's
recorded data to disk. The job's name is <tt> data_record_group<n>.<in_name></tt>.

*/
Trick::DataRecordBuffer::DataRecordBuffer() {
    buffer = last_value = NULL ;
    ref = NULL ;
    ref_searched = false ;
}

Trick::DataRecordBuffer::~DataRecordBuffer() {
    if ( buffer ) {
        free(buffer) ;
    }
    if ( last_value ) {
        free(last_value) ;
    }

    ref_free(ref) ;
    free(ref) ;
}


Trick::LoggingCycle::LoggingCycle(double rate_in)
{
    set_rate(rate_in);
}

void Trick::LoggingCycle::set_rate(double rate_in)
{
    rate_in_seconds = rate_in;
    rate_in_tics = (long long)round(rate_in * Trick::JobData::time_tic_value);
}

long long Trick::LoggingCycle::calc_next_tics_on_or_after_input_tic(long long input_tic, long long cycle_tic)
{
    long long next_tic;
    if((input_tic % cycle_tic) != 0)
    {
        next_tic = (input_tic/cycle_tic) * cycle_tic + cycle_tic;
    } else 
    {
        next_tic = input_tic;
    }
    return next_tic;
}

Trick::DataRecordGroupJobData::DataRecordGroupJobData(Trick::DataRecordGroup &owner_in)
    : owner(owner_in)
{
}

Trick::DataRecordGroupJobData::DataRecordGroupJobData(Trick::DataRecordGroup &owner_in, int in_thread, int in_id, std::string in_job_class_name, void *in_sup_class_data,
                                                      double in_cycle, std::string in_name, std::string in_tag, int in_phase,
                                                      double in_start, double in_stop)
    : Trick::JobData(in_thread, in_id, in_job_class_name, in_sup_class_data, in_cycle, in_name, in_tag, in_phase, in_start, in_stop),
      owner(owner_in)
{
}

int Trick::DataRecordGroupJobData::set_cycle(double rate)
{
    owner.set_cycle(rate);
    return 0;
}

Trick::DataRecordGroup::DataRecordGroup( std::string in_name, Trick::DR_Type dr_type ) :
 record(true) ,
 inited(false) ,
 group_name(in_name) ,
 freq(DR_Always),
 start(0.0) ,
 cycle(0.1) ,
 time_value_attr() ,
 num_variable_names(0),
 variable_names(NULL),
 variable_alias(NULL),
 num_change_variable_names(0),
 change_variable_names(NULL),
 change_variable_alias(NULL),
 max_num(100000),
 buffer_num(0),
 writer_num(0),
 max_file_size(1<<30), // 1 GB
 total_bytes_written(0),
 max_size_warning(false),
 writer_buff(NULL),
 single_prec_only(false),
 buffer_type(DR_Buffer),
 job_class("data_record"),
 curr_time(0.0),
 curr_time_dr_job(0.0)
{

    union {
        long l;
        char c[sizeof(long)];
    } byte_order_union;

    byte_order_union.l = 1;
    if (byte_order_union.c[sizeof(long) - 1] != 1) {
        byte_order = "little_endian" ;
    } else {
        byte_order = "big_endian" ;
    }

    // sim object name
    name = std::string("trick_data_record_group_") + in_name ;

    configure_jobs(dr_type) ;

    add_time_variable() ;

    logging_rates.emplace_back(cycle);
}

Trick::DataRecordGroup::~DataRecordGroup() {
    free((void *)time_value_attr.units) ;
}

int Trick::DataRecordGroup::call_function( Trick::JobData * curr_job ) {

    int ret = 0 ;

    switch (curr_job->id) {
        case 1:
            ret = init() ;
            break ;
        case 2:
            ret = write_data(false) ;
            break ;
        case 3:
            ret = checkpoint() ;
            break ;
        case 4:
            clear_checkpoint_vars() ;
            break ;
        case 5:
            ret = restart() ;
            break ;
        case 6:
            ret = shutdown() ;
            break ;
        default:
            ret = data_record(exec_get_sim_time()) ;
            break ;
    }

    return(ret) ;

}

double Trick::DataRecordGroup::call_function_double( Trick::JobData * curr_job ) {
    (void) curr_job ;
    return(0.0) ;
}

void Trick::DataRecordGroup::register_group_with_mm(void * address , const char * type) {
    // Only add to the memory manager if it has not already been added
    if ( TMM_var_exists(name.c_str()) == 0 ) {
        // Declare this to the memory manager.  Must be done here to get the correct type name
        TMM_declare_ext_var(address , TRICK_STRUCTURED, type , 0 , name.c_str() , 0 , NULL ) ;
        ALLOC_INFO * alloc_info = get_alloc_info_at(address) ;
        alloc_info->stcl = TRICK_LOCAL ;
        alloc_info->alloc_type = TRICK_ALLOC_NEW ;
    }
}

const std::string & Trick::DataRecordGroup::get_group_name() {
    return group_name ;
}

size_t Trick::DataRecordGroup::get_num_rates(){
    return logging_rates.size();
}

double Trick::DataRecordGroup::get_rate(const size_t rateIdx)
{
    if(rateIdx < logging_rates.size())
    {
        return logging_rates[rateIdx].rate_in_seconds;
    }
    return -1.0;
}

int Trick::DataRecordGroup::set_cycle( double in_cycle ) {
    return set_rate(0, in_cycle);    
}

int Trick::DataRecordGroup::add_cycle(double in_cycle)
{
    logging_rates.emplace_back(in_cycle);
    set_rate(logging_rates.size()-1, in_cycle);
    return (int)logging_rates.size()-1;
}

int Trick::DataRecordGroup::set_rate(const size_t rate_idx, const double rate_in)
{
    if(rate_idx >= logging_rates.size())
    {
        message_publish(MSG_ERROR, "DataRecordGroup ERROR: DR Group \"%s\" : set_rate: invalid rate idx %lu\n", group_name.c_str(), rate_idx);
        return 1;
    }
    if(inited) {
        int ret = check_if_rate_is_valid(rate_in);
        if(ret)
        {
            emit_rate_error(ret, rate_idx, rate_in);
            message_publish(MSG_ERROR, "DataRecordGroup ERROR: DR Group \"%s\" : Rejecting runtime set_rate(%lu, %.16g)\n", group_name.c_str(), rate_idx, rate_in);
            return 1;
        }
        long long prev_log_tics = (long long)round(curr_time_dr_job * Trick::JobData::time_tic_value);
        long long curr_time_tic = exec_get_time_tics();
        LoggingCycle & curLog = logging_rates[rate_idx];
        curLog.set_rate(rate_in);
        curLog.next_cycle_in_tics = LoggingCycle::calc_next_tics_on_or_after_input_tic(curr_time_tic, curLog.rate_in_tics);
        if(curLog.next_cycle_in_tics == curr_time_tic && curLog.next_cycle_in_tics == prev_log_tics)
        {
            curLog.next_cycle_in_tics += curLog.rate_in_tics;
        }
        for(auto & logCycle : logging_rates)
        {
            logCycle.next_cycle_in_tics = 0;
        }
        advance_log_tics_given_curr_tic(curr_time_tic-1);
        write_job->next_tics = calculate_next_logging_tic(curr_time_tic-1);

        long long next_next_tics = calculate_next_logging_tic(write_job->next_tics);
        write_job->cycle_tics = next_next_tics - write_job->next_tics;
        write_job->cycle = (double)write_job->cycle_tics / Trick::JobData::time_tic_value;
    } else {
        logging_rates[rate_idx].set_rate(rate_in);
    }
    return 0;
}

int Trick::DataRecordGroup::set_phase( unsigned short in_phase ) {
    write_job->phase = in_phase ;
    return(0) ;
}

int Trick::DataRecordGroup::set_freq( DR_Freq in_freq ) {
    freq = in_freq ;
    return(0) ;
}

int Trick::DataRecordGroup::set_max_buffer_size( int num ) {
    max_num = num ;
    return(0) ;
}

int Trick::DataRecordGroup::set_buffer_type( int in_buffer_type ) {
    buffer_type = (DR_Buffering)in_buffer_type ;
    return(0) ;
}

int Trick::DataRecordGroup::set_max_file_size( uint64_t bytes ) {
    if(bytes == 0) {
        max_file_size = UINT64_MAX ;
    } else {
    max_file_size = bytes ; 
    }
    return(0) ;
}

int Trick::DataRecordGroup::set_single_prec_only( bool in_single_prec_only ) {
    single_prec_only = in_single_prec_only ;
    return(0) ;
}

int Trick::DataRecordGroup::set_thread( unsigned int in_thread_id ) {

    unsigned int jj ;
    Trick::JobData * temp_job  ;

    /* make all data_record_groups have same sim object id as data_record */
    for ( jj = 0 ; jj < jobs.size() ; jj++ ) {
        temp_job = jobs[jj] ;
        temp_job->thread = in_thread_id ;
    }
    return 0 ;
}

int Trick::DataRecordGroup::set_job_class( std::string in_class ) {
    write_job->job_class_name = job_class = in_class ;
    return(0) ;
}

int Trick::DataRecordGroup::add_time_variable() {
    REF2 * new_ref ;

    // Create attributes for time recorded as a double
    time_value_attr.type = TRICK_DOUBLE ;
    time_value_attr.size = sizeof(double) ;
    time_value_attr.units = strdup("s") ;

    // Create a reference that records time as sys.exec.out.time
    new_ref = (REF2 *)calloc( 1 , sizeof(REF2));
    new_ref->reference = strdup("sys.exec.out.time") ;
    new_ref->address = &curr_time ;
    new_ref->attr = &time_value_attr ;
    add_variable(new_ref) ;

    return 0 ;
}

int Trick::DataRecordGroup::add_variable( std::string in_name , std::string alias ) {

    Trick::DataRecordBuffer * new_var = new Trick::DataRecordBuffer ;
    // Trim leading spaces
    in_name.erase( 0, in_name.find_first_not_of( " \t" ) );
    // Trim trailing spaces
    in_name.erase( in_name.find_last_not_of( " \t" ) + 1);
    new_var->name = in_name ;
    new_var->alias = alias ;
    rec_buffer.push_back(new_var) ;
    return 0 ;
}

void Trick::DataRecordGroup::remove_variable( std::string in_name ) {
    // Trim leading spaces++ 
    in_name.erase( 0, in_name.find_first_not_of( " \t" ) );
    // Trim trailing spaces
    in_name.erase( in_name.find_last_not_of( " \t" ) + 1);

    if (!in_name.compare("sys.exec.out.time")) {
        // This class assumes sim time is always the first variable.
        // Removing it results in errors.
        return;
    }

    auto remove_from = [&](std::vector<DataRecordBuffer*>& buffer) {
        for (auto i = buffer.begin(); i != buffer.end(); ++i) {
            if (!(*i)->name.compare(in_name)) {
                delete *i;
                buffer.erase(i);
                break;
            }
        }
    };

    remove_from(rec_buffer);
    remove_from(change_buffer);
}

void Trick::DataRecordGroup::remove_all_variables() {
    // remove all but the first variable, which is sim time
    if(!rec_buffer.empty()) {
        for (auto i = rec_buffer.begin() + 1; i != rec_buffer.end(); ++i) {
            delete *i;
        }
        rec_buffer.erase(rec_buffer.begin() + 1, rec_buffer.end());
    }

    // remove everything
    for (auto variable : change_buffer) {
        delete variable;
    }

    change_buffer.clear();
}

int Trick::DataRecordGroup::add_variable( REF2 * ref2 ) {

    if ( ref2 == NULL || ref2->attr == NULL ) {
        return(-1) ;
    }

    Trick::DataRecordBuffer * new_var = new Trick::DataRecordBuffer ;
    new_var->name = std::string(ref2->reference) ;
    new_var->ref_searched = true ;
    new_var->ref = ref2 ;
    new_var->last_value = (char *)calloc(1 , new_var->ref->attr->size) ;
    // Don't allocate space for the temp storage buffer until "init"
    rec_buffer.push_back(new_var) ;

    return(0) ;

}

int Trick::DataRecordGroup::add_change_variable( std::string in_name ) {

    REF2 * ref2 ;

    ref2 = ref_attributes(in_name.c_str()) ;

    if ( ref2 == NULL || ref2->attr == NULL ) {
        message_publish(MSG_WARNING, "DR Group \"%s\" : Could not find Data Record change variable %s.\n", group_name.c_str(), in_name.c_str()) ;
        return(-1) ;
    }

    Trick::DataRecordBuffer * new_var = new Trick::DataRecordBuffer ;
    new_var->ref = ref2 ;
    new_var->name = in_name;
    new_var->buffer = (char *)malloc(ref2->attr->size) ;
    new_var->last_value =  NULL ;
    memcpy(new_var->buffer , ref2->address , ref2->attr->size) ;
    change_buffer.push_back(new_var) ;

    return(0) ;

}

bool Trick::DataRecordGroup::isSupportedType(REF2 * ref2, std::string& message) {
    if (ref2->attr->type == TRICK_STRING || ref2->attr->type == TRICK_STL || ref2->attr->type == TRICK_STRUCTURED) {
        message = "Cannot Data Record variable " + std::string(ref2->reference) + " of unsupported type " + std::to_string(ref2->attr->type);
        return false;
    }
    
    // If this is an array and not a single value, don't record it
    if (ref2->num_index != ref2->attr->num_index) {
        message = "Cannot Data Record arrayed variable " + std::string(ref2->reference);
        return false;
    }

    return true;
}

/**
@details
-# The simulation output directory is retrieved from the CommandLineArguments
-# The log header file is created
   -# The endianness of the log file is written to the log header.
   -# The names of the parameters contained in the log file are written to the header.
-# Memory buffers are allocated to store simulation data
-# The DataRecordGroupObject (a derived SimObject) is added to the Scheduler.
*/
int Trick::DataRecordGroup::init(bool is_restart) {

    unsigned int jj ;
    int ret ;

    // reset counter here so we can "re-init" our recording
    buffer_num = writer_num = total_bytes_written = 0 ;

    output_dir = command_line_args_get_output_dir() ;
    /* this is the common part of the record file name, the format specific will add the correct suffix */
    file_name = output_dir + "/log_" + group_name ;

    pthread_mutex_init(&buffer_mutex, NULL);

    // Allocate recording space for time.
    rec_buffer[0]->buffer = (char *)calloc(max_num , rec_buffer[0]->ref->attr->size) ;
    rec_buffer[0]->last_value = (char *)calloc(1 , rec_buffer[0]->ref->attr->size) ;

    /* Loop through all variables looking up names.  Allocate recording space
       according to size of the variable */
    for (jj = 1; jj < rec_buffer.size() ; jj++) {
        Trick::DataRecordBuffer * drb = rec_buffer[jj] ;
        if ( drb->ref_searched == false ) {
            REF2 * ref2 ;

            ref2 = ref_attributes(drb->name.c_str()) ;
            if ( ref2 == NULL || ref2->attr == NULL ) {
                message_publish(MSG_WARNING, "DR Group \"%s\" : Could not find Data Record variable %s.\n", group_name.c_str(), drb->name.c_str()) ;
                rec_buffer.erase(rec_buffer.begin() + jj--) ;
                delete drb ;
                continue ;
            } else {
                std::string message;
                if (!isSupportedType(ref2, message)) {
                    message_publish(MSG_WARNING, "DR Group \"%s\" : %s\n", group_name.c_str(), message.c_str()) ;
                    rec_buffer.erase(rec_buffer.begin() + jj--) ;
                    delete drb ;
                    continue ;
                } else {
                    drb->ref = ref2 ;
                }
            }
        }
        if ( drb->alias.compare("") ) {
            drb->ref->reference = strdup(drb->alias.c_str()) ;
        }
        drb->last_value = (char *)calloc(1 , drb->ref->attr->size) ;
        drb->buffer = (char *)calloc(max_num , drb->ref->attr->size) ;
        drb->ref_searched = true ;
    }

    write_header() ;

    // call format specific initialization to open destination and write header
    ret = format_specific_init() ;

    if(!is_restart)
    {
        if(!check_if_rates_are_valid())
        {
            disable();
            return (1);
        }
        long long curr_tics = exec_get_time_tics();
        write_job->next_tics = curr_tics;

        long long next_next_tics = calculate_next_logging_tic(write_job->next_tics);
        write_job->cycle_tics = next_next_tics - curr_tics;
        write_job->cycle = (double)write_job->cycle_tics / Trick::JobData::time_tic_value;
    }

    // set the inited flag to true when all initialization is done
    if ( ret == 0 ) {
        inited = true ;
    }

    return(0) ;

}

void Trick::DataRecordGroup::configure_jobs(DR_Type type) {
    switch(type) {
    default:
        // run the restart job in phase 60001
        add_job(0, 5, (char *)"restart", NULL, 1.0, (char *)"restart", (char *)"TRK", 60001) ;

    case DR_Type::DR_Type_FrameLogDataRecord:
        // add_jobs_to_queue will fill in job_id later
        // make the init job run after all other initialization jobs but before the post init checkpoint
        // job so users can allocate memory in initialization jobs and checkpointing data rec groups will work
        add_job(0, 1, (char *)"initialization", NULL, cycle, (char *)"init", (char *)"TRK", 65534) ;
        add_job(0, 2, (char *)"end_of_frame", NULL, 1.0, (char *)"write_data", (char *)"TRK") ;
        add_job(0, 3, (char *)"checkpoint", NULL, 1.0, (char *)"checkpoint", (char *)"TRK") ;
        add_job(0, 4, (char *)"post_checkpoint", NULL, 1.0, (char *)"clear_checkpoint_vars", (char *)"TRK") ;
        add_job(0, 6, (char *)"shutdown", NULL, 1.0, (char *)"shutdown", (char *)"TRK") ;

        write_job = new Trick::DataRecordGroupJobData(*this, 0, 99, (char *)job_class.c_str(), NULL, cycle, (char *)"data_record" , (char *)"TRK") ;
        jobs.push_back(write_job) ;
        break ;
    }
    write_job->set_system_job_class(true);
}

int Trick::DataRecordGroup::checkpoint() {
    unsigned int jj ;

    /*
       Save the names of the variables and the aliases to the checkpoint,
       the rest of the DataRecordBuffer will be reconstructed during restart.
       The first variable is time which we do not have to save.
     */
    if ( rec_buffer.size() > 1 ) {
        num_variable_names = rec_buffer.size() - 1 ;
        variable_names = (char **)TMM_declare_var_1d("char *", (int)rec_buffer.size() - 1) ;
        variable_alias = (char **)TMM_declare_var_1d("char *", (int)rec_buffer.size() - 1) ;

        for (jj = 1; jj < rec_buffer.size() ; jj++) {
            Trick::DataRecordBuffer * drb = rec_buffer[jj] ;

            variable_names[jj-1] = TMM_strdup((char *)drb->name.c_str()) ;
            variable_alias[jj-1] = TMM_strdup((char *)drb->alias.c_str()) ;
        }
    }

    /*
       Save the names of the change variables and the aliases to the checkpoint,
       the rest of the DataRecordBuffer will be reconstructed during restart
     */
    if ( change_buffer.size() > 0 ) {
        num_change_variable_names = change_buffer.size() ;
        change_variable_names = (char **)TMM_declare_var_1d("char *", (int)change_buffer.size()) ;
        change_variable_alias = (char **)TMM_declare_var_1d("char *", (int)change_buffer.size()) ;

        for (jj = 0; jj < change_buffer.size() ; jj++) {
            Trick::DataRecordBuffer * drb = change_buffer[jj] ;

            change_variable_names[jj] = TMM_strdup((char *)drb->name.c_str()) ;
            change_variable_alias[jj] = TMM_strdup((char *)drb->alias.c_str()) ;
        }
    }

    return 0 ;
}

void Trick::DataRecordGroup::clear_checkpoint_vars() {
    
    if ( variable_names ) {
        for(unsigned int jj = 0; jj < num_variable_names; jj++) {
            TMM_delete_var_a(variable_names[jj]);
        }
        TMM_delete_var_a(variable_names) ;
    }

    if ( variable_alias ) {
        for(unsigned int jj = 0; jj < num_variable_names; jj++) {
            TMM_delete_var_a(variable_alias[jj]);
        }
        TMM_delete_var_a(variable_alias) ;
    }

    if ( change_variable_names ) {
        for(unsigned int jj = 0; jj < num_change_variable_names; jj++) {
            TMM_delete_var_a(change_variable_names[jj]);
        }
        TMM_delete_var_a(change_variable_names) ;
    }

    if ( change_variable_alias ) {
        for(unsigned int jj = 0; jj < num_change_variable_names; jj++) {
            TMM_delete_var_a(change_variable_alias[jj]);
        }
        TMM_delete_var_a(change_variable_alias) ;
    }

    variable_names = NULL ;
    variable_alias = NULL ;
    change_variable_names = NULL ;
    change_variable_alias = NULL ;
    num_variable_names = 0 ;
    num_change_variable_names = 0 ;
}

int Trick::DataRecordGroup::restart() {
    std::vector <Trick::DataRecordBuffer *>::iterator drb_it ;

    /* delete the current rec_buffer */
    for ( drb_it = rec_buffer.begin() ; drb_it != rec_buffer.end() ; ++drb_it ) {
        delete *drb_it ;
    }
    rec_buffer.clear() ;
    /* Add back the time variable */
    add_time_variable() ;

    /* delete the current change_buffer contents */
    for ( drb_it = change_buffer.begin() ; drb_it != change_buffer.end() ; ++drb_it ) {
        delete *drb_it ;
    }
    change_buffer.clear() ;

    unsigned int jj ;
    /* add the variable names listed in the checkpoint file */
    for ( jj = 0 ; jj < num_variable_names ; jj++ ) {
        add_variable( variable_names[jj] , variable_alias[jj] ) ;
    }
    for ( jj = 0 ; jj < num_change_variable_names ; jj++ ) {
        add_change_variable( change_variable_names[jj] ) ;
    }

    clear_checkpoint_vars() ;

    // set the write job class to what is in the checkpoint file.
    write_job->job_class_name = job_class ;

    // reset the sim_object name.
    name = std::string("data_record_group_") + group_name ;

    /* call init to open the recording file and look up variable name addresses */
    init(true) ;

    return 0 ;
}

int Trick::DataRecordGroup::write_header() {

    unsigned int jj ;
    std::string header_name ;
    std::fstream out_stream ;

    /*! create the header file used by the GUIs */
    header_name = output_dir + "/log_" + group_name + ".header" ;

    out_stream.open(header_name.c_str(), std::fstream::out ) ;
    if ( ! out_stream  ||  ! out_stream.good() ) {
        return -1;
    }

    /* Header file first line is created in format specific header */
    out_stream << "log_" << group_name ;

    format_specific_header(out_stream) ;

    /* Output the file name, variable size, units, and variable name
     * to the rest of recorded data header file.
     * (e.g. file_name  C_type  units  sim_name)
     * Note: "sys.exec.out.time" should be the first variable in the buffer.
     */
    for (jj = 0; jj < rec_buffer.size() ; jj++) {
        /*! recording single data item */
        out_stream << "log_" << group_name << "\t"
            << type_string(rec_buffer[jj]->ref->attr->type,
                           rec_buffer[jj]->ref->attr->size) << "\t"
            << std::setw(6) ;

        if ( rec_buffer[jj]->ref->attr->mods & TRICK_MODS_UNITSDASHDASH ) {
            out_stream << "--" ;
        } else {
            out_stream << rec_buffer[jj]->ref->attr->units ;
        }
        out_stream << "\t" << rec_buffer[jj]->ref->reference << std::endl ;
    }

    // Send all unwritten characters in the buffer to its output/file.
    out_stream.flush() ;
    out_stream.close() ;

    return(0) ;

}

int Trick::DataRecordGroup::data_record(double in_time) {

    unsigned int jj ;
    unsigned int buffer_offset ;
    Trick::DataRecordBuffer * drb ;
    bool change_detected = false ;

    curr_time_dr_job = in_time;

    //TODO: does not handle bitfields correctly!
    if ( record == true ) {
        if ( freq != DR_Always ) {
            for (jj = 0; jj < change_buffer.size() ; jj++) {
                drb = change_buffer[jj] ;
                REF2 * ref = drb->ref ;
                if ( ref->pointer_present == 1 ) {
                    ref->address = follow_address_path(ref) ;
                }
                if ( memcmp( drb->buffer , drb->ref->address , drb->ref->attr->size) ) {
                    change_detected = true ;
                    memcpy( drb->buffer , drb->ref->address , drb->ref->attr->size) ;
                }
            }

        }

        if ( freq == DR_Always || change_detected == true ) {

            // If this is not the ring buffer and
            // we are going to have trouble fitting 2 data sets then write the data now.
            if ( buffer_type != DR_Ring_Buffer ) {
                if ( buffer_num - writer_num >= (max_num - 2) ) {
                    write_data(true) ;
                }
            }

            curr_time = in_time ;

            if ( freq == DR_Changes_Step ) {
                buffer_offset = buffer_num % max_num ;
                *((double *)(rec_buffer[0]->last_value)) = in_time ;
                for (jj = 0; jj < rec_buffer.size() ; jj++) {
                    drb = rec_buffer[jj] ;
                    REF2 * ref = drb->ref ;
                    int param_size = ref->attr->size ;
                    if ( buffer_offset == 0 ) {
                       drb->curr_buffer = drb->buffer ;
                    } else {
                       drb->curr_buffer += param_size ;
                    }
                    switch ( param_size ) {
                        case 8:
                            *(int64_t *)drb->curr_buffer = *(int64_t *)drb->last_value ;
                            break ;
                        case 4:
                            *(int32_t *)drb->curr_buffer = *(int32_t *)drb->last_value ;
                            break ;
                        case 2:
                            *(int16_t *)drb->curr_buffer = *(int16_t *)drb->last_value ;
                            break ;
                        case 1:
                            *(int8_t *)drb->curr_buffer = *(int8_t *)drb->last_value ;
                            break ;
                        default:
                            memcpy( drb->curr_buffer , drb->last_value , param_size ) ;
                            break ;
                    }
                }
                buffer_num++ ;
            }

            buffer_offset = buffer_num % max_num ;
            for (jj = 0; jj < rec_buffer.size() ; jj++) {
                drb = rec_buffer[jj] ;
                REF2 * ref = drb->ref ;
                if ( ref->pointer_present == 1 ) {
                    ref->address = follow_address_path(ref) ;
                }
                int param_size = ref->attr->size ;
                if ( buffer_offset == 0 ) {
                   drb->curr_buffer = drb->buffer ;
                } else {
                   drb->curr_buffer += param_size ;
                }
                /**
                 * While the typical idiom is something like:
                 * 1. previous_value = current_value
                 * 2. current_value = new_value
                 * That is incorrect here, as curr_buffer is a pointer that has already been
                 * incremented to the next value's location. We therefore set *curr_buffer and
                 * *last_value to the same value, which results in the DR_Changes_Step loop above
                 * correctly using this value as the first point of the step change on the next
                 * call to this function.
                 */
                switch ( param_size ) {
                    case 8:
                        *(int64_t *)drb->last_value = *(int64_t *)drb->curr_buffer = *(int64_t *)ref->address ;
                        break ;
                    case 4:
                        *(int32_t *)drb->last_value = *(int32_t *)drb->curr_buffer = *(int32_t *)ref->address ;
                        break ;
                    case 2:
                        *(int16_t *)drb->last_value = *(int16_t *)drb->curr_buffer = *(int16_t *)ref->address ;
                        break ;
                    case 1:
                        *(int8_t *)drb->last_value = *(int8_t *)drb->curr_buffer = *(int8_t *)ref->address ;
                        break ;
                    default:
                        memcpy( drb->curr_buffer , ref->address , param_size ) ;
                        memcpy( drb->last_value , drb->curr_buffer , param_size ) ;
                        break ;
                }
            }
            buffer_num++ ;
        }
    }

    long long curr_tics = (long long)round(in_time * Trick::JobData::time_tic_value);
    advance_log_tics_given_curr_tic(curr_tics);

    write_job->next_tics = calculate_next_logging_tic(curr_tics);
    write_job->cycle_tics = write_job->next_tics - curr_tics;
    write_job->cycle = (double)write_job->cycle_tics / Trick::JobData::time_tic_value;

    return(0) ;
}

bool Trick::DataRecordGroup::check_if_rates_are_valid()
{
    // long long curr_tics = exec_get_time_tics();
    long long tic_value = Trick::JobData::time_tic_value;
    bool areValid = true;

    for(size_t ii = 0; ii < logging_rates.size(); ++ii)
    {
        double logging_rate = logging_rates[ii].rate_in_seconds;
        int ret = check_if_rate_is_valid(logging_rate);
        if(ret != 0){
            emit_rate_error(ret, ii, logging_rate);
            areValid = false;
        }
    }
    return areValid;
}

void Trick::DataRecordGroup::emit_rate_error(int rate_err_code, size_t log_idx, double err_rate)
{
    long long tic_value = Trick::JobData::time_tic_value;
    if(rate_err_code == 1) {
        message_publish(
            MSG_ERROR,
            "DataRecordGroup ERROR: DR Group \"%s\" : Cycle for %lu logging rate idx is less than time tic value. cycle = "
            "%16.12f, time_tic = %16.12f\n",
            group_name.c_str(),
            log_idx,
            err_rate,
            tic_value);
    } else if(rate_err_code == 2)
    {
        long long cycle_tics = (long long)round(err_rate * tic_value);
        message_publish(MSG_ERROR,
                        "DataRecordGroup ERROR: DR Group \"%s\" : Cycle for %lu logging rate idx cannot be exactly scheduled "
                        "with time tic value. "
                        "cycle = %16.12f, cycle_tics = %lld , time_tic = %16.12f\n",
                        group_name.c_str(),
                        log_idx,
                        err_rate,
                        cycle_tics,
                        1.0 / tic_value);
    }
}

 int Trick::DataRecordGroup::check_if_rate_is_valid(double test_rate)
 {
    long long tic_value = Trick::JobData::time_tic_value;
    int ret = 0;

    double logging_rate = test_rate;
    if(logging_rate < (1.0 / tic_value))
    {
        ret = 1;        
    } else {        
        /* Calculate the if the cycle_tics would be a whole number  */
        double test_rem = fmod(logging_rate * (double)tic_value, 1.0);

        if(test_rem > 0.001)
        {
            ret = 2;
        }
    }
    
    return ret;
 }


/**
 * Loop through the required logging rates and calculate the
 * next logging time in tics.
 * @return Next logging time in tics,
 */
long long Trick::DataRecordGroup::calculate_next_logging_tic(long long min_tic)
{
    long long ticOfCycleToProcess = std::numeric_limits<long long>::max();

    // Loop over all the logging rates. If the logging rate's next tic is equal to the min_tic, test against
    // that rate's next cycle from min. Find the smallest next tic 
    for(size_t cycleIndex = 0; cycleIndex < logging_rates.size(); ++cycleIndex)
    {
        long long logNextTic = logging_rates[cycleIndex].next_cycle_in_tics;

        if(logNextTic == min_tic)
        {
            logNextTic += logging_rates[cycleIndex].rate_in_tics;
        }

        if(logNextTic < ticOfCycleToProcess)
        {
            ticOfCycleToProcess = logNextTic;
        }
    }

    return ticOfCycleToProcess;
}

/**
 * Loop through the required logging rates and advance the next cycle tics of matching rates
 * @param curr_tic_in - time in tics to match and advance the next cycle tic
 */
void Trick::DataRecordGroup::advance_log_tics_given_curr_tic(long long curr_tic_in)
{
    for(size_t cycleIndex = 0; cycleIndex < logging_rates.size(); ++cycleIndex)
    {
        long long & logNextTic = logging_rates[cycleIndex].next_cycle_in_tics;
        logNextTic = LoggingCycle::calc_next_tics_on_or_after_input_tic(curr_tic_in, logging_rates[cycleIndex].rate_in_tics);
        if(logNextTic <= curr_tic_in)
        {
            logNextTic += logging_rates[cycleIndex].rate_in_tics;
        }
    }
}

int Trick::DataRecordGroup::write_data(bool must_write) {

    unsigned int local_buffer_num ;
    unsigned int num_to_write ;
    unsigned int writer_offset ;

    if ( record and inited and (buffer_type == DR_No_Buffer or must_write) and (total_bytes_written <= max_file_size)) {

        // buffer_mutex is used in this one place to prevent forced calls of write_data
        // to not overwrite data being written by the asynchronous thread.
        pthread_mutex_lock(&buffer_mutex) ;

        local_buffer_num = buffer_num ;
        if ( (local_buffer_num - writer_num) > max_num ) {
            num_to_write = max_num ;
        } else {
            num_to_write = (local_buffer_num - writer_num) ;
        }
        writer_num = local_buffer_num - num_to_write ;

        //! This loop pulls a "row" of time homogeneous data and writes it to the file
        while ( writer_num != local_buffer_num ) {

            writer_offset = writer_num % max_num ;
            //! keep record of bytes written to file. Default max is 1GB
            total_bytes_written += format_specific_write_data(writer_offset) ;
            writer_num++ ;

        }

        if(!max_size_warning && (total_bytes_written > max_file_size)) {
            std::cerr << "WARNING: Data record max file size " << (static_cast<double>(max_file_size))/(1<<20) << "MB reached.\n"
            "https://nasa.github.io/trick/documentation/simulation_capabilities/Data-Record#changing-the-max-file-size-of-a-data-record-group-ascii-and-binary-only" 
            << std::endl;
            max_size_warning = true;
        }

        pthread_mutex_unlock(&buffer_mutex) ;

    }

    return 0 ;
}

int Trick::DataRecordGroup::enable() {
    record = true ;
    return(0) ;
}

int Trick::DataRecordGroup::disable() {
    record = false ;
    return(0) ;
}

int Trick::DataRecordGroup::shutdown() {

    // Force write out all data
    record = true ; // If user disabled group, make sure any recorded data gets written out
    write_data(true) ;
    format_specific_shutdown() ;

    remove_all_variables();

    // remove_all_variables does not remove sim time
    if(!rec_buffer.empty()){
        delete rec_buffer[0];
        rec_buffer.clear();
    }

    if ( writer_buff ) {
        free(writer_buff) ;
        writer_buff = NULL ;
    }

    return 0 ;
}

std::string Trick::DataRecordGroup::type_string( int item_type, int item_size ) {
    switch (item_type) {
        case TRICK_CHARACTER:
                return "char";
                break;
        case TRICK_UNSIGNED_CHARACTER:
                return "unsigned_char";
                break;
        case TRICK_STRING:
                return "string";
                break;
        case TRICK_SHORT:
                return "short";
                break;
        case TRICK_UNSIGNED_SHORT:
                return "unsigned_short";
                break;
        case TRICK_ENUMERATED:
        case TRICK_INTEGER:
                return "int";
                break;
        case TRICK_UNSIGNED_INTEGER:
                return "unsigned_int";
                break;
        case TRICK_LONG:
                return "long";
                break;
        case TRICK_UNSIGNED_LONG:
                return "unsigned_long";
                break;
        case TRICK_FLOAT:
                return "float";
                break;
        case TRICK_DOUBLE:
                if ( single_prec_only ) {
                        return "float";
                }
                else {
                        return "double";
                }
                break;
        case TRICK_BITFIELD:
                if (item_size == sizeof(int)) {
                        return "int";
                } else if (item_size == sizeof(short)) {
                        return "short";
                } else {
                        return "char";
                }
                break;
        case TRICK_UNSIGNED_BITFIELD:
                if (item_size == sizeof(int)) {
                        return "unsigned_int";
                } else if (item_size == sizeof(short)) {
                        return "unsigned_short";
                } else {
                        return "unsigned_char";
                }
                break;
        case TRICK_LONG_LONG:
                return "long_long";
                break;
        case TRICK_UNSIGNED_LONG_LONG:
                return "unsigned_long_long";
                break;
        case TRICK_BOOLEAN:
#if ( __sun | __APPLE__ )
                return "int";
#else
                return "unsigned_char";
#endif
                break;
    }
    return "";
}


nasa / trick / 21849135008

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous