coreTest_MessageGeneratorComponent.h

// Copyright 2009-2025 NTESS. Under the terms
// of Contract DE-NA0003525 with NTESS, the U.S.
// Government retains certain rights in this software.
//
// Copyright (c) 2009-2025, NTESS
// All rights reserved.
//
// This file is part of the SST software package. For license
// information, see the LICENSE file in the top level directory of the
// distribution.
 
#ifndef SST_CORE_CORETEST_MESSAGEGENERATORCOMPONENT_H
#define SST_CORE_CORETEST_MESSAGEGENERATORCOMPONENT_H
 
#include "sst/core/component.h"
#include "sst/core/link.h"
 
#include <cstdint>
#include <cstdio>
#include <string>
 
namespace SST::CoreTestMessageGeneratorComponent {
 
class coreTestMessageGeneratorComponent : public SST::Component
{
public:
    // REGISTER THIS COMPONENT INTO THE ELEMENT LIBRARY
    SST_ELI_REGISTER_COMPONENT(
        coreTestMessageGeneratorComponent,
        "coreTestElement",
        "coreTestMessageGeneratorComponent",
        SST_ELI_ELEMENT_VERSION(1,0,0),
        "Messaging rate benchmark component",
        COMPONENT_CATEGORY_NETWORK
    )
 
    SST_ELI_DOCUMENT_PARAMS(
        { "printStats", "Prints the statistics from the component", "0"},
        { "clock", "Sets the clock for the message generator", "1GHz" },
        { "sendcount", "Sets the number of sends in the simulation.", "1000" },
        { "outputinfo", "Sets the level of output information", "1" }
    )
 
    // Optional since there is nothing to document
    SST_ELI_DOCUMENT_STATISTICS(
    )
 
    SST_ELI_DOCUMENT_PORTS(
        { "remoteComponent", "Sets the link for the message component, message components talk to each other exchanging coreTest messages", { "coreTestMessageGeneratorComponent.coreTestMessage", "" } }
    )
 
    // Optional since there is nothing to document
    SST_ELI_DOCUMENT_SUBCOMPONENT_SLOTS(
    )
 
    coreTestMessageGeneratorComponent(SST::ComponentId_t id, SST::Params& params);
    void setup() override {}
    void finish() override
    {
        fprintf(stdout, "Component completed at: %" PRIu64 " milliseconds\n", (uint64_t)getCurrentSimTimeMilli());
    }
 
private:
    coreTestMessageGeneratorComponent(); // for serialization only
    coreTestMessageGeneratorComponent(const coreTestMessageGeneratorComponent&)            = delete; // do not implement
    coreTestMessageGeneratorComponent& operator=(const coreTestMessageGeneratorComponent&) = delete; // do not implement
 
    void         handleEvent(SST::Event* ev);
    virtual bool tick(SST::Cycle_t);
 
    std::string clock_frequency_str;
    int         message_counter_sent;
    int         message_counter_recv;
    int         total_message_send_count;
    int         output_message_info;
 
    SST::Link* remote_component;
};
 
} // namespace SST::CoreTestMessageGeneratorComponent
 
#endif // SST_CORE_CORETEST_MESSAGEGENERATORCOMPONENT_H