Example for the Node Manager

[Previous] [Next] [Up]

This example demonstrates the use of the node manager. See Node manager for a general introduction to key concepts of the node manager.

New Topics

• Node manager process on worker nodes
• Node manager process on client nodes

Detailed Description

Node manager process on worker nodes

The node manager process running on the worker nodes is quite simple. Its main purpose is to make that node available to the node manager and to execute child processes as requested by the node manager. This processes can be generic, independent of the application logic (whereas the executed child process is typically specific to the application).

The example below is very simple: it allows to configure the networking mode (UDP or TCP), the node manager address, and the address range used for child processes. In addition, one can set custom properties via the command line.

In this example the node manager process on the worker node(s) should be started first. The node manager process on the client node(s) should be started afterwards, e.g., in parallel or one after another.

Node manager process on client nodes

The node manager process running on the client nodes is a bit more complex. Typically, this process is your application that contains additional code to make use of the worker nodes managed by the node manager.

This example for the client node process is based on Example for Rendering and Example for Networking modes : the "client" part is contained in this example itself, the "worker" part of that example is launched as child process by the node manager. Additionally, the example shows how to enumerate the known worker nodes and their properties, and how to install callbacks to monitor various events.

In this example the node manager process on the worker node(s) should be started first. The node manager process on the client node(s) should be started afterwards, e.g., in parallel or one after another.

Example Source

Source Code Location: examples/example_node_manager_worker.cpp

/******************************************************************************
 * Copyright 2024 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
// examples/example_node_manager_worker.cpp
//
// Demonstrates a simple node manager process for worker nodes.
//
// The example expects the following command line arguments:
//
//   example_node_manager_worker <mode> <nm_address> <base_address> [<key=value> [...]]
//
// mode           either "UDP or "TCP"
// nm_address     UDP multicast address or TCP unicast address used by the node manager
// base_address   UDP multicast address range used by child processes
// key=value      one or more properties in the form key=value
//
// Examples:
//
//   UDP multicast
//
//   @192.168.1.1: ./example_node_manager_worker UDP 224.1.1.1:1111 224.2.2.2:2222 some_property=foo
//   @192.168.1.2: ./example_node_manager_worker UDP 224.1.1.1:1111 224.2.2.2:2222 some_property=bar
//
//   TCP with head node
//
//   @192.168.1.1: ./example_node_manager_worker TCP 192.168.1.1:1111 224.2.2.2:2222 ...
//   @192.168.1.2: ./example_node_manager_worker TCP 192.168.1.1:1111 224.2.2.2:2222 ...
 
#include <iostream>
#include <string>
 
#include <mi/neuraylib.h>
 
// Include code shared by all examples.
#include "example_shared.h"
 
// An implementation of IChild_process_resolver that accepts all command strings to start child
// processes. This is also the default behavior if no child process resolver is installed.
class Default_child_process_resolver
  : public mi::base::Interface_implement<mi::neuraylib::IChild_process_resolver>
{
public:
    Default_child_process_resolver( mi::neuraylib::IFactory* factory)
      : m_factory( make_handle_dup( factory)) { }
 
    const mi::IString* resolve_process( const char* program_name, const char* /*program_arguments*/)
    {
#ifdef MI_PLATFORM_WINDOWS
        std::string s = program_name + std::string( ".exe");
#else
        std::string s = std::string( "./") + program_name;
#endif
        mi::IString* result = m_factory->create<mi::IString>();
        result->set_c_str( s.c_str());
        return result;
    }
 
private:
    mi::base::Handle<mi::neuraylib::IFactory> m_factory;
};
 
