/*
*         OpenPBS (Portable Batch System) v2.3 Software License
*
* Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
* All rights reserved.
*
* ---------------------------------------------------------------------------
* For a license to use or redistribute the OpenPBS software under conditions
* other than those described below, or to purchase support for this software,
* please contact Veridian Systems, PBS Products Department ("Licensor") at:
*
*    www.OpenPBS.org  +1 650 967-4675                  sales@OpenPBS.org
*                        877 902-4PBS (US toll-free)
* ---------------------------------------------------------------------------
*
* This license covers use of the OpenPBS v2.3 software (the "Software") at
* your site or location, and, for certain users, redistribution of the
* Software to other sites and locations.  Use and redistribution of
* OpenPBS v2.3 in source and binary forms, with or without modification,
* are permitted provided that all of the following conditions are met.
* After December 31, 2001, only conditions 3-6 must be met:
*
* 1. Commercial and/or non-commercial use of the Software is permitted
*    provided a current software registration is on file at www.OpenPBS.org.
*    If use of this software contributes to a publication, product, or
*    service, proper attribution must be given; see www.OpenPBS.org/credit.html
*
* 2. Redistribution in any form is only permitted for non-commercial,
*    non-profit purposes.  There can be no charge for the Software or any
*    software incorporating the Software.  Further, there can be no
*    expectation of revenue generated as a consequence of redistributing
*    the Software.
*
* 3. Any Redistribution of source code must retain the above copyright notice
*    and the acknowledgment contained in paragraph 6, this list of conditions
*    and the disclaimer contained in paragraph 7.
*
* 4. Any Redistribution in binary form must reproduce the above copyright
*    notice and the acknowledgment contained in paragraph 6, this list of
*    conditions and the disclaimer contained in paragraph 7 in the
*    documentation and/or other materials provided with the distribution.
*
* 5. Redistributions in any form must be accompanied by information on how to
*    obtain complete source code for the OpenPBS software and any
*    modifications and/or additions to the OpenPBS software.  The source code
*    must either be included in the distribution or be available for no more
*    than the cost of distribution plus a nominal fee, and all modifications
*    and additions to the Software must be freely redistributable by any party
*    (including Licensor) without restriction.
*
* 6. All advertising materials mentioning features or use of the Software must
*    display the following acknowledgment:
*
*     "This product includes software developed by NASA Ames Research Center,
*     Lawrence Livermore National Laboratory, and Veridian Information
*     Solutions, Inc.
*     Visit www.OpenPBS.org for OpenPBS software support,
*     products, and information."
*
* 7. DISCLAIMER OF WARRANTY
*
* THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
* ARE EXPRESSLY DISCLAIMED.
*
* IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
* U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR 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.
*
* This license will be governed by the laws of the Commonwealth of Virginia,
* without reference to its choice of law rules.
*/

/*
 * include file for error/event logging
 */

#ifndef LOG_H
#define LOG_H

#include <pthread.h>
#define LOG_BUF_SIZE        16384
#define LOCAL_LOG_BUF_SIZE  5096

/* The following macro assist in sharing code between the Server and Mom */
#define LOG_EVENT log_event

/*
** Set up a debug print macro.
*/
#ifdef NDEBUG
#define DBPRT(x)
#else
#define DBPRT(x) printf x;
#endif  /* END NDEBUG */

#if SYSLOG
#include <syslog.h>
#endif /* SYSLOG */

#if !SYSLOG
/* define syslog constants that can be used in code regardless of whether we
 * are using syslog or not! */

#ifndef LOG_EMERG
#define LOG_EMERG 1
#endif

#ifndef LOG_ALERT
#define LOG_ALERT 2
#endif

#ifndef LOG_CRIT
#define LOG_CRIT 3
#endif

#ifndef LOG_ERR
#define LOG_ERR 4 
#endif

#ifndef LOG_ERR
#define LOG_ERR 5 
#endif

