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