int main( int argc, char* argv[])
{
    // Collect command line parameters
    if( argc < 4 || (strcmp( argv[1], "UDP") != 0 && strcmp( argv[1], "TCP") != 0)) {
        std::cerr << "Usage: example_node_manager_worker UDP|TCP <nm_address> <base_address> \\\n"
                  << "           [<key=value> ...]" << std::endl;
        keep_console_open();
        return EXIT_FAILURE;
    }
    const char* mode                   = argv[1];
    const char* node_manager_address   = argv[2];
    const char* multicast_base_address = argv[3];
 
    // Access the neuray library
    mi::base::Handle<mi::neuraylib::INeuray> neuray( load_and_get_ineuray());
    check_success( neuray.is_valid_interface());
 
    // Create an instance of a node manager worker
    mi::base::Handle<mi::neuraylib::INode_manager_factory> node_manager_factory(
        neuray->get_api_component<mi::neuraylib::INode_manager_factory>());
    mi::base::Handle<mi::neuraylib::INode_manager_worker> worker(
        node_manager_factory->create_worker());
    node_manager_factory = 0;
 
    // Install a child process resolver. The implementation used here is equivalent to not using
    // a child process resolver at all and is merely used for demonstration purposes.
    mi::base::Handle<mi::neuraylib::IFactory> factory(
        neuray->get_api_component<mi::neuraylib::IFactory>());
    mi::base::Handle<mi::neuraylib::IChild_process_resolver> child_process_resolver(
        new Default_child_process_resolver( factory.get()));
    worker->set_child_process_resolver( child_process_resolver.get());
    child_process_resolver = 0;
    factory = 0;
 
    // Set worker node properties specified on the command line
    for( int i = 4; i < argc; i++) {
        const char* equal = strchr( argv[i], '=');
        check_success( equal);
        std::string key( argv[i], static_cast<mi::Size>( equal-argv[i]));
        std::string value( equal+1);
        worker->set_property( key.c_str(), value.c_str());
    }
 
    // Configure the networking mode and address, start the node manager worker
    worker->set_multicast_base_address( multicast_base_address);
    mi::Sint32 result = worker->start( node_manager_address, strcmp( mode, "TCP") == 0);
    check_success( result == 0);
    std::cerr << "Worker node successfully started." << std::endl;
 
    // Wait for other hosts to join/leave the cluster
    sleep_seconds( 30);
 
    // Shut down the node manager worker
    worker->shutdown();
    worker = 0;
    neuray = 0;
 
    // Unload the neuray library
    check_success( unload());
 
    keep_console_open();
    return EXIT_SUCCESS;
}

Source Code Location: examples/example_node_manager_client.cpp

