graph_sample.c

Go to the documentation of this file.

/*
 * Copyright (c) 2023 NVIDIA CORPORATION AND AFFILIATES.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice, this list of
 *       conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *     * Neither the name of the NVIDIA CORPORATION nor the names of its contributors may be used
 *       to endorse or promote products derived from this software without specific prior written
 *       permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NVIDIA CORPORATION BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TOR (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
 
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
 
#include <doca_mmap.h>
#include <doca_buf.h>
#include <doca_buf_inventory.h>
#include <doca_ctx.h>
#include <doca_pe.h>
#include <doca_dma.h>
#include <doca_graph.h>
#include <doca_types.h>
#include <doca_log.h>
 
#include <samples/common.h>
 
DOCA_LOG_REGISTER(GRAPH::SAMPLE);
 
#define EXIT_ON_FAILURE(_expression_) \
    { \
        doca_error_t _status_ = _expression_; \
\
        if (_status_ != DOCA_SUCCESS) { \
            DOCA_LOG_ERR("%s failed with status %s", __func__, doca_error_get_descr(_status_)); \
            return _status_; \
        } \
    }
 
#define NUM_DMA_NODES 2
 
#define NUM_GRAPH_INSTANCES 10
 
#define DMA_BUFFER_SIZE 1024
 
#define REQUIRED_ENTRY_SIZE (DMA_BUFFER_SIZE + (DMA_BUFFER_SIZE * NUM_DMA_NODES))
 
#define BUFFER_SIZE (REQUIRED_ENTRY_SIZE * NUM_GRAPH_INSTANCES)
 
/* One buffer for source + one buffer for each DMA node (destination) */
#define GRAPH_INSTANCE_NUM_BUFFERS (1 + NUM_DMA_NODES)
#define BUF_INVENTORY_SIZE (GRAPH_INSTANCE_NUM_BUFFERS * NUM_GRAPH_INSTANCES)
 
struct graph_instance_data {
    uint32_t index; /* Index is used for printing */
    struct doca_graph_instance *graph_instance;
    struct doca_buf *source;
    uint8_t *source_addr;
 
    struct doca_dma_task_memcpy *dma_task[NUM_DMA_NODES];
    struct doca_buf *dma_dest[NUM_DMA_NODES];
    uint8_t *dma_dest_addr[NUM_DMA_NODES];
};
 
struct graph_sample_state {
    struct doca_dev *device;
    struct doca_mmap *mmap;
    struct doca_buf_inventory *inventory;
    struct doca_pe *pe;
    struct doca_ctx *contexts[NUM_DMA_NODES];
    struct doca_dma *dma[NUM_DMA_NODES];
 
    uint8_t *buffer;
    uint8_t *available_buffer; /* Points to the available location in the buffer, used during initialization */
 
    struct doca_graph *graph;
    struct doca_graph_node *dma_node[NUM_DMA_NODES];
    struct doca_graph_node *user_node;
 
    /* Array of graph instances. All will be submitted to the work queue at once */
    struct graph_instance_data instances[NUM_GRAPH_INSTANCES];
 
    uint32_t num_completed_instances;
};
 
static doca_error_t allocate_buffer(struct graph_sample_state *state)
{
    DOCA_LOG_INFO("Allocating buffer");
 
    state->buffer = (uint8_t *)malloc(BUFFER_SIZE);
    if (state->buffer == NULL)
        return DOCA_ERROR_NO_MEMORY;
 
    state->available_buffer = state->buffer;
 
    return DOCA_SUCCESS;
}
 
