---

ahm.h

Go to the documentation of this file.

/***************************************************************************
BSD License
 
Copyright (c) 2002, Intel Corporation
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
  a.. Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
  b.. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
  c.. Neither the name of Intel Corporation nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
****************************************************************************/

#ifndef __AHM_H__
#define __AHM_H__

#include <sys/types.h>
#include <unistd.h>
#include <glib.h>

#if (POSIX_EVENT_LOGGING)
#include <posix_evlog.h>
#endif


#define REGISTRATION_DIRECTORY  "/var/appmonitord"
#define REGISTRATION_INTERVAL   3000     /* in milliseconds */
#define NAME_LENGTH             256
#define STRING_LENGTH           256

#define MILLISECONDS_TO_MICROSECONDS 1000

#define ASCII_ZERO      48
#define ASCII_NINE      57
 
#define ENOTFOUND               1
#define E_UID_INVALID           2       
#define E_GID_INVALID           3       
#define E_MODE_INVALID          4
#define E_FILE_NOT_FOUND        5
#define E_INVALID               6
#define E_FAULT                 7

#define SUCCESS                 0

extern int errno;

/**
 * Each application may register using a registration file and
 * writing its registration information in that file.  The 
 * application may provide an application identifier that is 
 * unique to the application's actual process id (which is 
 * unique on the system).  This allows a single process
 * to register more than one heartbeat. 
 * 
 * This structure is used as the "value" for the hash table.
 */ 
typedef struct reginfo {
 
   pid_t m_pid; /** the process id */
   uid_t m_uid; /** the uid of the process */
   uid_t m_gid; /** the gid of the process */
  
   unsigned long m_appid; /** the application identifier */   

   int  m_hbfd; /** the heartbeat fifo descriptor */
   char m_procname[NAME_LENGTH]; /** The name of the process */
   char m_regfilename[NAME_LENGTH]; /** The registration file filename */
   char m_processname[NAME_LENGTH]; /** The process name */
   char m_hbfifoname[NAME_LENGTH]; /** The name of the fifo to read heartbeats */
   char m_script[NAME_LENGTH]; /** The full path to the recovery script */
   unsigned long m_period; /** The duration between updates, in milliseconds */
   time_t m_creation; /** The timestamp for creation of file */

   gboolean m_invalid_registration; /** indicates if the registration file could not be parsed or has invalid components */

} registration_info;

/**
 * This structure is used as the "key" in the hash table
 */
typedef struct regkey {
   pid_t pid;
} registration_key;

/**
 * This is the structure that contains the fifo data to 
 * be passed in a heartbeat.
 * 
 */
typedef struct pingdata {
   long data;
   time_t timestamp;
} ping_data;

/** This is the hash table containing the registered processes */
extern GHashTable * prochash;

/** This is the main event loop for the application */
extern GMainLoop  * mainloop;

/** Indicates if the monitor should be run as a daemon or not. 
    This intent of this is to help with debugging */
extern gboolean daemon_mode;

/** This is the location where applications should register */
extern char registration_dir[NAME_LENGTH];

/** This is the approximate amount of time to allow to lapse
    between checking for new registrations */
extern unsigned long register_period;

/** FUNCTION PROTOTYPES */

void signal_shutdown(int a_arg);
pid_t extract_pid(const char *d_name);
int start_daemon(int a_ignoreSIGCLD);
void sig_child();
int validate_process(pid_t a_pid);
gboolean find_registration_files(gpointer a_data);
int verify_heartbeat_fifo(const char *a_fifoname, const registration_info *a_reginfo);
void recover_process(registration_key *a_regkey, registration_info *a_reginfo);


#endif /* __AHM_H__ */

---