mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-11-17 10:01:01 +03:00
0e6c493fec
In order for cppcheck to perform a proper analysis it needs to be aware of how the sources are compiled (source files, include paths/files, extra defines, etc). All the needed information is available from the Makefiles and can be leveraged with a generic cppcheck Makefile target. So let's add one. Additional minor changes: * Removing the cppcheck-suppressions.txt file. With cppcheck 2.3 and these changes it appears to no longer be needed. Some inline suppressions were also removed since they appear not to be needed. We can add them back if it turns out they're needed for older versions of cppcheck. * Added the ax_count_cpus m4 macro to detect at configure time how many processors are available in order to run multiple cppcheck jobs. This value is also now used as a replacement for nproc when executing the kernel interface checks. * "PHONY =" line moved in to the Rules.am file which is included at the top of all Makefile.am's. This is just convenient becase it allows us to use the += syntax to add phony targets. * One upside of this integration worth mentioning is it now allows `make cppcheck` to be run in any directory to check that subtree. * For the moment, cppcheck is not run against the FreeBSD specific kernel sources. The cppcheck-FreeBSD target will need to be implemented and testing on FreeBSD to support this. Reviewed-by: Ryan Moeller <ryan@ixsystems.com> Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Closes #11508 |
||
---|---|---|
.. | ||
setjmp | ||
lapi.c | ||
lapi.h | ||
lauxlib.c | ||
lbaselib.c | ||
lcode.c | ||
lcode.h | ||
lcompat.c | ||
lcorolib.c | ||
lctype.c | ||
lctype.h | ||
ldebug.c | ||
ldebug.h | ||
ldo.c | ||
ldo.h | ||
lfunc.c | ||
lfunc.h | ||
lgc.c | ||
lgc.h | ||
llex.c | ||
llex.h | ||
llimits.h | ||
lmem.c | ||
lmem.h | ||
lobject.c | ||
lobject.h | ||
lopcodes.c | ||
lopcodes.h | ||
lparser.c | ||
lparser.h | ||
lstate.c | ||
lstate.h | ||
lstring.c | ||
lstring.h | ||
lstrlib.c | ||
ltable.c | ||
ltable.h | ||
ltablib.c | ||
ltm.c | ||
ltm.h | ||
lvm.c | ||
lvm.h | ||
lzio.c | ||
lzio.h | ||
Makefile.in | ||
README.zfs |
# # CDDL HEADER START # # This file and its contents are supplied under the terms of the # Common Development and Distribution License ("CDDL"), version 1.0. # You may only use this file in accordance with the terms of version # 1.0 of the CDDL. # # A full copy of the text of the CDDL should have accompanied this # source. A copy of the CDDL is also available via the Internet at # http://www.illumos.org/license/CDDL. # # CDDL HEADER END # # # Copyright (c) 2017 by Delphix. All rights reserved. # Introduction ------------ This README describes the Lua interpreter source code that lives in the ZFS source tree to enable execution of ZFS channel programs, including its maintenance policy, the modifications that have been made to it, and how it should (and should not) be used. For a description of the Lua language and features exposed by ZFS channel programs, please refer to the zfs-program(1m) man page instead. Maintenance policy ------------------ The Lua runtime is considered stable software. Channel programs don't need much complicated logic, so updates to the Lua runtime from upstream are viewed as nice-to-have, but not required for channel programs to be well-supported. As such, the Lua runtime in ZFS should be updated on an as-needed basis for security vulnerabilities, but not much else. Modifications to Lua -------------------- The version of the Lua runtime we're using in ZFS has been modified in a variety of ways to make it more useful for the specific purpose of running channel programs. These changes include: 1. "Normal" Lua uses floating point for all numbers it stores, but those aren't useful inside ZFS / the kernel. We have changed the runtime to use int64_t throughout for all numbers. 2. Some of the Lua standard libraries do file I/O or spawn processes, but neither of these make sense from inside channel programs. We have removed those libraries rather than reimplementing them using kernel APIs. 3. The "normal" Lua runtime handles errors by failing fatally, but since this version of Lua runs inside the kernel we must handle these failures and return meaningful error codes to userland. We have customized the Lua failure paths so that they aren't fatal. 4. Running poorly-vetted code inside the kernel is always a risk; even if the ability to do so is restricted to the root user, it's still possible to write an incorrect program that results in an infinite loop or massive memory use. We've added new protections into the Lua interpreter to limit the runtime (measured in number of Lua instructions run) and memory overhead of running a channel program. 5. The Lua bytecode is not designed to be secure / safe, so it would be easy to pass invalid bytecode which can panic the kernel. By comparison, the parser is hardened and fails gracefully on invalid input. Therefore, we only accept Lua source code at the ioctl level and then interpret it inside the kernel. Each of these modifications have been tested in the zfs-test suite. If / when new modifications are made, new tests should be added to the suite located in zfs-tests/tests/functional/channel_program/lua_core. How to use this Lua interpreter ------------------------------- From the above, it should be clear that this is not a general-purpose Lua interpreter. Additional work would be required to extricate this custom version of Lua from ZFS and make it usable by other areas of the kernel.