/*
 * Check if DOCA device is DMA capable
 *
 * @devinfo [in]: Device to check
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
static doca_error_t check_dev_dma_capable(struct doca_devinfo *devinfo)
{
    return doca_dma_cap_task_memcpy_is_supported(devinfo);
}
 
static doca_error_t open_device(struct graph_sample_state *state)
{
    DOCA_LOG_INFO("Opening device");
 
    EXIT_ON_FAILURE(open_doca_device_with_capabilities(check_dev_dma_capable, &state->device));
 
    return DOCA_SUCCESS;
}
 
static doca_error_t create_pe(struct graph_sample_state *state)
{
    DOCA_LOG_INFO("Creating progress engine");
 
    EXIT_ON_FAILURE(doca_pe_create(&state->pe));
 
    return DOCA_SUCCESS;
}
 
static doca_error_t create_mmap(struct graph_sample_state *state)
{
    DOCA_LOG_INFO("Creating MMAP");
 
    EXIT_ON_FAILURE(doca_mmap_create(&state->mmap));
    EXIT_ON_FAILURE(doca_mmap_set_memrange(state->mmap, state->buffer, BUFFER_SIZE));
    EXIT_ON_FAILURE(doca_mmap_add_dev(state->mmap, state->device));
    EXIT_ON_FAILURE(doca_mmap_set_permissions(state->mmap, DOCA_ACCESS_FLAG_LOCAL_READ_WRITE));
    EXIT_ON_FAILURE(doca_mmap_start(state->mmap));
 
    return DOCA_SUCCESS;
}
 
static doca_error_t create_buf_inventory(struct graph_sample_state *state)
{
    DOCA_LOG_INFO("Creating buf inventory");
 
    EXIT_ON_FAILURE(doca_buf_inventory_create(BUF_INVENTORY_SIZE, &state->inventory));
    EXIT_ON_FAILURE(doca_buf_inventory_start(state->inventory));
 
    return DOCA_SUCCESS;
}
 
static void dma_task_completed_callback(struct doca_dma_task_memcpy *task,
                    union doca_data task_user_data,
                    union doca_data ctx_user_data)
{
    (void)task;
    (void)task_user_data;
    (void)ctx_user_data;
}
 
static doca_error_t create_dma(struct graph_sample_state *state, uint32_t idx)
{
    DOCA_LOG_INFO("Creating DMA %d", idx);
 
    EXIT_ON_FAILURE(doca_dma_create(state->device, &state->dma[idx]));
    state->contexts[idx] = doca_dma_as_ctx(state->dma[idx]);
 
    EXIT_ON_FAILURE(doca_pe_connect_ctx(state->pe, state->contexts[idx]));
 
    EXIT_ON_FAILURE(doca_dma_task_memcpy_set_conf(state->dma[idx],
                              dma_task_completed_callback,
                              dma_task_completed_callback,
                              NUM_GRAPH_INSTANCES));
 
    return DOCA_SUCCESS;
}
 
static doca_error_t create_dmas(struct graph_sample_state *state)
{
    uint32_t i = 0;
 
    for (i = 0; i < NUM_DMA_NODES; i++)
        EXIT_ON_FAILURE(create_dma(state, i));
 
    return DOCA_SUCCESS;
}
 
static doca_error_t start_contexts(struct graph_sample_state *state)
{
    uint32_t i = 0;
 
    DOCA_LOG_INFO("Starting contexts");
 
    for (i = 0; i < NUM_DMA_NODES; i++)
        EXIT_ON_FAILURE(doca_ctx_start(state->contexts[i]));
 
    return DOCA_SUCCESS;
}
 
static void stop_contexts(struct graph_sample_state *state)
{
    uint32_t i = 0;
 
    /* Assumption: this method is called when contexts can be stopped synchronously */
    for (i = 0; i < NUM_DMA_NODES; i++)
        if (state->contexts[i] != NULL)
            (void)doca_ctx_stop(state->contexts[i]);
}
 
static doca_error_t user_node_callback(void *cookie)
{
    uint32_t i = 0;
 
    struct graph_instance_data *instance = (struct graph_instance_data *)cookie;
    size_t dma_length = 0;
 
    DOCA_LOG_INFO("Instance %d user callback", instance->index);
 
    for (i = 0; i < NUM_DMA_NODES; i++) {
        EXIT_ON_FAILURE(doca_buf_get_data_len(instance->dma_dest[i], &dma_length));
 
        if (dma_length != DMA_BUFFER_SIZE) {
            DOCA_LOG_ERR("DMA destination buffer length %zu should be %d", dma_length, DMA_BUFFER_SIZE);
            return DOCA_ERROR_BAD_STATE;
        }
 
        if (memcmp(instance->dma_dest_addr[i], instance->source_addr, dma_length) != 0) {
            DOCA_LOG_ERR("DMA source and destination mismatch");
            return DOCA_ERROR_BAD_STATE;
        }
    }
 
    return DOCA_SUCCESS;
}
 
