utils/src/image_dfx.cpp

/*
 * Copyright (c) 2024 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "image_dfx.h"

#include <unistd.h>
#include <fstream>
#include <chrono>

#if !defined(IOS_PLATFORM) && !defined(ANDROID_PLATFORM)
#include <sys/timerfd.h>
#include "ffrt.h"
#include "hisysevent.h"
#endif

#include "image_utils.h"
#include "image_log.h"

namespace OHOS {
namespace Media {
static constexpr char IMAGE_FWK_UE[] = "IMAGE_FWK_UE";
const static std::string DEFAULT_VERSION_ID = "1";

ImageEvent::ImageEvent()
{
    startTime_ = ImageUtils::GetNowTimeMilliSeconds();
}

ImageEvent::~ImageEvent()
{
    if (!options_.errorMsg.empty()) {
        ReportDecodeFault();
    } else {
        ReportDecodeInfo();
    }
}

void ImageEvent::SetDecodeInfoOptions(const DecodeInfoOptions &options)
{
    options_ = options;
}

DecodeInfoOptions& ImageEvent::GetDecodeInfoOptions()
{
    return options_;
}

void ImageEvent::SetDecodeErrorMsg(std::string msg)
{
    options_.errorMsg = msg;
}

std::string ImageEvent::getInvokeType()
{
    std::string invokeType;
    switch (options_.invokeType) {
        case (JS_INTERFACE):
            invokeType = "js_interface";
            break;
        case (C_INTERFACE):
            invokeType = "c_interface";
            break;
        default:
            invokeType = "inner_interface";
    }
    return invokeType;
}

void ImageEvent::ReportDecodeFault()
{
    std::string temp = getInvokeType();
#if !defined(IOS_PLATFORM) && !defined(ANDROID_PLATFORM)
    int timerFd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK | TFD_CLOEXEC);
    if (timerFd < 0) {
        return;
    }
    close(timerFd);
    DecodeInfoOptions options = options_;
    ffrt::submit([options, temp] {
        std::string packageName = ImageUtils::GetCurrentProcessName();
        HiSysEventWrite(IMAGE_FWK_UE,
                        "DECODE_FAULT",
                        OHOS::HiviewDFX::HiSysEvent::EventType::BEHAVIOR,
                        "PNAMEID", packageName,
                        "PVERSIONID", DEFAULT_VERSION_ID,
                        "APPLICATION_NAME", packageName,
                        "ROTATE", options.rotate,
                        "EDITABLE", options.editable,
                        "SAMPLE_SIZE", options.sampleSize,
                        "SOURCE_WIDTH", options.sourceWidth,
                        "SOURCE_HEIGHT", options.sourceHeight,
                        "DESIRE_SIZE_WIDTH", options.desireSizeWidth,
                        "DESIRE_SIZE_HEIGHT", options.desireSizeHeight,
                        "DESIRE_REGION_WIDTH", options.desireRegionWidth,
                        "DESIRE_REGION_HEIGHT", options.desireRegionHeight,
                        "DESIRE_REGION_X", options.desireRegionX,
                        "DESIRE_REGION_Y", options.desireRegionY,
                        "DESIRE_DESIRE_PIXEL_FORMAT", options.desirePixelFormat,
                        "INDEX", options.index,
                        "FIT_DENSITY", options.fitDensity,
                        "DESIRE_COLOR_SPACE", options.desireColorSpace,
                        "MIMETYPE", options.mimeType,
                        "MEMORY_SIZE", options.memorySize,
                        "MEMORY_TYPE", options.memoryType,
                        "IMAGE_SOURCE", options.imageSource,
                        "INVOKE_TYPE", temp,
                        "INCREMENTAL_DECODE", options.isIncrementalDecode,
                        "HARD_DECODE", options.isHardDecode,
                        "HARD_DECODE_ERROR", options.hardDecodeError,
                        "ERROR_MSG", options.errorMsg,
                        "PLUGIN_TYPE", options.pluginType,
                        "HEIF_GRID_WIDTH", options.heifGridWidth,
                        "HEIF_GRID_HEIGHT", options.heifGridHeight);
        }, {}, {});
#endif
}

std::string GetInvokeTypeStr(uint16_t invokeType)
{
    switch (invokeType) {
        case (JS_INTERFACE):
            return "js_interface";
        case (C_INTERFACE):
            return "c_interface";
        default:
            return "inner_interface";
    }
}

void ImageEvent::ReportDecodeInfo()
{
    uint64_t costTime = ImageUtils::GetNowTimeMilliSeconds() - startTime_;
    std::string temp = GetInvokeTypeStr(options_.invokeType);
#if !defined(IOS_PLATFORM) && !defined(ANDROID_PLATFORM)
    int timerFd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK | TFD_CLOEXEC);
    if (timerFd < 0) {
        return;
    }
    close(timerFd);
    DecodeInfoOptions options = options_;
    ffrt::submit([options, temp, costTime] {
        std::string packageName = ImageUtils::GetCurrentProcessName();
        HiSysEventParam params[] = {
            { .name = "PNAMEID", .t = HISYSEVENT_STRING, .v = { .s = const_cast<char*>(packageName.c_str()) } },
            { .name = "PVERSIONID", .t = HISYSEVENT_STRING,
              .v = { .s = const_cast<char*>(DEFAULT_VERSION_ID.c_str()) } },
            { .name = "APPLICATION_NAME", .t = HISYSEVENT_STRING,
              .v = { .s = const_cast<char*>(packageName.c_str()) } },
            { .name = "ROTATE", .t = HISYSEVENT_FLOAT, .v = { .f = options.rotate } },
            { .name = "EDITABLE", .t = HISYSEVENT_BOOL, .v = { .b = options.editable } },
            { .name = "SAMPLE_SIZE", .t = HISYSEVENT_UINT32, .v = { .ui32 = options.sampleSize } },
            { .name = "SOURCE_WIDTH", .t = HISYSEVENT_INT32, .v = { .i32 = options.sourceWidth } },
            { .name = "SOURCE_HEIGHT", .t = HISYSEVENT_INT32, .v = { .i32 = options.sourceHeight } },
            { .name = "DESIRE_SIZE_WIDTH", .t = HISYSEVENT_INT32, .v = { .i32 = options.desireSizeWidth } },
            { .name = "DESIRE_SIZE_HEIGHT", .t = HISYSEVENT_INT32, .v = { .i32 = options.desireSizeHeight } },
            { .name = "DESIRE_REGION_WIDTH", .t = HISYSEVENT_INT32, .v = { .i32 = options.desireRegionWidth } },
            { .name = "DESIRE_REGION_HEIGHT", .t = HISYSEVENT_INT32, .v = { .i32 = options.desireRegionHeight } },
            { .name = "DESIRE_REGION_X", .t = HISYSEVENT_INT32, .v = { .i32 = options.desireRegionX } },
            { .name = "DESIRE_REGION_Y", .t = HISYSEVENT_INT32, .v = { .i32 = options.desireRegionY } },
            { .name = "DESIRE_DESIRE_PIXEL_FORMAT", .t = HISYSEVENT_INT32, .v = { .i32 = options.desirePixelFormat } },
            { .name = "INDEX", .t = HISYSEVENT_UINT32, .v = { .ui32 = options.index } },
            { .name = "FIT_DENSITY", .t = HISYSEVENT_INT32, .v = { .i32 = options.fitDensity } },
            { .name = "DESIRE_COLOR_SPACE", .t = HISYSEVENT_INT32, .v = { .i32 = options.desireColorSpace } },
            { .name = "MIMETYPE", .t = HISYSEVENT_STRING, .v = { .s = const_cast<char*>(options.mimeType.c_str()) } },
            { .name = "MEMORY_SIZE", .t = HISYSEVENT_UINT32, .v = { .ui32 = options.memorySize } },
            { .name = "MEMORY_TYPE", .t = HISYSEVENT_INT32, .v = { .i32 = options.memoryType } },
            { .name = "IMAGE_SOURCE", .t = HISYSEVENT_STRING,
              .v = { .s = const_cast<char*>(options.imageSource.c_str()) } },
            { .name = "INVOKE_TYPE", .t = HISYSEVENT_STRING, .v = { .s = const_cast<char*>(temp.c_str()) } },
            { .name = "INCREMENTAL_DECODE", .t = HISYSEVENT_BOOL, .v = { .b = options.isIncrementalDecode } },
            { .name = "HARD_DECODE", .t = HISYSEVENT_BOOL, .v = { .b = options.isHardDecode } },
            { .name = "HARD_DECODE_ERROR", .t = HISYSEVENT_STRING,
              .v = { .s = const_cast<char*>(options.hardDecodeError.c_str()) } },
            { .name = "COST_TIME", .t = HISYSEVENT_UINT64, .v = { .ui64 = costTime } },
            { .name = "PLUGIN_TYPE", .t = HISYSEVENT_STRING,
              .v = { .s = const_cast<char*>(options.pluginType.c_str()) } },
            { .name = "HEIF_GRID_WIDTH", .t = HISYSEVENT_UINT32, .v = { .ui32 = options.heifGridWidth } },
            { .name = "HEIF_GRID_HEIGHT", .t = HISYSEVENT_UINT32, .v = { .ui32 = options.heifGridHeight } },
        };
        OH_HiSysEvent_Write(IMAGE_FWK_UE, "DECODE_INFORMATION", HISYSEVENT_BEHAVIOR, params,
            sizeof(params) / sizeof(params[0]));
        }, {}, {});
#endif
}

void ReportCreateImageSourceFault(uint32_t width, uint32_t height, std::string type, std::string message)
{
#if !defined(IOS_PLATFORM) && !defined(ANDROID_PLATFORM)
    std::string packageName = ImageUtils::GetCurrentProcessName();
    HiSysEventWrite(IMAGE_FWK_UE,
                    "CREATE_IMAGESOURCE_FAULT",
                    OHOS::HiviewDFX::HiSysEvent::EventType::BEHAVIOR,
                    "PNAMEID", packageName,
                    "PVERSIONID", DEFAULT_VERSION_ID,
                    "WIDTH", width,
                    "HEIGHT", height,
                    "TYPE", type,
                    "ERROR_MSG", message);
#endif
}

void ReportEncodeFault(uint32_t width, uint32_t height, std::string mimeType, std::string message)
{
#if !defined(IOS_PLATFORM) && !defined(ANDROID_PLATFORM)
    std::string packageName = ImageUtils::GetCurrentProcessName();
    HiSysEventWrite(IMAGE_FWK_UE,
                    "ENCODE_FAULT",
                    OHOS::HiviewDFX::HiSysEvent::EventType::BEHAVIOR,
                    "PNAMEID", packageName,
                    "PVERSIONID", DEFAULT_VERSION_ID,
                    "WIDTH", width,
                    "HEIGHT", height,
                    "MIME_TYPE", mimeType,
                    "ERROR_MSG", message);
#endif
}
} // namespace Media
} // namespace OHOS