apsh_modules_get_sample.c

Go to the documentation of this file.

/*
 * Copyright (c) 2022 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 <doca_apsh.h>
#include <doca_log.h>
 
#include "apsh_common.h"
 
DOCA_LOG_REGISTER(MODULES_GET);
 
/*
 * Calls the DOCA APSH API function that matches this sample name and prints the result
 *
 * @dma_device_name [in]: IBDEV Name of the device to use for DMA
 * @pci_vuid [in]: VUID of the device exposed to the target system
 * @os_type [in]: Indicates the OS type of the target system
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
doca_error_t modules_get(const char *dma_device_name,
             const char *pci_vuid,
             enum doca_apsh_system_os os_type,
             const char *mem_region,
             const char *os_symbols)
{
    doca_error_t result;
    int num_modules, i;
    struct doca_apsh_ctx *apsh_ctx;
    struct doca_apsh_system *sys;
    struct doca_apsh_module **modules;
    DOCA_APSH_MODULES_NAME_TYPE mod_name;
 
    /* Init */
    result = init_doca_apsh(dma_device_name, &apsh_ctx);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to init the DOCA APSH lib");
        return result;
    }
    DOCA_LOG_INFO("DOCA APSH lib context init successful");
 
    result = init_doca_apsh_system(apsh_ctx, os_type, os_symbols, mem_region, pci_vuid, &sys);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to init the system context");
        return result;
    }
    DOCA_LOG_INFO("DOCA APSH system context created");
 
    result = doca_apsh_modules_get(sys, &modules, &num_modules);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to get modules of system");
        cleanup_doca_apsh(apsh_ctx, sys);
        return result;
    }
    DOCA_LOG_INFO("Successfully performed %s. Host system has %d modules", __func__, num_modules);
 
    /* Print names of some modules */
    DOCA_LOG_INFO("System modules (showing only 5 or less):");
    for (i = 0; i < 5 && i < num_modules; ++i) {
        mod_name = (DOCA_APSH_MODULES_NAME_TYPE)doca_apsh_module_info_get(modules[i], DOCA_APSH_MODULES_NAME);
        DOCA_LOG_INFO("\t%s", mod_name);
    }
 
    /* Cleanup */
    doca_apsh_module_free(modules);
    cleanup_doca_apsh(apsh_ctx, sys);
    return DOCA_SUCCESS;
}