root/usr/src/cmd/listen/lslog.c
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*      Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
/*        All Rights Reserved   */

/*
 * error/logging/cleanup functions for the network listener process.
 */


/* system include files */

#include <fcntl.h>
#include <signal.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <tiuser.h>
#include <sys/utsname.h>
#include <sys/param.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/ipc.h>
#include <values.h>
#include <ctype.h>
#include <time.h>

/* listener include files */

#include "lsparam.h"            /* listener parameters          */
#include "listen.h"             /* listener */
#include "lsfiles.h"            /* listener files info          */
#include "lserror.h"            /* listener error codes         */
#include "lsdbf.h"

extern char Lastmsg[];
extern int NLPS_proc;
extern char *Netspec;
extern FILE *Logfp;
extern FILE *Debugfp;
extern char Mytag[];

static char *stamp(char *);
void logmessage(char *s);
void clean_up(int code, int flag, char *msg);

/*
 * error handling and debug routines
 * most routines take two args: code and exit.
 * code is a #define in lserror.h.
 * if EXIT bit in exitflag is non-zero, the routine exits. (see clean_up() )
 * define COREDUMP to do the obvious.
 */


/*
 * error: catastrophic error handler
 */

void
error(int code, int exitflag)
{
        char scratch[BUFSIZ];

        if (!(exitflag & NO_MSG)) {
                strcpy(scratch, err_list[code].err_msg);
                clean_up(code, exitflag, scratch);
        }
        clean_up(code, exitflag, NULL);
}

/*
 * tli_error:  Deal (appropriately) with an error in a TLI call
 */

static char *tlirange = "Unknown TLI error (t_errno > t_nerr)";

void
tli_error(int code, int exitflag)
{
        void    t_error();
        char    scratch[256];
        const char *p;
        int     save_errno = errno;

        p = (t_errno < t_nerr ? t_errlist[t_errno] : tlirange);

        (void) snprintf(scratch, sizeof (scratch), "%s: %s",
            err_list[code].err_msg, p);
        if (t_errno == TSYSERR)  {
                (void) strlcat(scratch, ": ", sizeof (scratch));
                (void) strlcat(scratch, strerror(save_errno), sizeof (scratch));
        }
        clean_up(code, exitflag, scratch);
}


/*
 * sys_error: error in a system call
 */

void
sys_error(int code, int exitflag)
{
        char scratch[256];

        (void) snprintf(scratch, sizeof (scratch), "%s: %s",
            err_list[code].err_msg, strerror(errno));
        clean_up(code, exitflag, scratch);
}


/*
 * clean_up:    if 'flag', and main listener is exiting, clean things
 *              up and exit.  Dumps core if !(flag & NOCORE).
 *              Tries to send a message to someone if the listener
 *              is exiting due to an error. (Inherrently machine dependent.)
 */

void
clean_up(int code, int flag, char *msg)
{
        extern int Dbf_entries;
        extern void logexit();
        extern int NLPS_proc, Nflag;
        int i;
        extern dbf_t Dbfhead;
        dbf_t   *dbp = &Dbfhead;

        if (!(flag & EXIT)) {
                logmessage(msg);
                return;
        }

        if (!(NLPS_proc))  {

                /*
                 * unbind anything that we bound.
                 * Needs more intelligence.
                 */


                for (i=0;i<Dbf_entries;i++) {
                        t_unbind(dbp->dbf_fd);
                        dbp++;
                }
        }

#ifdef  COREDUMP
        if (!(flag & NOCORE))
                abort();
#endif  /* COREDUMP */

        logexit(err_list[code].err_code, msg);
}


void
logexit(exitcode, msg)
int exitcode;
char *msg;
{
        if (msg) {
                logmessage(msg); /* put it in the log */
        }
        if (!NLPS_proc)
                logmessage("*** listener terminating!!! ***");
        exit(exitcode);

}


#ifdef  DEBUGMODE

/*VARARGS2*/
int
debug(int level, char *format, ...)
{
        char buf[256];
        va_list ap;

        va_start(ap, format);
        (void) vsprintf(buf, format, ap);
        va_end(ap);

        fprintf(Debugfp, stamp(buf));
        fflush(Debugfp);
}

#endif



/*
 * log:         given a message number (code), write a message to the logfile
 * logmessage:  given a string, write a message to the logfile
 */

void
log(int code)
{
        logmessage(err_list[code].err_msg);
}


static int nlogs;               /* maintains size of logfile    */

void
logmessage(char *s)
{
        char log[BUFSIZ];
        char olog[BUFSIZ];
        int err = 0;
        FILE *nlogfp;
        extern int Logmax;
        extern int Splflag;

        /*
         * The listener may be maintaining the size of it's logfile.
         * Nothing in here should make the listener abort.
         * If it can't save the file, it rewinds the existing log.
         * Note that the algorithm is not exact, child listener's
         * messages do not affect the parent's count.
         */

        if (!Logfp)
                return;
        if (!NLPS_proc && Logmax && ( nlogs >= Logmax ) && !Splflag)  {
                nlogs = 0;
                fprintf(Logfp, stamp("Restarting log file"));
                sprintf(log, "%s/%s/%s", ALTDIR, Mytag, LOGNAME);
                sprintf(olog, "%s/%s/%s", ALTDIR, Mytag, OLOGNAME);
                DEBUG((1, "Logfile exceeds Logmax (%d) lines", Logmax));
                unlink(olog); /* remove stale saved logfile */
                if (rename(log, olog))  {
                        ++err;
                        rewind(Logfp);
                        DEBUG((1,"errno %d renaming log to old logfile",errno));
                }
                else  if (nlogfp = fopen(log, "a+"))  {
                        fclose(Logfp);
                        Logfp = nlogfp;
                        fcntl(fileno(Logfp), F_SETFD, 1); /* reset close-on-exec */
                        DEBUG((1, "logmessage: logfile saved successfully"));
                }  else  {
                        ++err;
                        rewind(Logfp);
                        DEBUG((1, "Lost the logfile, errno %d", errno));
                }
                if (err)
                        fprintf(Logfp, stamp("Trouble saving the logfile"));
        }

        fprintf(Logfp, stamp(s));
        fflush(Logfp);
        ++nlogs;
}

extern pid_t Pid;

static char *
stamp(char *msg)
{
        time_t clock;
        struct tm *tm_p;

        (void)time(&clock);
        tm_p = (struct tm *) localtime(&clock);
        tm_p->tm_mon++; /* since months are 0-11 */
        sprintf(Lastmsg, "%2.2d/%2.2d/%2.2d %2.2d:%2.2d:%2.2d; %ld; %s\n",
                tm_p->tm_mon, tm_p->tm_mday, (tm_p->tm_year % 100),
                tm_p->tm_hour, tm_p->tm_min, tm_p->tm_sec, Pid, msg);
        return(Lastmsg);
}