sysctl.c File Reference

#include <stdbool.h>
#include <stdint.h>
#include <string.h>
#include <errno.h>
#include <sys/kassert.h>
#include <sys/kdebug.h>
#include <sys/sysctl.h>

Include dependency graph for sysctl.c:

Go to the source code of this file.

Data Structures
struct	SysCtlEntry

Macros
#define	SYSCTL_STR(_PATH, _FLAGS, _DESCRIPTION, _DEFAULT)    { #_PATH, SYSCTL_TYPE_STR, _FLAGS, _DESCRIPTION, &SYSCTL_##_PATH },
#define	SYSCTL_INT(_PATH, _FLAGS, _DESCRIPTION, _DEFAULT)    { #_PATH, SYSCTL_TYPE_INT, _FLAGS, _DESCRIPTION, &SYSCTL_##_PATH },
#define	SYSCTL_BOOL(_PATH, _FLAGS, _DESCRIPTION, _DEFAULT)    { #_PATH, SYSCTL_TYPE_BOOL, _FLAGS, _DESCRIPTION, &SYSCTL_##_PATH },
#define	SYSCTL_STR(_PATH, _FLAGS, _DESCRIPTION, _DEFAULT)   SysCtlString SYSCTL_##_PATH = { #_PATH, _DEFAULT };
#define	SYSCTL_INT(_PATH, _FLAGS, _DESCRIPTION, _DEFAULT)   SysCtlInt SYSCTL_##_PATH = { #_PATH, _DEFAULT };
#define	SYSCTL_BOOL(_PATH, _FLAGS, _DESCRIPTION, _DEFAULT)   SysCtlBool SYSCTL_##_PATH = { #_PATH, _DEFAULT };

Typedefs
typedef struct SysCtlEntry	SysCtlEntry

Functions
SYSCTL_LIST int	SysCtl_Lookup (const char *path)
uint64_t	SysCtl_GetType (const char *node)
void *	SysCtl_GetObject (const char *node)
uint64_t	SysCtl_SetObject (const char *node, void *obj)
void	Debug_SysCtl (int argc, const char *argv[])
	REGISTER_DBGCMD (sysctl, "SYSCTL", Debug_SysCtl)

Variables
SysCtlEntry	SYSCTLTable []

---

Data Structure Documentation

SysCtlEntry

struct SysCtlEntry

Definition at line 10 of file sysctl.c.

Collaboration diagram for SysCtlEntry:

Data Fields
char	description[128]
int	flags
void *	node
char	path[64]
int	type

Macro Definition Documentation

SYSCTL_BOOL [1/2]

#define SYSCTL_BOOL	(		_PATH,
			_FLAGS,
			_DESCRIPTION,
			_DEFAULT
	)		{ #_PATH, SYSCTL_TYPE_BOOL, _FLAGS, _DESCRIPTION, &SYSCTL_##_PATH },

Definition at line 37 of file sysctl.c.

SYSCTL_BOOL [2/2]

#define SYSCTL_BOOL	(		_PATH,
			_FLAGS,
			_DESCRIPTION,
			_DEFAULT
	)		SysCtlBool SYSCTL_##_PATH = { #_PATH, _DEFAULT };

Definition at line 37 of file sysctl.c.

SYSCTL_INT [1/2]

#define SYSCTL_INT	(		_PATH,
			_FLAGS,
			_DESCRIPTION,
			_DEFAULT
	)		{ #_PATH, SYSCTL_TYPE_INT, _FLAGS, _DESCRIPTION, &SYSCTL_##_PATH },

Definition at line 35 of file sysctl.c.

SYSCTL_INT [2/2]

#define SYSCTL_INT	(		_PATH,
			_FLAGS,
			_DESCRIPTION,
			_DEFAULT
	)		SysCtlInt SYSCTL_##_PATH = { #_PATH, _DEFAULT };

Definition at line 35 of file sysctl.c.

SYSCTL_STR [1/2]

#define SYSCTL_STR	(		_PATH,
			_FLAGS,
			_DESCRIPTION,
			_DEFAULT
	)		{ #_PATH, SYSCTL_TYPE_STR, _FLAGS, _DESCRIPTION, &SYSCTL_##_PATH },

Definition at line 33 of file sysctl.c.

SYSCTL_STR [2/2]

#define SYSCTL_STR	(		_PATH,
			_FLAGS,
			_DESCRIPTION,
			_DEFAULT
	)		SysCtlString SYSCTL_##_PATH = { #_PATH, _DEFAULT };

Definition at line 33 of file sysctl.c.

Typedef Documentation

SysCtlEntry

typedef struct SysCtlEntry SysCtlEntry

Function Documentation

Debug_SysCtl()

void Debug_SysCtl	(	int	argc,
		const char *	argv[]
	)

Definition at line 111 of file sysctl.c.

