#!/bin/ksh -p
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#

#
# Copyright (c) 2012 by Delphix. All rights reserved.
#

. $STF_SUITE/include/libtest.shlib

#
# DESCRIPTION:
# With ZFS_ABORT set, all zfs commands should be able to abort and generate a
# core file.
#
# STRATEGY:
# 1. Create an array of zfs command
# 2. Execute each command in the array
# 3. Verify the command aborts and generate a core file
#

verify_runnable "both"

function cleanup
{
	unset ZFS_ABORT

	if [[ -d $corepath ]]; then
		$RM -rf $corepath
	fi
	for ds in $fs1 $fs $ctr; do
		destroy_dataset -rRf $ds
	done
	if [[ -n "$LINUX" && -n "$def_cor_pat" ]]; then
		echo "$def_cor_pat" > /proc/sys/kernel/core_pattern
		echo "$def_cor_suid" > /proc/sys/fs/suid_dumpable
		ulimit -c $ulimit
	fi
}

log_assert "With ZFS_ABORT set, all zfs commands can abort and generate a " \
    "core file."
log_onexit cleanup

#preparation work for testing
if [[ -n "$OSX" ]]; then
    corepath=~/Library/Logs/DiagnosticReports
else
    corepath=$TESTDIR/core
    if [[ -d $corepath ]]; then
        $RM -rf $corepath
    fi
    log_must $MKDIR $corepath
fi

ctr=$TESTPOOL/$TESTCTR
log_must $ZFS create $ctr

fs=$ctr/$TESTFS
fs1=$ctr/$TESTFS1
snap=$fs@$TESTSNAP
clone=$ctr/$TESTCLONE
streamf=$corepath/s.$$

#
# This test needs updating. The abort feature does work, the output
# is in ~/Library/Logs/DiagnosticReports/
#
# zfs_2015-06-13-091154_fatmac-2.crash is an example
#

typeset cmds=("create $fs" "list $fs" "snapshot $snap" "set snapdir=hidden $fs" \
    "get snapdir $fs" "rollback $snap" "inherit snapdir $fs" \
    "rename $fs $fs-new" "rename $fs-new $fs" "unmount $fs" \
    "mount $fs" "share $fs" "unshare $fs" "send $snap \>$streamf" \
    "receive $fs1 \<$streamf" "clone $snap $clone" "promote $clone" \
    "promote $fs" "destroy -rRf $fs")

typeset badparams=("" "create" "destroy" "snapshot" "rollback" "clone" \
    "promote" "rename" "list -*" "set" "get -*" "inherit" "mount -A" \
    "unmount" "share" "unshare" "send" "receive")

if [[ -n "$LINUX" && -f "/proc/sys/kernel/core_pattern" ]]; then
	# NOTE: This file is only provided if the kernel was built
	#       with the CONFIG_ELF_CORE configuration option
	typeset def_cor_pat=$(cat /proc/sys/kernel/core_pattern)
	typeset def_cor_suid=$(cat /proc/sys/fs/suid_dumpable)
	typeset ulimit=$(ulimit -c)
	echo "${corepath}/core.%e" > /proc/sys/kernel/core_pattern
	ulimit -c unlimited
elif [[ -n "$OSX" ]]; then
    log_note "no core path control on OSX"
else
	log_must $COREADM -p ${corepath}/core.%f
fi
log_must export ZFS_ABORT=yes

if [[ -n "$OSX" ]]; then
    for subcmd in "${cmds[@]}" "${badparams[@]}"; do

        typeset -i num_cores_before=`ls -l ${corepath} | grep $ZFS | wc -l`

        $ZFS $subcmd >/dev/null 2>&1 && log_fail "$subcmd passed incorrectly."

        typeset -i num_cores_after=`ls -l ${corepath} | grep $ZFS | wc -l`

        if [[ num_cores_before == num_cores_after ]]; then
            log_fail "$ZFS $subcmd cannot generate core file with " \
            "ZFS_ABORT set."
        fi
    done
else
    for subcmd in "${cmds[@]}" "${badparams[@]}"; do
        $ZFS $subcmd >/dev/null 2>&1 && log_fail "$subcmd passed incorrectly."
        corefile=${corepath}/core.zfs
        if [[ ! -e $corefile ]]; then
            log_fail "$ZFS $subcmd cannot generate core file with " \
                "ZFS_ABORT set."
        fi
        log_must $RM -f $corefile
    done
fi

log_pass "With ZFS_ABORT set, zfs command can abort and generate core file " \
    "as expected."
