bsd/sys/syslog.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  26 /*
  27  * Copyright (c) 1982, 1986, 1988, 1993
  28  *      The Regents of the University of California.  All rights reserved.
  29  *
  30  * Redistribution and use in source and binary forms, with or without
  31  * modification, are permitted provided that the following conditions
  32  * are met:
  33  * 1. Redistributions of source code must retain the above copyright
  34  *    notice, this list of conditions and the following disclaimer.
  35  * 2. Redistributions in binary form must reproduce the above copyright
  36  *    notice, this list of conditions and the following disclaimer in the
  37  *    documentation and/or other materials provided with the distribution.
  38  * 3. All advertising materials mentioning features or use of this software
  39  *    must display the following acknowledgement:
  40  *      This product includes software developed by the University of
  41  *      California, Berkeley and its contributors.
  42  * 4. Neither the name of the University nor the names of its contributors
  43  *    may be used to endorse or promote products derived from this software
  44  *    without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  *
  58  *      @(#)syslog.h    8.1 (Berkeley) 6/2/93
  59  */
  60
  61 #ifndef _SYS_SYSLOG_H_
  62 #define _SYS_SYSLOG_H_
  63
  64 #include <sys/appleapiopts.h>
  65
  66 #define _PATH_LOG       "/var/run/syslog"
  67
  68 /*
  69  * priorities/facilities are encoded into a single 32-bit quantity, where the
  70  * bottom 3 bits are the priority (0-7) and the top 28 bits are the facility
  71  * (0-big number).  Both the priorities and the facilities map roughly
  72  * one-to-one to strings in the syslogd(8) source code.  This mapping is
  73  * included in this file.
  74  *
  75  * priorities (these are ordered)
  76  */
  77 #define LOG_EMERG       0       /* system is unusable */
  78 #define LOG_ALERT       1       /* action must be taken immediately */
  79 #define LOG_CRIT        2       /* critical conditions */
  80 #define LOG_ERR         3       /* error conditions */
  81 #define LOG_WARNING     4       /* warning conditions */
  82 #define LOG_NOTICE      5       /* normal but significant condition */
  83 #define LOG_INFO        6       /* informational */
  84 #define LOG_DEBUG       7       /* debug-level messages */
  85
  86 #define LOG_PRIMASK     0x07    /* mask to extract priority part (internal) */
  87                                 /* extract priority */
  88 #define LOG_PRI(p)      ((p) & LOG_PRIMASK)
  89 #define LOG_MAKEPRI(fac, pri)   (((fac) << 3) | (pri))
  90
  91 #ifdef SYSLOG_NAMES
  92 #define INTERNAL_NOPRI  0x10    /* the "no priority" priority */
  93                                 /* mark "facility" */
  94 #define INTERNAL_MARK   LOG_MAKEPRI(LOG_NFACILITIES, 0)
  95 typedef struct _code {
  96         char    *c_name;
  97         int     c_val;
  98 } CODE;
  99
 100 CODE prioritynames[] = {
 101         "alert",        LOG_ALERT,
 102         "crit",         LOG_CRIT,
 103         "debug",        LOG_DEBUG,
 104         "emerg",        LOG_EMERG,
 105         "err",          LOG_ERR,
 106         "error",        LOG_ERR,                /* DEPRECATED */
 107         "info",         LOG_INFO,
 108         "none",         INTERNAL_NOPRI,         /* INTERNAL */
 109         "notice",       LOG_NOTICE,
 110         "panic",        LOG_EMERG,              /* DEPRECATED */
 111         "warn",         LOG_WARNING,            /* DEPRECATED */
 112         "warning",      LOG_WARNING,
 113         NULL,           -1,
 114 };
 115 #endif
 116
 117 /* facility codes */
 118 #define LOG_KERN        (0<<3)  /* kernel messages */
 119 #define LOG_USER        (1<<3)  /* random user-level messages */
 120 #define LOG_MAIL        (2<<3)  /* mail system */
 121 #define LOG_DAEMON      (3<<3)  /* system daemons */
 122 #define LOG_AUTH        (4<<3)  /* security/authorization messages */
 123 #define LOG_SYSLOG      (5<<3)  /* messages generated internally by syslogd */
 124 #define LOG_LPR         (6<<3)  /* line printer subsystem */
 125 #define LOG_NEWS        (7<<3)  /* network news subsystem */
 126 #define LOG_UUCP        (8<<3)  /* UUCP subsystem */
 127 #define LOG_CRON        (9<<3)  /* clock daemon */
 128 #define LOG_AUTHPRIV    (10<<3) /* security/authorization messages (private) */
 129 #define LOG_FTP         (11<<3) /* ftp daemon */
 130 #define LOG_NETINFO     (12<<3) /* NetInfo */
 131 #define LOG_REMOTEAUTH  (13<<3) /* remote authentication/authorization */
 132
 133         /* other codes through 15 reserved for system use */
 134 #define LOG_LOCAL0      (16<<3) /* reserved for local use */
 135 #define LOG_LOCAL1      (17<<3) /* reserved for local use */
 136 #define LOG_LOCAL2      (18<<3) /* reserved for local use */
 137 #define LOG_LOCAL3      (19<<3) /* reserved for local use */
 138 #define LOG_LOCAL4      (20<<3) /* reserved for local use */
 139 #define LOG_LOCAL5      (21<<3) /* reserved for local use */
 140 #define LOG_LOCAL6      (22<<3) /* reserved for local use */
 141 #define LOG_LOCAL7      (23<<3) /* reserved for local use */
 142
 143 #define LOG_NFACILITIES 24      /* current number of facilities */
 144 #define LOG_FACMASK     0x03f8  /* mask to extract facility part */
 145                                 /* facility of pri */
 146 #define LOG_FAC(p)      (((p) & LOG_FACMASK) >> 3)
 147
 148 #ifdef SYSLOG_NAMES
 149 CODE facilitynames[] = {
 150         "auth",         LOG_AUTH,
 151         "authpriv",     LOG_AUTHPRIV,
 152         "cron",         LOG_CRON,
 153         "daemon",       LOG_DAEMON,
 154         "ftp",          LOG_FTP,
 155         "kern",         LOG_KERN,
 156         "lpr",          LOG_LPR,
 157         "mail",         LOG_MAIL,
 158         "mark",         INTERNAL_MARK,          /* INTERNAL */
 159         "netinfo",      LOG_NETINFO,
 160         "remoteauth",   LOG_REMOTEAUTH,
 161         "news",         LOG_NEWS,
 162         "security",     LOG_AUTH,               /* DEPRECATED */
 163         "syslog",       LOG_SYSLOG,
 164         "user",         LOG_USER,
 165         "uucp",         LOG_UUCP,
 166         "local0",       LOG_LOCAL0,
 167         "local1",       LOG_LOCAL1,
 168         "local2",       LOG_LOCAL2,
 169         "local3",       LOG_LOCAL3,
 170         "local4",       LOG_LOCAL4,
 171         "local5",       LOG_LOCAL5,
 172         "local6",       LOG_LOCAL6,
 173         "local7",       LOG_LOCAL7,
 174         NULL,           -1,
 175 };
 176 #endif
 177
 178 #ifdef KERNEL
 179 #ifdef __APPLE_API_PRIVATE
 180 #define LOG_PRINTF      -1      /* pseudo-priority to indicate use of printf */
 181 #endif /* __APPLE_API_PRIVATE */
 182 #endif
 183
 184 /*
 185  * arguments to setlogmask.
 186  */
 187 #define LOG_MASK(pri)   (1 << (pri))            /* mask for one priority */
 188 #define LOG_UPTO(pri)   ((1 << ((pri)+1)) - 1)  /* all priorities through pri */
 189
 190 /*
 191  * Option flags for openlog.
 192  *
 193  * LOG_ODELAY no longer does anything.
 194  * LOG_NDELAY is the inverse of what it used to be.
 195  */
 196 #define LOG_PID         0x01    /* log the pid with each message */
 197 #define LOG_CONS        0x02    /* log on the console if errors in sending */
 198 #define LOG_ODELAY      0x04    /* delay open until first syslog() (default) */
 199 #define LOG_NDELAY      0x08    /* don't delay open */
 200 #define LOG_NOWAIT      0x10    /* don't wait for console forks: DEPRECATED */
 201 #define LOG_PERROR      0x20    /* log to stderr as well */
 202
 203 #include <sys/cdefs.h>
 204
 205 #ifndef KERNEL
 206
 207 /*
 208  * Don't use va_list in the vsyslog() prototype.   Va_list is typedef'd in two
 209  * places (<machine/varargs.h> and <machine/stdarg.h>), so if we include one
 210  * of them here we may collide with the utility's includes.  It's unreasonable
 211  * for utilities to have to include one of them to include syslog.h, so we get
 212  * _BSD_VA_LIST_ from <machine/ansi.h> and use it.
 213  */
 214 #include <machine/ansi.h>
 215
 216 __BEGIN_DECLS
 217 void    closelog __P((void));
 218 void    openlog __P((const char *, int, int));
 219 int     setlogmask __P((int));
 220 void    syslog __P((int, const char *, ...));
 221 void    vsyslog __P((int, const char *, _BSD_VA_LIST_));
 222 __END_DECLS
 223
 224 #else /* !KERNEL */
 225 #ifdef __APPLE_API_OBSOLETE
 226 /*
 227  * bit field descriptions for printf %r and %R formats
 228  */
 229
 230 /*
 231  * printf("%r %R", val, reg_descp);
 232  * struct reg_desc *reg_descp;
 233  *
 234  * the %r and %R formats allow formatted output of bit fields.
 235  * reg_descp points to an array of reg_desc structures, each element of the
 236  * array describes a range of bits within val.  the array should have a
 237  * final element with all structure elements 0.
 238  * %r outputs a string of the format "<bit field descriptions>"
 239  * %R outputs a string of the format "0x%x<bit field descriptions>"
 240  *
 241  * The fields in a reg_desc are:
 242  *      unsigned rd_mask;       An appropriate mask to isolate the bit field
 243  *                              within a word, and'ed with val
 244  *
 245  *      int rd_shift;           A shift amount to be done to the isolated
 246  *                              bit field.  done before printing the isolate
 247  *                              bit field with rd_format and before searching
 248  *                              for symbolic value names in rd_values
 249  *
 250  *      char *rd_name;          If non-null, a bit field name to label any
 251  *                              out from rd_format or searching rd_values.
 252  *                              if neither rd_format or rd_values is non-null
 253  *                              rd_name is printed only if the isolated
 254  *                              bit field is non-null.
 255  *
 256  *      char *rd_format;        If non-null, the shifted bit field value
 257  *                              is printed using this format.
 258  *
 259  *      struct reg_values *rd_values;   If non-null, a pointer to a table
 260  *                              matching numeric values with symbolic names.
 261  *                              rd_values are searched and the symbolic
 262  *                              value is printed if a match is found, if no
 263  *                              match is found "???" is printed.
 264  *
 265  * printf("%n %N", val, reg_valuesp);
 266  * struct reg_values *reg_valuesp;
 267  *
 268  * the %n and %N formats allow formatted output of symbolic constants
 269  * Reg_valuesp is a pointer to an array of struct reg_values which pairs
 270  * numeric values (rv_value) with symbolic names (rv_name).  The array is
 271  * terminated with a reg_values entry that has a null pointer for the
 272  * rv_name field.  When %n or %N is used rd_values are searched and the
 273  * symbolic value is printed if a match is found, if no match is found
 274  * "???" is printed.
 275  *
 276  * printf("%C", val);
 277  * int val;
 278  *
 279  * the %C format prints an int as a 4 character string.
 280  * The most significant byte of the int is printed first, the least
 281  * significant byte is printed last.
 282  */
 283
 284 /*
 285  * register values
 286  * map between numeric values and symbolic values
 287  */
 288 struct reg_values {
 289         unsigned rv_value;
 290         char *rv_name;
 291 };
 292
 293 /*
 294  * register descriptors are used for formatted prints of register values
 295  * rd_mask and rd_shift must be defined, other entries may be null
 296  */
 297 struct reg_desc {
 298         unsigned rd_mask;       /* mask to extract field */
 299         int rd_shift;           /* shift for extracted value, - >>, + << */
 300         char *rd_name;          /* field name */
 301         char *rd_format;        /* format to print field */
 302         struct reg_values *rd_values;   /* symbolic names of values */
 303 };
 304
 305 #endif /* __APPLE_API_OBSOLETE */
 306
 307 void    logpri __P((int));
 308 void    log __P((int, const char *, ...));
 309 void    addlog __P((const char *, ...));
 310
 311 #endif /* !KERNEL */
 312 #endif /* !_SYS_SYSLOG_H_ */