{
    int i;
 
    if (argc == 1) {
        kprintf("%-20s %s\n", "Name", "Description");
        for (i = 0; SYSCTLTable[i].path[0] != '\0'; i++) {
            kprintf("%-20s %s\n", SYSCTLTable[i].path, SYSCTLTable[i].description);
        }
 
        return;
    }
 
    if (argc != 2 && argc != 3) {
        kprintf("Usage: sysctl NODE [VALUE]\n");
        return;
    }
 
    i = SysCtl_Lookup(argv[1]);
    if (i == -1) {
        kprintf("Unknown sysctl node!\n");
        return;
    }
 
    if (argc == 2) {
        switch (SYSCTLTable[i].type) {
            case SYSCTL_TYPE_STR: {
                SysCtlString *val = (SysCtlString *)SYSCTLTable[i].node;
                kprintf("%s: %s\n", argv[1], val->value);
                break;
            }
            case SYSCTL_TYPE_INT: {
                SysCtlInt *val = (SysCtlInt *)SYSCTLTable[i].node;
                kprintf("%s: %ld\n", argv[1], val->value);
                break;
            }
            case SYSCTL_TYPE_BOOL: {
                SysCtlBool *val = (SysCtlBool *)SYSCTLTable[i].node;
                kprintf("%s: %s\n", argv[1], val->value ? "true" : "false");
                break;
            }
        }
 
        return;
    }
 
    if (argc == 3) {
        if (SYSCTLTable[i].flags == SYSCTL_FLAG_RO) {
            kprintf("Sysctl node is read-only!\n");
            return;
        }
 
        switch (SYSCTLTable[i].type) {
            case SYSCTL_TYPE_STR: {
                SysCtlString *val = (SysCtlString *)SYSCTLTable[i].node;
                strncpy(&val->value[0], argv[2], SYSCTL_STR_MAXLENGTH);
                break;
            }
            case SYSCTL_TYPE_INT: {
                SysCtlInt *val = (SysCtlInt *)SYSCTLTable[i].node;
                val->value = Debug_StrToInt(argv[2]);
                break;
            }
            case SYSCTL_TYPE_BOOL: {
                SysCtlBool *val = (SysCtlBool *)SYSCTLTable[i].node;
                if (strcmp(argv[2], "0") == 0) {
                    val->value = false;
                } else if (strcmp(argv[2], "1") == 0) {
                    val->value = true;
                } else {
                    kprintf("Invalid value!\n");
                }
                break;
            }
        }
    }
}

Here is the call graph for this function:

REGISTER_DBGCMD()

REGISTER_DBGCMD	(	sysctl	,
		"SYSCTL"	,
		Debug_SysCtl
	)

SysCtl_GetObject()

void * SysCtl_GetObject

(

const char *

node

)

Definition at line 69 of file sysctl.c.

{
    int i = SysCtl_Lookup(node);
    if (i == -1) {
        return NULL;
    }
 
    return SYSCTLTable[i].node;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SysCtl_GetType()

uint64_t SysCtl_GetType

(

const char *

node

)

Definition at line 58 of file sysctl.c.

{
    int i = SysCtl_Lookup(node);
    if (i == -1) {
        return SYSCTL_TYPE_INVALID;
    }
 
    return SYSCTLTable[i].type;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SysCtl_Lookup()

SYSCTL_LIST int SysCtl_Lookup

(

const char *

path

)

Definition at line 45 of file sysctl.c.

{
    int i;
 
    for (i = 0; SYSCTLTable[i].path[0] != '\0'; i++) {
        if (strcmp(path, SYSCTLTable[i].path) == 0)
            return i;
    }
 
    return -1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SysCtl_SetObject()

uint64_t SysCtl_SetObject	(	const char *	node,
		void *	obj
	)

Definition at line 80 of file sysctl.c.

{
    int i = SysCtl_Lookup(node);
    if (i == -1) {
        return ENOENT;
    }
 
    if (SYSCTLTable[i].flags == SYSCTL_FLAG_RO) {
        kprintf("Sysctl node is read-only!\n");
        return EACCES;
    }
 
    switch (SYSCTLTable[i].type) {
        case SYSCTL_TYPE_STR: {
            SysCtlString *val = (SysCtlString *)SYSCTLTable[i].node;
            memcpy(val, obj, sizeof(*val));
        }
        case SYSCTL_TYPE_INT: {
            SysCtlInt *val = (SysCtlInt *)SYSCTLTable[i].node;
            memcpy(val, obj, sizeof(*val));
        }
        case SYSCTL_TYPE_BOOL: {
            SysCtlBool *val = (SysCtlBool *)SYSCTLTable[i].node;
            memcpy(val, obj, sizeof(*val));
        }
    }
 
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

SYSCTLTable

SysCtlEntry SYSCTLTable[]

Initial value:

= {
    SYSCTL_LIST
    { "", 0, 0, "", NULL },
}

Definition at line 25 of file sysctl.c.