static void destroy_graph_instance(struct graph_sample_state *state, uint32_t index)
{
    struct graph_instance_data *instance = &state->instances[index];
    uint32_t i = 0;
 
    if (instance->graph_instance != NULL) {
        (void)doca_graph_instance_destroy(instance->graph_instance);
        instance->graph_instance = NULL;
    }
    for (i = 0; i < NUM_DMA_NODES; i++) {
        if (instance->dma_task[i] != NULL) {
            doca_task_free(doca_dma_task_memcpy_as_task(instance->dma_task[i]));
            instance->dma_task[i] = NULL;
        }
 
        if (instance->dma_dest[i] != NULL) {
            (void)doca_buf_dec_refcount(instance->dma_dest[i], NULL);
            instance->dma_dest[i] = NULL;
        }
    }
 
    if (instance->source != NULL) {
        (void)doca_buf_dec_refcount(instance->source, NULL);
        instance->source = NULL;
    }
}
 
static void graph_completion_callback(struct doca_graph_instance *graph_instance,
                      union doca_data instance_user_data,
                      union doca_data graph_user_data)
{
    struct graph_sample_state *state = (struct graph_sample_state *)graph_user_data.ptr;
    (void)graph_instance;
    (void)instance_user_data;
 
    state->num_completed_instances++;
 
    /* Graph instance and tasks are destroyed at cleanup */
}
 
static doca_error_t create_graph(struct graph_sample_state *state)
{
    union doca_data graph_user_data = {};
    uint32_t i = 0;
 
    DOCA_LOG_INFO("Creating graph");
 
    EXIT_ON_FAILURE(doca_graph_create(state->pe, &state->graph));
 
    EXIT_ON_FAILURE(doca_graph_node_create_from_user(state->graph, user_node_callback, &state->user_node));
 
    /* Creating nodes and building the graph */
    for (i = 0; i < NUM_DMA_NODES; i++) {
        EXIT_ON_FAILURE(doca_graph_node_create_from_ctx(state->graph, state->contexts[i], &state->dma_node[i]));
 
        /* Setting between the user node and the DMA node */
        EXIT_ON_FAILURE(doca_graph_add_dependency(state->graph, state->dma_node[i], state->user_node));
    }
 
    /* Notice that the sample uses the same callback for success & failure. Program can supply different cb */
    EXIT_ON_FAILURE(doca_graph_set_conf(state->graph,
                        graph_completion_callback,
                        graph_completion_callback,
                        NUM_GRAPH_INSTANCES));
 
    graph_user_data.ptr = state;
    EXIT_ON_FAILURE(doca_graph_set_user_data(state->graph, graph_user_data));
 
    /* Graph must be started before it is added to the work queue. The graph is validated during this call */
    EXIT_ON_FAILURE(doca_graph_start(state->graph));
 
    return DOCA_SUCCESS;
}
 
static void destroy_graph(struct graph_sample_state *state)
{
    if (state->graph == NULL)
        return;
 
    doca_graph_stop(state->graph);
    doca_graph_destroy(state->graph);
}
 
static doca_error_t create_graph_instance(struct graph_sample_state *state, uint32_t index)
{
    struct graph_instance_data *instance = &state->instances[index];
    union doca_data task_user_data = {};
    union doca_data graph_instance_user_data = {};
    uint32_t i = 0;
 
    instance->index = index;
 
    EXIT_ON_FAILURE(doca_graph_instance_create(state->graph, &instance->graph_instance));
 
    /* Use doca_buf_inventory_buf_get_by_data to initialize the source buffer */
    EXIT_ON_FAILURE(doca_buf_inventory_buf_get_by_data(state->inventory,
                               state->mmap,
                               state->available_buffer,
                               DMA_BUFFER_SIZE,
                               &instance->source));
    memset(state->available_buffer, (index + 1), DMA_BUFFER_SIZE);
    instance->source_addr = state->available_buffer;
    state->available_buffer += DMA_BUFFER_SIZE;
 
    /* Initialize DMA tasks */
    for (i = 0; i < NUM_DMA_NODES; i++) {
        EXIT_ON_FAILURE(doca_buf_inventory_buf_get_by_addr(state->inventory,
                                   state->mmap,
                                   state->available_buffer,
                                   DMA_BUFFER_SIZE,
                                   &instance->dma_dest[i]));
        instance->dma_dest_addr[i] = state->available_buffer;
        state->available_buffer += DMA_BUFFER_SIZE;
 
        EXIT_ON_FAILURE(doca_dma_task_memcpy_alloc_init(state->dma[i],
                                instance->source,
                                instance->dma_dest[i],
                                task_user_data,
                                &instance->dma_task[i]));
        EXIT_ON_FAILURE(
            doca_graph_instance_set_ctx_node_data(instance->graph_instance,
                                  state->dma_node[i],
                                  doca_dma_task_memcpy_as_task(instance->dma_task[i])));
    }
 
    /* Initialize user callback */
    /* The sample uses the instance as a cookie. From there it can get all the information it needs */
    EXIT_ON_FAILURE(doca_graph_instance_set_user_node_data(instance->graph_instance, state->user_node, instance));
 
    graph_instance_user_data.ptr = instance;
    doca_graph_instance_set_user_data(instance->graph_instance, graph_instance_user_data);
 
    return DOCA_SUCCESS;
}
 
