rocm-systems/include/amd_smi/impl/amd_smi_drm.h

/*
 * =============================================================================
 * The University of Illinois/NCSA
 * Open Source License (NCSA)
 *
 * Copyright (c) 2023, Advanced Micro Devices, Inc.
 * All rights reserved.
 *
 * Developed by:
 *
 *                 AMD Research and AMD ROC Software Development
 *
 *                 Advanced Micro Devices, Inc.
 *
 *                 www.amd.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal with the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimers.
 *  - Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimers in
 *    the documentation and/or other materials provided with the distribution.
 *  - Neither the names of <Name of Development Group, Name of Institution>,
 *    nor the names of its contributors may be used to endorse or promote
 *    products derived from this Software without specific prior written
 *    permission.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS WITH THE SOFTWARE.
 *
 */

#ifndef AMD_SMI_INCLUDE_IMPL_AMD_SMI_DRM_H_
#define AMD_SMI_INCLUDE_IMPL_AMD_SMI_DRM_H_

#include <unistd.h>
#include <xf86drm.h>
#include <vector>
#include <memory>
#include <mutex>  // NOLINT
#include "amd_smi/amdsmi.h"
#include "amd_smi/impl/amd_smi_lib_loader.h"

namespace amd {
namespace smi {

class AMDSmiDrm {
 public:
    amdsmi_status_t init();
    amdsmi_status_t cleanup();
    amdsmi_status_t get_drm_fd_by_index(uint32_t gpu_index, uint32_t *fd_info) const;
    amdsmi_status_t get_bdf_by_index(uint32_t gpu_index, amdsmi_bdf_t *bdf_info) const;
    amdsmi_status_t get_drm_path_by_index(uint32_t gpu_index, std::string *drm_path) const;
    std::vector<amdsmi_bdf_t> get_bdfs();
    std::vector<std::string>& get_drm_paths();
    bool check_if_drm_is_supported();

   uint32_t get_vendor_id();

    amdsmi_status_t amdgpu_query_info(int fd, unsigned info_id,
                    unsigned size, void *value);
    amdsmi_status_t  amdgpu_query_fw(int fd, unsigned info_id, unsigned fw_type,
                unsigned size, void *value);
    amdsmi_status_t amdgpu_query_hw_ip(int fd, unsigned info_id,
               unsigned hw_ip_type, unsigned size, void *value);
    amdsmi_status_t amdgpu_query_vbios(int fd, void *info);
    amdsmi_status_t amdgpu_query_driver_name(int fd, std::string& driver_name);
    amdsmi_status_t amdgpu_query_driver_date(int fd, std::string& driver_date);

 private:
    // when file is not found, the empty string will be returned
    std::string find_file_in_folder(const std::string& folder,
                  const std::string& regex);
    using DrmCmdWriteFunc = int (*)(int, unsigned long, void *, unsigned long);
    std::vector<int> drm_fds_;  // drm file descriptor by gpu_index
    std::vector<std::string> drm_paths_; // drm path (renderD128 for example)
    std::vector<amdsmi_bdf_t> drm_bdfs_; // bdf
    uint32_t vendor_id;

    AMDSmiLibraryLoader lib_loader_;  // lazy load libdrm
    DrmCmdWriteFunc drm_cmd_write_;   // drmCommandWrite
    using drmGetVersionFunc = drmVersionPtr (*)(int);    // drmGetVersion
    using drmFreeVersionFunc = void (*)(drmVersionPtr);  // drmFreeVersion
    drmGetVersionFunc drm_get_version_;
    drmFreeVersionFunc drm_free_version_;

    std::mutex drm_mutex_;
};


}  // namespace smi
}  // namespace amd

#endif  // AMD_SMI_INCLUDE_IMPL_AMD_SMI_DRM_H_