wdog.h

Go to the documentation of this file.

/* Watchdog API for the process supervisor, its clients, and others
 *
 * Copyright (C) 2015-2024  Joachim Wiberg <troglobit@gmail.com>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifdef __cplusplus
extern "C"
{
#endif

#ifndef WDOG_H_
#define WDOG_H_

#include <time.h>

typedef enum {
    WDOG_SYSTEM_NONE = 0,         
    WDOG_SYSTEM_OK,           
    WDOG_FAILED_SUBSCRIPTION,     
    WDOG_FAILED_KICK,         
    WDOG_FAILED_UNSUBSCRIPTION,   
    WDOG_FAILED_TO_MEET_DEADLINE, 
    WDOG_FORCED_RESET,        
    WDOG_FAILED_UNKNOWN,          
    WDOG_DESCRIPTOR_LEAK,         
    WDOG_MEMORY_LEAK,         
    WDOG_CPU_OVERLOAD,        
} wdog_code_t;

typedef struct
{
    unsigned int  counter;   
    unsigned int  wid;       
    wdog_code_t   code;      
    unsigned int  enabled;   
    char          label[48]; 
    struct tm     date;      
} wdog_reason_t;

/*
 * Check if watchdogd API is actively responding,
 * returns %TRUE(1) or %FALSE(0)
 */
int   wdog_ping             (void);
int   wdog_reload           (void);

int   wdog_enable           (int enable);   /* Attempt to temp. disable */
int   wdog_status           (int *status);  /* Check if enabled */

int   wdog_failed           (wdog_code_t code, int pid, char *label, unsigned int timeout);

int   wdog_reset            (int pid, char *label);
int   wdog_reset_timeout    (int pid, char *label, unsigned int timeout);

int wdog_set_debug(int enable);

int wdog_get_debug(int *status);

int wdog_set_loglevel(char *level);

char *wdog_get_loglevel(void);

int wdog_reset_counter(unsigned int *counter);

int wdog_reset_reason(wdog_reason_t *reason);

int wdog_reset_reason_raw(wdog_reason_t *reason);

char *wdog_reset_reason_str(wdog_reason_t *reason);

int wdog_reset_reason_clr(void);

/*
 * Process supervisor API, see also compat.h
 */

int wdog_subscribe(char *label, unsigned int timeout, unsigned int *next_ack);

int wdog_unsubscribe(int id, unsigned int ack);

int wdog_kick(int id, unsigned int timeout, unsigned int ack, unsigned int *next_ack);

int wdog_extend_kick(int id, unsigned int timeout, unsigned int *ack);

int wdog_kick2(int id, unsigned int *ack);

/*
 * Compatibility wrapper layer
 */
#include "compat.h"

#endif /* WDOG_H_ */

#ifdef __cplusplus
}
#endif