gkemu.h

Go to the documentation of this file.

/*
 * gkemu.h
 *
 * Copyright (c) 2003 The University of Utah and the Flux Group.
 * All rights reserved.
 *
 * This file is licensed under the terms of the GNU Public License.  
 * See the file "license.terms" for restrictions on redistribution 
 * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 */

/**
 * @file gkemu.h
 *
 * Header file for GKrellmd (http://www.gkrellm.net) emulation functions.
 * GKrellm is a system monitoring utility that displays the current system
 * state in a nice GUI.  Fortunately, it supports a client/server mode that
 * uses a simple network protocol for communicating the system state.  So,
 * instead of sending the entire state of the system back to the GUI client, we
 * send back the state of a TimeSys resource set.  The following monitors are
 * supported:
 *
 * @li @e HostName The name of the resource set.
 * @li @e SystemName The name of the executable.
 * @li @e CPU_0 The CPU usage for all the processes in the set.
 * @li @e CPU_1 The CPU reservation for the resource set and the amount of the
 * reservation that is currently in use.
 * @li @e UpTime The length of time rktimes(1) has been running.
 * @li @e Proc The number of processes in the resource set.
 */

#ifndef _gkemu_h
#define _gkemu_h

#ifdef __cplusplus
extern "C" {
#endif

#include <sys/types.h>

/**
 * Argument tags for the functions.
 */
typedef enum {
    GKA_TAG_DONE,         /**< () - Terminate the tag list. */
    GKA_HostName,         /**< (char *) - Host name. */
    GKA_SystemName,       /**< (char *) - System name. */
    GKA_CPUUser,          /**< (unsigned long long) - User time CPU usage. */
    GKA_CPUIdle,          /**< (unsigned long long) - CPU idle time. */
    GKA_CPUReserveUser,   /**< (unsigned long long) - CPU reserve. */
    GKA_CPUReserveNice,   /**< (unsigned long long) - CPU reserve consumed. */
    GKA_CPUReserveIdle,   /**< (unsigned long long) - CPU not reserved. */
    GKA_UpTime,           /**< (struct timeval *) - Process running time. */
    GKA_Processes,        /**< (unsigned int) - Number of processes in the
                           *   set.
                           */
    GKA_ProcessesRunning, /**< (unsigned int) - Number of running processes in
                           *   the set.
                           */
} gka_tag_t;

/**
 * Tag string used to mark the beginning of the "initial update".
 */
extern const char *gkInitialUpdateOpen;

/**
 * Tag string used to mark the end of the "initial update".
 */
extern const char *gkInitialUpdateClose;
    
/**
 * Format the preamble into the given buffer.
 *
 * @param buf The buffer to fill with the preamble.
 * @param buf_len The length, in bytes, of 'buf'.
 * @param tag The beginning of the tag arguments.
 * @return The length of preamble in the buffer.
 */
int gkFormatPreamble(char *buf, size_t buf_len, gka_tag_t tag, ...);

/**
 * Format an update into the given buffer.
 *
 * @param buf The buffer to fill with the preamble.
 * @param buf_len The length, in bytes, of 'buf'.
 * @param tag The beginning of the tag arguments.
 * @return The length of the update in the buffer.
 */
int gkFormatUpdate(char *buf, size_t buf_len, gka_tag_t tag, ...);

#ifdef __cplusplus
}
#endif

#endif

---