X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/cf7d32b81c573a0536dc4da4157f9c26f8d0bed3..e8c3f78193f1895ea514044358b93b1add9322f3:/bsd/vfs/vfs_fslog.c diff --git a/bsd/vfs/vfs_fslog.c b/bsd/vfs/vfs_fslog.c index 618e4546c..87db6067f 100644 --- a/bsd/vfs/vfs_fslog.c +++ b/bsd/vfs/vfs_fslog.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2006 Apple Computer, Inc. All rights reserved. + * Copyright (c) 2006-2017 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * @@ -26,7 +26,6 @@ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ -#include #include #include #include @@ -35,426 +34,242 @@ #include #include #include -#include /* for vaddlog() */ +#include #include -#include - #include #include +#include -/* String to append as format modifier for each key-value pair */ -#define FSLOG_KEYVAL_FMT "[%s %s] " -#define FSLOG_KEYVAL_FMT_LEN (sizeof(FSLOG_KEYVAL_FMT) - 1) - -#define FSLOG_NEWLINE_CHAR "\n" -#define FSLOG_NEWLINE_CHAR_LEN (sizeof(FSLOG_NEWLINE_CHAR) - 1) +#include +#include -/* Length of entire ASL message in 10 characters. Kernel defaults to zero */ -#define FSLOG_ASL_MSG_LEN " 0" +#include -/* Length of default format string to be used by printf */ -#define MAX_FMT_LEN 256 +#include -/* Internal function to print input values as key-value pairs in format - * identifiable by Apple system log (ASL) facility. All key-value pairs - * are assumed to be pointer to strings and are provided using two ways - - * (a) va_list argument which is a list of varying number of arguments - * created by the caller of this function. - * (b) variable number of arguments passed to this function. - * - * Parameters - - * level - Priority level for this ASL message - * facility - Facility for this ASL message. - * num_pairs - Number of key-value pairs provided by vargs argument. - * vargs - List of key-value pairs. - * ... - Additional key-value pairs (apart from vargs) as variable - * argument list. A NULL value indicates the end of the - * variable argument list. - * - * Returns - - * zero - On success, when it prints all key-values pairs provided. - * E2BIG - When it cannot print all key-value pairs provided and had - * to truncate the output. +/* Log information about external modification of a process, + * using MessageTracer formatting. Assumes that both the caller + * and target are appropriately locked. + * Currently prints following information - + * 1. Caller process name (truncated to 16 characters) + * 2. Caller process Mach-O UUID + * 3. Target process name (truncated to 16 characters) + * 4. Target process Mach-O UUID */ -static int fslog_asl_msg(int level, const char *facility, int num_pairs, va_list vargs, ...) +void +fslog_extmod_msgtracer(proc_t caller, proc_t target) { - int err = 0; - char fmt[MAX_FMT_LEN]; /* Format string to use with vaddlog */ - int calc_pairs = 0; - size_t len; - int i; - va_list ap; - char *ptr; - - /* Mask extra bits, if any, from priority level */ - level = LOG_PRI(level); - - /* Create the first part of format string consisting of ASL - * message length, level, and facility. - */ - if (facility) { - snprintf(fmt, MAX_FMT_LEN, "%s [%s %d] [%s %d] [%s %s] ", - FSLOG_ASL_MSG_LEN, - FSLOG_KEY_LEVEL, level, - FSLOG_KEY_READ_UID, FSLOG_VAL_READ_UID, - FSLOG_KEY_FACILITY, facility); - } else { - snprintf(fmt, MAX_FMT_LEN, "%s [%s %d] [%s %d] ", - FSLOG_ASL_MSG_LEN, - FSLOG_KEY_LEVEL, level, - FSLOG_KEY_READ_UID, FSLOG_VAL_READ_UID); - } - - /* Determine the number of key-value format string [%s %s] that - * should be added in format string for every key-value pair provided - * in va_list. Calculate maximum number of format string that can be - * accommodated in the remaining format buffer (after saving space - * for newline character). If the caller provided pairs in va_list - * is more than calculated pairs, truncate extra pairs. - */ - len = MAX_FMT_LEN - strlen(fmt) - FSLOG_NEWLINE_CHAR_LEN - 1; - calc_pairs = len / FSLOG_KEYVAL_FMT_LEN; - if (num_pairs <= calc_pairs) { - calc_pairs = num_pairs; - } else { - err = E2BIG; - } - - /* Append format strings [%s %s] for the key-value pairs in vargs */ - len = MAX_FMT_LEN - FSLOG_NEWLINE_CHAR_LEN; - for (i = 0; i < calc_pairs; i++) { - (void) strlcat(fmt, FSLOG_KEYVAL_FMT, len); - } + if ((caller != PROC_NULL) && (target != PROC_NULL)) { - /* Count number of variable arguments provided to this function - * and determine total number of key-value pairs. - */ - calc_pairs = 0; - va_start(ap, vargs); - ptr = va_arg(ap, char *); - while (ptr) { - calc_pairs++; - ptr = va_arg(ap, char *); - } - calc_pairs /= 2; - va_end(ap); + /* + * Print into buffer large enough for "ThisIsAnApplicat(BC223DD7-B314-42E0-B6B0-C5D2E6638337)", + * including space for escaping, and NUL byte included in sizeof(uuid_string_t). + */ - /* If user provided variable number of arguments, append them as - * as real key-value "[k v]" into the format string. If the format - * string is too small, ignore the key-value pair completely. - */ - if (calc_pairs) { - char *key, *val; - size_t pairlen; - int offset; + uuid_string_t uuidstr; + char c_name[2*MAXCOMLEN + 2 /* () */ + sizeof(uuid_string_t)]; + char t_name[2*MAXCOMLEN + 2 /* () */ + sizeof(uuid_string_t)]; + + strlcpy(c_name, caller->p_comm, sizeof(c_name)); + uuid_unparse_upper(caller->p_uuid, uuidstr); + strlcat(c_name, "(", sizeof(c_name)); + strlcat(c_name, uuidstr, sizeof(c_name)); + strlcat(c_name, ")", sizeof(c_name)); + if (0 != escape_str(c_name, strlen(c_name) + 1, sizeof(c_name))) { + return; + } - /* Calculate bytes available for key-value pairs after reserving - * bytes for newline character and NULL terminator - */ - len = MAX_FMT_LEN - strlen(fmt) - FSLOG_NEWLINE_CHAR_LEN - 1; - offset = strlen(fmt); - - va_start(ap, vargs); - for (i = 0; i < calc_pairs; i++) { - key = va_arg(ap, char *); - val = va_arg(ap, char *); - - /* Calculate bytes required to store next key-value pair as - * "[key val] " including space for '[', ']', and two spaces. - */ - pairlen = strlen(key) + strlen(val) + 4; - if (pairlen > len) { - err = E2BIG; - break; - } - - /* len + 1 because one byte has been set aside for NULL - * terminator in calculation of 'len' above - */ - snprintf((fmt + offset), len + 1, FSLOG_KEYVAL_FMT, key, val); - offset += pairlen; - len -= pairlen; + strlcpy(t_name, target->p_comm, sizeof(t_name)); + uuid_unparse_upper(target->p_uuid, uuidstr); + strlcat(t_name, "(", sizeof(t_name)); + strlcat(t_name, uuidstr, sizeof(t_name)); + strlcat(t_name, ")", sizeof(t_name)); + if (0 != escape_str(t_name, strlen(t_name) + 1, sizeof(t_name))) { + return; } - va_end(ap); +#if DEBUG + printf("EXTMOD: %s(%d) -> %s(%d)\n", + c_name, + proc_pid(caller), + t_name, + proc_pid(target)); +#endif + + kern_asl_msg(LOG_DEBUG, "messagetracer", + 5, + "com.apple.message.domain", "com.apple.kernel.external_modification", /* 0 */ + "com.apple.message.signature", c_name, /* 1 */ + "com.apple.message.signature2", t_name, /* 2 */ + "com.apple.message.result", "noop", /* 3 */ + "com.apple.message.summarize", "YES", /* 4 */ + NULL); } +} + +#if defined(__x86_64__) - /* Append newline */ - (void) strlcat(fmt, FSLOG_NEWLINE_CHAR, MAX_FMT_LEN); +/* + * Log information about floating point exception handling + */ - /* Print the key-value pairs in ASL format */ - vaddlog(fmt, vargs); +static lck_mtx_t fpxlock; - return err; +void +fpxlog_init(void) +{ + lck_grp_attr_t *lck_grp_attr = lck_grp_attr_alloc_init(); + lck_grp_t *lck_grp = lck_grp_alloc_init("fpx", lck_grp_attr); + lck_mtx_init(&fpxlock, lck_grp, LCK_ATTR_NULL); } -/* Log file system related error in key-value format identified by Apple - * system log (ASL) facility. The key-value pairs are string pointers - * (char *) and are provided as variable arguments list. A NULL value - * indicates end of the list. - * - * Keys can not contain '[', ']', space, and newline. Values can not - * contain '[', ']', and newline. If any key-value contains any of the - * reserved characters, the behavior is undefined. The caller of the - * function should escape any occurrences of '[' and ']' by prefixing - * it with '\'. - * - * The function takes a message ID which can be used to logically group - * different ASL messages. Messages in same logical group have same message - * ID and have information to describe order of the message --- first, - * middle, or last. - * - * The following message IDs have special meaning - - * FSLOG_MSG_FIRST - This message is the first message in its logical - * group. This generates a unique message ID, creates two key-value - * pairs with message ID and order of the message as "First". - * FSLOG_MSG_LAST - This is really a MASK which should be logically OR'ed - * with message ID to indicate the last message for a logical group. - * This also creates two key-value pairs with message ID and order of - * message as "Last". - * FSLOG_MSG_SINGLE - This signifies that the message is the only message - * in its logical group. Therefore no extra key-values are generated - * for this option. - * For all other values of message IDs, it regards them as intermediate - * message and generates two key-value pairs with message ID and order of - * message as "Middle". - * - * Returns - - * Message ID of the ASL message printed. The caller should use - * this value to print intermediate messages or end the logical message - * group. - * For FSLOG_MSG_SINGLE option, it returns FSLOG_MSG_SINGLE. - */ -unsigned long fslog_err(unsigned long msg_id, ... ) +struct fpx_event { + uuid_t fe_uuid; + uint32_t fe_code; + uint32_t fe_xcpt; + TAILQ_ENTRY(fpx_event) fe_link; +}; + +static bool +match_fpx_event(const struct fpx_event *fe, + const uuid_t uuid, const uint32_t code, const uint32_t xcpt) { - va_list ap; - int num_pairs; - char msg_id_str[21]; /* To convert 64-bit number to string with NULL char */ - char *arg; - const char *msg_order_ptr; - - /* Count number of arguments and key-value pairs provided by user */ - num_pairs = 0; - va_start(ap, msg_id); - arg = va_arg(ap, char *); - while (arg) { - num_pairs++; - arg = va_arg(ap, char *); - } - num_pairs /= 2; - va_end(ap); - - va_start(ap, msg_id); - if (msg_id == FSLOG_MSG_SINGLE) { - /* Single message, do not print message ID and message order */ - (void) fslog_asl_msg(FSLOG_VAL_LEVEL, FSLOG_VAL_FACILITY, - num_pairs, ap, NULL); - } else { - if (msg_id == FSLOG_MSG_FIRST) { - /* First message, generate random message ID */ - while ((msg_id == FSLOG_MSG_FIRST) || - (msg_id == FSLOG_MSG_LAST) || - (msg_id == FSLOG_MSG_SINGLE)) { - msg_id = RandomULong(); - /* MSB is reserved for indicating last message - * in sequence. Clear the MSB while generating - * new message ID. - */ - msg_id = msg_id >> 1; - } - msg_order_ptr = FSLOG_VAL_ORDER_FIRST; - } else if (msg_id & FSLOG_MSG_LAST) { - /* MSB set to indicate last message for this ID */ - msg_order_ptr = FSLOG_VAL_ORDER_LAST; - /* MSB of message ID is set to indicate last message - * in sequence. Clear the bit to get real message ID. - */ - msg_id = msg_id & ~FSLOG_MSG_LAST; - } else { - /* Intermediate message for this ID */ - msg_order_ptr = FSLOG_VAL_ORDER_MIDDLE; - } + return (code == fe->fe_code && xcpt == fe->fe_xcpt && + 0 == memcmp(uuid, fe->fe_uuid, sizeof (uuid_t))); +} - snprintf(msg_id_str, sizeof(msg_id_str), "%lu", msg_id); - (void) fslog_asl_msg(FSLOG_VAL_LEVEL, FSLOG_VAL_FACILITY, - num_pairs, ap, - FSLOG_KEY_MSG_ID, msg_id_str, - FSLOG_KEY_MSG_ORDER, msg_order_ptr, NULL); - } - va_end(ap); - return msg_id; +#if FPX_EVENT_DBG +static __attribute__((noinline)) void +print_fpx_event(const char *pfx, const struct fpx_event *fe) +{ + uuid_string_t uustr; + uuid_unparse_upper(fe->fe_uuid, uustr); + printf("%s: code 0x%x xcpt 0x%x uuid '%s'\n", + pfx, fe->fe_code, fe->fe_xcpt, uustr); } +#define DPRINTF_FPX_EVENT(pfx, fe) print_fpx_event(pfx, fe) +#else +#define DPRINTF_FPX_EVENT(pfx, fe) /* nothing */ +#endif -/* Search if given string contains '[' and ']'. If any, escape it by - * prefixing with a '\'. If the length of the string is not big enough, - * no changes are done and error is returned. +#define MAX_DISTINCT_FPX_EVENTS 101 /* (approx one page of heap) */ + +/* + * Filter to detect "new" tuples. + * Uses limited amount of state, managed LRU. + * Optimized to ignore repeated invocation with the same tuple. * - * Parameters - - * str - string that can contain '[' or ']', should be NULL terminated - * len - length, in bytes, of valid data, including NULL character. - * buflen - size of buffer that contains the string + * Note that there are 6 exception types, two types of FP, and + * many binaries, so don't make the list bound too small. + * It's also a linear search, so don't make it too large either. + * Next level filtering provided by syslogd, and summarization. */ -static int escape_str(char *str, int len, int buflen) +static bool +novel_fpx_event(const uuid_t uuid, uint32_t code, uint32_t xcpt) { - int count; - char *src, *dst; - - /* Count number of characters to escape */ - src = str; - count = 0; - do { - if ((*src == '[') || (*src == ']')) { - count++; - } - } while (*src++); + static TAILQ_HEAD(fpx_event_head, fpx_event) fehead = + TAILQ_HEAD_INITIALIZER(fehead); + struct fpx_event *fe; + + lck_mtx_lock(&fpxlock); + + fe = TAILQ_FIRST(&fehead); + if (NULL != fe && + match_fpx_event(fe, uuid, code, xcpt)) { + /* seen before and element already at head */ + lck_mtx_unlock(&fpxlock); + DPRINTF_FPX_EVENT("seen, head", fe); + return (false); + } - if (count) { - /* Check if the buffer has enough space to escape all characters */ - if ((buflen - len) < count) { - return ENOSPC; - } + unsigned int count = 0; - src = str + len; - dst = src + count; - while (count) { - *dst-- = *src; - if ((*src == '[') || (*src == ']')) { - /* Last char copied needs to be escaped */ - *dst-- = '\\'; - count--; - } - src--; + TAILQ_FOREACH(fe, &fehead, fe_link) { + if (match_fpx_event(fe, uuid, code, xcpt)) { + /* seen before, now move element to head */ + TAILQ_REMOVE(&fehead, fe, fe_link); + TAILQ_INSERT_HEAD(&fehead, fe, fe_link); + lck_mtx_unlock(&fpxlock); + DPRINTF_FPX_EVENT("seen, moved to head", fe); + return (false); } + count++; } - return 0; -} + /* not recorded here => novel */ -/* Log information about runtime file system corruption detected by - * the file system. It takes the VFS mount structure as - * parameter which is used to access the mount point of the - * corrupt volume. If no mount structure or mount point string - * string exists, nothing is logged to ASL database. - * - * Currently prints following information - - * 1. Mount Point - */ -void fslog_fs_corrupt(struct mount *mnt) -{ - if (mnt != NULL) { - if (mnt->mnt_vfsstat.f_mntonname != NULL) { - fslog_err(FSLOG_MSG_SINGLE, - FSLOG_KEY_ERR_TYPE, FSLOG_VAL_ERR_TYPE_FS, - FSLOG_KEY_MNTPT, mnt->mnt_vfsstat.f_mntonname, - NULL); - } + if (count >= MAX_DISTINCT_FPX_EVENTS) { + /* reuse LRU element */ + fe = TAILQ_LAST(&fehead, fpx_event_head); + TAILQ_REMOVE(&fehead, fe, fe_link); + DPRINTF_FPX_EVENT("reusing", fe); + } else { + /* add a new element to the list */ + fe = kalloc(sizeof (*fe)); } - - return; -} + memcpy(fe->fe_uuid, uuid, sizeof (uuid_t)); + fe->fe_code = code; + fe->fe_xcpt = xcpt; + TAILQ_INSERT_HEAD(&fehead, fe, fe_link); + lck_mtx_unlock(&fpxlock); -/* Log information about IO error detected in buf_biodone() - * Currently prints following information - - * 1. Physical block number - * 2. Logical block number - * 3. Device node - * 4. Mount point - * 5. Path for file, if any - * 6. Error number - * 7. Type of IO (read/write) - */ -void fslog_io_error(const buf_t bp) + DPRINTF_FPX_EVENT("novel", fe); + + return (true); +} + +void +fpxlog( + int code, /* Mach exception code: e.g. 5 or 8 */ + uint32_t stat, /* Full FP status register bits */ + uint32_t ctrl, /* Full FP control register bits */ + uint32_t xcpt) /* Exception bits from FP status */ { - int err; - unsigned long msg_id; - char blknum_str[21]; - char lblknum_str[21]; - char errno_str[6]; - const char *iotype; - unsigned char print_last = 0; - vnode_t vp; - - if (buf_error(bp) == 0) { + proc_t p = current_proc(); + if (PROC_NULL == p) return; - } - /* Convert error number to string */ - snprintf (errno_str, sizeof(errno_str), "%d", buf_error(bp)); + uuid_t uuid; + proc_getexecutableuuid(p, uuid, sizeof (uuid)); - /* Determine type of IO operation */ - if (buf_flags(bp) & B_READ) { - iotype = FSLOG_VAL_IOTYPE_READ; - } else { - iotype = FSLOG_VAL_IOTYPE_WRITE; - } + /* + * Check to see if an exception with this + * has been seen before. If "novel" then log a message. + */ + if (!novel_fpx_event(uuid, code, xcpt)) + return; - /* Convert physical block number to string */ - snprintf (blknum_str, sizeof(blknum_str), "%lld", buf_blkno(bp)); - - /* Convert logical block number to string */ - snprintf (lblknum_str, sizeof(lblknum_str), "%lld", buf_lblkno(bp)); - - msg_id = fslog_err(FSLOG_MSG_FIRST, - FSLOG_KEY_ERR_TYPE, FSLOG_VAL_ERR_TYPE_IO, - FSLOG_KEY_ERRNO, errno_str, - FSLOG_KEY_IOTYPE, iotype, - FSLOG_KEY_PHYS_BLKNUM, blknum_str, - FSLOG_KEY_LOG_BLKNUM, lblknum_str, - NULL); - - /* Access the vnode for this buffer */ - vp = buf_vnode(bp); - if (vp) { - struct vfsstatfs *sp; - mount_t mp; - char *path; - int len; - struct vfs_context context; - - mp = vnode_mount(vp); - /* mp should be NULL only for bdevvp during boot */ - if (mp == NULL) { - goto out; - } - sp = vfs_statfs(mp); - - /* Access the file path */ - MALLOC(path, char *, MAXPATHLEN, M_TEMP, M_WAITOK); - if (path) { - len = MAXPATHLEN; - context.vc_thread = current_thread(); - context.vc_ucred = kauth_cred_get(); - /* Find path without entering file system */ - err = build_path(vp, path, len, &len, BUILDPATH_NO_FS_ENTER, - &context); - if (!err) { - err = escape_str(path, len, MAXPATHLEN); - if (!err) { - /* Print device node, mount point, path */ - msg_id = fslog_err(msg_id | FSLOG_MSG_LAST, - FSLOG_KEY_DEVNODE, sp->f_mntfromname, - FSLOG_KEY_MNTPT, sp->f_mntonname, - FSLOG_KEY_PATH, path, - NULL); - print_last = 1; - } - } - FREE(path, M_TEMP); - } - - if (print_last == 0) { - /* Print device node and mount point */ - msg_id = fslog_err(msg_id | FSLOG_MSG_LAST, - FSLOG_KEY_DEVNODE, sp->f_mntfromname, - FSLOG_KEY_MNTPT, sp->f_mntonname, - NULL); - print_last = 1; - } - } + const size_t nmlen = 2 * MAXCOMLEN + 1; + char nm[nmlen] = {}; + proc_selfname(nm, nmlen); + if (escape_str(nm, strlen(nm) + 1, nmlen)) + snprintf(nm, nmlen, "(a.out)"); + + const size_t slen = 8 + 1 + 8 + 1; + char xcptstr[slen], csrstr[slen]; + + snprintf(xcptstr, slen, "%x.%x", code, xcpt); + if (ctrl == stat) + snprintf(csrstr, slen, "%x", ctrl); + else + snprintf(csrstr, slen, "%x.%x", ctrl, stat); + +#if DEVELOPMENT || DEBUG + printf("%s[%d]: com.apple.kernel.fpx: %s, %s\n", + nm, proc_pid(p), xcptstr, csrstr); +#endif + kern_asl_msg(LOG_DEBUG, "messagetracer", 5, + /* 0 */ "com.apple.message.domain", "com.apple.kernel.fpx", + /* 1 */ "com.apple.message.signature", nm, + /* 2 */ "com.apple.message.signature2", xcptstr, + /* 3 */ "com.apple.message.value", csrstr, + /* 4 */ "com.apple.message.summarize", "YES", + NULL); +} -out: - if (print_last == 0) { - msg_id = fslog_err(msg_id | FSLOG_MSG_LAST, NULL); - } +#else - return; -} +void +fpxlog_init(void) +{} + +#endif /* __x86_64__ */