h4zt
/
openGauss-server
forked from Cachuela/openGauss-server
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request '对src/gausskernel/cbb/bbox/目录下cpp文件中一些函数的注释' (#4) from Eao3piq4e/openGauss-server:master into master

This commit is contained in:
xiangxinyong 2022-08-04 20:58:13 +08:00
parent 72a82e2182 fb3e4435e0
commit bcfff28219
4 changed files with 208 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
src/gausskernel/cbb/bbox/bbox_print.cpp
View File

@ -122,15 +122,21 @@ s32 bbox_put_dox(BBOX_vnprintCallBack pCallback, void* ptr, s32* piCount, u32 iS
return iRet;
}
/*
* simple signal-safe function vsnprintf
* in : pCallback - call back function
* ptr - private data to call this function
* iSize - buffer size
* pFmt - format type
* ap - parameter list pointer<EFBFBD><EFBFBD>ʽ
* return : length of string
*/
function name: bbox_vsnprintf
description: The function is used to print string in corresponding array.
arguments: The first argument is a pointer to a callback function, the next is a
pointer to private data to call this function, also to buffer.
The third is used to destine buffer size. The forth is used to destine
the print format of deferent string, the last is a pointer to variable parameter list.
return value: An integer, if iSize is big enough, then the return value is the length of
string been written in destined memory successfully, not include '\0',
if function makes errors, the return value is a negative integer.
note: none
date: 2022/8/3
contact tel: 18720816902
*/
s32 bbox_vsnprintf(BBOX_vnprintCallBack pCallback, void* ptr, s32 iSize, const char* pFmt, va_list ap)
{
@ -249,13 +255,20 @@ s32 bbox_vsnprintf(BBOX_vnprintCallBack pCallback, void* ptr, s32 iSize, const c
}
/*
* call back function of snprintf_s
* in : c - string to calculate
* pPtr - pointer to buffer
* piCount - count of character
* iSize - limit of length
* return : length of string
*/
function name: bbox_SnprintCallback
description: The function is used to print string in corresponding array, usually
used as the first argument of function bbox_vsnprintf.
arguments: The first argument is a character waited to be written into buffer that
pPtr directs, the second argument directs a buffer area, the third is a
pointer to an integera used to record the count to call this callback function,
at the same time, it represents the count of characters written into buffer, it's
a pointer so that we can conveniently modify data storedin it. The last
argument destines the size of buffer, it represents the limit of length.
return value: An integer, if written successfully, it's RET_OK, else it's RET_ERR.
note: none
date: 2022/8/3
contact tel: 18720816902
*/
s32 bbox_SnprintCallback(char c, void* pPtr, s32* piCount, s32 iSize)
{
char** pszBuff = (char**)pPtr;

130
src/gausskernel/cbb/bbox/bbox_threads.cpp
View File

@ -64,8 +64,14 @@ u8 g_szAltStackMem[BBOX_ALT_STACKSIZE]; /* independent thread stack memory */
BBOX_ATOMIC_STRU g_isBusy = BBOX_ATOMIC_INIT(0); /* whether deal with core file. */
/*
* reserved count bytes on current stack, and set 0
*/
function name: BBOX_ReserveZeroStack
description: The function creat a empty stack, and its size depend on argument count.
arguments: An integer of type s32, namely int, it destines the storage of stack.
return value: void
note: The stack this function creats is actually a character array.
date: 2022/8/3
contact tel: 18720816902
*/
void BBOX_ReserveZeroStack(s32 count)
{
char buff[count];
@ -95,8 +101,14 @@ s32 BBOX_CloneRun(u32 uFlags, s32 (*pFn)(void*), void* pArg, ...)
}
/*
* get count of thread
*/
function name: BBOX_GetTaskNumber
description: When get a path to specific process, this function will return count of threads below it.
arguments: A pointer of type char*, including a path to specific process.
return value: An integer that indicates the count of threads below specific process.
note: none
date: 2022/8/3
contact tel: 18720816902
*/
s32 BBOX_GetTaskNumber(char* szTaskPath)
{
struct kernel_stat stProcSB = {0};
@ -130,8 +142,17 @@ s32 BBOX_GetTaskNumber(char* szTaskPath)
}
/*
* get thread pid
*/
function name: BBOX_GetTaskId
description: When get a path to specific process, this function will return count of threads below it.
arguments: The first argument is a structure pointer named pstTaskInfo,its type is struct TASK_ATTACH_INFO*,
we use it as a structure array to store requisite thread infomation, the next argument destines
the max size of the array that the first argument destines. The last argument is a pointer of type
char*, including a path to specific process.
return value: An integer that indicates the count of threads stored in structure array.
note: none
date: 2022/8/3
contact tel: 18720816902
*/
s32 BBOX_GetTaskId(struct TASK_ATTACH_INFO* pstTaskInfo, s32 iSize, char* szTaskPath)
{
s32 iProc = -1;
@ -214,13 +235,19 @@ errout:
}
/*
* a ptrace debug thread
* in : TASK_ATTACH_INFO - thread information
* iPidCount - count of thread information
* iDoPtraceCheck - check if ptrace success
* return : 0 - success
* err code - failed
*/
function name: BBOX_PtraceAttachPid
description: The function is used to check the process whose id stored in structure array pstTaskInfo work normally.
arguments: The first argument is a structure pointer named pstTaskInfo,its type is struct TASK_ATTACH_INFO*,
it is used as a structure array that has stored requisite thread infomation, the next argument destines
the size of the array that the first argument destines, namely how many elements the array has.
The last argument is an integer to decide if need to check if the trace to destined process
work normally, if normal, corresponding element of array pstTaskInfo's member variable cIsAttached
will change from 0 to 1.
return value: An integer, if function work normally, the value is RET_OK, else is RET_ERR.
note: none
date: 2022/8/3
contact tel: 18720816902
*/
s32 BBOX_PtraceAttachPid(struct TASK_ATTACH_INFO* pstTaskInfo, s32 iPidCount, s32 iDoPtraceCheck)
{
u32 i;
@ -272,13 +299,18 @@ s32 BBOX_PtraceAttachPid(struct TASK_ATTACH_INFO* pstTaskInfo, s32 iPidCount, s3
}
/*
* cancel ptrace debug thread
* in : TASK_ATTACH_INFO - thread information
* iPidCount - count of thread information
* iDoPtraceCheck - check if ptrace success
* return : 0 - success
* err code - failed
*/
function name: BBOX_DetachAllThread
description: The function is used to cancel checking the process whose id stored in structure array pstTaskInfo
work normally, "work normally" means in array pstTaskInfo corresponding element's member
variable cIsAttached's value is 1.
arguments: The first argument is a structure pointer named pstTaskInfo,its type is struct TASK_ATTACH_INFO*,
it is used as a structure array that has stored requisite thread infomation, the next argument destines
the size of the array that the first argument destines, namely how many elements the array has.
return value: void
note: none
date: 2022/8/3
contact tel: 18720816902
*/
void BBOX_DetachAllThread(struct TASK_ATTACH_INFO* pstTaskInfo, s32 iPidCount)
{
u32 i;
@ -323,12 +355,18 @@ void BBOX_CheckResumeThread(void* pArgs)
}
/*
* ptrace thread and run function.
* in : pstArgs - information of callback function
* iMaxThreadCount - max count of thread
* pszProcSelfTask - /proc/[pid]/task of current tracked thread.
* return 0 if success else err code.
*/
function name: BBOX_PtraceAndRun
description: When get a path to specific process, this function will trace the threads below it, and get the
information for example how many threads work normally then store it in pstArgs.
arguments: The first argument is a structure pointer named pstArgs, its type is struct BBOX_ListParams*,
what matters is its member variable callback function pointer, the next argument destines
the max count of the thread. The last argument is a pointer of type char*, including a path
to specific process.
return value: An integer, if function work normally, the value is RET_OK, else is RET_ERR.
note: none
date: 2022/8/3
contact tel: 18720816902
*/
s32 BBOX_PtraceAndRun(struct BBOX_ListParams* pstArgs, s32 iMaxThreadCount, char* pszProcSelfTask)
{
struct TASK_ATTACH_INFO stTaskInfo[iMaxThreadCount];
@ -407,8 +445,15 @@ errout:
}
/*
* print log information if export failed.
*/
function name: BBOX_PrintFailedLog
description: Write log infomation into specific file, if errors arise, print the infomation about errors.
arguments: The only argument is a pointer of type const char* to a filename string, if this file doesn't
exist, we will creat a new file named it.
return value: An integer, if function work normally, the value is RET_OK, else is RET_ERR.
note: none
date: 2022/8/3
contact tel: 18720816902
*/
void BBOX_PrintFailedLog(const char* pFileName)
{
ssize_t iRet = 0;
@ -437,8 +482,15 @@ void BBOX_PrintFailedLog(const char* pFileName)
}
/*
* export thread information.
*/
function name: BBOX_ListThread
description: Export thread information.
arguments: The only argument is a structure pointer named pstArgs, its type is struct BBOX_ListParams*,
what matters is its member variable callback function pointer and thread infomation.
return value: void
note: none
date: 2022/8/3
contact tel: 18720816902
*/
void BBOX_ListThread(struct BBOX_ListParams* pstArgs)
{
pid_t ppid = 0;
@ -545,12 +597,18 @@ errout:
}
/*
* get return value of child process
* in : iClonePid - PID of child process
* pstArgs - parameter
* iCloneErrno - err code
* return 0 if success else failed.
*/
function name: BBOX_GetClonePidResult
description: The function get the status of child process at first, then according to it assign pstArgs's
member variables iError and iResult appropriate values.
arguments: The first argument is a integer named iClonePid, it represents the pid of child process.
The second argument is a structure pointer named pstArgs, its type is struct BBOX_ListParams*,
what matters is its member variable callback function pointer and thread infomation.
The third argument is a integer indicating error code.
return value: An integer, if function work normally, the value is RET_OK, else is RET_ERR.
note: none
date: 2022/8/3
contact tel: 18720816902
*/
s32 BBOX_GetClonePidResult(pid_t iClonePid, struct BBOX_ListParams* pstArgs, s32 iCloneErrno)
{
s32 iStatus = 0;

87
src/gausskernel/cbb/bbox/gs_bbox.cpp
View File

@ -57,6 +57,22 @@ BlacklistItem g_blacklist_items[] = {
{DATA_WRITER_QUEUE, "DATA_WRITER_QUEUE", false}
};
/*
function name: coredump_handler
description: When a program is abnormal, but the exception appears in the core of process and wasn't caught,
The function will generate a file to store the information about memory of process, status of register
and running stack.
arguments: The first argument is an integer indicating signal code that usually used in program of processing
signal as variable.
The second argument is a structure pointer of type siginfo_t*, the memory that this pointer
directs stores comprehensive information about signal, for example, which process sends
and which user sends.
The third argument is a pointer of type void*, other kinds of pointers can directly used here.
return value: void
note: none
date: 2022/8/4
contact tel: 18720816902
*/
static void coredump_handler(int sig, siginfo_t *si, void *uc)
{
static volatile int64 first_tid = INVALID_TID;
@ -84,8 +100,19 @@ static void coredump_handler(int sig, siginfo_t *si, void *uc)
}
/*
* bbox_handler - handle signal conditions for bbox
*/
function name: bbox_handler
description: Handle signal conditions for bbox.
arguments: The first argument is an integer indicating signal code that usually used in program of processing
signal as variable.
The second argument is a structure pointer of type siginfo_t*, the memory that this pointer
directs stores comprehensive information about signal, for example, which process sends
and which user sends.
The third argument is a pointer of type void*, other kinds of pointers can directly used here.
return value: void
note: none
date: 2022/8/4
contact tel: 18720816902
*/
static void bbox_handler(int sig, siginfo_t *si, void *uc)
{
static volatile int64 first_tid = INVALID_TID;
@ -125,8 +152,16 @@ static void bbox_handler(int sig, siginfo_t *si, void *uc)
}
/*
* get_bbox_coredump_pattern_path - get the core dump path from the file "/proc/sys/kernel/core_pattern"
*/
function name: get_bbox_coredump_pattern_path
description: Get the core dump file's path from the file "/proc/sys/kernel/core_pattern".
arguments: The first argument is a pointer to string, we use it to store core dump file's path acquired
from the file "/proc/sys/kernel/core_pattern", the next argument is the number of characters
reading from the file "/proc/sys/kernel/core_pattern", all len-1 characters or less if appear '\n'.
return value: void
note: none
date: 2022/8/4
contact tel: 18720816902
*/
static void get_bbox_coredump_pattern_path(char* path, Size len)
{
FILE* fp = NULL;
@ -156,7 +191,17 @@ static void get_bbox_coredump_pattern_path(char* path, Size len)
}
}
/* compute directory into which bbox dump core files are saved. */
/*
function name: build_bbox_corepath
description: Get the core dump file's path.
arguments: The first argument is a pointer to string, we use it to store core dump file's path,
the next argument is the size of the path's name, the last argument is a pointer
to string that indicates maybe store a path to configure the core dump file.
return value: void
note: none
date: 2022/8/4
contact tel: 18720816902
*/
static void build_bbox_corepath(char *bbox_core_path, Size path_size, char *config_path)
{
struct stat stat_buf;
@ -232,6 +277,15 @@ void assign_bbox_corepath(const char* newval, void* extra)
return;
}
/*
function name: show_bbox_dump_path
description: Get the dump file's path.
arguments: void
return value: A pointer of type const char*, directing the path to dump or NULL.
note: none
date: 2022/8/4
contact tel: 18720816902
*/
const char* show_bbox_dump_path(void)
{
const char* path = g_bbox_dump_path;
@ -239,6 +293,15 @@ const char* show_bbox_dump_path(void)
return (path != NULL) ? path : "";
}
/*
function name: split_string_into_blacklist
description: Get all strings been divided into character ',' in source string.
arguments: A pointer of type const char*, directing the source string.
return value: A pointer of type static List*.
note: none
date: 2022/8/4
contact tel: 18720816902
*/
static List* split_string_into_blacklist(const char* source)
{
List *result = NIL;
@ -264,7 +327,6 @@ static List* split_string_into_blacklist(const char* source)
return result;
}
bool check_bbox_blacklist(char** newval, void** extra, GucSource source)
{
if (t_thrd.proc_cxt.MyProcPid != PostmasterPid)
@ -402,10 +464,15 @@ void bbox_blacklist_remove(BlacklistIndex item, void* addr)
}
/*
* @Description: check the value from environment variablethe to prevent command injection.
* @in input_env_value : the input value need be checked.
*
*/
function name: CheckFilenameValid
description: Check if the filename is in line with norms, or if dangerous characters appear
the filename is invalid.
arguments: A pointer to string indicating filename.
return value: An integer, if function works normally, the value is RET_OK, else it's RET_ERR.
note: none
date: 2022/8/4
contact tel: 18720816902
*/
int CheckFilenameValid(const char* inputEnvValue)
{
const int maxLen = 1024;

9
src/gausskernel/cbb/communication/comm_proxy/comm_common.cpp
View File

@ -45,6 +45,15 @@
static bool CommCheckFilterMatch(const char *filter, int len, const char *ip, int port);
/*
function name: SetCPUAffinity
description: The function set the affinity of CPU or CPUs destined by argument cpu_id.
arguments: An integer representing the id of one CPU or more.
return value: void
note: none
date: 2022/8/4
contact: 18720816902
*/
void SetCPUAffinity(int cpu_id)
{
cpu_set_t mask;