platform/unix/sys_util.c

/*
 * Copyright (C) 2021 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 "nstackx_util.h"
#include "nstackx_error.h"
#include "nstackx_log.h"
#include "securec.h"

#define TAG "nStackXUtil"

static const char *g_illegalPathString[] = {
    "/../",
};

static const char *g_illegalPathHeadString[] = {
    "../",
};

uint8_t IsFileNameLegal(const char *fileName)
{
    if (fileName == NULL || strlen(fileName) == 0) {
        return NSTACKX_FALSE;
    }

    for (uint32_t idx = 0; idx < sizeof(g_illegalPathHeadString) / sizeof(g_illegalPathHeadString[0]); idx++) {
        if (g_illegalPathHeadString[idx] == NULL || strlen(fileName) < strlen(g_illegalPathHeadString[idx])) {
            continue;
        }
        if (memcmp(fileName, g_illegalPathHeadString[idx], strlen(g_illegalPathHeadString[idx])) == 0) {
            LOGE(TAG, "illegal filename");
            return NSTACKX_FALSE;
        }
    }

    for (uint32_t idx = 0; idx < sizeof(g_illegalPathString) / sizeof(g_illegalPathString[0]); idx++) {
        if (g_illegalPathString[idx] == NULL || strlen(fileName) < strlen(g_illegalPathString[idx])) {
            continue;
        }
        if (strstr(fileName, g_illegalPathString[idx]) != NULL) {
            LOGE(TAG, "illegal filename");
            return NSTACKX_FALSE;
        }
    }
    return NSTACKX_TRUE;
}

int32_t GetCpuNum(void)
{
    return (int)sysconf(_SC_NPROCESSORS_CONF);
}

void StartThreadBindCore(int32_t cpu)
{
    int32_t cpus;
    cpu_set_t mask;
    int32_t syscallres;
    pid_t tid = gettid();
    if (cpu < 0) {
        return;
    }
    cpus = GetCpuNum();
    if (cpus < cpu + 1) {
        return;
    }
    CPU_ZERO(&mask);
    CPU_SET(cpu, &mask);
    syscallres = (int32_t)syscall(__NR_sched_setaffinity, tid, sizeof(mask), &mask);
    if (syscallres < 0) {
        LOGE(TAG, "set thread affinity failed, ret %d, error(%d)", syscallres, errno);
        return;
    }
}

void BindThreadToTargetMask(pid_t tid, uint32_t cpuMask)
{
    if (tid == 0) {
        LOGE(TAG, "invalid tid");
        return;
    }

    int32_t cpus = GetCpuNum();
    if (cpus < 0) {
        return;
    }

    if (cpuMask == 0 || cpuMask >= (1U << (uint32_t)cpus)) {
        LOGE(TAG, "invalid cpu mask");
        return;
    }
    cpu_set_t mask;
    int32_t syscallres;
    uint32_t cpu = CPU_IDX_0;
    CPU_ZERO(&mask);
    LOGI(TAG, "bind thread %d to target core :%x", tid, cpuMask);
    while (cpuMask > 0) {
        if ((cpuMask & 1) == 1) {
            CPU_SET(cpu, &mask);
        }
        cpu++;
        cpuMask = cpuMask >> 1;
    }
    syscallres = (int32_t)syscall(__NR_sched_setaffinity, tid, sizeof(mask), &mask);
    if (syscallres < 0) {
        LOGE(TAG, "set thread affinity failed, ret %d, error(%d)", syscallres, errno);
        return;
    }
}

void SetThreadName(const char *name)
{
    if (name == NULL || strlen(name) == 0 || strlen(name) >= MAX_THREAD_NAME_LEN) {
        LOGE(TAG, "invalid input");
    }
    if (prctl(PR_SET_NAME, name) < 0) {
        LOGE(TAG, "prctl errno %d", errno);
    }
}

void SetMaximumPriorityForThread(void)
{
    if (nice(THREAD_MAXIMUM_PRIORITY) == -1) {
        LOGE(TAG, "nice set error: %d", errno);
    }
}

void ClockGetTime(clockid_t id, struct timespec *tp)
{
    if (clock_gettime(id, tp) != 0) {
        LOGE(TAG, "clock_gettime error: %d", errno);
    }
}

int32_t SemInit(sem_t *sem, int pshared, unsigned int value)
{
    return sem_init(sem, pshared, value);
}

void SemGetValue(sem_t *sem, int *sval)
{
    if (sem_getvalue(sem, sval) != 0) {
        LOGE(TAG, "sem get error: %d", errno);
    }
}

void SemPost(sem_t *sem)
{
    if (sem_post(sem) != 0) {
        LOGE(TAG, "sem post error: %d", errno);
    }
}

void SemWait(sem_t *sem)
{
    if (sem_wait(sem) != 0) {
        LOGE(TAG, "sem wait error: %d", errno);
    }
}

void SemDestroy(sem_t *sem)
{
    if (sem_destroy(sem) != 0) {
        LOGE(TAG, "sem destroy error: %d", errno);
    }
}

int32_t PthreadCreate(pthread_t *tid, const pthread_attr_t *attr, void *(*entry)(void *), void *arg)
{
    return pthread_create(tid, attr, entry, arg);
}

void PthreadJoin(pthread_t thread, void **retval)
{
    if (pthread_join(thread, retval) != 0) {
        LOGE(TAG, "pthread_join failed error: %d", errno);
    }
}

int32_t PthreadMutexInit(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr)
{
    return pthread_mutex_init(mutex, attr);
}

void PthreadMutexDestroy(pthread_mutex_t *mutex)
{
    if (pthread_mutex_destroy(mutex) != 0) {
        LOGE(TAG, "pthread mutex destroy error: %d", errno);
    }
}

int32_t PthreadMutexLock(pthread_mutex_t *mutex)
{
    return pthread_mutex_lock(mutex);
}

int32_t PthreadMutexUnlock(pthread_mutex_t *mutex)
{
    return pthread_mutex_unlock(mutex);
}

void CloseDesc(int32_t desc)
{
    if (close(desc) != 0) {
        LOGE(TAG, "close desc error : %d", errno);
    }
}