2 # SPDX-License-Identifier: GPL-2.0
3 # Copyright (c) 2015 Facebook, Inc. All Rights Reserved.
5 # common functions for setting up and tearing down a dm log-writes device
9 [ -z "$LOGWRITES_DEV" -o ! -b "$LOGWRITES_DEV" ] && \
10 _notrun "This test requires a valid \$LOGWRITES_DEV"
12 _exclude_scratch_mount_option dax
13 _require_dm_target log-writes
14 _require_test_program "log-writes/replay-log"
17 # Starting from v4.15-rc1, DAX support was added to dm-log-writes, but note
18 # that it doesn't track the data that we write via the mmap(), so we can't do
19 # any data integrity checking. We can only verify that the metadata writes for
20 # the page faults happened, e.g. when mmap(2) with MAP_SYNC flag.
22 # Introduce a new helper to check if dm-log-writes target supports DAX
23 # explicitly. But this is considered as a temporary workaround, we want to move
24 # all the DAX check back to _require_log_writes when dm-log-writes gains full
25 # DAX support and remove this helper.
26 _require_log_writes_dax()
28 [ -z "$LOGWRITES_DEV" -o ! -b "$LOGWRITES_DEV" ] && \
29 _notrun "This test requires a valid \$LOGWRITES_DEV"
31 _require_dm_target log-writes
32 _require_test_program "log-writes/replay-log"
36 _log_writes_mkfs > /dev/null 2>&1
37 _log_writes_mount -o dax > /dev/null 2>&1
38 # Check options to be sure. XFS ignores dax option
39 # and goes on if dev underneath does not support dax.
40 _fs_options $LOGWRITES_DMDEV | grep -qw "dax"
43 if [ $ret -ne 0 ]; then
44 _notrun "$LOGWRITES_DMDEV $FSTYP does not support -o dax"
50 local BLK_DEV_SIZE=`blockdev --getsz $SCRATCH_DEV`
51 LOGWRITES_NAME=logwrites-test
52 LOGWRITES_DMDEV=/dev/mapper/$LOGWRITES_NAME
53 LOGWRITES_TABLE="0 $BLK_DEV_SIZE log-writes $SCRATCH_DEV $LOGWRITES_DEV"
54 $DMSETUP_PROG create $LOGWRITES_NAME --table "$LOGWRITES_TABLE" || \
55 _fail "failed to create log-writes device"
56 $DMSETUP_PROG mknodes > /dev/null 2>&1
61 [ $# -ne 1 ] && _fail "_log_writes_mark takes one argument"
62 $DMSETUP_PROG message $LOGWRITES_NAME 0 mark $1
68 _mkfs_dev $SCRATCH_OPTIONS $LOGWRITES_DMDEV
74 _scratch_options mount
75 $MOUNT_PROG -t $FSTYP `_common_dev_mount_options $*` $SCRATCH_OPTIONS \
76 $LOGWRITES_DMDEV $SCRATCH_MNT
81 $UMOUNT_PROG $SCRATCH_MNT
84 # _log_writes_replay_log <mark>
86 # This replays the log contained on $LOGWRITES_DEV onto $SCRATCH_DEV upto the
88 _log_writes_replay_log()
92 $here/src/log-writes/replay-log --log $LOGWRITES_DEV --find \
93 --end-mark $_mark >> $seqres.full 2>&1
94 [ $? -ne 0 ] && _fail "mark '$_mark' does not exist"
96 $here/src/log-writes/replay-log --log $LOGWRITES_DEV --replay $SCRATCH_DEV \
97 --end-mark $_mark >> $seqres.full 2>&1
98 [ $? -ne 0 ] && _fail "replay failed"
103 $DMSETUP_PROG remove $LOGWRITES_NAME > /dev/null 2>&1
104 $DMSETUP_PROG mknodes > /dev/null 2>&1
107 _log_writes_cleanup()
109 $UMOUNT_PROG $SCRATCH_MNT > /dev/null 2>&1
110 # wait for device to be fully settled so that 'dmsetup remove' doesn't
112 $UDEV_SETTLE_PROG >/dev/null 2>&1
116 # Convert log writes mark to entry number
117 # Result entry number is output to stdout, could be empty if not found
118 _log_writes_mark_to_entry_number()
123 [ -z "$mark" ] && _fatal \
124 "mark must be given for _log_writes_mark_to_entry_number"
126 ret=$($here/src/log-writes/replay-log --find --log $LOGWRITES_DEV \
127 --end-mark $mark 2> /dev/null)
128 [ -z "$ret" ] && return
129 ret=$(echo "$ret" | cut -f1 -d\@)
130 echo "mark $mark has entry number $ret" >> $seqres.full
134 # Find next fua write entry number
135 # Result entry number is output to stdout, could be empty if not found
136 _log_writes_find_next_fua()
141 [ -z "$start_entry" ] && start_entry=0
142 ret=$($here/src/log-writes/replay-log --find --log $LOGWRITES_DEV \
143 --next-fua --start-entry $start_entry 2> /dev/null)
144 [ -z "$ret" ] && return
146 # Result should be something like "1024@offset" where 1024 is the
147 # entry number we need
148 ret=$(echo "$ret" | cut -f1 -d\@)
149 echo "next fua is entry number $ret" >> $seqres.full
153 # Replay log range to specified entry
154 # $1: End entry. The entry with this number *WILL* be replayed
155 _log_writes_replay_log_range()
159 [ -z "$end" ] && _fail \
160 "end entry must be specified for _log_writes_replay_log_range"
162 # To ensure we replay the last entry,
163 # we need to manually increase the end entry number to ensure
165 echo "=== replay to $end ===" >> $seqres.full
166 $here/src/log-writes/replay-log --log $LOGWRITES_DEV \
167 --replay $SCRATCH_DEV --limit $(($end + 1)) \
169 [ $? -ne 0 ] && _fail "replay failed"