1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #pragma ident "%Z%%M% %I% %E% SMI" 27 28 #include <sys/fm/protocol.h> 29 #include <sys/strlog.h> 30 #include <sys/log.h> 31 #include <fm/fmd_api.h> 32 #include <fm/fmd_msg.h> 33 34 #include <stropts.h> 35 #include <syslog.h> 36 #include <locale.h> 37 #include <strings.h> 38 #include <stdlib.h> 39 #include <unistd.h> 40 #include <limits.h> 41 #include <alloca.h> 42 #include <errno.h> 43 #include <fcntl.h> 44 #include <time.h> 45 46 /* 47 * SYSLOG_DOMAIN and SYSLOG_TEMPLATE define the dgettext() parameters the agent 48 * can use to retrieve the localized format string for diagnosis messages. 49 * The format string retrieved from SYSLOG_DOMAIN is the default format 50 * string, but when processing each suspect list, dgettext() is also called 51 * for the domain that matches the diagcode dictname and if SYSLOG_TEMPLATE 52 * is defined, it overrides the default for that suspect list only. 53 * 54 * Similarly, SYSLOG_URL is also checked to see if syslog_url 55 * should be overridden for each suspect list. 56 * 57 * The net effect of all this is that for a given diagcode DICT-1234-56: 58 * 59 * - If DICT.mo defines syslog-msgs-message-template, it is used 60 * as the format string for the diagnosis message. 61 * 62 * - Otherwise, syslog-msgs-message-template from FMD.mo is used. 63 * 64 * - If DICT.mo defines syslog-url, it is used when filling 65 * in the %s in the "description" message. 66 * 67 * - Otherwise, if syslog-msgs.conf defines a "url" property, that 68 * value is used. 69 * 70 * - Otherwise, the default "http://sun.com/msg/" is used (via the 71 * fmd_props[] table defined in this file). 72 */ 73 static const char SYSLOG_DOMAIN[] = "FMD"; 74 static const char SYSLOG_TEMPLATE[] = "syslog-msgs-message-template"; 75 static const char SYSLOG_URL[] = "syslog-url"; 76 77 static struct stats { 78 fmd_stat_t bad_vers; 79 fmd_stat_t bad_fmri; 80 fmd_stat_t bad_code; 81 fmd_stat_t bad_time; 82 fmd_stat_t log_err; 83 fmd_stat_t msg_err; 84 fmd_stat_t no_msg; 85 } syslog_stats = { 86 { "bad_vers", FMD_TYPE_UINT64, "event version is missing or invalid" }, 87 { "bad_fmri", FMD_TYPE_UINT64, "event fmri is missing or invalid" }, 88 { "bad_code", FMD_TYPE_UINT64, "event code has no dictionary name" }, 89 { "bad_time", FMD_TYPE_UINT64, "event time is not properly encoded" }, 90 { "log_err", FMD_TYPE_UINT64, "failed to log message to log(7D)" }, 91 { "msg_err", FMD_TYPE_UINT64, "failed to log message to sysmsg(7D)" }, 92 { "no_msg", FMD_TYPE_UINT64, "message logging suppressed" } 93 }; 94 95 static const struct facility { 96 const char *fac_name; 97 int fac_value; 98 } syslog_facs[] = { 99 { "LOG_DAEMON", LOG_DAEMON }, 100 { "LOG_LOCAL0", LOG_LOCAL0 }, 101 { "LOG_LOCAL1", LOG_LOCAL1 }, 102 { "LOG_LOCAL2", LOG_LOCAL2 }, 103 { "LOG_LOCAL3", LOG_LOCAL3 }, 104 { "LOG_LOCAL4", LOG_LOCAL4 }, 105 { "LOG_LOCAL5", LOG_LOCAL5 }, 106 { "LOG_LOCAL6", LOG_LOCAL6 }, 107 { "LOG_LOCAL7", LOG_LOCAL7 }, 108 { NULL, 0 } 109 }; 110 111 static char *syslog_locdir; /* l10n messages directory (if alternate) */ 112 static char *syslog_url; /* current value of "url" property */ 113 static int syslog_msgall; /* set to message all faults */ 114 static log_ctl_t syslog_ctl; /* log(7D) meta-data for each msg */ 115 static int syslog_logfd = -1; /* log(7D) file descriptor */ 116 static int syslog_msgfd = -1; /* sysmsg(7D) file descriptor */ 117 static int syslog_file; /* log to syslog_logfd */ 118 static int syslog_cons; /* log to syslog_msgfd */ 119 120 /* 121 * Ideally we would just use syslog(3C) for outputting our messages, but our 122 * messaging standard defines a nice multi-line format and syslogd(1M) is very 123 * inflexible and stupid when it comes to multi-line messages. It pulls data 124 * out of log(7D) and splits it up by \n, printing each line to the console 125 * with its usual prefix of date and sender; it uses the same behavior for the 126 * messages file as well. Further, syslog(3C) provides no CE_CONT equivalent 127 * for userland callers (which at least works around repeated file prefixing). 128 * So with a multi-line message format, your file and console end up like this: 129 * 130 * Dec 02 18:08:40 hostname this is my nicely formatted 131 * Dec 02 18:08:40 hostname message designed for 80 cols 132 * ... 133 * 134 * To resolve these issues, we use our own syslog_emit() wrapper to emit 135 * messages and some knowledge of how the Solaris log drivers work. We first 136 * construct an enlarged format string containing the appropriate msgid(1). 137 * We then format the caller's message using the provided format and buffer. 138 * We send this message to log(7D) using putmsg() with SL_CONSOLE | SL_LOGONLY 139 * set in the log_ctl_t. The log driver allows us to set SL_LOGONLY when we 140 * construct messages ourself, indicating that syslogd should only emit the 141 * message to /var/adm/messages and any remote hosts, and skip the console. 142 * Note: the log driver packet size limit for output via putmsg is LOGMAX_PS. 143 * Then we emit the message a second time, without the special prefix, to the 144 * sysmsg(7D) device, which handles console redirection and also permits us 145 * to output any characters we like to the console, including \n and \r. 146 */ 147 /*PRINTFLIKE2*/ 148 static void 149 syslog_emit(fmd_hdl_t *hdl, const char *msgformat, ...) 150 { 151 struct strbuf ctl, dat; 152 uint32_t msgid; 153 154 char *format, c; 155 char *buf = NULL; 156 size_t formatlen, logmsglen; 157 int len; 158 va_list ap; 159 160 formatlen = strlen(msgformat) + 64; /* +64 for prefix and \0 */ 161 format = alloca(formatlen); 162 163 STRLOG_MAKE_MSGID(msgformat, msgid); 164 (void) snprintf(format, formatlen, 165 "fmd: [ID %u FACILITY_AND_PRIORITY] %s", msgid, msgformat); 166 167 /* 168 * Figure out the length of the message then allocate a buffer 169 * of adequate size. 170 */ 171 va_start(ap, msgformat); 172 if ((len = vsnprintf(&c, 1, format, ap)) >= 0 && 173 (buf = fmd_hdl_alloc(hdl, len + 1, FMD_SLEEP)) != NULL) 174 (void) vsnprintf(buf, len + 1, format, ap); 175 va_end(ap); 176 177 if (buf == NULL) 178 return; 179 180 ctl.buf = (void *)&syslog_ctl; 181 ctl.len = sizeof (syslog_ctl); 182 183 dat.buf = buf; 184 logmsglen = strlen(buf) + 1; 185 186 /* 187 * The underlying log driver won't accept (ERANGE) messages 188 * longer than LOG_MAXPS bytes so don't putmsg more than that. 189 */ 190 if (logmsglen > LOG_MAXPS) 191 dat.len = LOG_MAXPS; 192 else 193 dat.len = logmsglen; 194 195 if (syslog_file && putmsg(syslog_logfd, &ctl, &dat, 0) != 0) { 196 fmd_hdl_debug(hdl, "putmsg failed: %s\n", strerror(errno)); 197 syslog_stats.log_err.fmds_value.ui64++; 198 } 199 200 dat.buf = strchr(buf, ']'); 201 dat.len = (size_t)(logmsglen - (dat.buf - buf)); 202 203 dat.buf[0] = '\r'; /* overwrite ']' with carriage return */ 204 dat.buf[1] = '\n'; /* overwrite ' ' with newline */ 205 206 if (syslog_cons && write(syslog_msgfd, dat.buf, dat.len) != dat.len) { 207 fmd_hdl_debug(hdl, "write failed: %s\n", strerror(errno)); 208 syslog_stats.msg_err.fmds_value.ui64++; 209 } 210 211 fmd_hdl_free(hdl, buf, len + 1); 212 } 213 214 /*ARGSUSED*/ 215 static void 216 syslog_recv(fmd_hdl_t *hdl, fmd_event_t *ep, nvlist_t *nvl, const char *class) 217 { 218 char *uuid, *code, *dict, *url, *urlcode, *template, *p; 219 char *src_name, *src_vers, *platform, *chassis, *server; 220 char *typ, *sev, *fmt, *trfmt, *rsp, *imp, *act, *locdir; 221 char desc[1024], date[64]; 222 boolean_t domsg; 223 224 nvlist_t *fmri, *auth; 225 uint8_t version; 226 struct tm tm, *tmp; 227 int64_t *tv; 228 time_t sec; 229 uint_t tn = 0; 230 char *olang = NULL; 231 int locale_c = 0; 232 size_t len; 233 234 if (nvlist_lookup_uint8(nvl, FM_VERSION, &version) != 0 || 235 version > FM_SUSPECT_VERSION) { 236 fmd_hdl_debug(hdl, "invalid event version: %u\n", version); 237 syslog_stats.bad_vers.fmds_value.ui64++; 238 return; /* invalid event version */ 239 } 240 241 if (!syslog_msgall && nvlist_lookup_boolean_value(nvl, 242 FM_SUSPECT_MESSAGE, &domsg) == 0 && !domsg) { 243 fmd_hdl_debug(hdl, "%s requested no message\n", class); 244 syslog_stats.no_msg.fmds_value.ui64++; 245 return; /* event is not to be messaged */ 246 } 247 248 /* 249 * Extract the DE element, which is an FMRI for the diagnosis engine 250 * that made this event, and validate its meta-data before continuing. 251 */ 252 if (nvlist_lookup_nvlist(nvl, FM_SUSPECT_DE, &fmri) != 0 || 253 nvlist_lookup_string(fmri, FM_FMRI_SCHEME, &p) != 0 || 254 strcmp(p, FM_FMRI_SCHEME_FMD) != 0 || 255 nvlist_lookup_uint8(fmri, FM_VERSION, &version) != 0 || 256 version > FM_FMD_SCHEME_VERSION || 257 nvlist_lookup_nvlist(fmri, FM_FMRI_AUTHORITY, &auth) != 0 || 258 nvlist_lookup_uint8(auth, FM_VERSION, &version) != 0 || 259 version > FM_FMRI_AUTH_VERSION) { 260 syslog_stats.bad_fmri.fmds_value.ui64++; 261 return; /* invalid de fmri */ 262 } 263 264 /* 265 * Extract the relevant identifying elements of the FMRI and authority. 266 * Note: for now, we ignore FM_FMRI_AUTH_DOMAIN (only for SPs). 267 */ 268 (void) nvlist_lookup_string(fmri, FM_FMRI_FMD_NAME, &src_name); 269 (void) nvlist_lookup_string(fmri, FM_FMRI_FMD_VERSION, &src_vers); 270 (void) nvlist_lookup_string(auth, FM_FMRI_AUTH_PRODUCT, &platform); 271 (void) nvlist_lookup_string(auth, FM_FMRI_AUTH_SERVER, &server); 272 273 if (nvlist_lookup_string(auth, FM_FMRI_AUTH_CHASSIS, &chassis) != 0) 274 chassis = "-"; /* chassis serial number may not be present */ 275 276 /* 277 * Extract the uuid and diagcode dictionary from the event code. The 278 * dictionary name is the text preceding the first "-" in the code. 279 */ 280 (void) nvlist_lookup_string(nvl, FM_SUSPECT_UUID, &uuid); 281 (void) nvlist_lookup_string(nvl, FM_SUSPECT_DIAG_CODE, &code); 282 283 if ((p = strchr(code, '-')) == NULL || p == code) { 284 fmd_hdl_debug(hdl, "invalid diagnosis code: %s\n", code); 285 syslog_stats.bad_code.fmds_value.ui64++; 286 return; /* invalid diagnosis code */ 287 } 288 289 dict = alloca((size_t)(p - code) + 1); 290 (void) strncpy(dict, code, (size_t)(p - code)); 291 dict[(size_t)(p - code)] = '\0'; 292 293 /* 294 * Alloca a hunk of memory and use it to create the msgid strings 295 * <code>.type, <code>.severity, <code>.description, and so forth. 296 * These form the msgids we will use to look up the localized text. 297 * Since we've allocated things to be of the right size, we know 298 * than snprintf() can't overflow: INT_MAX is used shut lint up and 299 * avoid code to needlessly recompute the remaining buffer space. 300 */ 301 typ = alloca(6 * (strlen(code) + 16)); 302 sev = typ + snprintf(typ, INT_MAX, "%s.type", code) + 1; 303 fmt = sev + snprintf(sev, INT_MAX, "%s.severity", code) + 1; 304 rsp = fmt + snprintf(fmt, INT_MAX, "%s.description", code) + 1; 305 imp = rsp + snprintf(rsp, INT_MAX, "%s.response", code) + 1; 306 act = imp + snprintf(imp, INT_MAX, "%s.impact", code) + 1; 307 (void) snprintf(act, INT_MAX, "%s.action", code); 308 309 fmd_msg_lock(); 310 311 if (syslog_locdir != NULL) 312 locdir = bindtextdomain(dict, syslog_locdir); 313 314 if ((trfmt = dgettext(dict, fmt)) == fmt) { 315 /* 316 * We didn't find a translation in the dictionary for the 317 * current language. The string we passed to gettext is merely 318 * an index - it isn't sufficient, on its own, to be used as the 319 * message. Fall back to C and try again. 320 */ 321 olang = setlocale(LC_MESSAGES, NULL); 322 if (olang) { 323 p = alloca(strlen(olang) + 1); 324 olang = strcpy(p, olang); 325 } 326 locale_c = 1; 327 (void) setlocale(LC_MESSAGES, "C"); 328 trfmt = dgettext(dict, fmt); 329 } 330 331 if ((url = dgettext(dict, SYSLOG_URL)) == SYSLOG_URL) 332 url = syslog_url; 333 334 /* 335 * If the URL ends with a slash, that indicates the code should be 336 * appended to it. After formatting the URL, reformat the DESC 337 * text using the URL as an snprintf argument. 338 */ 339 len = strlen(url); 340 if (url[len - 1] == '/') { 341 urlcode = alloca(len + strlen(code) + 1); 342 (void) snprintf(urlcode, INT_MAX, "%s%s", url, code); 343 } else { 344 urlcode = url; 345 } 346 /* LINTED - variable format specifier to snprintf() */ 347 (void) snprintf(desc, sizeof (desc), trfmt, urlcode); 348 349 /* 350 * Extract the diagnosis time and format it using the locale's default. 351 * strftime() will use GMT or local time based on our "gmt" setting. 352 */ 353 if (nvlist_lookup_int64_array(nvl, FM_SUSPECT_DIAG_TIME, 354 &tv, &tn) == 0 && tn == 2 && (sec = (time_t)tv[0]) != (time_t)-1 && 355 (tmp = localtime_r(&sec, &tm)) != NULL) 356 (void) strftime(date, sizeof (date), "%C", tmp); 357 else { 358 syslog_stats.bad_time.fmds_value.ui64++; 359 (void) strcpy(date, "-"); 360 } 361 362 /* 363 * Create and log the final string by filling in the template with the 364 * strings we've created and the strings from the message dictionary. 365 * If a template is provided for this dictionary, use it, otherwise 366 * fall back to the default template. 367 */ 368 if ((template = dgettext(dict, SYSLOG_TEMPLATE)) == SYSLOG_TEMPLATE) 369 template = dgettext(SYSLOG_DOMAIN, SYSLOG_TEMPLATE); 370 371 syslog_ctl.pri &= LOG_FACMASK; 372 if (strcmp(class, FM_LIST_REPAIRED_CLASS) == 0) 373 syslog_ctl.pri |= LOG_NOTICE; 374 else 375 syslog_ctl.pri |= LOG_ERR; 376 syslog_emit(hdl, template, code, dgettext(dict, typ), 377 dgettext(dict, sev), date, platform, chassis, server, src_name, 378 src_vers, uuid, desc, dgettext(dict, rsp), dgettext(dict, imp), 379 dgettext(dict, act)); 380 381 /* 382 * Switch back to our original language if we had to fall back to C. 383 */ 384 if (olang != NULL) 385 (void) setlocale(LC_MESSAGES, olang); 386 387 if (syslog_locdir != NULL) 388 (void) bindtextdomain(dict, locdir); 389 390 fmd_msg_unlock(); 391 392 if (locale_c) { 393 fmd_hdl_debug(hdl, 394 trfmt == fmt ? 395 "dgettext(%s, %s) in %s and C failed\n" : 396 "dgettext(%s, %s) in %s failed; C used\n", 397 dict, fmt, olang ? olang : "<null>"); 398 } 399 } 400 401 static const fmd_prop_t fmd_props[] = { 402 { "console", FMD_TYPE_BOOL, "true" }, 403 { "facility", FMD_TYPE_STRING, "LOG_DAEMON" }, 404 { "gmt", FMD_TYPE_BOOL, "false" }, 405 { "syslogd", FMD_TYPE_BOOL, "true" }, 406 { "url", FMD_TYPE_STRING, "http://sun.com/msg/" }, 407 { "message_all", FMD_TYPE_BOOL, "false" }, 408 { NULL, 0, NULL } 409 }; 410 411 static const fmd_hdl_ops_t fmd_ops = { 412 syslog_recv, /* fmdo_recv */ 413 NULL, /* fmdo_timeout */ 414 NULL, /* fmdo_close */ 415 NULL, /* fmdo_stats */ 416 NULL, /* fmdo_gc */ 417 }; 418 419 static const fmd_hdl_info_t fmd_info = { 420 "Syslog Messaging Agent", "1.0", &fmd_ops, fmd_props 421 }; 422 423 void 424 _fmd_init(fmd_hdl_t *hdl) 425 { 426 const struct facility *fp; 427 char *facname, *tz, *rootdir, *locdir, *locale, *p; 428 429 if (fmd_hdl_register(hdl, FMD_API_VERSION, &fmd_info) != 0) 430 return; /* invalid data in configuration file */ 431 432 (void) fmd_stat_create(hdl, FMD_STAT_NOALLOC, sizeof (syslog_stats) / 433 sizeof (fmd_stat_t), (fmd_stat_t *)&syslog_stats); 434 435 if ((syslog_logfd = open("/dev/conslog", O_WRONLY | O_NOCTTY)) == -1) 436 fmd_hdl_abort(hdl, "syslog-msgs failed to open /dev/conslog"); 437 438 if ((syslog_msgfd = open("/dev/sysmsg", O_WRONLY | O_NOCTTY)) == -1) 439 fmd_hdl_abort(hdl, "syslog-msgs failed to open /dev/sysmsg"); 440 441 /* 442 * All FMA event dictionaries use msgfmt(1) message objects to produce 443 * messages, even for the C locale. We therefore want to use dgettext 444 * for all message lookups, but its defined behavior in the C locale is 445 * to return the input string. Since our input strings are event codes 446 * and not format strings, this doesn't help us. We resolve this nit 447 * by setting NLSPATH to a non-existent file: the presence of NLSPATH 448 * is defined to force dgettext(3C) to do a full lookup even for C. 449 */ 450 if (getenv("NLSPATH") == NULL && putenv(fmd_hdl_strdup(hdl, 451 "NLSPATH=/usr/lib/fm/fmd/fmd.cat", FMD_SLEEP)) != 0) 452 fmd_hdl_abort(hdl, "syslog-msgs failed to set NLSPATH"); 453 454 fmd_msg_lock(); 455 (void) setlocale(LC_MESSAGES, ""); 456 locale = setlocale(LC_MESSAGES, NULL); 457 if (locale) { 458 p = alloca(strlen(locale) + 1); 459 locale = strcpy(p, locale); 460 } else { 461 locale = "<null>"; 462 } 463 fmd_msg_unlock(); 464 fmd_hdl_debug(hdl, "locale=%s\n", locale); 465 466 /* 467 * If the "gmt" property is set to true, force our EVENT-TIME to be 468 * reported in GMT time; otherwise we use localtime. tzset() affects 469 * the results of subsequent calls to strftime(3C) above. 470 */ 471 if (fmd_prop_get_int32(hdl, "gmt") == FMD_B_TRUE && 472 ((tz = getenv("TZ")) == NULL || strcmp(tz, "GMT") != 0)) { 473 (void) putenv(fmd_hdl_strdup(hdl, "TZ=GMT", FMD_SLEEP)); 474 tzset(); /* reload env */ 475 } 476 477 /* 478 * Look up the value of the "facility" property and use it to determine 479 * what syslog LOG_* facility value we use to fill in our log_ctl_t. 480 * The details of our logging method are described above syslog_emit(). 481 */ 482 facname = fmd_prop_get_string(hdl, "facility"); 483 484 for (fp = syslog_facs; fp->fac_name != NULL; fp++) { 485 if (strcmp(fp->fac_name, facname) == 0) 486 break; 487 } 488 489 if (fp->fac_name == NULL) 490 fmd_hdl_abort(hdl, "invalid 'facility' setting: %s\n", facname); 491 492 fmd_prop_free_string(hdl, facname); 493 syslog_ctl.pri = fp->fac_value; 494 syslog_ctl.flags = SL_CONSOLE | SL_LOGONLY; 495 496 /* 497 * Cache any properties we use every time we receive an event and 498 * subscribe to list.suspect events regardless of the .conf file. 499 */ 500 syslog_file = fmd_prop_get_int32(hdl, "syslogd"); 501 syslog_cons = fmd_prop_get_int32(hdl, "console"); 502 syslog_url = fmd_prop_get_string(hdl, "url"); 503 syslog_msgall = fmd_prop_get_int32(hdl, "message_all"); 504 505 /* 506 * If fmd's rootdir property is set to a non-default root, then we are 507 * going to need to rebind the text domains we use for dgettext() as 508 * we go. Look up the default l10n messages directory and make 509 * syslog_locdir be this path with fmd.rootdir prepended to it. 510 */ 511 rootdir = fmd_prop_get_string(hdl, "fmd.rootdir"); 512 513 if (*rootdir != '\0' && strcmp(rootdir, "/") != 0) { 514 fmd_msg_lock(); 515 locdir = bindtextdomain(SYSLOG_DOMAIN, NULL); 516 fmd_msg_unlock(); 517 if (locdir != NULL) { 518 size_t len = strlen(rootdir) + strlen(locdir) + 1; 519 syslog_locdir = fmd_hdl_alloc(hdl, len, FMD_SLEEP); 520 (void) snprintf(syslog_locdir, len, "%s%s", rootdir, 521 locdir); 522 fmd_hdl_debug(hdl, 523 "binding textdomain to %s for syslog\n", 524 syslog_locdir); 525 } 526 } 527 528 fmd_prop_free_string(hdl, rootdir); 529 fmd_hdl_subscribe(hdl, FM_LIST_SUSPECT_CLASS); 530 fmd_hdl_subscribe(hdl, FM_LIST_REPAIRED_CLASS); 531 } 532 533 void 534 _fmd_fini(fmd_hdl_t *hdl) 535 { 536 fmd_hdl_strfree(hdl, syslog_locdir); 537 fmd_prop_free_string(hdl, syslog_url); 538 539 (void) close(syslog_logfd); 540 (void) close(syslog_msgfd); 541 } 542