pe_task_error_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 <stdbool.h>
#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_dma.h>
#include <doca_types.h>
#include <doca_log.h>
#include <doca_pe.h>
 
#include <samples/common.h>
#include "pe_common.h"
 
DOCA_LOG_REGISTER(PE_TASK_ERROR::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_TASKS (255)
#define DMA_BUFFER_SIZE (1024)
#define BUFFER_SIZE (DMA_BUFFER_SIZE * 2 * NUM_TASKS)
#define BUF_INVENTORY_SIZE (NUM_TASKS * 2)
 
struct pe_task_error_sample_state {
    struct pe_sample_state_base base;
 
    struct doca_dma *dma;
    struct doca_ctx *dma_ctx;
    struct doca_dma_task_memcpy *tasks[NUM_TASKS];
    bool dma_stop_called;
    bool dma_has_stopped;
};
 
static const char *ctx_state_to_string(enum doca_ctx_states state)
{
    switch (state) {
    case DOCA_CTX_STATE_IDLE:
        return "idle";
    case DOCA_CTX_STATE_STARTING:
        return "starting";
    case DOCA_CTX_STATE_RUNNING:
        return "running";
    case DOCA_CTX_STATE_STOPPING:
        return "stopping";
    default:
        return "unknown";
    }
}
 
static void dma_state_changed_cb(const union doca_data ctx_user_data,
                 struct doca_ctx *ctx,
                 enum doca_ctx_states prev_state,
                 enum doca_ctx_states next_state)
{
    struct pe_task_error_sample_state *state = (struct pe_task_error_sample_state *)ctx_user_data.ptr;
 
    DOCA_LOG_INFO("CTX %p state changed from %s to %s",
              ctx,
              ctx_state_to_string(prev_state),
              ctx_state_to_string(next_state));
 
    if (next_state == DOCA_CTX_STATE_STOPPING) {
        if (!state->dma_stop_called)
            DOCA_LOG_INFO("CTX moved to stopping state unexpectedly");
    }
 
    if ((prev_state == DOCA_CTX_STATE_STOPPING) && (next_state == DOCA_CTX_STATE_IDLE))
        state->dma_has_stopped = true;
}
 
/*
 * DMA Memcpy task completed callback
 *
 * @dma_task [in]: Completed task
 * @task_user_data [in]: doca_data from the task
 * @ctx_user_data [in]: doca_data from the context
 */
static void dma_memcpy_completed_callback(struct doca_dma_task_memcpy *dma_task,
                      union doca_data task_user_data,
                      union doca_data ctx_user_data)
{
    uint8_t expected_value = (uint8_t)task_user_data.u64;
    struct pe_task_error_sample_state *state = (struct pe_task_error_sample_state *)ctx_user_data.ptr;
 
    state->base.num_completed_tasks++;
 
    DOCA_LOG_INFO("Task completed (expected value = %d)", expected_value);
 
    (void)process_completed_dma_memcpy_task(dma_task, expected_value);
 
    /* The task is no longer required, therefore it can be freed */
    (void)dma_task_free(dma_task);
}
 
/*
 * Memcpy task error callback
 *
 * @dma_task [in]: failed task
 * @task_user_data [in]: doca_data from the task
 * @ctx_user_data [in]: doca_data from the context
 */
static void dma_memcpy_error_callback(struct doca_dma_task_memcpy *dma_task,
                      union doca_data task_user_data,
                      union doca_data ctx_user_data)
{
    struct pe_task_error_sample_state *state = (struct pe_task_error_sample_state *)ctx_user_data.ptr;
    struct doca_task *task = doca_dma_task_memcpy_as_task(dma_task);
    uint8_t expected_value = (uint8_t)task_user_data.u64;
 
    (void)task_user_data;
 
    /* This sample defines that a task is completed even if it is completed with error */
    state->base.num_completed_tasks++;
 
    DOCA_LOG_ERR("Task failed with status %s (expected value = %d)",
             doca_error_get_descr(doca_task_get_status(task)),
             expected_value);
 
    (void)dma_task_free(dma_task);
}
 
static doca_error_t create_dma(struct pe_task_error_sample_state *state)
{
    union doca_data ctx_user_data = {0};
 
    DOCA_LOG_INFO("Creating DMA");
 
    EXIT_ON_FAILURE(doca_dma_create(state->base.device, &state->dma));
    state->dma_ctx = doca_dma_as_ctx(state->dma);
 
    /* A context can only be connected to one PE (PE can run multiple contexts) */
    EXIT_ON_FAILURE(doca_pe_connect_ctx(state->base.pe, state->dma_ctx));
 
    ctx_user_data.ptr = state;
    EXIT_ON_FAILURE(doca_ctx_set_user_data(state->dma_ctx, ctx_user_data));
 
    EXIT_ON_FAILURE(doca_dma_task_memcpy_set_conf(state->dma,
                              dma_memcpy_completed_callback,
                              dma_memcpy_error_callback,
                              NUM_TASKS));
 
    EXIT_ON_FAILURE(doca_ctx_set_state_changed_cb(state->dma_ctx, dma_state_changed_cb));
 
    return DOCA_SUCCESS;
}
 
static doca_error_t allocate_tasks(struct pe_sample_state_base *state,
                   struct doca_dma *dma,
                   uint32_t num_tasks,
                   size_t dma_buffer_size,
                   struct doca_dma_task_memcpy **tasks)
{
    uint32_t task_id = 0;
 
    DOCA_LOG_INFO("Allocating tasks");
 
    for (task_id = 0; task_id < num_tasks; task_id++) {
        struct doca_buf *source = NULL;
        struct doca_buf *destination = NULL;
        union doca_data user_data = {0};
 
        /* User data will be used to verify copy content */
        user_data.u64 = (task_id + 1);
 
        /* 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,
                                   &source));
 
        memset(state->available_buffer, (task_id + 1), dma_buffer_size);
        state->available_buffer += dma_buffer_size;
 
        /* Setting the buf length to 0 will cause HW to fail */
        if (task_id == 2)
            doca_buf_reset_data_len(source);
 
        EXIT_ON_FAILURE(doca_buf_inventory_buf_get_by_addr(state->inventory,
                                   state->mmap,
                                   state->available_buffer,
                                   dma_buffer_size,
                                   &destination));
 
        memset(state->available_buffer, 0, dma_buffer_size);
        state->available_buffer += dma_buffer_size;
 
        EXIT_ON_FAILURE(doca_dma_task_memcpy_alloc_init(dma, source, destination, user_data, &tasks[task_id]));
    }
 
    return DOCA_SUCCESS;
}
 
doca_error_t poll_for_dma_stop(struct pe_task_error_sample_state *state)
{
    size_t num_inflight_tasks = 0;
 
    EXIT_ON_FAILURE(doca_ctx_get_num_inflight_tasks(state->dma_ctx, &num_inflight_tasks));
    while (num_inflight_tasks > 0) {
        (void)doca_pe_progress(state->base.pe);
        EXIT_ON_FAILURE(doca_ctx_get_num_inflight_tasks(state->dma_ctx, &num_inflight_tasks));
    }
 
    while (!state->dma_has_stopped)
        (void)doca_pe_progress(state->base.pe);
 
    return DOCA_SUCCESS;
}
 
static void cleanup(struct pe_task_error_sample_state *state)
{
    /* A context must be stopped before it is destroyed */
    if (state->dma_ctx != NULL)
        (void)doca_ctx_stop(state->dma_ctx);
 
    /* All contexts must be destroyed before PE is destroyed. Context destroy disconnects it from the PE */
    if (state->dma != NULL)
        (void)doca_dma_destroy(state->dma);
 
    pe_sample_base_cleanup(&state->base);
}
 
static doca_error_t run(struct pe_task_error_sample_state *state)
{
    memset(state, 0, sizeof(*state));
 
    state->base.buffer_size = BUFFER_SIZE;
    state->base.buf_inventory_size = BUF_INVENTORY_SIZE;
 
    EXIT_ON_FAILURE(allocate_buffer(&state->base));
    EXIT_ON_FAILURE(open_device(&state->base));
    EXIT_ON_FAILURE(create_mmap(&state->base));
    EXIT_ON_FAILURE(create_buf_inventory(&state->base));
    EXIT_ON_FAILURE(create_pe(&state->base));
    EXIT_ON_FAILURE(create_dma(state));
    EXIT_ON_FAILURE(doca_ctx_start(state->dma_ctx));
    EXIT_ON_FAILURE(allocate_tasks(&state->base, state->dma, NUM_TASKS, DMA_BUFFER_SIZE, state->tasks));
    EXIT_ON_FAILURE(submit_dma_tasks(NUM_TASKS, state->tasks));
    EXIT_ON_FAILURE(poll_for_completion(&state->base, NUM_TASKS));
    EXIT_ON_FAILURE(poll_for_dma_stop(state));
 
    return DOCA_SUCCESS;
}
 
doca_error_t run_pe_task_error_sample(void)
{
    struct pe_task_error_sample_state state;
    doca_error_t status = run(&state);
 
    cleanup(&state);
 
    return status;
}