2010-08-26 18:22:58 +00:00
|
|
|
dnl #
|
|
|
|
dnl # Default ZFS kernel configuration
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_AC_CONFIG_KERNEL], [
|
|
|
|
ZFS_AC_KERNEL
|
|
|
|
ZFS_AC_SPL
|
2012-07-17 08:36:43 +00:00
|
|
|
ZFS_AC_TEST_MODULE
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_CONFIG
|
Swap DTRACE_PROBE* with Linux tracepoints
This patch leverages Linux tracepoints from within the ZFS on Linux
code base. It also refactors the debug code to bring it back in sync
with Illumos.
The information exported via tracepoints can be used for a variety of
reasons (e.g. debugging, tuning, general exploration/understanding,
etc). It is advantageous to use Linux tracepoints as the mechanism to
export this kind of information (as opposed to something else) for a
number of reasons:
* A number of external tools can make use of our tracepoints
"automatically" (e.g. perf, systemtap)
* Tracepoints are designed to be extremely cheap when disabled
* It's one of the "accepted" ways to export this kind of
information; many other kernel subsystems use tracepoints too.
Unfortunately, though, there are a few caveats as well:
* Linux tracepoints appear to only be available to GPL licensed
modules due to the way certain kernel functions are exported.
Thus, to actually make use of the tracepoints introduced by this
patch, one might have to patch and re-compile the kernel;
exporting the necessary functions to non-GPL modules.
* Prior to upstream kernel version v3.14-rc6-30-g66cc69e, Linux
tracepoints are not available for unsigned kernel modules
(tracepoints will get disabled due to the module's 'F' taint).
Thus, one either has to sign the zfs kernel module prior to
loading it, or use a kernel versioned v3.14-rc6-30-g66cc69e or
newer.
Assuming the above two requirements are satisfied, lets look at an
example of how this patch can be used and what information it exposes
(all commands run as 'root'):
# list all zfs tracepoints available
$ ls /sys/kernel/debug/tracing/events/zfs
enable filter zfs_arc__delete
zfs_arc__evict zfs_arc__hit zfs_arc__miss
zfs_l2arc__evict zfs_l2arc__hit zfs_l2arc__iodone
zfs_l2arc__miss zfs_l2arc__read zfs_l2arc__write
zfs_new_state__mfu zfs_new_state__mru
# enable all zfs tracepoints, clear the tracepoint ring buffer
$ echo 1 > /sys/kernel/debug/tracing/events/zfs/enable
$ echo 0 > /sys/kernel/debug/tracing/trace
# import zpool called 'tank', inspect tracepoint data (each line was
# truncated, they're too long for a commit message otherwise)
$ zpool import tank
$ cat /sys/kernel/debug/tracing/trace | head -n35
# tracer: nop
#
# entries-in-buffer/entries-written: 1219/1219 #P:8
#
# _-----=> irqs-off
# / _----=> need-resched
# | / _---=> hardirq/softirq
# || / _--=> preempt-depth
# ||| / delay
# TASK-PID CPU# |||| TIMESTAMP FUNCTION
# | | | |||| | |
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss: hdr...
z_rd_int/0-30156 [003] .... 91344.200611: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201173: zfs_arc__miss: hdr...
z_rd_int/1-30157 [003] .... 91344.201756: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201795: zfs_arc__miss: hdr...
z_rd_int/2-30158 [003] .... 91344.202099: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202126: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202130: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202134: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202146: zfs_arc__miss: hdr...
z_rd_int/3-30159 [003] .... 91344.202457: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202484: zfs_arc__miss: hdr...
z_rd_int/4-30160 [003] .... 91344.202866: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202891: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203034: zfs_arc__miss: hdr...
z_rd_iss/1-30149 [001] .... 91344.203749: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.203789: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203878: zfs_arc__miss: hdr...
z_rd_iss/3-30151 [001] .... 91344.204315: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.204332: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204337: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204352: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204356: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204360: zfs_arc__hit: hdr ...
To highlight the kind of detailed information that is being exported
using this infrastructure, I've taken the first tracepoint line from the
output above and reformatted it such that it fits in 80 columns:
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss:
hdr {
dva 0x1:0x40082
birth 15491
cksum0 0x163edbff3a
flags 0x640
datacnt 1
type 1
size 2048
spa 3133524293419867460
state_type 0
access 0
mru_hits 0
mru_ghost_hits 0
mfu_hits 0
mfu_ghost_hits 0
l2_hits 0
refcount 1
} bp {
dva0 0x1:0x40082
dva1 0x1:0x3000e5
dva2 0x1:0x5a006e
cksum 0x163edbff3a:0x75af30b3dd6:0x1499263ff5f2b:0x288bd118815e00
lsize 2048
} zb {
objset 0
object 0
level -1
blkid 0
}
For the specific tracepoint shown here, 'zfs_arc__miss', data is
exported detailing the arc_buf_hdr_t (hdr), blkptr_t (bp), and
zbookmark_t (zb) that caused the ARC miss (down to the exact DVA!).
This kind of precise and detailed information can be extremely valuable
when trying to answer certain kinds of questions.
For anybody unfamiliar but looking to build on this, I found the XFS
source code along with the following three web links to be extremely
helpful:
* http://lwn.net/Articles/379903/
* http://lwn.net/Articles/381064/
* http://lwn.net/Articles/383362/
I should also node the more "boring" aspects of this patch:
* The ZFS_LINUX_COMPILE_IFELSE autoconf macro was modified to
support a sixth paramter. This parameter is used to populate the
contents of the new conftest.h file. If no sixth parameter is
provided, conftest.h will be empty.
* The ZFS_LINUX_TRY_COMPILE_HEADER autoconf macro was introduced.
This macro is nearly identical to the ZFS_LINUX_TRY_COMPILE macro,
except it has support for a fifth option that is then passed as
the sixth parameter to ZFS_LINUX_COMPILE_IFELSE.
These autoconf changes were needed to test the availability of the Linux
tracepoint macros. Due to the odd nature of the Linux tracepoint macro
API, a separate ".h" must be created (the path and filename is used
internally by the kernel's define_trace.h file).
* The HAVE_DECLARE_EVENT_CLASS autoconf macro was introduced. This
is to determine if we can safely enable the Linux tracepoint
functionality. We need to selectively disable the tracepoint code
due to the kernel exporting certain functions as GPL only. Without
this check, the build process will fail at link time.
In addition, the SET_ERROR macro was modified into a tracepoint as well.
To do this, the 'sdt.h' file was moved into the 'include/sys' directory
and now contains a userspace portion and a kernel space portion. The
dprintf and zfs_dbgmsg* interfaces are now implemented as tracepoint as
well.
Signed-off-by: Prakash Surya <surya1@llnl.gov>
Signed-off-by: Ned Bass <bass6@llnl.gov>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
2014-06-13 17:54:48 +00:00
|
|
|
ZFS_AC_KERNEL_DECLARE_EVENT_CLASS
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_BDEV_BLOCK_DEVICE_OPERATIONS
|
2013-06-03 06:58:52 +00:00
|
|
|
ZFS_AC_KERNEL_BLOCK_DEVICE_OPERATIONS_RELEASE_VOID
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_TYPE_FMODE_T
|
|
|
|
ZFS_AC_KERNEL_KOBJ_NAME_LEN
|
2012-07-11 13:06:32 +00:00
|
|
|
ZFS_AC_KERNEL_3ARG_BLKDEV_GET
|
2011-02-22 22:55:35 +00:00
|
|
|
ZFS_AC_KERNEL_BLKDEV_GET_BY_PATH
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_OPEN_BDEV_EXCLUSIVE
|
2013-01-28 22:15:39 +00:00
|
|
|
ZFS_AC_KERNEL_LOOKUP_BDEV
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_INVALIDATE_BDEV_ARGS
|
|
|
|
ZFS_AC_KERNEL_BDEV_LOGICAL_BLOCK_SIZE
|
2012-09-02 23:34:12 +00:00
|
|
|
ZFS_AC_KERNEL_BDEV_PHYSICAL_BLOCK_SIZE
|
2014-03-28 07:08:21 +00:00
|
|
|
ZFS_AC_KERNEL_BIO_BVEC_ITER
|
2010-11-10 22:40:38 +00:00
|
|
|
ZFS_AC_KERNEL_BIO_FAILFAST_DTD
|
|
|
|
ZFS_AC_KERNEL_REQ_FAILFAST_MASK
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_BIO_END_IO_T_ARGS
|
2010-11-10 23:49:40 +00:00
|
|
|
ZFS_AC_KERNEL_BIO_RW_SYNC
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_BIO_RW_SYNCIO
|
2010-11-10 23:49:40 +00:00
|
|
|
ZFS_AC_KERNEL_REQ_SYNC
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_BLK_END_REQUEST
|
2011-09-05 09:11:38 +00:00
|
|
|
ZFS_AC_KERNEL_BLK_QUEUE_FLUSH
|
2011-09-05 13:15:45 +00:00
|
|
|
ZFS_AC_KERNEL_BLK_QUEUE_MAX_HW_SECTORS
|
|
|
|
ZFS_AC_KERNEL_BLK_QUEUE_MAX_SEGMENTS
|
|
|
|
ZFS_AC_KERNEL_BLK_QUEUE_PHYSICAL_BLOCK_SIZE
|
|
|
|
ZFS_AC_KERNEL_BLK_QUEUE_IO_OPT
|
|
|
|
ZFS_AC_KERNEL_BLK_QUEUE_NONROT
|
2011-09-02 13:23:12 +00:00
|
|
|
ZFS_AC_KERNEL_BLK_QUEUE_DISCARD
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_BLK_FETCH_REQUEST
|
|
|
|
ZFS_AC_KERNEL_BLK_REQUEUE_REQUEST
|
|
|
|
ZFS_AC_KERNEL_BLK_RQ_BYTES
|
|
|
|
ZFS_AC_KERNEL_BLK_RQ_POS
|
|
|
|
ZFS_AC_KERNEL_BLK_RQ_SECTORS
|
|
|
|
ZFS_AC_KERNEL_GET_DISK_RO
|
2012-07-11 13:06:32 +00:00
|
|
|
ZFS_AC_KERNEL_GET_GENDISK
|
2010-08-26 18:22:58 +00:00
|
|
|
ZFS_AC_KERNEL_RQ_IS_SYNC
|
|
|
|
ZFS_AC_KERNEL_RQ_FOR_EACH_SEGMENT
|
2012-08-01 08:29:59 +00:00
|
|
|
ZFS_AC_KERNEL_DISCARD_GRANULARITY
|
2011-02-11 00:16:52 +00:00
|
|
|
ZFS_AC_KERNEL_CONST_XATTR_HANDLER
|
2011-02-11 18:33:01 +00:00
|
|
|
ZFS_AC_KERNEL_XATTR_HANDLER_GET
|
|
|
|
ZFS_AC_KERNEL_XATTR_HANDLER_SET
|
2013-10-28 16:22:15 +00:00
|
|
|
ZFS_AC_KERNEL_XATTR_HANDLER_LIST
|
|
|
|
ZFS_AC_KERNEL_INODE_OWNER_OR_CAPABLE
|
|
|
|
ZFS_AC_KERNEL_POSIX_ACL_FROM_XATTR_USERNS
|
|
|
|
ZFS_AC_KERNEL_POSIX_ACL_RELEASE
|
|
|
|
ZFS_AC_KERNEL_POSIX_ACL_CHMOD
|
|
|
|
ZFS_AC_KERNEL_POSIX_ACL_CACHING
|
|
|
|
ZFS_AC_KERNEL_POSIX_ACL_EQUIV_MODE_WANTS_UMODE_T
|
|
|
|
ZFS_AC_KERNEL_INODE_OPERATIONS_PERMISSION
|
|
|
|
ZFS_AC_KERNEL_INODE_OPERATIONS_PERMISSION_WITH_NAMEIDATA
|
|
|
|
ZFS_AC_KERNEL_INODE_OPERATIONS_CHECK_ACL
|
|
|
|
ZFS_AC_KERNEL_INODE_OPERATIONS_CHECK_ACL_WITH_FLAGS
|
|
|
|
ZFS_AC_KERNEL_INODE_OPERATIONS_GET_ACL
|
|
|
|
ZFS_AC_KERNEL_CURRENT_UMASK
|
2012-02-02 19:55:48 +00:00
|
|
|
ZFS_AC_KERNEL_SHOW_OPTIONS
|
2015-02-07 12:41:01 +00:00
|
|
|
ZFS_AC_KERNEL_FILE_INODE
|
2011-11-10 04:47:59 +00:00
|
|
|
ZFS_AC_KERNEL_FSYNC
|
2011-02-11 21:46:10 +00:00
|
|
|
ZFS_AC_KERNEL_EVICT_INODE
|
2012-12-12 00:58:44 +00:00
|
|
|
ZFS_AC_KERNEL_DIRTY_INODE_WITH_FLAGS
|
2011-12-22 20:20:43 +00:00
|
|
|
ZFS_AC_KERNEL_NR_CACHED_OBJECTS
|
|
|
|
ZFS_AC_KERNEL_FREE_CACHED_OBJECTS
|
2011-09-02 07:42:07 +00:00
|
|
|
ZFS_AC_KERNEL_FALLOCATE
|
2012-08-16 23:31:54 +00:00
|
|
|
ZFS_AC_KERNEL_MKDIR_UMODE_T
|
2012-10-12 14:41:06 +00:00
|
|
|
ZFS_AC_KERNEL_LOOKUP_NAMEIDATA
|
2012-10-12 15:20:58 +00:00
|
|
|
ZFS_AC_KERNEL_CREATE_NAMEIDATA
|
2015-07-15 17:54:26 +00:00
|
|
|
ZFS_AC_KERNEL_FOLLOW_LINK
|
|
|
|
ZFS_AC_KERNEL_PUT_LINK
|
2012-07-23 18:11:25 +00:00
|
|
|
ZFS_AC_KERNEL_TRUNCATE_RANGE
|
2011-11-11 07:15:53 +00:00
|
|
|
ZFS_AC_KERNEL_AUTOMOUNT
|
2012-07-23 17:55:48 +00:00
|
|
|
ZFS_AC_KERNEL_ENCODE_FH_WITH_INODE
|
2012-09-16 06:03:04 +00:00
|
|
|
ZFS_AC_KERNEL_COMMIT_METADATA
|
2012-07-23 18:39:25 +00:00
|
|
|
ZFS_AC_KERNEL_CLEAR_INODE
|
2011-03-22 16:55:09 +00:00
|
|
|
ZFS_AC_KERNEL_INSERT_INODE_LOCKED
|
2012-06-06 17:08:00 +00:00
|
|
|
ZFS_AC_KERNEL_D_MAKE_ROOT
|
2011-04-28 16:35:50 +00:00
|
|
|
ZFS_AC_KERNEL_D_OBTAIN_ALIAS
|
2015-06-18 16:21:19 +00:00
|
|
|
ZFS_AC_KERNEL_D_PRUNE_ALIASES
|
2013-01-14 21:59:14 +00:00
|
|
|
ZFS_AC_KERNEL_D_SET_D_OP
|
|
|
|
ZFS_AC_KERNEL_D_REVALIDATE_NAMEIDATA
|
|
|
|
ZFS_AC_KERNEL_CONST_DENTRY_OPERATIONS
|
2011-02-25 07:36:01 +00:00
|
|
|
ZFS_AC_KERNEL_CHECK_DISK_SIZE_CHANGE
|
2011-06-25 12:30:29 +00:00
|
|
|
ZFS_AC_KERNEL_TRUNCATE_SETSIZE
|
2011-05-19 19:47:32 +00:00
|
|
|
ZFS_AC_KERNEL_6ARGS_SECURITY_INODE_INIT_SECURITY
|
2012-01-12 21:59:44 +00:00
|
|
|
ZFS_AC_KERNEL_CALLBACK_SECURITY_INODE_INIT_SECURITY
|
2011-05-19 18:44:07 +00:00
|
|
|
ZFS_AC_KERNEL_MOUNT_NODEV
|
2011-12-22 20:20:43 +00:00
|
|
|
ZFS_AC_KERNEL_SHRINK
|
2015-06-14 16:19:40 +00:00
|
|
|
ZFS_AC_KERNEL_SHRINK_CONTROL_HAS_NID
|
2013-07-15 20:37:51 +00:00
|
|
|
ZFS_AC_KERNEL_S_INSTANCES_LIST_HEAD
|
2013-01-18 22:11:40 +00:00
|
|
|
ZFS_AC_KERNEL_S_D_OP
|
2011-11-08 00:39:03 +00:00
|
|
|
ZFS_AC_KERNEL_BDI_SETUP_AND_REGISTER
|
2011-12-16 21:15:12 +00:00
|
|
|
ZFS_AC_KERNEL_SET_NLINK
|
2012-08-26 20:38:06 +00:00
|
|
|
ZFS_AC_KERNEL_ELEVATOR_CHANGE
|
2012-10-12 13:40:53 +00:00
|
|
|
ZFS_AC_KERNEL_5ARG_SGET
|
2013-06-13 17:51:09 +00:00
|
|
|
ZFS_AC_KERNEL_LSEEK_EXECUTE
|
2013-08-07 12:53:45 +00:00
|
|
|
ZFS_AC_KERNEL_VFS_ITERATE
|
2015-05-11 23:26:18 +00:00
|
|
|
ZFS_AC_KERNEL_VFS_RW_ITERATE
|
2010-08-26 18:22:58 +00:00
|
|
|
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test "$LINUX_OBJ" != "$LINUX"], [
|
2010-09-04 20:26:23 +00:00
|
|
|
KERNELMAKE_PARAMS="$KERNELMAKE_PARAMS O=$LINUX_OBJ"
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
2010-09-04 20:26:23 +00:00
|
|
|
AC_SUBST(KERNELMAKE_PARAMS)
|
|
|
|
|
|
|
|
|
2010-08-26 18:22:58 +00:00
|
|
|
dnl # -Wall -fno-strict-aliasing -Wstrict-prototypes and other
|
|
|
|
dnl # compiler options are added by the kernel build system.
|
2011-06-14 18:02:13 +00:00
|
|
|
KERNELCPPFLAGS="$KERNELCPPFLAGS $NO_UNUSED_BUT_SET_VARIABLE"
|
2015-07-13 19:30:02 +00:00
|
|
|
KERNELCPPFLAGS="$KERNELCPPFLAGS $NO_BOOL_COMPARE"
|
2010-08-26 18:22:58 +00:00
|
|
|
KERNELCPPFLAGS="$KERNELCPPFLAGS -DHAVE_SPL -D_KERNEL"
|
|
|
|
KERNELCPPFLAGS="$KERNELCPPFLAGS -DTEXT_DOMAIN=\\\"zfs-linux-kernel\\\""
|
|
|
|
|
|
|
|
AC_SUBST(KERNELCPPFLAGS)
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # Detect name used for Module.symvers file in kernel
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_AC_MODULE_SYMVERS], [
|
|
|
|
modpost=$LINUX/scripts/Makefile.modpost
|
|
|
|
AC_MSG_CHECKING([kernel file name for module symbols])
|
2012-07-17 08:36:43 +00:00
|
|
|
AS_IF([test "x$enable_linux_builtin" != xyes -a -f "$modpost"], [
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([grep -q Modules.symvers $modpost], [
|
2010-08-26 18:22:58 +00:00
|
|
|
LINUX_SYMBOLS=Modules.symvers
|
2011-08-24 16:52:16 +00:00
|
|
|
], [
|
2010-08-26 18:22:58 +00:00
|
|
|
LINUX_SYMBOLS=Module.symvers
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
2011-03-07 21:03:48 +00:00
|
|
|
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test ! -f "$LINUX_OBJ/$LINUX_SYMBOLS"], [
|
2011-03-07 21:03:48 +00:00
|
|
|
AC_MSG_ERROR([
|
|
|
|
*** Please make sure the kernel devel package for your distribution
|
2013-03-30 02:27:50 +00:00
|
|
|
*** is installed. If you are building with a custom kernel, make sure the
|
2011-03-07 21:03:48 +00:00
|
|
|
*** kernel is configured, built, and the '--with-linux=PATH' configure
|
|
|
|
*** option refers to the location of the kernel source.])
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
|
|
|
], [
|
2010-08-26 18:22:58 +00:00
|
|
|
LINUX_SYMBOLS=NONE
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
AC_MSG_RESULT($LINUX_SYMBOLS)
|
|
|
|
AC_SUBST(LINUX_SYMBOLS)
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # Detect the kernel to be built against
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_AC_KERNEL], [
|
|
|
|
AC_ARG_WITH([linux],
|
|
|
|
AS_HELP_STRING([--with-linux=PATH],
|
|
|
|
[Path to kernel source]),
|
|
|
|
[kernelsrc="$withval"])
|
|
|
|
|
|
|
|
AC_ARG_WITH(linux-obj,
|
|
|
|
AS_HELP_STRING([--with-linux-obj=PATH],
|
|
|
|
[Path to kernel build objects]),
|
|
|
|
[kernelbuild="$withval"])
|
|
|
|
|
|
|
|
AC_MSG_CHECKING([kernel source directory])
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test -z "$kernelsrc"], [
|
|
|
|
AS_IF([test -e "/lib/modules/$(uname -r)/source"], [
|
2011-02-10 22:54:33 +00:00
|
|
|
headersdir="/lib/modules/$(uname -r)/source"
|
|
|
|
sourcelink=$(readlink -f "$headersdir")
|
2011-08-24 16:52:16 +00:00
|
|
|
], [test -e "/lib/modules/$(uname -r)/build"], [
|
2011-02-10 22:54:33 +00:00
|
|
|
headersdir="/lib/modules/$(uname -r)/build"
|
2010-08-26 18:22:58 +00:00
|
|
|
sourcelink=$(readlink -f "$headersdir")
|
2011-08-24 16:52:16 +00:00
|
|
|
], [
|
2010-08-26 18:22:58 +00:00
|
|
|
sourcelink=$(ls -1d /usr/src/kernels/* \
|
2011-08-24 16:52:16 +00:00
|
|
|
/usr/src/linux-* \
|
2010-08-26 18:22:58 +00:00
|
|
|
2>/dev/null | grep -v obj | tail -1)
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test -n "$sourcelink" && test -e ${sourcelink}], [
|
2010-08-26 18:22:58 +00:00
|
|
|
kernelsrc=`readlink -f ${sourcelink}`
|
2011-08-24 16:52:16 +00:00
|
|
|
], [
|
2012-11-30 04:19:25 +00:00
|
|
|
kernelsrc="[Not found]"
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
|
|
|
], [
|
|
|
|
AS_IF([test "$kernelsrc" = "NONE"], [
|
2010-08-26 18:22:58 +00:00
|
|
|
kernsrcver=NONE
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
|
|
|
|
AC_MSG_RESULT([$kernelsrc])
|
2012-11-30 04:19:25 +00:00
|
|
|
AS_IF([test ! -d "$kernelsrc"], [
|
|
|
|
AC_MSG_ERROR([
|
|
|
|
*** Please make sure the kernel devel package for your distribution
|
2013-03-30 02:27:50 +00:00
|
|
|
*** is installed and then try again. If that fails, you can specify the
|
2012-11-30 04:19:25 +00:00
|
|
|
*** location of the kernel source with the '--with-linux=PATH' option.])
|
|
|
|
])
|
|
|
|
|
2010-08-26 18:22:58 +00:00
|
|
|
AC_MSG_CHECKING([kernel build directory])
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test -z "$kernelbuild"], [
|
|
|
|
AS_IF([test -e "/lib/modules/$(uname -r)/build"], [
|
2011-02-10 22:54:33 +00:00
|
|
|
kernelbuild=`readlink -f /lib/modules/$(uname -r)/build`
|
2011-08-24 16:52:16 +00:00
|
|
|
], [test -d ${kernelsrc}-obj/${target_cpu}/${target_cpu}], [
|
2010-08-26 18:22:58 +00:00
|
|
|
kernelbuild=${kernelsrc}-obj/${target_cpu}/${target_cpu}
|
2011-08-24 16:52:16 +00:00
|
|
|
], [test -d ${kernelsrc}-obj/${target_cpu}/default], [
|
2012-07-25 21:38:58 +00:00
|
|
|
kernelbuild=${kernelsrc}-obj/${target_cpu}/default
|
2011-08-24 16:52:16 +00:00
|
|
|
], [test -d `dirname ${kernelsrc}`/build-${target_cpu}], [
|
2010-08-26 18:22:58 +00:00
|
|
|
kernelbuild=`dirname ${kernelsrc}`/build-${target_cpu}
|
2011-08-24 16:52:16 +00:00
|
|
|
], [
|
2010-08-26 18:22:58 +00:00
|
|
|
kernelbuild=${kernelsrc}
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
AC_MSG_RESULT([$kernelbuild])
|
|
|
|
|
|
|
|
AC_MSG_CHECKING([kernel source version])
|
|
|
|
utsrelease1=$kernelbuild/include/linux/version.h
|
|
|
|
utsrelease2=$kernelbuild/include/linux/utsrelease.h
|
|
|
|
utsrelease3=$kernelbuild/include/generated/utsrelease.h
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test -r $utsrelease1 && fgrep -q UTS_RELEASE $utsrelease1], [
|
2010-08-26 18:22:58 +00:00
|
|
|
utsrelease=linux/version.h
|
2011-08-24 16:52:16 +00:00
|
|
|
], [test -r $utsrelease2 && fgrep -q UTS_RELEASE $utsrelease2], [
|
2010-08-26 18:22:58 +00:00
|
|
|
utsrelease=linux/utsrelease.h
|
2011-08-24 16:52:16 +00:00
|
|
|
], [test -r $utsrelease3 && fgrep -q UTS_RELEASE $utsrelease3], [
|
2010-08-26 18:22:58 +00:00
|
|
|
utsrelease=generated/utsrelease.h
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test "$utsrelease"], [
|
2010-08-26 18:22:58 +00:00
|
|
|
kernsrcver=`(echo "#include <$utsrelease>";
|
|
|
|
echo "kernsrcver=UTS_RELEASE") |
|
|
|
|
cpp -I $kernelbuild/include |
|
|
|
|
grep "^kernsrcver=" | cut -d \" -f 2`
|
|
|
|
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test -z "$kernsrcver"], [
|
2010-08-26 18:22:58 +00:00
|
|
|
AC_MSG_RESULT([Not found])
|
|
|
|
AC_MSG_ERROR([*** Cannot determine kernel version.])
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
|
|
|
], [
|
2010-08-26 18:22:58 +00:00
|
|
|
AC_MSG_RESULT([Not found])
|
2012-07-17 08:36:43 +00:00
|
|
|
if test "x$enable_linux_builtin" != xyes; then
|
|
|
|
AC_MSG_ERROR([*** Cannot find UTS_RELEASE definition.])
|
|
|
|
else
|
|
|
|
AC_MSG_ERROR([
|
|
|
|
*** Cannot find UTS_RELEASE definition.
|
|
|
|
*** Please run 'make prepare' inside the kernel source tree.])
|
|
|
|
fi
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
|
|
|
|
AC_MSG_RESULT([$kernsrcver])
|
|
|
|
|
|
|
|
LINUX=${kernelsrc}
|
|
|
|
LINUX_OBJ=${kernelbuild}
|
|
|
|
LINUX_VERSION=${kernsrcver}
|
|
|
|
|
|
|
|
AC_SUBST(LINUX)
|
|
|
|
AC_SUBST(LINUX_OBJ)
|
|
|
|
AC_SUBST(LINUX_VERSION)
|
|
|
|
|
|
|
|
ZFS_AC_MODULE_SYMVERS
|
|
|
|
])
|
|
|
|
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # Detect the SPL module to be built against
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_AC_SPL], [
|
|
|
|
AC_ARG_WITH([spl],
|
|
|
|
AS_HELP_STRING([--with-spl=PATH],
|
|
|
|
[Path to spl source]),
|
|
|
|
[splsrc="$withval"])
|
|
|
|
|
|
|
|
AC_ARG_WITH([spl-obj],
|
|
|
|
AS_HELP_STRING([--with-spl-obj=PATH],
|
|
|
|
[Path to spl build objects]),
|
|
|
|
[splbuild="$withval"])
|
|
|
|
|
2013-04-27 18:18:11 +00:00
|
|
|
AC_ARG_WITH([spl-timeout],
|
|
|
|
AS_HELP_STRING([--with-spl-timeout=SECS],
|
|
|
|
[Wait SECS for SPL header and symver file @<:@default=0@:>@]),
|
|
|
|
[timeout="$withval"], [timeout=0])
|
|
|
|
|
2013-02-22 23:50:00 +00:00
|
|
|
dnl #
|
|
|
|
dnl # The existence of spl.release.in is used to identify a valid
|
|
|
|
dnl # source directory. In order of preference:
|
|
|
|
dnl #
|
|
|
|
splsrc0="/var/lib/dkms/spl/${VERSION}/build"
|
2014-08-29 17:09:52 +00:00
|
|
|
splsrc1="/usr/local/src/spl-${VERSION}/${LINUX_VERSION}"
|
|
|
|
splsrc2="/usr/local/src/spl-${VERSION}"
|
|
|
|
splsrc3="/usr/src/spl-${VERSION}/${LINUX_VERSION}"
|
|
|
|
splsrc4="/usr/src/spl-${VERSION}"
|
|
|
|
splsrc5="../spl/"
|
|
|
|
splsrc6="$LINUX"
|
2010-08-26 18:22:58 +00:00
|
|
|
|
|
|
|
AC_MSG_CHECKING([spl source directory])
|
2013-02-22 23:50:00 +00:00
|
|
|
AS_IF([test -z "${splsrc}"], [
|
|
|
|
AS_IF([ test -e "${splsrc0}/spl.release.in"], [
|
|
|
|
splsrc=${splsrc0}
|
|
|
|
], [ test -e "${splsrc1}/spl.release.in"], [
|
|
|
|
splsrc=${splsrc1}
|
|
|
|
], [ test -e "${splsrc2}/spl.release.in"], [
|
|
|
|
splsrc=${splsrc2}
|
|
|
|
], [ test -e "${splsrc3}/spl.release.in"], [
|
|
|
|
splsrc=$(readlink -f "${splsrc3}")
|
|
|
|
], [ test -e "${splsrc4}/spl.release.in" ], [
|
|
|
|
splsrc=${splsrc4}
|
2014-08-29 17:09:52 +00:00
|
|
|
], [ test -e "${splsrc5}/spl.release.in"], [
|
|
|
|
splsrc=$(readlink -f "${splsrc5}")
|
|
|
|
], [ test -e "${splsrc6}/spl.release.in" ], [
|
|
|
|
splsrc=${splsrc6}
|
2011-08-24 16:52:16 +00:00
|
|
|
], [
|
2013-02-22 23:50:00 +00:00
|
|
|
splsrc="[Not found]"
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
|
|
|
], [
|
|
|
|
AS_IF([test "$splsrc" = "NONE"], [
|
2010-08-26 18:22:58 +00:00
|
|
|
splbuild=NONE
|
|
|
|
splsrcver=NONE
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
|
|
|
|
AC_MSG_RESULT([$splsrc])
|
2013-02-22 23:50:00 +00:00
|
|
|
AS_IF([ test ! -e "$splsrc/spl.release.in"], [
|
|
|
|
AC_MSG_ERROR([
|
|
|
|
*** Please make sure the kmod spl devel package for your distribution
|
|
|
|
*** is installed then try again. If that fails you can specify the
|
|
|
|
*** location of the spl source with the '--with-spl=PATH' option.])
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # The existence of the spl_config.h is used to identify a valid
|
|
|
|
dnl # spl object directory. In many cases the object and source
|
|
|
|
dnl # directory are the same, however the objects may also reside
|
|
|
|
dnl # is a subdirectory named after the kernel version.
|
|
|
|
dnl #
|
2013-04-27 18:18:11 +00:00
|
|
|
dnl # This file is supposed to be available after DKMS finishes
|
|
|
|
dnl # building the SPL kernel module for the target kernel. The
|
|
|
|
dnl # '--with-spl-timeout' option can be passed to pause here,
|
|
|
|
dnl # waiting for the file to appear from a concurrently building
|
|
|
|
dnl # SPL package.
|
|
|
|
dnl #
|
2010-08-26 18:22:58 +00:00
|
|
|
AC_MSG_CHECKING([spl build directory])
|
2013-04-27 18:18:11 +00:00
|
|
|
while true; do
|
|
|
|
AS_IF([test -z "$splbuild"], [
|
|
|
|
AS_IF([ test -e "${splsrc}/${LINUX_VERSION}/spl_config.h" ], [
|
|
|
|
splbuild="${splsrc}/${LINUX_VERSION}"
|
|
|
|
], [ test -e "${splsrc}/spl_config.h" ], [
|
|
|
|
splbuild="${splsrc}"
|
2014-06-09 21:55:31 +00:00
|
|
|
], [ find -L "${splsrc}" -name spl_config.h 2> /dev/null | grep -wq spl_config.h ], [
|
|
|
|
splbuild=$(find -L "${splsrc}" -name spl_config.h | sed 's,/spl_config.h,,')
|
2013-04-27 18:18:11 +00:00
|
|
|
], [
|
|
|
|
splbuild="[Not found]"
|
|
|
|
])
|
|
|
|
])
|
|
|
|
AS_IF([test -e "$splbuild/spl_config.h" -o $timeout -le 0], [
|
|
|
|
break;
|
2013-02-22 23:50:00 +00:00
|
|
|
], [
|
2013-04-27 18:18:11 +00:00
|
|
|
sleep 1
|
|
|
|
timeout=$((timeout-1))
|
2013-02-22 23:50:00 +00:00
|
|
|
])
|
2013-04-27 18:18:11 +00:00
|
|
|
done
|
2013-02-22 23:50:00 +00:00
|
|
|
|
2010-08-26 18:22:58 +00:00
|
|
|
AC_MSG_RESULT([$splbuild])
|
2013-02-22 23:50:00 +00:00
|
|
|
AS_IF([ ! test -e "$splbuild/spl_config.h"], [
|
|
|
|
AC_MSG_ERROR([
|
|
|
|
*** Please make sure the kmod spl devel <kernel> package for your
|
|
|
|
*** distribution is installed then try again. If that fails you
|
|
|
|
*** can specify the location of the spl objects with the
|
|
|
|
*** '--with-spl-obj=PATH' option.])
|
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
|
|
|
|
AC_MSG_CHECKING([spl source version])
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test -r $splbuild/spl_config.h &&
|
|
|
|
fgrep -q SPL_META_VERSION $splbuild/spl_config.h], [
|
2010-08-26 18:22:58 +00:00
|
|
|
|
|
|
|
splsrcver=`(echo "#include <spl_config.h>";
|
2012-01-18 00:19:43 +00:00
|
|
|
echo "splsrcver=SPL_META_VERSION-SPL_META_RELEASE") |
|
2010-09-03 03:44:41 +00:00
|
|
|
cpp -I $splbuild |
|
2012-01-18 00:19:43 +00:00
|
|
|
grep "^splsrcver=" | tr -d \" | cut -d= -f2`
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
|
2011-08-24 16:52:16 +00:00
|
|
|
AS_IF([test -z "$splsrcver"], [
|
2010-08-26 18:22:58 +00:00
|
|
|
AC_MSG_RESULT([Not found])
|
|
|
|
AC_MSG_ERROR([
|
2011-08-24 16:23:44 +00:00
|
|
|
*** Cannot determine the version of the spl source.
|
|
|
|
*** Please prepare the spl source before running this script])
|
2011-08-24 16:52:16 +00:00
|
|
|
])
|
2010-08-26 18:22:58 +00:00
|
|
|
|
|
|
|
AC_MSG_RESULT([$splsrcver])
|
|
|
|
|
|
|
|
SPL=${splsrc}
|
|
|
|
SPL_OBJ=${splbuild}
|
|
|
|
SPL_VERSION=${splsrcver}
|
|
|
|
|
|
|
|
AC_SUBST(SPL)
|
|
|
|
AC_SUBST(SPL_OBJ)
|
|
|
|
AC_SUBST(SPL_VERSION)
|
|
|
|
|
2013-04-27 18:18:11 +00:00
|
|
|
dnl #
|
|
|
|
dnl # Detect the name used for the SPL Module.symvers file. If one
|
|
|
|
dnl # does not exist this is likely because the SPL has been configured
|
|
|
|
dnl # but not built. The '--with-spl-timeout' option can be passed
|
|
|
|
dnl # to pause here, waiting for the file to appear from a concurrently
|
|
|
|
dnl # building SPL package. If the file does not appear in time, a good
|
|
|
|
dnl # guess is made as to what this file will be named based on what it
|
|
|
|
dnl # is named in the kernel build products. This file will first be
|
|
|
|
dnl # used at link time so if the guess is wrong the build will fail
|
|
|
|
dnl # then. This unfortunately means the ZFS package does not contain a
|
|
|
|
dnl # reliable mechanism to detect symbols exported by the SPL at
|
|
|
|
dnl # configure time.
|
|
|
|
dnl #
|
|
|
|
AC_MSG_CHECKING([spl file name for module symbols])
|
|
|
|
SPL_SYMBOLS=NONE
|
|
|
|
|
|
|
|
while true; do
|
|
|
|
AS_IF([test -r $SPL_OBJ/Module.symvers], [
|
|
|
|
SPL_SYMBOLS=Module.symvers
|
|
|
|
], [test -r $SPL_OBJ/Modules.symvers], [
|
|
|
|
SPL_SYMBOLS=Modules.symvers
|
|
|
|
], [test -r $SPL_OBJ/module/Module.symvers], [
|
|
|
|
SPL_SYMBOLS=Module.symvers
|
|
|
|
], [test -r $SPL_OBJ/module/Modules.symvers], [
|
|
|
|
SPL_SYMBOLS=Modules.symvers
|
|
|
|
])
|
|
|
|
|
|
|
|
AS_IF([test $SPL_SYMBOLS != NONE -o $timeout -le 0], [
|
|
|
|
break;
|
|
|
|
], [
|
|
|
|
sleep 1
|
|
|
|
timeout=$((timeout-1))
|
|
|
|
])
|
|
|
|
done
|
|
|
|
|
|
|
|
AS_IF([test "$SPL_SYMBOLS" = NONE], [
|
|
|
|
SPL_SYMBOLS=$LINUX_SYMBOLS
|
|
|
|
])
|
|
|
|
|
|
|
|
AC_MSG_RESULT([$SPL_SYMBOLS])
|
|
|
|
AC_SUBST(SPL_SYMBOLS)
|
2010-08-26 18:22:58 +00:00
|
|
|
])
|
|
|
|
|
2012-07-17 08:36:43 +00:00
|
|
|
dnl #
|
|
|
|
dnl # Basic toolchain sanity check.
|
|
|
|
dnl #
|
2014-10-03 17:58:47 +00:00
|
|
|
AC_DEFUN([ZFS_AC_TEST_MODULE], [
|
|
|
|
AC_MSG_CHECKING([whether modules can be built])
|
2012-07-17 08:36:43 +00:00
|
|
|
ZFS_LINUX_TRY_COMPILE([],[],[
|
|
|
|
AC_MSG_RESULT([yes])
|
|
|
|
],[
|
|
|
|
AC_MSG_RESULT([no])
|
|
|
|
if test "x$enable_linux_builtin" != xyes; then
|
|
|
|
AC_MSG_ERROR([*** Unable to build an empty module.])
|
|
|
|
else
|
|
|
|
AC_MSG_ERROR([
|
|
|
|
*** Unable to build an empty module.
|
|
|
|
*** Please run 'make scripts' inside the kernel source tree.])
|
|
|
|
fi
|
|
|
|
])
|
|
|
|
])
|
|
|
|
|
2011-03-07 18:59:26 +00:00
|
|
|
dnl #
|
|
|
|
dnl # Certain kernel build options are not supported. These must be
|
|
|
|
dnl # detected at configure time and cause a build failure. Otherwise
|
|
|
|
dnl # modules may be successfully built that behave incorrectly.
|
|
|
|
dnl #
|
2012-05-21 19:59:58 +00:00
|
|
|
AC_DEFUN([ZFS_AC_KERNEL_CONFIG], [
|
2014-10-03 17:58:47 +00:00
|
|
|
AC_RUN_IFELSE([
|
|
|
|
AC_LANG_PROGRAM([
|
|
|
|
#include "$LINUX/include/linux/license.h"
|
|
|
|
], [
|
|
|
|
return !license_is_gpl_compatible("$ZFS_META_LICENSE");
|
|
|
|
])
|
|
|
|
], [
|
|
|
|
AC_DEFINE([ZFS_IS_GPL_COMPATIBLE], [1],
|
|
|
|
[Define to 1 if GPL-only symbols can be used])
|
|
|
|
], [
|
2012-05-21 19:59:58 +00:00
|
|
|
])
|
|
|
|
|
|
|
|
ZFS_AC_KERNEL_CONFIG_DEBUG_LOCK_ALLOC
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # Check CONFIG_DEBUG_LOCK_ALLOC
|
|
|
|
dnl #
|
|
|
|
dnl # This is typically only set for debug kernels because it comes with
|
|
|
|
dnl # a performance penalty. However, when it is set it maps the non-GPL
|
|
|
|
dnl # symbol mutex_lock() to the GPL-only mutex_lock_nested() symbol.
|
|
|
|
dnl # This will cause a failure at link time which we'd rather know about
|
|
|
|
dnl # at compile time.
|
|
|
|
dnl #
|
|
|
|
dnl # Since we plan to pursue making mutex_lock_nested() a non-GPL symbol
|
|
|
|
dnl # with the upstream community we add a check to detect this case.
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_AC_KERNEL_CONFIG_DEBUG_LOCK_ALLOC], [
|
|
|
|
|
|
|
|
ZFS_LINUX_CONFIG([DEBUG_LOCK_ALLOC], [
|
|
|
|
AC_MSG_CHECKING([whether mutex_lock() is GPL-only])
|
|
|
|
tmp_flags="$EXTRA_KCFLAGS"
|
|
|
|
ZFS_LINUX_TRY_COMPILE([
|
|
|
|
#include <linux/module.h>
|
|
|
|
#include <linux/mutex.h>
|
|
|
|
|
|
|
|
MODULE_LICENSE("$ZFS_META_LICENSE");
|
|
|
|
],[
|
|
|
|
struct mutex lock;
|
|
|
|
|
|
|
|
mutex_init(&lock);
|
|
|
|
mutex_lock(&lock);
|
|
|
|
mutex_unlock(&lock);
|
|
|
|
],[
|
|
|
|
AC_MSG_RESULT(no)
|
|
|
|
],[
|
|
|
|
AC_MSG_RESULT(yes)
|
|
|
|
AC_MSG_ERROR([
|
|
|
|
*** Kernel built with CONFIG_DEBUG_LOCK_ALLOC which is incompatible
|
2012-06-05 19:45:37 +00:00
|
|
|
*** with the CDDL license and will prevent the module linking stage
|
|
|
|
*** from succeeding. You must rebuild your kernel without this
|
|
|
|
*** option enabled.])
|
2012-05-21 19:59:58 +00:00
|
|
|
])
|
|
|
|
EXTRA_KCFLAGS="$tmp_flags"
|
|
|
|
], [])
|
2010-08-26 18:22:58 +00:00
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
Swap DTRACE_PROBE* with Linux tracepoints
This patch leverages Linux tracepoints from within the ZFS on Linux
code base. It also refactors the debug code to bring it back in sync
with Illumos.
The information exported via tracepoints can be used for a variety of
reasons (e.g. debugging, tuning, general exploration/understanding,
etc). It is advantageous to use Linux tracepoints as the mechanism to
export this kind of information (as opposed to something else) for a
number of reasons:
* A number of external tools can make use of our tracepoints
"automatically" (e.g. perf, systemtap)
* Tracepoints are designed to be extremely cheap when disabled
* It's one of the "accepted" ways to export this kind of
information; many other kernel subsystems use tracepoints too.
Unfortunately, though, there are a few caveats as well:
* Linux tracepoints appear to only be available to GPL licensed
modules due to the way certain kernel functions are exported.
Thus, to actually make use of the tracepoints introduced by this
patch, one might have to patch and re-compile the kernel;
exporting the necessary functions to non-GPL modules.
* Prior to upstream kernel version v3.14-rc6-30-g66cc69e, Linux
tracepoints are not available for unsigned kernel modules
(tracepoints will get disabled due to the module's 'F' taint).
Thus, one either has to sign the zfs kernel module prior to
loading it, or use a kernel versioned v3.14-rc6-30-g66cc69e or
newer.
Assuming the above two requirements are satisfied, lets look at an
example of how this patch can be used and what information it exposes
(all commands run as 'root'):
# list all zfs tracepoints available
$ ls /sys/kernel/debug/tracing/events/zfs
enable filter zfs_arc__delete
zfs_arc__evict zfs_arc__hit zfs_arc__miss
zfs_l2arc__evict zfs_l2arc__hit zfs_l2arc__iodone
zfs_l2arc__miss zfs_l2arc__read zfs_l2arc__write
zfs_new_state__mfu zfs_new_state__mru
# enable all zfs tracepoints, clear the tracepoint ring buffer
$ echo 1 > /sys/kernel/debug/tracing/events/zfs/enable
$ echo 0 > /sys/kernel/debug/tracing/trace
# import zpool called 'tank', inspect tracepoint data (each line was
# truncated, they're too long for a commit message otherwise)
$ zpool import tank
$ cat /sys/kernel/debug/tracing/trace | head -n35
# tracer: nop
#
# entries-in-buffer/entries-written: 1219/1219 #P:8
#
# _-----=> irqs-off
# / _----=> need-resched
# | / _---=> hardirq/softirq
# || / _--=> preempt-depth
# ||| / delay
# TASK-PID CPU# |||| TIMESTAMP FUNCTION
# | | | |||| | |
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss: hdr...
z_rd_int/0-30156 [003] .... 91344.200611: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201173: zfs_arc__miss: hdr...
z_rd_int/1-30157 [003] .... 91344.201756: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201795: zfs_arc__miss: hdr...
z_rd_int/2-30158 [003] .... 91344.202099: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202126: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202130: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202134: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202146: zfs_arc__miss: hdr...
z_rd_int/3-30159 [003] .... 91344.202457: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202484: zfs_arc__miss: hdr...
z_rd_int/4-30160 [003] .... 91344.202866: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202891: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203034: zfs_arc__miss: hdr...
z_rd_iss/1-30149 [001] .... 91344.203749: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.203789: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203878: zfs_arc__miss: hdr...
z_rd_iss/3-30151 [001] .... 91344.204315: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.204332: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204337: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204352: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204356: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204360: zfs_arc__hit: hdr ...
To highlight the kind of detailed information that is being exported
using this infrastructure, I've taken the first tracepoint line from the
output above and reformatted it such that it fits in 80 columns:
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss:
hdr {
dva 0x1:0x40082
birth 15491
cksum0 0x163edbff3a
flags 0x640
datacnt 1
type 1
size 2048
spa 3133524293419867460
state_type 0
access 0
mru_hits 0
mru_ghost_hits 0
mfu_hits 0
mfu_ghost_hits 0
l2_hits 0
refcount 1
} bp {
dva0 0x1:0x40082
dva1 0x1:0x3000e5
dva2 0x1:0x5a006e
cksum 0x163edbff3a:0x75af30b3dd6:0x1499263ff5f2b:0x288bd118815e00
lsize 2048
} zb {
objset 0
object 0
level -1
blkid 0
}
For the specific tracepoint shown here, 'zfs_arc__miss', data is
exported detailing the arc_buf_hdr_t (hdr), blkptr_t (bp), and
zbookmark_t (zb) that caused the ARC miss (down to the exact DVA!).
This kind of precise and detailed information can be extremely valuable
when trying to answer certain kinds of questions.
For anybody unfamiliar but looking to build on this, I found the XFS
source code along with the following three web links to be extremely
helpful:
* http://lwn.net/Articles/379903/
* http://lwn.net/Articles/381064/
* http://lwn.net/Articles/383362/
I should also node the more "boring" aspects of this patch:
* The ZFS_LINUX_COMPILE_IFELSE autoconf macro was modified to
support a sixth paramter. This parameter is used to populate the
contents of the new conftest.h file. If no sixth parameter is
provided, conftest.h will be empty.
* The ZFS_LINUX_TRY_COMPILE_HEADER autoconf macro was introduced.
This macro is nearly identical to the ZFS_LINUX_TRY_COMPILE macro,
except it has support for a fifth option that is then passed as
the sixth parameter to ZFS_LINUX_COMPILE_IFELSE.
These autoconf changes were needed to test the availability of the Linux
tracepoint macros. Due to the odd nature of the Linux tracepoint macro
API, a separate ".h" must be created (the path and filename is used
internally by the kernel's define_trace.h file).
* The HAVE_DECLARE_EVENT_CLASS autoconf macro was introduced. This
is to determine if we can safely enable the Linux tracepoint
functionality. We need to selectively disable the tracepoint code
due to the kernel exporting certain functions as GPL only. Without
this check, the build process will fail at link time.
In addition, the SET_ERROR macro was modified into a tracepoint as well.
To do this, the 'sdt.h' file was moved into the 'include/sys' directory
and now contains a userspace portion and a kernel space portion. The
dprintf and zfs_dbgmsg* interfaces are now implemented as tracepoint as
well.
Signed-off-by: Prakash Surya <surya1@llnl.gov>
Signed-off-by: Ned Bass <bass6@llnl.gov>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
2014-06-13 17:54:48 +00:00
|
|
|
dnl # ZFS_LINUX_CONFTEST_H
|
2010-08-26 18:22:58 +00:00
|
|
|
dnl #
|
Swap DTRACE_PROBE* with Linux tracepoints
This patch leverages Linux tracepoints from within the ZFS on Linux
code base. It also refactors the debug code to bring it back in sync
with Illumos.
The information exported via tracepoints can be used for a variety of
reasons (e.g. debugging, tuning, general exploration/understanding,
etc). It is advantageous to use Linux tracepoints as the mechanism to
export this kind of information (as opposed to something else) for a
number of reasons:
* A number of external tools can make use of our tracepoints
"automatically" (e.g. perf, systemtap)
* Tracepoints are designed to be extremely cheap when disabled
* It's one of the "accepted" ways to export this kind of
information; many other kernel subsystems use tracepoints too.
Unfortunately, though, there are a few caveats as well:
* Linux tracepoints appear to only be available to GPL licensed
modules due to the way certain kernel functions are exported.
Thus, to actually make use of the tracepoints introduced by this
patch, one might have to patch and re-compile the kernel;
exporting the necessary functions to non-GPL modules.
* Prior to upstream kernel version v3.14-rc6-30-g66cc69e, Linux
tracepoints are not available for unsigned kernel modules
(tracepoints will get disabled due to the module's 'F' taint).
Thus, one either has to sign the zfs kernel module prior to
loading it, or use a kernel versioned v3.14-rc6-30-g66cc69e or
newer.
Assuming the above two requirements are satisfied, lets look at an
example of how this patch can be used and what information it exposes
(all commands run as 'root'):
# list all zfs tracepoints available
$ ls /sys/kernel/debug/tracing/events/zfs
enable filter zfs_arc__delete
zfs_arc__evict zfs_arc__hit zfs_arc__miss
zfs_l2arc__evict zfs_l2arc__hit zfs_l2arc__iodone
zfs_l2arc__miss zfs_l2arc__read zfs_l2arc__write
zfs_new_state__mfu zfs_new_state__mru
# enable all zfs tracepoints, clear the tracepoint ring buffer
$ echo 1 > /sys/kernel/debug/tracing/events/zfs/enable
$ echo 0 > /sys/kernel/debug/tracing/trace
# import zpool called 'tank', inspect tracepoint data (each line was
# truncated, they're too long for a commit message otherwise)
$ zpool import tank
$ cat /sys/kernel/debug/tracing/trace | head -n35
# tracer: nop
#
# entries-in-buffer/entries-written: 1219/1219 #P:8
#
# _-----=> irqs-off
# / _----=> need-resched
# | / _---=> hardirq/softirq
# || / _--=> preempt-depth
# ||| / delay
# TASK-PID CPU# |||| TIMESTAMP FUNCTION
# | | | |||| | |
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss: hdr...
z_rd_int/0-30156 [003] .... 91344.200611: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201173: zfs_arc__miss: hdr...
z_rd_int/1-30157 [003] .... 91344.201756: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201795: zfs_arc__miss: hdr...
z_rd_int/2-30158 [003] .... 91344.202099: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202126: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202130: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202134: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202146: zfs_arc__miss: hdr...
z_rd_int/3-30159 [003] .... 91344.202457: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202484: zfs_arc__miss: hdr...
z_rd_int/4-30160 [003] .... 91344.202866: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202891: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203034: zfs_arc__miss: hdr...
z_rd_iss/1-30149 [001] .... 91344.203749: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.203789: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203878: zfs_arc__miss: hdr...
z_rd_iss/3-30151 [001] .... 91344.204315: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.204332: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204337: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204352: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204356: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204360: zfs_arc__hit: hdr ...
To highlight the kind of detailed information that is being exported
using this infrastructure, I've taken the first tracepoint line from the
output above and reformatted it such that it fits in 80 columns:
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss:
hdr {
dva 0x1:0x40082
birth 15491
cksum0 0x163edbff3a
flags 0x640
datacnt 1
type 1
size 2048
spa 3133524293419867460
state_type 0
access 0
mru_hits 0
mru_ghost_hits 0
mfu_hits 0
mfu_ghost_hits 0
l2_hits 0
refcount 1
} bp {
dva0 0x1:0x40082
dva1 0x1:0x3000e5
dva2 0x1:0x5a006e
cksum 0x163edbff3a:0x75af30b3dd6:0x1499263ff5f2b:0x288bd118815e00
lsize 2048
} zb {
objset 0
object 0
level -1
blkid 0
}
For the specific tracepoint shown here, 'zfs_arc__miss', data is
exported detailing the arc_buf_hdr_t (hdr), blkptr_t (bp), and
zbookmark_t (zb) that caused the ARC miss (down to the exact DVA!).
This kind of precise and detailed information can be extremely valuable
when trying to answer certain kinds of questions.
For anybody unfamiliar but looking to build on this, I found the XFS
source code along with the following three web links to be extremely
helpful:
* http://lwn.net/Articles/379903/
* http://lwn.net/Articles/381064/
* http://lwn.net/Articles/383362/
I should also node the more "boring" aspects of this patch:
* The ZFS_LINUX_COMPILE_IFELSE autoconf macro was modified to
support a sixth paramter. This parameter is used to populate the
contents of the new conftest.h file. If no sixth parameter is
provided, conftest.h will be empty.
* The ZFS_LINUX_TRY_COMPILE_HEADER autoconf macro was introduced.
This macro is nearly identical to the ZFS_LINUX_TRY_COMPILE macro,
except it has support for a fifth option that is then passed as
the sixth parameter to ZFS_LINUX_COMPILE_IFELSE.
These autoconf changes were needed to test the availability of the Linux
tracepoint macros. Due to the odd nature of the Linux tracepoint macro
API, a separate ".h" must be created (the path and filename is used
internally by the kernel's define_trace.h file).
* The HAVE_DECLARE_EVENT_CLASS autoconf macro was introduced. This
is to determine if we can safely enable the Linux tracepoint
functionality. We need to selectively disable the tracepoint code
due to the kernel exporting certain functions as GPL only. Without
this check, the build process will fail at link time.
In addition, the SET_ERROR macro was modified into a tracepoint as well.
To do this, the 'sdt.h' file was moved into the 'include/sys' directory
and now contains a userspace portion and a kernel space portion. The
dprintf and zfs_dbgmsg* interfaces are now implemented as tracepoint as
well.
Signed-off-by: Prakash Surya <surya1@llnl.gov>
Signed-off-by: Ned Bass <bass6@llnl.gov>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
2014-06-13 17:54:48 +00:00
|
|
|
AC_DEFUN([ZFS_LINUX_CONFTEST_H], [
|
|
|
|
cat - <<_ACEOF >conftest.h
|
|
|
|
$1
|
|
|
|
_ACEOF
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # ZFS_LINUX_CONFTEST_C
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_LINUX_CONFTEST_C], [
|
2010-08-26 18:22:58 +00:00
|
|
|
cat confdefs.h - <<_ACEOF >conftest.c
|
|
|
|
$1
|
|
|
|
_ACEOF
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # ZFS_LANG_PROGRAM(C)([PROLOGUE], [BODY])
|
|
|
|
dnl #
|
|
|
|
m4_define([ZFS_LANG_PROGRAM], [
|
|
|
|
$1
|
|
|
|
int
|
|
|
|
main (void)
|
|
|
|
{
|
|
|
|
dnl Do *not* indent the following line: there may be CPP directives.
|
|
|
|
dnl Don't move the `;' right after for the same reason.
|
|
|
|
$2
|
|
|
|
;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # ZFS_LINUX_COMPILE_IFELSE / like AC_COMPILE_IFELSE
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_LINUX_COMPILE_IFELSE], [
|
Swap DTRACE_PROBE* with Linux tracepoints
This patch leverages Linux tracepoints from within the ZFS on Linux
code base. It also refactors the debug code to bring it back in sync
with Illumos.
The information exported via tracepoints can be used for a variety of
reasons (e.g. debugging, tuning, general exploration/understanding,
etc). It is advantageous to use Linux tracepoints as the mechanism to
export this kind of information (as opposed to something else) for a
number of reasons:
* A number of external tools can make use of our tracepoints
"automatically" (e.g. perf, systemtap)
* Tracepoints are designed to be extremely cheap when disabled
* It's one of the "accepted" ways to export this kind of
information; many other kernel subsystems use tracepoints too.
Unfortunately, though, there are a few caveats as well:
* Linux tracepoints appear to only be available to GPL licensed
modules due to the way certain kernel functions are exported.
Thus, to actually make use of the tracepoints introduced by this
patch, one might have to patch and re-compile the kernel;
exporting the necessary functions to non-GPL modules.
* Prior to upstream kernel version v3.14-rc6-30-g66cc69e, Linux
tracepoints are not available for unsigned kernel modules
(tracepoints will get disabled due to the module's 'F' taint).
Thus, one either has to sign the zfs kernel module prior to
loading it, or use a kernel versioned v3.14-rc6-30-g66cc69e or
newer.
Assuming the above two requirements are satisfied, lets look at an
example of how this patch can be used and what information it exposes
(all commands run as 'root'):
# list all zfs tracepoints available
$ ls /sys/kernel/debug/tracing/events/zfs
enable filter zfs_arc__delete
zfs_arc__evict zfs_arc__hit zfs_arc__miss
zfs_l2arc__evict zfs_l2arc__hit zfs_l2arc__iodone
zfs_l2arc__miss zfs_l2arc__read zfs_l2arc__write
zfs_new_state__mfu zfs_new_state__mru
# enable all zfs tracepoints, clear the tracepoint ring buffer
$ echo 1 > /sys/kernel/debug/tracing/events/zfs/enable
$ echo 0 > /sys/kernel/debug/tracing/trace
# import zpool called 'tank', inspect tracepoint data (each line was
# truncated, they're too long for a commit message otherwise)
$ zpool import tank
$ cat /sys/kernel/debug/tracing/trace | head -n35
# tracer: nop
#
# entries-in-buffer/entries-written: 1219/1219 #P:8
#
# _-----=> irqs-off
# / _----=> need-resched
# | / _---=> hardirq/softirq
# || / _--=> preempt-depth
# ||| / delay
# TASK-PID CPU# |||| TIMESTAMP FUNCTION
# | | | |||| | |
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss: hdr...
z_rd_int/0-30156 [003] .... 91344.200611: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201173: zfs_arc__miss: hdr...
z_rd_int/1-30157 [003] .... 91344.201756: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201795: zfs_arc__miss: hdr...
z_rd_int/2-30158 [003] .... 91344.202099: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202126: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202130: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202134: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202146: zfs_arc__miss: hdr...
z_rd_int/3-30159 [003] .... 91344.202457: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202484: zfs_arc__miss: hdr...
z_rd_int/4-30160 [003] .... 91344.202866: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202891: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203034: zfs_arc__miss: hdr...
z_rd_iss/1-30149 [001] .... 91344.203749: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.203789: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203878: zfs_arc__miss: hdr...
z_rd_iss/3-30151 [001] .... 91344.204315: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.204332: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204337: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204352: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204356: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204360: zfs_arc__hit: hdr ...
To highlight the kind of detailed information that is being exported
using this infrastructure, I've taken the first tracepoint line from the
output above and reformatted it such that it fits in 80 columns:
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss:
hdr {
dva 0x1:0x40082
birth 15491
cksum0 0x163edbff3a
flags 0x640
datacnt 1
type 1
size 2048
spa 3133524293419867460
state_type 0
access 0
mru_hits 0
mru_ghost_hits 0
mfu_hits 0
mfu_ghost_hits 0
l2_hits 0
refcount 1
} bp {
dva0 0x1:0x40082
dva1 0x1:0x3000e5
dva2 0x1:0x5a006e
cksum 0x163edbff3a:0x75af30b3dd6:0x1499263ff5f2b:0x288bd118815e00
lsize 2048
} zb {
objset 0
object 0
level -1
blkid 0
}
For the specific tracepoint shown here, 'zfs_arc__miss', data is
exported detailing the arc_buf_hdr_t (hdr), blkptr_t (bp), and
zbookmark_t (zb) that caused the ARC miss (down to the exact DVA!).
This kind of precise and detailed information can be extremely valuable
when trying to answer certain kinds of questions.
For anybody unfamiliar but looking to build on this, I found the XFS
source code along with the following three web links to be extremely
helpful:
* http://lwn.net/Articles/379903/
* http://lwn.net/Articles/381064/
* http://lwn.net/Articles/383362/
I should also node the more "boring" aspects of this patch:
* The ZFS_LINUX_COMPILE_IFELSE autoconf macro was modified to
support a sixth paramter. This parameter is used to populate the
contents of the new conftest.h file. If no sixth parameter is
provided, conftest.h will be empty.
* The ZFS_LINUX_TRY_COMPILE_HEADER autoconf macro was introduced.
This macro is nearly identical to the ZFS_LINUX_TRY_COMPILE macro,
except it has support for a fifth option that is then passed as
the sixth parameter to ZFS_LINUX_COMPILE_IFELSE.
These autoconf changes were needed to test the availability of the Linux
tracepoint macros. Due to the odd nature of the Linux tracepoint macro
API, a separate ".h" must be created (the path and filename is used
internally by the kernel's define_trace.h file).
* The HAVE_DECLARE_EVENT_CLASS autoconf macro was introduced. This
is to determine if we can safely enable the Linux tracepoint
functionality. We need to selectively disable the tracepoint code
due to the kernel exporting certain functions as GPL only. Without
this check, the build process will fail at link time.
In addition, the SET_ERROR macro was modified into a tracepoint as well.
To do this, the 'sdt.h' file was moved into the 'include/sys' directory
and now contains a userspace portion and a kernel space portion. The
dprintf and zfs_dbgmsg* interfaces are now implemented as tracepoint as
well.
Signed-off-by: Prakash Surya <surya1@llnl.gov>
Signed-off-by: Ned Bass <bass6@llnl.gov>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
2014-06-13 17:54:48 +00:00
|
|
|
m4_ifvaln([$1], [ZFS_LINUX_CONFTEST_C([$1])])
|
|
|
|
m4_ifvaln([$6], [ZFS_LINUX_CONFTEST_H([$6])], [ZFS_LINUX_CONFTEST_H([])])
|
Fake modpost stage for LINUX_COMPILE.
Currently, when building a test case, we're compiling an entire Linux
module from beginning to end. This includes the MODPOST stage, which
generates a "conftest.mod.c" file with some boilerplate module
declaration code.
This poses a problem when configuring for built-in on kernels which have
loadable module support disabled. In this case conftest.mod.c is
referencing disabled code, resulting in a compilation failure, thus
breaking the tests.
This patch fixes the issue by faking the modpost stage when the
--enable-linux-builtin option is provided. It does so by forcing the
modpost command to be /bin/true, and using an empty conftest.mod.c file.
The test module still compiles fine, although the result isn't loadable,
but we don't really care at this point.
Note it is important to preserve the modpost stage when building out of
tree. The ZFS_AC_KERNEL_BLK_END_REQUEST, ZFS_AC_KERNEL_BLK_QUEUE_FLUSH,
and ZFS_AC_KERNEL_BLK_RQ_BYTES configure checks all depend on it to
identify GPL-only symbols.
Signed-off-by: Prakash Surya <surya1@llnl.gov>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
Issue #851
2012-07-16 07:37:38 +00:00
|
|
|
rm -Rf build && mkdir -p build && touch build/conftest.mod.c
|
2010-08-26 18:22:58 +00:00
|
|
|
echo "obj-m := conftest.o" >build/Makefile
|
Fake modpost stage for LINUX_COMPILE.
Currently, when building a test case, we're compiling an entire Linux
module from beginning to end. This includes the MODPOST stage, which
generates a "conftest.mod.c" file with some boilerplate module
declaration code.
This poses a problem when configuring for built-in on kernels which have
loadable module support disabled. In this case conftest.mod.c is
referencing disabled code, resulting in a compilation failure, thus
breaking the tests.
This patch fixes the issue by faking the modpost stage when the
--enable-linux-builtin option is provided. It does so by forcing the
modpost command to be /bin/true, and using an empty conftest.mod.c file.
The test module still compiles fine, although the result isn't loadable,
but we don't really care at this point.
Note it is important to preserve the modpost stage when building out of
tree. The ZFS_AC_KERNEL_BLK_END_REQUEST, ZFS_AC_KERNEL_BLK_QUEUE_FLUSH,
and ZFS_AC_KERNEL_BLK_RQ_BYTES configure checks all depend on it to
identify GPL-only symbols.
Signed-off-by: Prakash Surya <surya1@llnl.gov>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
Issue #851
2012-07-16 07:37:38 +00:00
|
|
|
modpost_flag=''
|
|
|
|
test "x$enable_linux_builtin" = xyes && modpost_flag='modpost=true' # fake modpost stage
|
2010-08-26 18:22:58 +00:00
|
|
|
AS_IF(
|
Swap DTRACE_PROBE* with Linux tracepoints
This patch leverages Linux tracepoints from within the ZFS on Linux
code base. It also refactors the debug code to bring it back in sync
with Illumos.
The information exported via tracepoints can be used for a variety of
reasons (e.g. debugging, tuning, general exploration/understanding,
etc). It is advantageous to use Linux tracepoints as the mechanism to
export this kind of information (as opposed to something else) for a
number of reasons:
* A number of external tools can make use of our tracepoints
"automatically" (e.g. perf, systemtap)
* Tracepoints are designed to be extremely cheap when disabled
* It's one of the "accepted" ways to export this kind of
information; many other kernel subsystems use tracepoints too.
Unfortunately, though, there are a few caveats as well:
* Linux tracepoints appear to only be available to GPL licensed
modules due to the way certain kernel functions are exported.
Thus, to actually make use of the tracepoints introduced by this
patch, one might have to patch and re-compile the kernel;
exporting the necessary functions to non-GPL modules.
* Prior to upstream kernel version v3.14-rc6-30-g66cc69e, Linux
tracepoints are not available for unsigned kernel modules
(tracepoints will get disabled due to the module's 'F' taint).
Thus, one either has to sign the zfs kernel module prior to
loading it, or use a kernel versioned v3.14-rc6-30-g66cc69e or
newer.
Assuming the above two requirements are satisfied, lets look at an
example of how this patch can be used and what information it exposes
(all commands run as 'root'):
# list all zfs tracepoints available
$ ls /sys/kernel/debug/tracing/events/zfs
enable filter zfs_arc__delete
zfs_arc__evict zfs_arc__hit zfs_arc__miss
zfs_l2arc__evict zfs_l2arc__hit zfs_l2arc__iodone
zfs_l2arc__miss zfs_l2arc__read zfs_l2arc__write
zfs_new_state__mfu zfs_new_state__mru
# enable all zfs tracepoints, clear the tracepoint ring buffer
$ echo 1 > /sys/kernel/debug/tracing/events/zfs/enable
$ echo 0 > /sys/kernel/debug/tracing/trace
# import zpool called 'tank', inspect tracepoint data (each line was
# truncated, they're too long for a commit message otherwise)
$ zpool import tank
$ cat /sys/kernel/debug/tracing/trace | head -n35
# tracer: nop
#
# entries-in-buffer/entries-written: 1219/1219 #P:8
#
# _-----=> irqs-off
# / _----=> need-resched
# | / _---=> hardirq/softirq
# || / _--=> preempt-depth
# ||| / delay
# TASK-PID CPU# |||| TIMESTAMP FUNCTION
# | | | |||| | |
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss: hdr...
z_rd_int/0-30156 [003] .... 91344.200611: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201173: zfs_arc__miss: hdr...
z_rd_int/1-30157 [003] .... 91344.201756: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201795: zfs_arc__miss: hdr...
z_rd_int/2-30158 [003] .... 91344.202099: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202126: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202130: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202134: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202146: zfs_arc__miss: hdr...
z_rd_int/3-30159 [003] .... 91344.202457: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202484: zfs_arc__miss: hdr...
z_rd_int/4-30160 [003] .... 91344.202866: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202891: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203034: zfs_arc__miss: hdr...
z_rd_iss/1-30149 [001] .... 91344.203749: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.203789: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203878: zfs_arc__miss: hdr...
z_rd_iss/3-30151 [001] .... 91344.204315: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.204332: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204337: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204352: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204356: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204360: zfs_arc__hit: hdr ...
To highlight the kind of detailed information that is being exported
using this infrastructure, I've taken the first tracepoint line from the
output above and reformatted it such that it fits in 80 columns:
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss:
hdr {
dva 0x1:0x40082
birth 15491
cksum0 0x163edbff3a
flags 0x640
datacnt 1
type 1
size 2048
spa 3133524293419867460
state_type 0
access 0
mru_hits 0
mru_ghost_hits 0
mfu_hits 0
mfu_ghost_hits 0
l2_hits 0
refcount 1
} bp {
dva0 0x1:0x40082
dva1 0x1:0x3000e5
dva2 0x1:0x5a006e
cksum 0x163edbff3a:0x75af30b3dd6:0x1499263ff5f2b:0x288bd118815e00
lsize 2048
} zb {
objset 0
object 0
level -1
blkid 0
}
For the specific tracepoint shown here, 'zfs_arc__miss', data is
exported detailing the arc_buf_hdr_t (hdr), blkptr_t (bp), and
zbookmark_t (zb) that caused the ARC miss (down to the exact DVA!).
This kind of precise and detailed information can be extremely valuable
when trying to answer certain kinds of questions.
For anybody unfamiliar but looking to build on this, I found the XFS
source code along with the following three web links to be extremely
helpful:
* http://lwn.net/Articles/379903/
* http://lwn.net/Articles/381064/
* http://lwn.net/Articles/383362/
I should also node the more "boring" aspects of this patch:
* The ZFS_LINUX_COMPILE_IFELSE autoconf macro was modified to
support a sixth paramter. This parameter is used to populate the
contents of the new conftest.h file. If no sixth parameter is
provided, conftest.h will be empty.
* The ZFS_LINUX_TRY_COMPILE_HEADER autoconf macro was introduced.
This macro is nearly identical to the ZFS_LINUX_TRY_COMPILE macro,
except it has support for a fifth option that is then passed as
the sixth parameter to ZFS_LINUX_COMPILE_IFELSE.
These autoconf changes were needed to test the availability of the Linux
tracepoint macros. Due to the odd nature of the Linux tracepoint macro
API, a separate ".h" must be created (the path and filename is used
internally by the kernel's define_trace.h file).
* The HAVE_DECLARE_EVENT_CLASS autoconf macro was introduced. This
is to determine if we can safely enable the Linux tracepoint
functionality. We need to selectively disable the tracepoint code
due to the kernel exporting certain functions as GPL only. Without
this check, the build process will fail at link time.
In addition, the SET_ERROR macro was modified into a tracepoint as well.
To do this, the 'sdt.h' file was moved into the 'include/sys' directory
and now contains a userspace portion and a kernel space portion. The
dprintf and zfs_dbgmsg* interfaces are now implemented as tracepoint as
well.
Signed-off-by: Prakash Surya <surya1@llnl.gov>
Signed-off-by: Ned Bass <bass6@llnl.gov>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
2014-06-13 17:54:48 +00:00
|
|
|
[AC_TRY_COMMAND(cp conftest.c conftest.h build && make [$2] -C $LINUX_OBJ EXTRA_CFLAGS="-Werror $EXTRA_KCFLAGS" $ARCH_UM M=$PWD/build $modpost_flag) >/dev/null && AC_TRY_COMMAND([$3])],
|
2010-08-26 18:22:58 +00:00
|
|
|
[$4],
|
|
|
|
[_AC_MSG_LOG_CONFTEST m4_ifvaln([$5],[$5])]
|
|
|
|
)
|
|
|
|
rm -Rf build
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # ZFS_LINUX_TRY_COMPILE like AC_TRY_COMPILE
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_LINUX_TRY_COMPILE],
|
|
|
|
[ZFS_LINUX_COMPILE_IFELSE(
|
|
|
|
[AC_LANG_SOURCE([ZFS_LANG_PROGRAM([[$1]], [[$2]])])],
|
|
|
|
[modules],
|
|
|
|
[test -s build/conftest.o],
|
|
|
|
[$3], [$4])
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # ZFS_LINUX_CONFIG
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_LINUX_CONFIG],
|
|
|
|
[AC_MSG_CHECKING([whether Linux was built with CONFIG_$1])
|
|
|
|
ZFS_LINUX_TRY_COMPILE([
|
2011-07-22 21:10:38 +00:00
|
|
|
#include <linux/module.h>
|
2010-08-26 18:22:58 +00:00
|
|
|
],[
|
|
|
|
#ifndef CONFIG_$1
|
|
|
|
#error CONFIG_$1 not #defined
|
|
|
|
#endif
|
|
|
|
],[
|
|
|
|
AC_MSG_RESULT([yes])
|
|
|
|
$2
|
|
|
|
],[
|
|
|
|
AC_MSG_RESULT([no])
|
|
|
|
$3
|
|
|
|
])
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # ZFS_CHECK_SYMBOL_EXPORT
|
|
|
|
dnl # check symbol exported or not
|
|
|
|
dnl #
|
2012-07-25 21:38:58 +00:00
|
|
|
AC_DEFUN([ZFS_CHECK_SYMBOL_EXPORT], [
|
2010-08-26 18:22:58 +00:00
|
|
|
grep -q -E '[[[:space:]]]$1[[[:space:]]]' \
|
|
|
|
$LINUX_OBJ/$LINUX_SYMBOLS 2>/dev/null
|
|
|
|
rc=$?
|
2012-07-25 21:38:58 +00:00
|
|
|
if test $rc -ne 0; then
|
2010-08-26 18:22:58 +00:00
|
|
|
export=0
|
|
|
|
for file in $2; do
|
2012-07-25 21:38:58 +00:00
|
|
|
grep -q -E "EXPORT_SYMBOL.*($1)" \
|
|
|
|
"$LINUX/$file" 2>/dev/null
|
2010-08-26 18:22:58 +00:00
|
|
|
rc=$?
|
2012-07-25 21:38:58 +00:00
|
|
|
if test $rc -eq 0; then
|
2011-08-24 16:52:16 +00:00
|
|
|
export=1
|
|
|
|
break;
|
2012-07-25 21:38:58 +00:00
|
|
|
fi
|
2010-08-26 18:22:58 +00:00
|
|
|
done
|
2012-07-25 21:38:58 +00:00
|
|
|
if test $export -eq 0; then :
|
2010-08-26 18:22:58 +00:00
|
|
|
$4
|
2012-07-25 21:38:58 +00:00
|
|
|
else :
|
2010-08-26 18:22:58 +00:00
|
|
|
$3
|
2012-07-25 21:38:58 +00:00
|
|
|
fi
|
|
|
|
else :
|
2010-08-26 18:22:58 +00:00
|
|
|
$3
|
2012-07-25 21:38:58 +00:00
|
|
|
fi
|
|
|
|
])
|
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # ZFS_LINUX_TRY_COMPILE_SYMBOL
|
|
|
|
dnl # like ZFS_LINUX_TRY_COMPILE, except ZFS_CHECK_SYMBOL_EXPORT
|
|
|
|
dnl # is called if not compiling for builtin
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_LINUX_TRY_COMPILE_SYMBOL], [
|
|
|
|
ZFS_LINUX_TRY_COMPILE([$1], [$2], [rc=0], [rc=1])
|
|
|
|
if test $rc -ne 0; then :
|
|
|
|
$6
|
|
|
|
else
|
|
|
|
if test "x$enable_linux_builtin" != xyes; then
|
|
|
|
ZFS_CHECK_SYMBOL_EXPORT([$3], [$4], [rc=0], [rc=1])
|
|
|
|
fi
|
|
|
|
if test $rc -ne 0; then :
|
|
|
|
$6
|
|
|
|
else :
|
|
|
|
$5
|
|
|
|
fi
|
|
|
|
fi
|
2010-08-26 18:22:58 +00:00
|
|
|
])
|
Swap DTRACE_PROBE* with Linux tracepoints
This patch leverages Linux tracepoints from within the ZFS on Linux
code base. It also refactors the debug code to bring it back in sync
with Illumos.
The information exported via tracepoints can be used for a variety of
reasons (e.g. debugging, tuning, general exploration/understanding,
etc). It is advantageous to use Linux tracepoints as the mechanism to
export this kind of information (as opposed to something else) for a
number of reasons:
* A number of external tools can make use of our tracepoints
"automatically" (e.g. perf, systemtap)
* Tracepoints are designed to be extremely cheap when disabled
* It's one of the "accepted" ways to export this kind of
information; many other kernel subsystems use tracepoints too.
Unfortunately, though, there are a few caveats as well:
* Linux tracepoints appear to only be available to GPL licensed
modules due to the way certain kernel functions are exported.
Thus, to actually make use of the tracepoints introduced by this
patch, one might have to patch and re-compile the kernel;
exporting the necessary functions to non-GPL modules.
* Prior to upstream kernel version v3.14-rc6-30-g66cc69e, Linux
tracepoints are not available for unsigned kernel modules
(tracepoints will get disabled due to the module's 'F' taint).
Thus, one either has to sign the zfs kernel module prior to
loading it, or use a kernel versioned v3.14-rc6-30-g66cc69e or
newer.
Assuming the above two requirements are satisfied, lets look at an
example of how this patch can be used and what information it exposes
(all commands run as 'root'):
# list all zfs tracepoints available
$ ls /sys/kernel/debug/tracing/events/zfs
enable filter zfs_arc__delete
zfs_arc__evict zfs_arc__hit zfs_arc__miss
zfs_l2arc__evict zfs_l2arc__hit zfs_l2arc__iodone
zfs_l2arc__miss zfs_l2arc__read zfs_l2arc__write
zfs_new_state__mfu zfs_new_state__mru
# enable all zfs tracepoints, clear the tracepoint ring buffer
$ echo 1 > /sys/kernel/debug/tracing/events/zfs/enable
$ echo 0 > /sys/kernel/debug/tracing/trace
# import zpool called 'tank', inspect tracepoint data (each line was
# truncated, they're too long for a commit message otherwise)
$ zpool import tank
$ cat /sys/kernel/debug/tracing/trace | head -n35
# tracer: nop
#
# entries-in-buffer/entries-written: 1219/1219 #P:8
#
# _-----=> irqs-off
# / _----=> need-resched
# | / _---=> hardirq/softirq
# || / _--=> preempt-depth
# ||| / delay
# TASK-PID CPU# |||| TIMESTAMP FUNCTION
# | | | |||| | |
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss: hdr...
z_rd_int/0-30156 [003] .... 91344.200611: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201173: zfs_arc__miss: hdr...
z_rd_int/1-30157 [003] .... 91344.201756: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201795: zfs_arc__miss: hdr...
z_rd_int/2-30158 [003] .... 91344.202099: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202126: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202130: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202134: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202146: zfs_arc__miss: hdr...
z_rd_int/3-30159 [003] .... 91344.202457: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202484: zfs_arc__miss: hdr...
z_rd_int/4-30160 [003] .... 91344.202866: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202891: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203034: zfs_arc__miss: hdr...
z_rd_iss/1-30149 [001] .... 91344.203749: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.203789: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203878: zfs_arc__miss: hdr...
z_rd_iss/3-30151 [001] .... 91344.204315: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.204332: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204337: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204352: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204356: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204360: zfs_arc__hit: hdr ...
To highlight the kind of detailed information that is being exported
using this infrastructure, I've taken the first tracepoint line from the
output above and reformatted it such that it fits in 80 columns:
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss:
hdr {
dva 0x1:0x40082
birth 15491
cksum0 0x163edbff3a
flags 0x640
datacnt 1
type 1
size 2048
spa 3133524293419867460
state_type 0
access 0
mru_hits 0
mru_ghost_hits 0
mfu_hits 0
mfu_ghost_hits 0
l2_hits 0
refcount 1
} bp {
dva0 0x1:0x40082
dva1 0x1:0x3000e5
dva2 0x1:0x5a006e
cksum 0x163edbff3a:0x75af30b3dd6:0x1499263ff5f2b:0x288bd118815e00
lsize 2048
} zb {
objset 0
object 0
level -1
blkid 0
}
For the specific tracepoint shown here, 'zfs_arc__miss', data is
exported detailing the arc_buf_hdr_t (hdr), blkptr_t (bp), and
zbookmark_t (zb) that caused the ARC miss (down to the exact DVA!).
This kind of precise and detailed information can be extremely valuable
when trying to answer certain kinds of questions.
For anybody unfamiliar but looking to build on this, I found the XFS
source code along with the following three web links to be extremely
helpful:
* http://lwn.net/Articles/379903/
* http://lwn.net/Articles/381064/
* http://lwn.net/Articles/383362/
I should also node the more "boring" aspects of this patch:
* The ZFS_LINUX_COMPILE_IFELSE autoconf macro was modified to
support a sixth paramter. This parameter is used to populate the
contents of the new conftest.h file. If no sixth parameter is
provided, conftest.h will be empty.
* The ZFS_LINUX_TRY_COMPILE_HEADER autoconf macro was introduced.
This macro is nearly identical to the ZFS_LINUX_TRY_COMPILE macro,
except it has support for a fifth option that is then passed as
the sixth parameter to ZFS_LINUX_COMPILE_IFELSE.
These autoconf changes were needed to test the availability of the Linux
tracepoint macros. Due to the odd nature of the Linux tracepoint macro
API, a separate ".h" must be created (the path and filename is used
internally by the kernel's define_trace.h file).
* The HAVE_DECLARE_EVENT_CLASS autoconf macro was introduced. This
is to determine if we can safely enable the Linux tracepoint
functionality. We need to selectively disable the tracepoint code
due to the kernel exporting certain functions as GPL only. Without
this check, the build process will fail at link time.
In addition, the SET_ERROR macro was modified into a tracepoint as well.
To do this, the 'sdt.h' file was moved into the 'include/sys' directory
and now contains a userspace portion and a kernel space portion. The
dprintf and zfs_dbgmsg* interfaces are now implemented as tracepoint as
well.
Signed-off-by: Prakash Surya <surya1@llnl.gov>
Signed-off-by: Ned Bass <bass6@llnl.gov>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
2014-06-13 17:54:48 +00:00
|
|
|
|
|
|
|
dnl #
|
|
|
|
dnl # ZFS_LINUX_TRY_COMPILE_HEADER
|
|
|
|
dnl # like ZFS_LINUX_TRY_COMPILE, except the contents conftest.h are
|
|
|
|
dnl # provided via the fifth parameter
|
|
|
|
dnl #
|
|
|
|
AC_DEFUN([ZFS_LINUX_TRY_COMPILE_HEADER],
|
|
|
|
[ZFS_LINUX_COMPILE_IFELSE(
|
|
|
|
[AC_LANG_SOURCE([ZFS_LANG_PROGRAM([[$1]], [[$2]])])],
|
|
|
|
[modules],
|
|
|
|
[test -s build/conftest.o],
|
2014-12-15 21:53:00 +00:00
|
|
|
[$3], [$4], [$5])
|
Swap DTRACE_PROBE* with Linux tracepoints
This patch leverages Linux tracepoints from within the ZFS on Linux
code base. It also refactors the debug code to bring it back in sync
with Illumos.
The information exported via tracepoints can be used for a variety of
reasons (e.g. debugging, tuning, general exploration/understanding,
etc). It is advantageous to use Linux tracepoints as the mechanism to
export this kind of information (as opposed to something else) for a
number of reasons:
* A number of external tools can make use of our tracepoints
"automatically" (e.g. perf, systemtap)
* Tracepoints are designed to be extremely cheap when disabled
* It's one of the "accepted" ways to export this kind of
information; many other kernel subsystems use tracepoints too.
Unfortunately, though, there are a few caveats as well:
* Linux tracepoints appear to only be available to GPL licensed
modules due to the way certain kernel functions are exported.
Thus, to actually make use of the tracepoints introduced by this
patch, one might have to patch and re-compile the kernel;
exporting the necessary functions to non-GPL modules.
* Prior to upstream kernel version v3.14-rc6-30-g66cc69e, Linux
tracepoints are not available for unsigned kernel modules
(tracepoints will get disabled due to the module's 'F' taint).
Thus, one either has to sign the zfs kernel module prior to
loading it, or use a kernel versioned v3.14-rc6-30-g66cc69e or
newer.
Assuming the above two requirements are satisfied, lets look at an
example of how this patch can be used and what information it exposes
(all commands run as 'root'):
# list all zfs tracepoints available
$ ls /sys/kernel/debug/tracing/events/zfs
enable filter zfs_arc__delete
zfs_arc__evict zfs_arc__hit zfs_arc__miss
zfs_l2arc__evict zfs_l2arc__hit zfs_l2arc__iodone
zfs_l2arc__miss zfs_l2arc__read zfs_l2arc__write
zfs_new_state__mfu zfs_new_state__mru
# enable all zfs tracepoints, clear the tracepoint ring buffer
$ echo 1 > /sys/kernel/debug/tracing/events/zfs/enable
$ echo 0 > /sys/kernel/debug/tracing/trace
# import zpool called 'tank', inspect tracepoint data (each line was
# truncated, they're too long for a commit message otherwise)
$ zpool import tank
$ cat /sys/kernel/debug/tracing/trace | head -n35
# tracer: nop
#
# entries-in-buffer/entries-written: 1219/1219 #P:8
#
# _-----=> irqs-off
# / _----=> need-resched
# | / _---=> hardirq/softirq
# || / _--=> preempt-depth
# ||| / delay
# TASK-PID CPU# |||| TIMESTAMP FUNCTION
# | | | |||| | |
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss: hdr...
z_rd_int/0-30156 [003] .... 91344.200611: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201173: zfs_arc__miss: hdr...
z_rd_int/1-30157 [003] .... 91344.201756: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.201795: zfs_arc__miss: hdr...
z_rd_int/2-30158 [003] .... 91344.202099: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202126: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202130: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202134: zfs_arc__hit: hdr ...
lt-zpool-30132 [003] .... 91344.202146: zfs_arc__miss: hdr...
z_rd_int/3-30159 [003] .... 91344.202457: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202484: zfs_arc__miss: hdr...
z_rd_int/4-30160 [003] .... 91344.202866: zfs_new_state__mru...
lt-zpool-30132 [003] .... 91344.202891: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203034: zfs_arc__miss: hdr...
z_rd_iss/1-30149 [001] .... 91344.203749: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.203789: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.203878: zfs_arc__miss: hdr...
z_rd_iss/3-30151 [001] .... 91344.204315: zfs_new_state__mru...
lt-zpool-30132 [001] .... 91344.204332: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204337: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204352: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204356: zfs_arc__hit: hdr ...
lt-zpool-30132 [001] .... 91344.204360: zfs_arc__hit: hdr ...
To highlight the kind of detailed information that is being exported
using this infrastructure, I've taken the first tracepoint line from the
output above and reformatted it such that it fits in 80 columns:
lt-zpool-30132 [003] .... 91344.200050: zfs_arc__miss:
hdr {
dva 0x1:0x40082
birth 15491
cksum0 0x163edbff3a
flags 0x640
datacnt 1
type 1
size 2048
spa 3133524293419867460
state_type 0
access 0
mru_hits 0
mru_ghost_hits 0
mfu_hits 0
mfu_ghost_hits 0
l2_hits 0
refcount 1
} bp {
dva0 0x1:0x40082
dva1 0x1:0x3000e5
dva2 0x1:0x5a006e
cksum 0x163edbff3a:0x75af30b3dd6:0x1499263ff5f2b:0x288bd118815e00
lsize 2048
} zb {
objset 0
object 0
level -1
blkid 0
}
For the specific tracepoint shown here, 'zfs_arc__miss', data is
exported detailing the arc_buf_hdr_t (hdr), blkptr_t (bp), and
zbookmark_t (zb) that caused the ARC miss (down to the exact DVA!).
This kind of precise and detailed information can be extremely valuable
when trying to answer certain kinds of questions.
For anybody unfamiliar but looking to build on this, I found the XFS
source code along with the following three web links to be extremely
helpful:
* http://lwn.net/Articles/379903/
* http://lwn.net/Articles/381064/
* http://lwn.net/Articles/383362/
I should also node the more "boring" aspects of this patch:
* The ZFS_LINUX_COMPILE_IFELSE autoconf macro was modified to
support a sixth paramter. This parameter is used to populate the
contents of the new conftest.h file. If no sixth parameter is
provided, conftest.h will be empty.
* The ZFS_LINUX_TRY_COMPILE_HEADER autoconf macro was introduced.
This macro is nearly identical to the ZFS_LINUX_TRY_COMPILE macro,
except it has support for a fifth option that is then passed as
the sixth parameter to ZFS_LINUX_COMPILE_IFELSE.
These autoconf changes were needed to test the availability of the Linux
tracepoint macros. Due to the odd nature of the Linux tracepoint macro
API, a separate ".h" must be created (the path and filename is used
internally by the kernel's define_trace.h file).
* The HAVE_DECLARE_EVENT_CLASS autoconf macro was introduced. This
is to determine if we can safely enable the Linux tracepoint
functionality. We need to selectively disable the tracepoint code
due to the kernel exporting certain functions as GPL only. Without
this check, the build process will fail at link time.
In addition, the SET_ERROR macro was modified into a tracepoint as well.
To do this, the 'sdt.h' file was moved into the 'include/sys' directory
and now contains a userspace portion and a kernel space portion. The
dprintf and zfs_dbgmsg* interfaces are now implemented as tracepoint as
well.
Signed-off-by: Prakash Surya <surya1@llnl.gov>
Signed-off-by: Ned Bass <bass6@llnl.gov>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
2014-06-13 17:54:48 +00:00
|
|
|
])
|