computing-offload/qtfs/rexec/rexec.h

/******************************************************************************
 * Copyright (c) Huawei Technologies Co., Ltd. 2023. All rights reserved.
 * qtfs licensed under the Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 * http://license.coscl.org.cn/MulanPSL2
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR
 * PURPOSE.
 * See the Mulan PSL v2 for more details.
 * Author: Liqiang
 * Create: 2023-03-20
 * Description: 
 *******************************************************************************/

#ifndef __REXEC_H__
#define __REXEC_H__

#include <time.h>
#include <stdbool.h>
#include <sys/stat.h>

enum {
	PIPE_READ = 0,
	PIPE_WRITE,
};

enum {
	REXEC_EVENT_OK,
	REXEC_EVENT_DEL, // del this event
	REXEC_EVENT_EXIT, // exit process
	REXEC_EVENT_ERR,
};

enum {
	REXEC_STDIN = 0,
	REXEC_STDOUT,
	REXEC_STDERR,
	REXEC_NONE,
};

#define REXEC_MSG_1K 1024
#define REXEC_MSG_MAX REXEC_MSG_1K * 1024
#define REXEC_LOG_PATH_LEN 64

// rexec client与server之间建联的sock文件路径
#define REXEC_UDS_CONN "/var/run/rexec/rexec_uds.sock"
#define REXEC_LOCK_PATH   "/var/run/rexec/rexec_uds.lock"
#define REXEC_RUN_PATH    "/var/run/rexec/"

enum rexec_msgtype {
	REXEC_EXEC = 0x5a5a,    // exec process
	REXEC_KILL,             // kill process
	REXEC_PIPE,             // client send a pipefd as stdin/out/err to server
	REXEC_PIDMAP,           // server send remote process's pid to client
	REXEC_HANDSHAKE,
};

struct rexec_msg {
	int msgtype;
	// client to server
	int argc;
	int pipefd;
	int msglen;
	// server to client
	int exit_status;
	int pid; // for pidmap
	char msg[0];
};

extern FILE *rexec_logfile;
static inline void rexec_log_init()
{
	char deflog[REXEC_LOG_PATH_LEN] = "/dev/null";
	char *logfile = getenv("REXEC_LOG_FILE");
	if (logfile == NULL) {
		logfile = deflog;
	} else if (strcmp(logfile, "std") == 0) {
		rexec_logfile = stderr;
		return;
	} else {
		printf("REXEC_LOG_FILE cannot be set to any value other than std\n");
	}
retry:
	rexec_logfile = fopen(logfile, "a");
	if (rexec_logfile == NULL) {
		if (strcmp(logfile, "/dev/null") == 0) {
			return;
		}
		// 输入的文件打开失败则回退到无日志模式
		logfile = deflog;
		goto retry;
	}
	return;
}

// flag: 1--nonblock; 0--block
static inline int rexec_set_nonblock(int fd, int block)
{
	int fflags;
	if ((fflags = fcntl(fd, F_GETFL)) < 0)
		return -1;
	if (block == 0)
		fflags &= ~O_NONBLOCK;
	else
		fflags |= O_NONBLOCK;
	if ((fcntl(fd, F_SETFL, fflags)) < 0)
		return -1;
	return 0;
}

static inline int rexec_set_inherit(int fd, bool inherit)
{
	int fflags;
	if ((fflags = fcntl(fd, F_GETFD)) < 0)
		return -1;
	if (inherit)
		fflags &= ~FD_CLOEXEC;
	else
		fflags |= FD_CLOEXEC;
	if ((fcntl(fd, F_SETFD, fflags)) < 0)
		return -1;
	return 0;
}

#define rexec_log(info, ...) \
	if (rexec_logfile != NULL) {\
		time_t t; \
		struct tm p; \
		time(&t); \
		localtime_r(&t, &p); \
		fprintf(rexec_logfile, "[%d/%02d/%02d %02d:%02d:%02d][LOG:%s:%3d]"info"\n", \
				p.tm_year + 1900, p.tm_mon+1, p.tm_mday, \
				p.tm_hour, p.tm_min, p.tm_sec, __func__, __LINE__, ##__VA_ARGS__); \
	}

#define rexec_log2(info, ...) \
	if (rexec_logfile != NULL) {\
		time_t t; \
		struct tm p; \
		time(&t); \
		localtime_r(&t, &p); \
		fprintf(rexec_logfile, "[%d/%02d/%02d %02d:%02d:%02d][LOG:%s:%3d]"info"\n", \
				p.tm_year + 1900, p.tm_mon+1, p.tm_mday, \
				p.tm_hour, p.tm_min, p.tm_sec, __func__, __LINE__, ##__VA_ARGS__); \
	}

#define rexec_err(info, ...) \
	if (rexec_logfile != NULL) {\
		time_t t; \
		struct tm p; \
		time(&t); \
		localtime_r(&t, &p); \
		fprintf(rexec_logfile, "[%d/%02d/%02d %02d:%02d:%02d][ERROR:%s:%3d]"info"\n", \
				p.tm_year + 1900, p.tm_mon+1, p.tm_mday, \
				p.tm_hour, p.tm_min, p.tm_sec, __func__, __LINE__, ##__VA_ARGS__); \
	}

static inline unsigned int rexec_fd_mode(int fd)
{
	struct stat st;
	if (fstat(fd, &st) != 0) {
		rexec_err("get fd:%d fstat failed, errno:%d", fd, errno);
		return 0;
	}
	return st.st_mode;
}

#endif