#ifndef LOG_WARNING
#define LOG_WARNING 6
#endif

#ifndef LOG_NOTICE
#define LOG_NOTICE 7
#endif

#ifndef LOG_INFO
#define LOG_INFO 8
#endif

#ifndef LOG_DEBUG
#define LOG_DEBUG 9
#endif
#endif /* SYSLOG */

#define MAXLINE 1024

enum getter_setter { GETV, SETV };
typedef enum getter_setter SGetter;

extern int LOGLEVEL;

extern long *log_event_mask;
extern pthread_mutex_t log_mutex;
extern pthread_mutex_t job_log_mutex;

/* set this to non-zero in calling app if errors go to stderr */
extern int   chk_file_sec_stderr;

/* extern void log_close (int); */
/* extern void job_log_close (int); */
void log_err (int, const char *, const char *);
void log_ext (int, const char *, const char *,int);
void log_event (int, int, const char *, const char *);
/* extern int  log_open (char *, char *); */
/* extern int  job_log_open (char *, char *); */
void log_record (int, int, const char *, const char *);
bool log_available(int eventtype);
/* extern void log_roll (int); */
/* extern long log_size (void); */
/* extern long job_log_size (void); */
/* extern int  log_remove_old (char *,unsigned long); */
extern char log_buffer[LOG_BUF_SIZE];
/* int log_init (char *, char *); */

/* extern int  IamRoot (void); */
/* #ifdef __CYGWIN__ */
/* extern int  IamAdminByName (char *); */
/* extern int  IamUser (void); */
/* extern int  IamUserByName (char *); */
/* #endif  __CYGWIN__ */

/* extern int  chk_file_sec (char *, int, int, int, int, char *); */
/* extern int  setup_env (char *); */


/* Event types */

#define PBSEVENT_ERROR  0x0001  /* internal errors       */
#define PBSEVENT_SYSTEM  0x0002  /* system (server) & (trqauthd) events     */
#define PBSEVENT_ADMIN  0x0004  /* admin events        */
#define PBSEVENT_JOB  0x0008  /* job related events       */
#define PBSEVENT_JOB_USAGE 0x0010  /* End of Job accounting      */
#define PBSEVENT_SECURITY 0x0020  /* security violation events  */
#define PBSEVENT_SCHED  0x0040  /* scheduler events       */
#define PBSEVENT_DEBUG  0x0080  /* common debug messages      */
#define PBSEVENT_DEBUG2  0x0100  /* less needed debug messages */
#define PBSEVENT_CLIENTAUTH 0X0200 /* TRQAUTHD login events */
#define PBSEVENT_SYSLOG 0x0400   /* pass this event to the syslog as well (if defined) */
#define PBSEVENT_FORCE  0x8000  /* set to force a message     */

/* Event Object Classes, see array class_names[] in ../lib/Liblog/pbs_log.c   */

#define PBS_EVENTCLASS_SERVER 1 /* The server itself */
#define PBS_EVENTCLASS_QUEUE 2 /* Queues  */
#define PBS_EVENTCLASS_JOB 3 /* Jobs   */
#define PBS_EVENTCLASS_REQUEST 4 /* Batch Requests */
#define PBS_EVENTCLASS_FILE 5 /* A Job related File */
#define PBS_EVENTCLASS_ACCT 6 /* Accounting info */
#define PBS_EVENTCLASS_NODE 7 /* Nodes           */
#define PBS_EVENTCLASS_TRQAUTHD 8 /* trqauthd */

/* Logging Masks */

#define PBSEVENT_MASK  0x01ff

/* definition's for pbs_log.c's log_remove_old() function */
#define MAX_PATH_LEN    1024  /* maximum possible length of any path */
#define SECS_PER_DAY     86400

#if !defined(TRUE) || !defined(FALSE)
#define TRUE 1
#define FALSE 0
#endif /* !defined(TRUE) || !defined(FALSE) */

#endif /* ifndef LOG_H */