static doca_error_t create_graph_instances(struct graph_sample_state *state)
{
    uint32_t i = 0;
 
    DOCA_LOG_INFO("Creating graph instances");
 
    for (i = 0; i < NUM_GRAPH_INSTANCES; i++)
        EXIT_ON_FAILURE(create_graph_instance(state, i));
 
    return DOCA_SUCCESS;
}
 
static void destroy_graph_instances(struct graph_sample_state *state)
{
    uint32_t i = 0;
 
    for (i = 0; i < NUM_GRAPH_INSTANCES; i++)
        destroy_graph_instance(state, i);
}
 
static doca_error_t submit_instances(struct graph_sample_state *state)
{
    uint32_t i = 0;
 
    DOCA_LOG_INFO("Submitting all graph instances");
 
    for (i = 0; i < NUM_GRAPH_INSTANCES; i++)
        EXIT_ON_FAILURE(doca_graph_instance_submit(state->instances[i].graph_instance));
 
    return DOCA_SUCCESS;
}
 
static void poll_for_completion(struct graph_sample_state *state)
{
    state->num_completed_instances = 0;
 
    DOCA_LOG_INFO("Waiting until all instances are complete");
 
    while (state->num_completed_instances < NUM_GRAPH_INSTANCES)
        (void)doca_pe_progress(state->pe);
 
    DOCA_LOG_INFO("All instances completed");
}
 
static void cleanup(struct graph_sample_state *state)
{
    uint32_t i = 0;
 
    destroy_graph_instances(state);
 
    destroy_graph(state);
 
    stop_contexts(state);
 
    for (i = 0; i < NUM_DMA_NODES; i++)
        if (state->dma[i] != NULL)
            (void)doca_dma_destroy(state->dma[i]);
 
    if (state->pe != NULL)
        (void)doca_pe_destroy(state->pe);
 
    if (state->inventory != NULL) {
        (void)doca_buf_inventory_stop(state->inventory);
        (void)doca_buf_inventory_destroy(state->inventory);
    }
 
    if (state->mmap != NULL) {
        (void)doca_mmap_stop(state->mmap);
        (void)doca_mmap_destroy(state->mmap);
    }
 
    if (state->device != NULL)
        (void)doca_dev_close(state->device);
 
    if (state->buffer != NULL)
        free(state->buffer);
}
 
static doca_error_t run(struct graph_sample_state *state)
{
    EXIT_ON_FAILURE(allocate_buffer(state));
    EXIT_ON_FAILURE(open_device(state));
    EXIT_ON_FAILURE(create_mmap(state));
    EXIT_ON_FAILURE(create_buf_inventory(state));
    EXIT_ON_FAILURE(create_pe(state));
    EXIT_ON_FAILURE(create_dmas(state));
    EXIT_ON_FAILURE(start_contexts(state));
    EXIT_ON_FAILURE(create_graph(state));
    EXIT_ON_FAILURE(create_graph_instances(state));
    EXIT_ON_FAILURE(submit_instances(state));
    poll_for_completion(state);
 
    return DOCA_SUCCESS;
}
 
doca_error_t run_graph_sample(void)
{
    struct graph_sample_state state = {0};
    doca_error_t status = run(&state);
 
    cleanup(&state);
 
    return status;
}