Blame stdlib/fmtmsg.c

Packit 6c4009
/* Copyright (C) 1997-2018 Free Software Foundation, Inc.
Packit 6c4009
   This file is part of the GNU C Library.
Packit 6c4009
   Contributed by Ulrich Drepper <drepper@cygnus.com>, 1997.
Packit 6c4009
Packit 6c4009
   The GNU C Library is free software; you can redistribute it and/or
Packit 6c4009
   modify it under the terms of the GNU Lesser General Public
Packit 6c4009
   License as published by the Free Software Foundation; either
Packit 6c4009
   version 2.1 of the License, or (at your option) any later version.
Packit 6c4009
Packit 6c4009
   The GNU C Library is distributed in the hope that it will be useful,
Packit 6c4009
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 6c4009
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 6c4009
   Lesser General Public License for more details.
Packit 6c4009
Packit 6c4009
   You should have received a copy of the GNU Lesser General Public
Packit 6c4009
   License along with the GNU C Library; if not, see
Packit 6c4009
   <http://www.gnu.org/licenses/>.  */
Packit 6c4009
Packit 6c4009
#include <fmtmsg.h>
Packit 6c4009
#include <libc-lock.h>
Packit 6c4009
#include <stdio.h>
Packit 6c4009
#include <stdint.h>
Packit 6c4009
#include <stdlib.h>
Packit 6c4009
#include <string.h>
Packit 6c4009
#include <sys/syslog.h>
Packit 6c4009
#include <wchar.h>
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* We have global data, protect the modification.  */
Packit 6c4009
__libc_lock_define_initialized (static, lock)
Packit 6c4009
Packit 6c4009
Packit 6c4009
enum
Packit 6c4009
{
Packit 6c4009
  label_mask = 0x01,
Packit 6c4009
  severity_mask = 0x02,
Packit 6c4009
  text_mask = 0x04,
Packit 6c4009
  action_mask = 0x08,
Packit 6c4009
  tag_mask = 0x10,
Packit 6c4009
  all_mask = label_mask | severity_mask | text_mask | action_mask | tag_mask
Packit 6c4009
};
Packit 6c4009
Packit 6c4009
static const struct
Packit 6c4009
{
Packit 6c4009
  uint32_t len;
Packit 6c4009
  /* Adjust the size if new elements are added.  */
Packit 6c4009
  const char name[12];
Packit 6c4009
} keywords[] =
Packit 6c4009
  {
Packit 6c4009
    { 5, "label" },
Packit 6c4009
    { 8, "severity" },
Packit 6c4009
    { 4, "text" },
Packit 6c4009
    { 6, "action"},
Packit 6c4009
    { 3, "tag" }
Packit 6c4009
  };
Packit 6c4009
#define NKEYWORDS (sizeof( keywords) / sizeof (keywords[0]))
Packit 6c4009
Packit 6c4009
Packit 6c4009
struct severity_info
Packit 6c4009
{
Packit 6c4009
  int severity;
Packit 6c4009
  const char *string;
Packit 6c4009
  struct severity_info *next;
Packit 6c4009
};
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* List of known severities.  */
Packit 6c4009
static const struct severity_info nosev =
Packit 6c4009
{
Packit 6c4009
  MM_NOSEV, "", NULL
Packit 6c4009
};
Packit 6c4009
static const struct severity_info haltsev =
Packit 6c4009
{
Packit 6c4009
  MM_HALT, "HALT", (struct severity_info *) &nosev
Packit 6c4009
};
Packit 6c4009
static const struct severity_info errorsev =
Packit 6c4009
{
Packit 6c4009
  MM_ERROR, "ERROR", (struct severity_info *) &haltsev
Packit 6c4009
};
Packit 6c4009
static const struct severity_info warningsev =
Packit 6c4009
{
Packit 6c4009
  MM_WARNING, "WARNING", (struct severity_info *) &errorsev
Packit 6c4009
};
Packit 6c4009
static const struct severity_info infosev =
Packit 6c4009
{
Packit 6c4009
  MM_INFO, "INFO", (struct severity_info *) &warningsev
Packit 6c4009
};
Packit 6c4009
Packit 6c4009
/* Start of the list.  */
Packit 6c4009
static struct severity_info *severity_list = (struct severity_info *) &infosev;
Packit 6c4009
Packit 6c4009
/* Mask of values we will print.  */
Packit 6c4009
static int print;
Packit 6c4009
Packit 6c4009
/* Prototypes for local functions.  */
Packit 6c4009
static void init (void);
Packit 6c4009
static int internal_addseverity (int severity, const char *string);
Packit 6c4009
Packit 6c4009
Packit 6c4009
int
Packit 6c4009
fmtmsg (long int classification, const char *label, int severity,
Packit 6c4009
	const char *text, const char *action, const char *tag)