/******************************************************************************
 * Copyright 2024 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
// examples/example_node_manager_client.cpp
//
// Demonstrates a simple node manager process for client nodes.
//
// The example expects the following command line arguments:
//
//   example_networking <mode> <nm_address> <base_address> <scene_file> <mdl_path>
//
// mode           either "UDP or "TCP"
// nm_address     UDP multicast address or TCP unicast address used by the node manager
// base_address   UDP multicast address range used by child processes
// scene_file     some scene file, e.g., main.mi
// mdl_path       path to the MDL modules, e.g., iray-<version>/mdl
//
// Examples:
//
//   UDP multicast
//
//   @192.168.1.1: ./example_node_manager_client UDP 224.1.1.1:1111 224.2.2.2:2222
//   @192.168.1.2: ./example_node_manager_client UDP 224.1.1.1:1111 224.2.2.2:2222
//
//   TCP with head node
//
//   @192.168.1.1: ./example_node_manager_client TCP 192.168.1.1:1111 224.2.2.2:2222
//   @192.168.1.2: ./example_node_manager_client TCP 192.168.1.1:1111 224.2.2.2:2222
 
#include <iostream>
#include <string>
 
#include <mi/neuraylib.h>
 
// Include code shared by all examples.
#include "example_shared.h"
// Include an implementation of IRender_target.
#include "example_render_target_simple.h"
 
// Dumps a map of properties in the form key=value, one item per line.
void dump_properties( const mi::IMap* properties)
{
    mi::Size n_properties = properties->get_length();
    for( mi::Size j = 0; j < n_properties; ++j) {
        const char* key = properties->get_key( j);
        mi::base::Handle<const mi::IString> value( properties->get_value<mi::IString>( key));
        std::cerr << "    " << key << "=" << value->get_c_str() << std::endl;
    }
}
 
// An implementation of IWorker_node_filter that accepts all worker nodes.
class Accept_all_worker_nodes
  : public mi::base::Interface_implement<mi::neuraylib::IWorker_node_filter>
{
public:
    bool is_eligible( const mi::neuraylib::IWorker_node_descriptor*) { return true; }
};
 
// An implementation of ICluster_filter that accepts all clusters.
class Accept_all_clusters
  : public mi::base::Interface_implement<mi::neuraylib::ICluster_filter>
{
public:
    bool is_eligible( const mi::neuraylib::ICluster_descriptor*) { return true; }
};
 
// An implementation of IWorker_node_property_callback that outputs the changed property (or all
// properties if no single change is signalled).
class Worker_node_property_callback
  : public mi::base::Interface_implement<mi::neuraylib::IWorker_node_property_callback>
{
public:
    void property_callback(
        const mi::neuraylib::IWorker_node_descriptor* worker_descriptor,
        const char* changed_property_name)
    {
        mi::base::Handle<const mi::IString> address( worker_descriptor->get_address());
        mi::base::Handle<const mi::IMap> properties( worker_descriptor->get_properties());
        if( changed_property_name) {
            mi::base::Handle<const mi::IString> property(
                properties->get_value<mi::IString>( changed_property_name));
            std::cerr << "Worker node " << address->get_c_str() << " changed property \""
                << changed_property_name << "\" to \"" << property->get_c_str() << "\"."
                << std::endl;
        } else {
            std::cerr << "Worker node " << address->get_c_str() << " communicated its properties:"
                << std::endl;
            dump_properties( properties.get());
        }
    }
};
 
// An implementation of ICluster_property_callback that outputs the changed property (or all
// properties if no single change is signalled).
class Cluster_property_callback
  : public mi::base::Interface_implement<mi::neuraylib::ICluster_property_callback>
{
public:
    void property_callback(
        const mi::neuraylib::ICluster_descriptor* cluster_descriptor,
        const char* changed_property_name)
    {
        mi::base::Handle<const mi::IString> address( cluster_descriptor->get_multicast_address());
        mi::base::Handle<const mi::IMap> properties( cluster_descriptor->get_properties());
        if( changed_property_name) {
            mi::base::Handle<const mi::IString> property(
                properties->get_value<mi::IString>( changed_property_name));
            std::cerr << "Cluster " << address->get_c_str() << " changed property \""
                << changed_property_name << "\" to \"" << property->get_c_str() << "\"."
                << std::endl;
        } else {
            std::cerr << "Cluster " << address->get_c_str() << " communicated its properties:"
                << std::endl;
            dump_properties( properties.get());
        }
    }
};
 
// An implementation of IClient_node_callback that outputs the client node that joined or left the
// cluster.
class Client_node_callback
  : public mi::base::Interface_implement<mi::neuraylib::IClient_node_callback>
{
public:
    void membership_callback( const char* address, bool flag)
    {
        std::cerr << "Client node " << address << (flag ? "joined" : "left")
            << " the cluster." << std::endl;
    }
};
 
// An implementation of IWorker_node_callback that outputs the worker node that joined or left the
// cluster.
class Worker_node_callback
  : public mi::base::Interface_implement<mi::neuraylib::IWorker_node_callback>
{
public:
    void membership_callback( mi::neuraylib::IWorker_node_descriptor* worker_descriptor, bool flag)
    {
        mi::base::Handle<const mi::IString> address( worker_descriptor->get_address());
        std::cerr << "Worker node " << address->get_c_str() << (flag ? " joined" : " left")
            << " the cluster." << std::endl;
    }
};
 
// Set up network and register the serializable classes.
void configuration( mi::neuraylib::INeuray* neuray, const char* address, const char* mdl_path)
{
    // Set UDP networking mode and the given multicast address.
    mi::base::Handle<mi::neuraylib::INetwork_configuration> nc(
        neuray->get_api_component<mi::neuraylib::INetwork_configuration>());
    check_success( nc->set_mode( mi::neuraylib::INetwork_configuration::MODE_UDP) == 0);
    check_success( nc->set_multicast_address( address) == 0);
 
    // Set the search path for .mdl files.
    mi::base::Handle<mi::neuraylib::IRendering_configuration> rc(
        neuray->get_api_component<mi::neuraylib::IRendering_configuration>());
    check_success( rc->add_mdl_path( mdl_path) == 0);
    check_success( rc->add_mdl_path( ".") == 0);
 
    // Load the OpenImageIO, Iray Photoreal, and .mi importer plugins.
    mi::base::Handle<mi::neuraylib::IPlugin_configuration> pc(
        neuray->get_api_component<mi::neuraylib::IPlugin_configuration>());
    check_success( pc->load_plugin_library( "nv_openimageio" MI_BASE_DLL_FILE_EXT) == 0);
    check_success( pc->load_plugin_library( "libiray" MI_BASE_DLL_FILE_EXT) == 0);
    check_success( pc->load_plugin_library( "mi_importer" MI_BASE_DLL_FILE_EXT) == 0);
}
 
void rendering( mi::neuraylib::INeuray* neuray, const char* scene_file)
{
    // Get the database, the global scope of the database, and create a transaction in the global
    // scope for importing the scene file and storing the scene.
    mi::base::Handle<mi::neuraylib::IDatabase> database(
        neuray->get_api_component<mi::neuraylib::IDatabase>());
    check_success( database.is_valid_interface());
    mi::base::Handle<mi::neuraylib::IScope> scope(
        database->get_global_scope());
    mi::base::Handle<mi::neuraylib::ITransaction> transaction(
        scope->create_transaction());
    check_success( transaction.is_valid_interface());
 
    // Import the scene file
    mi::base::Handle<mi::neuraylib::IImport_api> import_api(
        neuray->get_api_component<mi::neuraylib::IImport_api>());
    check_success( import_api.is_valid_interface());
    mi::base::Handle<const mi::IString> uri( import_api->convert_filename_to_uri( scene_file));
    mi::base::Handle<const mi::neuraylib::IImport_result> import_result(
        import_api->import_elements( transaction.get(), uri->get_c_str()));
    check_success( import_result->get_error_number() == 0);
 
    // Create the scene object
    mi::base::Handle<mi::neuraylib::IScene> scene(
        transaction->create<mi::neuraylib::IScene>( "Scene"));
    scene->set_rootgroup(       import_result->get_rootgroup());
    scene->set_options(         import_result->get_options());
    scene->set_camera_instance( import_result->get_camera_inst());
    transaction->store( scene.get(), "the_scene");
 
    // Create the render context using the Iray Photoreal render mode
    scene = transaction->edit<mi::neuraylib::IScene>( "the_scene");
    mi::base::Handle<mi::neuraylib::IRender_context> render_context(
        scene->create_render_context( transaction.get(), "iray"));
    check_success( render_context.is_valid_interface());
    mi::base::Handle<mi::IString> scheduler_mode( transaction->create<mi::IString>());
    scheduler_mode->set_c_str( "batch");
    render_context->set_option( "scheduler_mode", scheduler_mode.get());
    scene = 0;
 
    // Create the render target and render the scene
    mi::base::Handle<mi::neuraylib::IImage_api> image_api(
        neuray->get_api_component<mi::neuraylib::IImage_api>());
    mi::base::Handle<mi::neuraylib::IRender_target> render_target(
        new Render_target( image_api.get(), "Color", 512, 384));
    check_success( render_context->render( transaction.get(), render_target.get(), 0) >= 0);
 
    // Write the image to disk
    mi::base::Handle<mi::neuraylib::IExport_api> export_api(
        neuray->get_api_component<mi::neuraylib::IExport_api>());
    check_success( export_api.is_valid_interface());
    mi::base::Handle<mi::neuraylib::ICanvas> canvas( render_target->get_canvas( 0));
    export_api->export_canvas( "file:example_node_manager_client.png", canvas.get());
 
    transaction->commit();
}
 
int main( int argc, char* argv[])
{
    // Collect command line parameters
    if( argc != 6 || (strcmp( argv[1], "UDP") != 0 && strcmp( argv[1], "TCP") != 0)) {
        std::cerr << "Usage: example_node_manager_client UDP|TCP <nm_address> <base_address> \\\n"
                  << "           <scene_file> <mdl_path>" << std::endl;
        keep_console_open();
        return EXIT_FAILURE;
    }
    const char* mode                   = argv[1];
    const char* node_manager_address   = argv[2];
    const char* multicast_base_address = argv[3];
    const char* scene_file             = argv[4];
    const char* mdl_path               = argv[5];
 
    // Access the neuray library
    mi::base::Handle<mi::neuraylib::INeuray> neuray( load_and_get_ineuray());
    check_success( neuray.is_valid_interface());
 
    // Create an instance of a node manager client
    mi::base::Handle<mi::neuraylib::INode_manager_factory> node_manager_factory(
        neuray->get_api_component<mi::neuraylib::INode_manager_factory>());
    mi::base::Handle<mi::neuraylib::INode_manager_client> client(
        node_manager_factory->create_client());
    node_manager_factory = 0;
 
    // Configure the networking mode and address, start the node manager client
    mi::Sint32 result = client->start( node_manager_address, strcmp( mode, "TCP") == 0);
    check_success( result == 0);
    std::cerr << "Client node successfully started." << std::endl;
    client->set_multicast_base_address( multicast_base_address);
 
    // Output information about known worker nodes
    std::cerr << "Currently known worker nodes:" << std::endl;
    mi::Size n_workers = client->get_number_of_worker_nodes();
    for( mi::Size i = 0; i < n_workers; ++i) {
        mi::base::Handle<const mi::neuraylib::IWorker_node_descriptor> desc(
            client->get_worker_node( i));
        if( !desc.is_valid_interface())
            continue;
        mi::base::Handle<const mi::IString> address( desc->get_address());
        std::cerr << "Address: " << address->get_c_str()
                  << ", in cluster: " << (desc->is_in_cluster() ? "yes": "no")
                  << ", properties:" << std::endl;
        mi::base::Handle<const mi::IMap> properties( desc->get_properties());
        dump_properties( properties.get());
    }
 
    // Attempt to join an existing cluster of at least one worker node. If there is no such cluster
    // yet, create a cluster of one arbitrary worker node and execute the example for networking
    // as child process on the worker node. That node will support the rendering of our scene.
    Accept_all_clusters accept_all_clusters;
    Accept_all_worker_nodes accept_all_worker_nodes;
    mi::base::Handle<mi::neuraylib::INode_manager_cluster> cluster(
        client->join_or_create_cluster( 1, 1, &accept_all_clusters, &accept_all_worker_nodes,
        "example_networking", "UDP %m . ."));
    check_success( cluster.is_valid_interface());
    check_success( cluster->get_cluster_status()
        == mi::neuraylib::INode_manager_cluster::CLUSTER_ESTABLISHED);
 
    // Install our callbacks
    mi::base::Handle<mi::neuraylib::IWorker_node_callback> worker_node_callback(
        new Worker_node_callback);
    cluster->add_worker_node_callback( worker_node_callback.get());
    mi::base::Handle<mi::neuraylib::IClient_node_callback> client_node_callback(
        new Client_node_callback);
    cluster->add_client_node_callback( client_node_callback.get());
    mi::base::Handle<mi::neuraylib::IWorker_node_property_callback> worker_node_property_callback(
        new Worker_node_property_callback);
    cluster->add_worker_property_callback( worker_node_property_callback.get());
    mi::base::Handle<mi::neuraylib::ICluster_property_callback> cluster_property_callback(
        new Cluster_property_callback);
    cluster->add_cluster_property_callback( cluster_property_callback.get());
 
    // Use the cluster. The following section including the called methods is essentially the
    // the example for rendering.
    {
        // Configure the neuray library
        mi::base::Handle<const mi::neuraylib::ICluster_descriptor> cluster_descriptor(
            cluster->get_cluster_descriptor());
        mi::base::Handle<const mi::IString> address( cluster_descriptor->get_multicast_address());
        configuration( neuray.get(), address->get_c_str(), mdl_path);
 
        // Start the neuray library
        mi::Sint32 result = neuray->start();
        check_start_success( result);
 
        // Do the actual rendering
        rendering( neuray.get(), scene_file);
 
        // Shut down the neuray library
        check_success( neuray->shutdown() == 0);
    }
 
    // Leave cluster
    cluster->shutdown();
    cluster = 0;
 
    // Shut down the node manager client
    client->shutdown();
    client = 0;
    neuray = 0;
 
    // Unload the neuray library
    check_success( unload());
 
    keep_console_open();
    return EXIT_SUCCESS;
}

[Previous] [Next] [Up]