ExternalVendorCode/serval-dna
1
0
Fork 0
mirror of https://github.com/servalproject/serval-dna.git synced 2024-12-18 12:56:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add comments and assertions to server.h and server.c

Browse Source
This commit is contained in:
Andrew Bettison 2018-06-01 01:12:35 +09:30
parent b8ddad6ff2
commit bbe7a87904
2 changed files with 40 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
server.c
View File

@ -447,6 +447,9 @@ static int get_proc_path(const char *path, char *buf, size_t bufsiz)
int server_write_proc_state(const char *path, const char *fmt, ...)
{
// Only a running server process/thread may modify the proc files.
assert(serverMode != SERVER_NOT_RUNNING);
char path_buf[400];
if (get_proc_path(path, path_buf, sizeof path_buf)==-1)
return -1;
@ -480,6 +483,9 @@ int server_write_proc_state(const char *path, const char *fmt, ...)
int server_unlink_proc_state(const char *path)
{
// Only a running server process/thread may modify the proc files.
assert(serverMode != SERVER_NOT_RUNNING);
char path_buf[400];
if (get_proc_path(path, path_buf, sizeof path_buf)==-1)
return -1;
@ -517,6 +523,8 @@ DEFINE_ALARM(server_config_reload);
void server_config_reload(struct sched_ent *alarm)
{
if (serverMode == SERVER_CLOSING){
// All shutdown triggers should unschedule their respective alarms. Once there are no alarms
// left, the fd_poll2() in server_loop() will return zero.
CALL_TRIGGER(shutdown);
return;
}
@ -682,9 +690,11 @@ void server_close(){
DEBUGF(server,"Graceful shutdown");
// Cause the next server_config_reload() alarm to invoke the "shutdown" trigger, which in turn
// will cause an orderly exit from server_loop().
serverMode = SERVER_CLOSING;
// trigger an alarm to finish cleanup
// Schedule the server_config_reload() alarm to go off immediately.
time_ms_t now = gettime_ms();
RESCHEDULE(&ALARM_STRUCT(server_config_reload),
now,
@ -802,7 +812,7 @@ static void cli_server_details(struct cli_context *context, const struct pid_tid
}
}
DEFINE_CMD(app_server_start, 0,
DEFINE_CMD(app_server_start, 0,
"Start daemon with instance path from SERVALINSTANCE_PATH environment variable.",
"start" KEYRING_PIN_OPTIONS, "[--seed]", "[foreground|exec <path>]");
static int app_server_start(const struct cli_parsed *parsed, struct cli_context *context)
@ -821,6 +831,8 @@ static int app_server_start(const struct cli_parsed *parsed, struct cli_context
/* Create the instance directory if it does not yet exist */
if (create_serval_instance_dir() == -1)
RETURN(-1);
// Work out the Process and Thread IDs of any currently running server process, by reading an
// existing pidfile.
struct pid_tid id = get_server_pid_tid();
if (id.pid < 0)
RETURN(-1);

28
server.h
View File

@ -43,15 +43,39 @@ extern __thread enum server_mode serverMode;
*/
int server_pid();
/* Call this method within a server process/thread to initialise the server:
* - marks the server state as "running" (thread-local variable)
* - sets up signal handling
* - calls the "startup" trigger
* - starts the HTTP server (if enabled)
* - creates the pidfile
* - initialises the network packet queues
* - schedules a periodic stats job
*/
int server_bind();
void server_close();
/* Call this method within a server process/thread to execute the server main
* loop. Only returns once the server is shut down.
*/
void server_loop(time_ms_t (*waiting)(time_ms_t, time_ms_t, time_ms_t), void (*wokeup)());
/* Call this method within a server process/thread to initiate an orderly
* shut-down of the server. It sets the server state as "closing" so that
* server_loop() will exit in an orderly fashion.
*/
void server_close();
/* These functions are called by various server subsystems to populate the
* "proc" directory, which gives information about the running server, such as:
* - port numbers
* - primary identity
* - etc.
*/
int server_write_proc_state(const char *path, const char *fmt, ...);
int server_unlink_proc_state(const char *path);
/* Triggers that are fired during server start-up and shut-down.
*/
DECLARE_TRIGGER(startup);
DECLARE_TRIGGER(shutdown);