/*
 * pfmlib_arm_perf_event.c : perf_event ARM functions
 *
 * Copyright (c) 2011 Google, Inc
 * Contributed by Stephane Eranian <eranian@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#include <sys/types.h>
#include <string.h>
#include <stdlib.h>

/* private headers */
#include "pfmlib_priv.h"		/* library private */
#include "pfmlib_arm_priv.h"
#include "pfmlib_perf_event_priv.h"

int
pfm_arm_get_perf_encoding(void *this, pfmlib_event_desc_t *e)
{
	pfmlib_pmu_t *pmu = this;
	pfm_arm_reg_t reg;
	struct perf_event_attr *attr = e->os_data;
	int type;
	int ret;

	if (!pmu->get_event_encoding[PFM_OS_NONE])
		return PFM_ERR_NOTSUPP;

	/*
	 * use generic raw encoding function first
	 */
	ret = pmu->get_event_encoding[PFM_OS_NONE](this, e);
	if (ret != PFM_SUCCESS)
		return ret;

	if (e->count > 1) {
		DPRINT("unsupported count=%d\n", e->count);
		return PFM_ERR_NOTSUPP;
	}
	/*
	 * To eliminate the issue of PERF_TYPE_RAW not working
	 * for hybrid because the attr needs to encode the actual
	 * PMU type, then we simply extract the actual PMU type
	 * from sysfs.
	 */
	if (pfm_perf_find_pmu_type(pmu, &type) != PFM_SUCCESS) {
		DPRINT("cannot determine PMU type for %s\n", pmu->name);
		return PFM_ERR_NOTSUPP;
	}
	attr->type = type;
	reg.val = e->codes[0];
	/*
	 * suppress the bits which are under the control of perf_events.
	 * Recent version of the Linux perf tools may warn if bits which
	 * should not be set by users are set. To avoid the warning,
	 * clear the bits, they are overwritten by the kernel anyway.
	 */
	reg.evtsel.excl_pl1 = 0;
	reg.evtsel.excl_usr = 0;
	reg.evtsel.excl_hyp = 0;

	attr->config = reg.val;
	return PFM_SUCCESS;
}

void
pfm_arm_perf_validate_pattrs(void *this, pfmlib_event_desc_t *e)
{
	int i, compact;

	for (i = 0; i < e->npattrs; i++) {
		compact = 0;

		/* umasks never conflict */
		if (e->pattrs[i].type == PFM_ATTR_UMASK)
			continue;

		/*
		 * with perf_events, u and k, hv are handled at the OS
		 * level via attr.exclude_* fields
		 */
		if (arm_has_plm(this, e) && e->pattrs[i].ctrl == PFM_ATTR_CTRL_PMU) {
			if (   e->pattrs[i].idx == ARM_ATTR_U
			    || e->pattrs[i].idx == ARM_ATTR_K
			    || e->pattrs[i].idx == ARM_ATTR_HV)
				compact = 1;
		}
		if (e->pattrs[i].ctrl == PFM_ATTR_CTRL_PERF_EVENT) {
			if (e->pattrs[i].idx == PERF_ATTR_PR)
				compact = 1;
		}
		/* hardware sampling not supported */
		if (e->pattrs[i].idx == PERF_ATTR_HWS)
			compact = 1;

		if (compact) {
			pfmlib_compact_pattrs(e, i);
			i--;
		}
	}
}