Packit 6c4009
{
Packit 6c4009
  __libc_once_define (static, once);
Packit 6c4009
  struct severity_info *severity_rec;
Packit 6c4009
Packit 6c4009
  /* Make sure everything is initialized.  */
Packit 6c4009
  __libc_once (once, init);
Packit 6c4009
Packit 6c4009
  /* Start the real work.  First check whether the input is ok.  */
Packit 6c4009
  if (label != MM_NULLLBL)
Packit 6c4009
    {
Packit 6c4009
      /* Must be two fields, separated by a colon.  */
Packit 6c4009
      const char *cp = strchr (label, ':');
Packit 6c4009
      if (cp == NULL)
Packit 6c4009
	return MM_NOTOK;
Packit 6c4009
Packit 6c4009
      /* The first field must not contain more than 10 bytes.  */
Packit 6c4009
      if (cp - label > 10
Packit 6c4009
	  /* The second field must not have more than 14 bytes.  */
Packit 6c4009
	  || strlen (cp + 1) > 14)
Packit 6c4009
	return MM_NOTOK;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
#ifdef __libc_ptf_call
Packit 6c4009
  /* We do not want this call to be cut short by a thread
Packit 6c4009
     cancellation.  Therefore disable cancellation for now.  */
Packit 6c4009
  int state = PTHREAD_CANCEL_ENABLE;
Packit 6c4009
  __libc_ptf_call (__pthread_setcancelstate,
Packit 6c4009
		   (PTHREAD_CANCEL_DISABLE, &state), 0);
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
  __libc_lock_lock (lock);
Packit 6c4009
Packit 6c4009
  for (severity_rec = severity_list; severity_rec != NULL;
Packit 6c4009
       severity_rec = severity_rec->next)
Packit 6c4009
    if (severity == severity_rec->severity)
Packit 6c4009
      /* Bingo.  */
Packit 6c4009
      break;
Packit 6c4009
Packit 6c4009
  /* If we don't know anything about the severity level return an error.  */
Packit 6c4009
  int result = MM_NOTOK;
Packit 6c4009
  if (severity_rec != NULL)
Packit 6c4009
    {
Packit 6c4009
      result = MM_OK;
Packit 6c4009
Packit 6c4009
      /* Now we can print.  */
Packit 6c4009
      if (classification & MM_PRINT)
Packit 6c4009
	{
Packit 6c4009
	  int do_label = (print & label_mask) && label != MM_NULLLBL;
Packit 6c4009
	  int do_severity = (print & severity_mask) && severity != MM_NULLSEV;
Packit 6c4009
	  int do_text = (print & text_mask) && text != MM_NULLTXT;
Packit 6c4009
	  int do_action = (print & action_mask) && action != MM_NULLACT;
Packit 6c4009
	  int do_tag = (print & tag_mask) && tag != MM_NULLTAG;
Packit 6c4009
	  int need_colon = (do_label
Packit 6c4009
			    && (do_severity | do_text | do_action | do_tag));
Packit 6c4009
Packit 6c4009
	  if (__fxprintf (stderr, "%s%s%s%s%s%s%s%s%s%s\n",
Packit 6c4009
			  do_label ? label : "",
Packit 6c4009
			  need_colon ? ": " : "",
Packit 6c4009
			  do_severity ? severity_rec->string : "",
Packit 6c4009
			  do_severity && (do_text | do_action | do_tag)
Packit 6c4009
			  ? ": " : "",
Packit 6c4009
			  do_text ? text : "",
Packit 6c4009
			  do_text && (do_action | do_tag) ? "\n" : "",
Packit 6c4009
			  do_action ? "TO FIX: " : "",
Packit 6c4009
			  do_action ? action : "",
Packit 6c4009
			  do_action && do_tag ? "  " : "",
Packit 6c4009
			  do_tag ? tag : "") < 0)
Packit 6c4009
	    /* Oh, oh.  An error occurred during the output.  */
Packit 6c4009
	    result = MM_NOMSG;
Packit 6c4009
	}
Packit 6c4009
Packit 6c4009
      if (classification & MM_CONSOLE)
Packit 6c4009
	{
Packit 6c4009
	  int do_label = label != MM_NULLLBL;
Packit 6c4009
	  int do_severity = severity != MM_NULLSEV;
Packit 6c4009
	  int do_text = text != MM_NULLTXT;
Packit 6c4009
	  int do_action = action != MM_NULLACT;
Packit 6c4009
	  int do_tag = tag != MM_NULLTAG;
Packit 6c4009
	  int need_colon = (do_label
Packit 6c4009
			    && (do_severity | do_text | do_action | do_tag));
Packit 6c4009
Packit 6c4009
	  syslog (LOG_ERR, "%s%s%s%s%s%s%s%s%s%s\n",
Packit 6c4009
		  do_label ? label : "",
Packit 6c4009
		  need_colon ? ": " : "",
Packit 6c4009
		  do_severity ? severity_rec->string : "",
Packit 6c4009
		  do_severity && (do_text | do_action | do_tag) ? ": " : "",
Packit 6c4009
		  do_text ? text : "",
Packit 6c4009
		  do_text && (do_action | do_tag) ? "\n" : "",
Packit 6c4009
		  do_action ? "TO FIX: " : "",
Packit 6c4009
		  do_action ? action : "",
Packit 6c4009
		  do_action && do_tag ? "  " : "",
Packit 6c4009
		  do_tag ? tag : "");
Packit 6c4009
	}
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  __libc_lock_unlock (lock);
Packit 6c4009
Packit 6c4009
#ifdef __libc_ptf_call
Packit 6c4009
  __libc_ptf_call (__pthread_setcancelstate, (state, NULL), 0);
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
  return result;
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Initialize from environment variable content.  */
Packit 6c4009
static void
Packit 6c4009
init (void)
Packit 6c4009
{
Packit 6c4009
  const char *msgverb_var = getenv ("MSGVERB");
Packit 6c4009
  const char *sevlevel_var = getenv ("SEV_LEVEL");
Packit 6c4009
Packit 6c4009
  if (msgverb_var != NULL && msgverb_var[0] != '\0')
Packit 6c4009
    {
Packit 6c4009
      /* Using this extra variable allows us to work without locking.  */
Packit 6c4009
      do
Packit 6c4009
	{
Packit 6c4009
	  size_t cnt;
Packit 6c4009
Packit 6c4009
	  for (cnt = 0; cnt < NKEYWORDS; ++cnt)
Packit 6c4009
	    if (memcmp (msgverb_var,
Packit 6c4009
			keywords[cnt].name, keywords[cnt].len) == 0
Packit 6c4009
		&& (msgverb_var[keywords[cnt].len] == ':'
Packit 6c4009
		    || msgverb_var[keywords[cnt].len] == '\0'))
Packit 6c4009
	      break;
Packit 6c4009
Packit 6c4009
	  if (cnt < NKEYWORDS)
Packit 6c4009
	    {
Packit 6c4009
	      print |= 1 << cnt;
Packit 6c4009
Packit 6c4009
	      msgverb_var += keywords[cnt].len;
Packit 6c4009
	      if (msgverb_var[0] == ':')
Packit 6c4009
		++msgverb_var;
Packit 6c4009
	    }
Packit 6c4009
	  else
Packit 6c4009
	    {
Packit 6c4009
	      /* We found an illegal keyword in the environment
Packit 6c4009
		 variable.  The specifications say that we print all
Packit 6c4009
		 fields.  */
Packit 6c4009
	      print = all_mask;
Packit 6c4009
	      break;
Packit 6c4009
	    }
Packit 6c4009
	}
Packit 6c4009
      while (msgverb_var[0] != '\0');
Packit 6c4009
    }
Packit 6c4009
  else
Packit 6c4009
    print = all_mask;
Packit 6c4009
Packit 6c4009
Packit 6c4009
  if (sevlevel_var != NULL)
Packit 6c4009
    {
Packit 6c4009
      __libc_lock_lock (lock);
Packit 6c4009
Packit 6c4009
      while (sevlevel_var[0] != '\0')
Packit 6c4009
	{
Packit 6c4009
	  const char *end = __strchrnul (sevlevel_var, ':');
Packit 6c4009
	  int level;
Packit 6c4009
Packit 6c4009
	  /* First field: keyword.  This is not used here but it must be
Packit 6c4009
	     present.  */
Packit 6c4009
	  while (sevlevel_var < end)
Packit 6c4009
	    if (*sevlevel_var++ == ',')
Packit 6c4009
	      break;
Packit 6c4009
Packit 6c4009
	  if (sevlevel_var < end)
Packit 6c4009
	    {
Packit 6c4009
	      /* Second field: severity level, a number.  */
Packit 6c4009
	      char *cp;
Packit 6c4009
Packit 6c4009
	      level = strtol (sevlevel_var, &cp, 0);
Packit 6c4009
	      if (cp != sevlevel_var && cp < end && *cp++ == ','
Packit 6c4009
		  && level > MM_INFO)
Packit 6c4009
		{
Packit 6c4009
		  const char *new_string;
Packit 6c4009
Packit 6c4009
		  new_string = __strndup (cp, end - cp);
Packit 6c4009
Packit 6c4009
		  if (new_string != NULL
Packit 6c4009
		      && (internal_addseverity (level, new_string)
Packit 6c4009
			  != MM_OK))
Packit 6c4009
		    free ((char *) new_string);
Packit 6c4009
		}
Packit 6c4009
	    }
Packit 6c4009
Packit 6c4009
	  sevlevel_var = end + (*end == ':' ? 1 : 0);
Packit 6c4009
	}
Packit 6c4009
Packit 6c4009
      __libc_lock_unlock (lock);
Packit 6c4009
    }
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Add the new entry to the list.  */
Packit 6c4009
static int
Packit 6c4009
internal_addseverity (int severity, const char *string)
Packit 6c4009
{
Packit 6c4009
  struct severity_info *runp, *lastp;
Packit 6c4009
  int result = MM_OK;
Packit 6c4009
Packit 6c4009
  /* First see if there is already a record for the severity level.  */
Packit 6c4009
  for (runp = severity_list, lastp = NULL; runp != NULL; runp = runp->next)
Packit 6c4009
    if (runp->severity == severity)
Packit 6c4009
      break;
Packit 6c4009
    else
Packit 6c4009
      lastp = runp;
Packit 6c4009
Packit 6c4009
  if (runp != NULL)
Packit 6c4009
    {
Packit 6c4009
      if (string != NULL)
Packit 6c4009
	/* Change the string.  */
Packit 6c4009
	runp->string = string;
Packit 6c4009
      else
Packit 6c4009
	{
Packit 6c4009
	  /* Remove the severity class.  */
Packit 6c4009
	  if (lastp == NULL)
Packit 6c4009
	    severity_list = runp->next;
Packit 6c4009
	  else
Packit 6c4009
	    lastp->next = runp->next;
Packit 6c4009
Packit 6c4009
	  free (runp);
Packit 6c4009
	}
Packit 6c4009
    }
Packit 6c4009
  else if (string != NULL)
Packit 6c4009
    {
Packit 6c4009
      runp = malloc (sizeof (*runp));
Packit 6c4009
      if (runp == NULL)
Packit 6c4009
	result = MM_NOTOK;
Packit 6c4009
      else
Packit 6c4009
	{
Packit 6c4009
	  runp->severity = severity;
Packit 6c4009
	  runp->next = severity_list;
Packit 6c4009
	  runp->string = string;
Packit 6c4009
	  severity_list = runp;
Packit 6c4009
	}
Packit 6c4009
    }
Packit 6c4009
  else
Packit 6c4009
    /* We tried to remove a non-existing severity class.  */
Packit 6c4009
    result = MM_NOTOK;
Packit 6c4009
Packit 6c4009
  return result;
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Add new severity level or remove old one.  */
Packit 6c4009
int
Packit 6c4009
__addseverity (int severity, const char *string)
Packit 6c4009
{
Packit 6c4009
  int result;
Packit 6c4009
Packit 6c4009
  /* Prevent illegal SEVERITY values.  */
Packit 6c4009
  if (severity <= MM_INFO)
Packit 6c4009
    return MM_NOTOK;
Packit 6c4009
Packit 6c4009
  /* Protect the global data.  */
Packit 6c4009
  __libc_lock_lock (lock);
Packit 6c4009
Packit 6c4009
  /* Do the real work.  */
Packit 6c4009
  result = internal_addseverity (severity, string);
Packit 6c4009
Packit 6c4009
  /* Release the lock.  */
Packit 6c4009
  __libc_lock_unlock (lock);
Packit 6c4009
Packit 6c4009
  return result;
Packit 6c4009
}
Packit 6c4009
weak_alias (__addseverity, addseverity)
Packit 6c4009
Packit 6c4009
Packit 6c4009
libc_freeres_fn (free_mem)
Packit 6c4009
{
Packit 6c4009
  struct severity_info *runp = severity_list;
Packit 6c4009
Packit 6c4009
  while (runp != NULL)
Packit 6c4009
    if (runp->severity > MM_INFO)
Packit 6c4009
      {
Packit 6c4009
	/* This is data we have to release.  */
Packit 6c4009
	struct severity_info *here = runp;
Packit 6c4009
	runp = runp->next;
Packit 6c4009
	free (here);
Packit 6c4009
      }
Packit 6c4009
    else
Packit 6c4009
      runp = runp->next;
Packit 6c4009
}