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 /*
23 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
24 */
25
26 /*
27 * Copyright 2015 Nexenta Systems, Inc. All rights reserved.
28 */
29
30 #include <sys/fm/protocol.h>
31 #include <sys/strlog.h>
32 #include <sys/log.h>
33 #include <libscf.h>
34
35 #include <fm/fmd_api.h>
36 #include <fm/fmd_msg.h>
37
38 #include <stropts.h>
39 #include <strings.h>
40 #include <syslog.h>
41 #include <alloca.h>
42 #include <unistd.h>
43 #include <stdlib.h>
44 #include <errno.h>
45 #include <fcntl.h>
46
47 static struct stats {
48 fmd_stat_t bad_vers;
49 fmd_stat_t bad_code;
50 fmd_stat_t log_err;
51 fmd_stat_t msg_err;
52 fmd_stat_t no_msg;
53 } syslog_stats = {
54 { "bad_vers", FMD_TYPE_UINT64, "event version is missing or invalid" },
55 { "bad_code", FMD_TYPE_UINT64, "event code has no dictionary name" },
56 { "log_err", FMD_TYPE_UINT64, "failed to log message to log(7D)" },
57 { "msg_err", FMD_TYPE_UINT64, "failed to log message to sysmsg(7D)" },
58 { "no_msg", FMD_TYPE_UINT64, "message logging suppressed" }
59 };
60
61 static const struct facility {
62 const char *fac_name;
63 int fac_value;
64 } syslog_facs[] = {
65 { "LOG_DAEMON", LOG_DAEMON },
66 { "LOG_LOCAL0", LOG_LOCAL0 },
67 { "LOG_LOCAL1", LOG_LOCAL1 },
68 { "LOG_LOCAL2", LOG_LOCAL2 },
69 { "LOG_LOCAL3", LOG_LOCAL3 },
70 { "LOG_LOCAL4", LOG_LOCAL4 },
71 { "LOG_LOCAL5", LOG_LOCAL5 },
72 { "LOG_LOCAL6", LOG_LOCAL6 },
73 { "LOG_LOCAL7", LOG_LOCAL7 },
74 { NULL, 0 }
75 };
76
77 static fmd_msg_hdl_t *syslog_msghdl; /* handle for libfmd_msg calls */
78 static int syslog_msgall; /* set to message all faults */
79 static log_ctl_t syslog_ctl; /* log(7D) meta-data for each msg */
80 static int syslog_logfd = -1; /* log(7D) file descriptor */
81 static int syslog_msgfd = -1; /* sysmsg(7D) file descriptor */
82 static int syslog_file; /* log to syslog_logfd */
83 static int syslog_cons; /* log to syslog_msgfd */
84 static const char SYSLOG_POINTER[] = "syslog-msgs-pointer";
85
86 /*
87 * Ideally we would just use syslog(3C) for outputting our messages, but our
88 * messaging standard defines a nice multi-line format and syslogd(1M) is very
89 * inflexible and stupid when it comes to multi-line messages. It pulls data
90 * out of log(7D) and splits it up by \n, printing each line to the console
91 * with its usual prefix of date and sender; it uses the same behavior for the
92 * messages file as well. Further, syslog(3C) provides no CE_CONT equivalent
93 * for userland callers (which at least works around repeated file prefixing).
94 * So with a multi-line message format, your file and console end up like this:
95 *
96 * Dec 02 18:08:40 hostname this is my nicely formatted
97 * Dec 02 18:08:40 hostname message designed for 80 cols
98 * ...
99 *
100 * To resolve these issues, we use our own syslog_emit() wrapper to emit
101 * messages and some knowledge of how the Solaris log drivers work. We first
102 * construct an enlarged format string containing the appropriate msgid(1).
103 * We then format the caller's message using the provided format and buffer.
104 * We send this message to log(7D) using putmsg() with SL_CONSOLE | SL_LOGONLY
105 * set in the log_ctl_t. The log driver allows us to set SL_LOGONLY when we
106 * construct messages ourself, indicating that syslogd should only emit the
107 * message to /var/adm/messages and any remote hosts, and skip the console.
108 * Then we emit the message a second time, without the special prefix, to the
109 * sysmsg(7D) device, which handles console redirection and also permits us
110 * to output any characters we like to the console, including \n and \r.
111 */
112 static void
113 syslog_emit(fmd_hdl_t *hdl, const char *msg)
114 {
115 struct strbuf ctl, dat;
116 uint32_t msgid;
117
118 char *buf;
119 size_t buflen;
120
121 const char *format = "fmd: [ID %u FACILITY_AND_PRIORITY] %s";
122 STRLOG_MAKE_MSGID(format, msgid);
123
124 buflen = snprintf(NULL, 0, format, msgid, msg);
125 buf = alloca(buflen + 1);
126 (void) snprintf(buf, buflen + 1, format, msgid, msg);
127
128 ctl.buf = (void *)&syslog_ctl;
129 ctl.len = sizeof (syslog_ctl);
130
131 dat.buf = buf;
132 dat.len = buflen + 1;
133
134 /*
135 * The underlying log driver won't accept messages longer than
136 * LOG_MAXPS bytes. Therefore, messages which exceed this limit will
137 * be truncated and appended with a pointer to the full message.
138 */
139 if (dat.len > LOG_MAXPS) {
140 char *syslog_pointer, *p;
141 size_t plen;
142
143 if ((syslog_pointer = fmd_msg_gettext_id(syslog_msghdl, NULL,
144 SYSLOG_POINTER)) == NULL) {
145 /*
146 * This shouldn't happen, but if it does we'll just
147 * truncate the message.
148 */
149 buf[LOG_MAXPS - 1] = '\0';
150 dat.len = LOG_MAXPS;
151 } else {
152 plen = strlen(syslog_pointer) + 1;
153 buf[LOG_MAXPS - plen] = '\0';
154 /*
155 * If possible, the pointer is appended after a newline
156 */
157 if ((p = strrchr(buf, '\n')) == NULL)
158 p = &buf[LOG_MAXPS - plen];
159
160 (void) strcpy(p, syslog_pointer);
161 free(syslog_pointer);
162 dat.len = strlen(buf) + 1;
163 }
164 }
165 if (syslog_file && putmsg(syslog_logfd, &ctl, &dat, 0) != 0) {
166 fmd_hdl_debug(hdl, "putmsg failed: %s\n", strerror(errno));
167 syslog_stats.log_err.fmds_value.ui64++;
168 }
169
170 dat.buf = strchr(buf, ']');
171 dat.len -= (size_t)(dat.buf - buf);
172
173 dat.buf[0] = '\r'; /* overwrite ']' with carriage return */
174 dat.buf[1] = '\n'; /* overwrite ' ' with newline */
175
176 if (syslog_cons && write(syslog_msgfd, dat.buf, dat.len) != dat.len) {
177 fmd_hdl_debug(hdl, "write failed: %s\n", strerror(errno));
178 syslog_stats.msg_err.fmds_value.ui64++;
179 }
180 }
181
182 static void
183 free_notify_prefs(fmd_hdl_t *hdl, nvlist_t **prefs, uint_t nprefs)
184 {
185 int i;
186
187 for (i = 0; i < nprefs; i++) {
188 nvlist_free(prefs[i]);
189 }
190
191 fmd_hdl_free(hdl, prefs, sizeof (nvlist_t *) * nprefs);
192 }
193
194 static int
195 get_notify_prefs(fmd_hdl_t *hdl, nvlist_t *ev_nvl, nvlist_t ***pref_nvl,
196 uint_t *nprefs)
197 {
198 nvlist_t *top_nvl, **np_nvlarr, *mech_nvl;
199 nvlist_t **tmparr;
200 int ret, i;
201 uint_t nelem, nslelem;
202
203 if ((ret = smf_notify_get_params(&top_nvl, ev_nvl)) != SCF_SUCCESS) {
204 ret = scf_error();
205 if (ret != SCF_ERROR_NOT_FOUND) {
206 fmd_hdl_debug(hdl, "Error looking up notification "
207 "preferences (%s)", scf_strerror(ret));
208 return (ret);
209 }
210 return (ret);
211 }
212
213 if (nvlist_lookup_nvlist_array(top_nvl, SCF_NOTIFY_PARAMS, &np_nvlarr,
214 &nelem) != 0) {
215 fmd_hdl_debug(hdl, "Malformed preference nvlist\n");
216 ret = SCF_ERROR_INVALID_ARGUMENT;
217 goto pref_done;
218 }
219
220 tmparr = fmd_hdl_alloc(hdl, nelem * sizeof (nvlist_t *), FMD_SLEEP);
221 nslelem = 0;
222
223 for (i = 0; i < nelem; i++) {
224 if (nvlist_lookup_nvlist(np_nvlarr[i], "syslog", &mech_nvl)
225 == 0)
226 tmparr[nslelem++] = fmd_nvl_dup(hdl, mech_nvl,
227 FMD_SLEEP);
228 }
229
230 if (nslelem != 0) {
231 size_t sz = nslelem * sizeof (nvlist_t *);
232
233 *pref_nvl = fmd_hdl_zalloc(hdl, sz, FMD_SLEEP);
234 *nprefs = nslelem;
235 bcopy(tmparr, *pref_nvl, sz);
236 ret = 0;
237 } else {
238 *pref_nvl = NULL;
239 *nprefs = 0;
240 ret = SCF_ERROR_NOT_FOUND;
241 }
242
243 fmd_hdl_free(hdl, tmparr, nelem * sizeof (nvlist_t *));
244 pref_done:
245 nvlist_free(top_nvl);
246 return (ret);
247 }
248
249 /*ARGSUSED*/
250 static void
251 syslog_recv(fmd_hdl_t *hdl, fmd_event_t *ep, nvlist_t *nvl, const char *class)
252 {
253 uint8_t version;
254 boolean_t domsg, *active;
255 char *msg;
256 nvlist_t **prefs;
257 uint_t nprefs, nelems;
258 int ret;
259
260 if (nvlist_lookup_uint8(nvl, FM_VERSION, &version) != 0 ||
261 version > FM_SUSPECT_VERSION) {
262 fmd_hdl_debug(hdl, "invalid event version: %u\n", version);
263 syslog_stats.bad_vers.fmds_value.ui64++;
264 return; /* invalid event version */
265 }
266
267 if (!syslog_msgall && nvlist_lookup_boolean_value(nvl,
268 FM_SUSPECT_MESSAGE, &domsg) == 0 && !domsg) {
269 fmd_hdl_debug(hdl, "%s requested no message\n", class);
270 syslog_stats.no_msg.fmds_value.ui64++;
271 return; /* event is not to be messaged */
272 }
273
274 ret = get_notify_prefs(hdl, nvl, &prefs, &nprefs);
275 if (ret == SCF_ERROR_NOT_FOUND) {
276 /*
277 * No syslog notification preferences specified for this type of
278 * event, so we're done
279 */
280 fmd_hdl_debug(hdl, "No syslog notification preferences "
281 "configured for class %s\n", class);
282 syslog_stats.no_msg.fmds_value.ui64++;
283 return;
284 } else if (ret != 0 || nvlist_lookup_boolean_array(prefs[0], "active",
285 &active, &nelems)) {
286 fmd_hdl_debug(hdl, "Failed to retrieve notification "
287 "preferences for class %s\n", class);
288 if (ret == 0)
289 free_notify_prefs(hdl, prefs, nprefs);
290 return;
291 } else if (!active[0]) {
292 fmd_hdl_debug(hdl, "Syslog notifications disabled for "
293 "class %s\n", class);
294 syslog_stats.no_msg.fmds_value.ui64++;
295 free_notify_prefs(hdl, prefs, nprefs);
296 return;
297 }
298 free_notify_prefs(hdl, prefs, nprefs);
299
300 if ((msg = fmd_msg_gettext_nv(syslog_msghdl, NULL, nvl)) == NULL) {
301 fmd_hdl_debug(hdl, "failed to format message");
302 syslog_stats.bad_code.fmds_value.ui64++;
303 return; /* libfmd_msg error */
304 }
305
306 syslog_ctl.pri &= LOG_FACMASK;
307 if (strcmp(class, FM_LIST_ISOLATED_CLASS) == 0 ||
308 strcmp(class, FM_LIST_RESOLVED_CLASS) == 0 ||
309 strcmp(class, FM_LIST_REPAIRED_CLASS) == 0 ||
310 strcmp(class, FM_LIST_UPDATED_CLASS) == 0)
311 syslog_ctl.pri |= LOG_NOTICE;
312 else
313 syslog_ctl.pri |= LOG_ERR;
314
315 syslog_emit(hdl, msg);
316 free(msg);
317 }
318
319 static const fmd_prop_t fmd_props[] = {
320 #ifdef DEBUG
321 { "console", FMD_TYPE_BOOL, "true" },
322 #else
323 { "console", FMD_TYPE_BOOL, "false" },
324 #endif
325 { "facility", FMD_TYPE_STRING, "LOG_DAEMON" },
326 { "gmt", FMD_TYPE_BOOL, "false" },
327 { "syslogd", FMD_TYPE_BOOL, "true" },
328 { "url", FMD_TYPE_STRING, "http://illumos.org/msg/" },
329 { "message_all", FMD_TYPE_BOOL, "false" },
330 { NULL, 0, NULL }
331 };
332
333 static const fmd_hdl_ops_t fmd_ops = {
334 syslog_recv, /* fmdo_recv */
335 NULL, /* fmdo_timeout */
336 NULL, /* fmdo_close */
337 NULL, /* fmdo_stats */
338 NULL, /* fmdo_gc */
339 };
340
341 static const fmd_hdl_info_t fmd_info = {
342 "Syslog Messaging Agent", "1.1", &fmd_ops, fmd_props
343 };
344
345 void
346 _fmd_init(fmd_hdl_t *hdl)
347 {
348 const struct facility *fp;
349 char *facname, *tz, *rootdir, *urlbase;
350
351 if (fmd_hdl_register(hdl, FMD_API_VERSION, &fmd_info) != 0)
352 return; /* invalid data in configuration file */
353
354 (void) fmd_stat_create(hdl, FMD_STAT_NOALLOC, sizeof (syslog_stats) /
355 sizeof (fmd_stat_t), (fmd_stat_t *)&syslog_stats);
356
357 if ((syslog_logfd = open("/dev/conslog", O_WRONLY | O_NOCTTY)) == -1)
358 fmd_hdl_abort(hdl, "syslog-msgs failed to open /dev/conslog");
359
360 if ((syslog_msgfd = open("/dev/sysmsg", O_WRONLY | O_NOCTTY)) == -1)
361 fmd_hdl_abort(hdl, "syslog-msgs failed to open /dev/sysmsg");
362
363 /*
364 * If the "gmt" property is set to true, force our EVENT-TIME to be
365 * reported in GMT time; otherwise we use localtime. tzset() affects
366 * the results of subsequent calls to strftime(3C) above.
367 */
368 if (fmd_prop_get_int32(hdl, "gmt") == FMD_B_TRUE &&
369 ((tz = getenv("TZ")) == NULL || strcmp(tz, "GMT") != 0)) {
370 (void) putenv(fmd_hdl_strdup(hdl, "TZ=GMT", FMD_SLEEP));
371 tzset(); /* reload env */
372 }
373
374 /*
375 * Look up the value of the "facility" property and use it to determine
376 * what syslog LOG_* facility value we use to fill in our log_ctl_t.
377 * The details of our logging method are described above syslog_emit().
378 */
379 facname = fmd_prop_get_string(hdl, "facility");
380
381 for (fp = syslog_facs; fp->fac_name != NULL; fp++) {
382 if (strcmp(fp->fac_name, facname) == 0)
383 break;
384 }
385
386 if (fp->fac_name == NULL)
387 fmd_hdl_abort(hdl, "invalid 'facility' setting: %s\n", facname);
388
389 fmd_prop_free_string(hdl, facname);
390 syslog_ctl.pri = fp->fac_value;
391 syslog_ctl.flags = SL_CONSOLE | SL_LOGONLY;
392
393 /*
394 * Cache any properties we use every time we receive an event and
395 * subscribe to list.suspect events regardless of the .conf file.
396 */
397 syslog_file = fmd_prop_get_int32(hdl, "syslogd");
398 syslog_cons = fmd_prop_get_int32(hdl, "console");
399 syslog_msgall = fmd_prop_get_int32(hdl, "message_all");
400
401 rootdir = fmd_prop_get_string(hdl, "fmd.rootdir");
402 syslog_msghdl = fmd_msg_init(rootdir, FMD_MSG_VERSION);
403 fmd_prop_free_string(hdl, rootdir);
404
405 if (syslog_msghdl == NULL)
406 fmd_hdl_abort(hdl, "failed to initialize libfmd_msg");
407
408 urlbase = fmd_prop_get_string(hdl, "url");
409 (void) fmd_msg_url_set(syslog_msghdl, urlbase);
410 fmd_prop_free_string(hdl, urlbase);
411
412 /*
413 * We subscribe to all FM events and then consult the notification
414 * preferences in the serice configuration repo to determine whether
415 * or not to emit a console message.
416 */
417 fmd_hdl_subscribe(hdl, FM_LIST_SUSPECT_CLASS);
418 fmd_hdl_subscribe(hdl, FM_LIST_REPAIRED_CLASS);
419 fmd_hdl_subscribe(hdl, FM_LIST_RESOLVED_CLASS);
420 fmd_hdl_subscribe(hdl, FM_LIST_ISOLATED_CLASS);
421 fmd_hdl_subscribe(hdl, FM_LIST_UPDATED_CLASS);
422 }
423
424 /*ARGSUSED*/
425 void
426 _fmd_fini(fmd_hdl_t *hdl)
427 {
428 fmd_msg_fini(syslog_msghdl);
429 (void) close(syslog_logfd);
430 (void) close(syslog_msgfd);
431 }