/*

 * validate_arm.c - validate ARM event tables + encodings

 *

 * 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 <stdio.h>

#include <stdlib.h>

#include <inttypes.h>

#include <stdarg.h>

#include <errno.h>

#include <unistd.h>

#include <string.h>

#include <perfmon/pfmlib.h>

#define MAX_ENCODING	1

#define SRC_LINE	.line = __LINE__

typedef struct {

	const char *name;

	const char *fstr;

	uint64_t codes[MAX_ENCODING];

	int ret, count, line;

} test_event_t;

static const test_event_t arm_test_events[]={

	{ SRC_LINE,

	  .name = "arm_ac7::CPU_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000011,

	  .fstr = "arm_ac7::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac7::CPU_CYCLES:k",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x88000011,

	  .fstr = "arm_ac7::CPU_CYCLES:k=1:u=0:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac7::CPU_CYCLES:k:u",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000011,

	  .fstr = "arm_ac7::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac7::INST_RETIRED",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000008,

	  .fstr = "arm_ac7::INST_RETIRED:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac8::NEON_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x5a,

	  .fstr = "arm_ac8::NEON_CYCLES",

	},

	{ SRC_LINE,

	  .name = "arm_ac8::NEON_CYCLES:k",

	  .ret  = PFM_ERR_ATTR,

	},

	{ SRC_LINE,

	  .name = "arm_ac8::CPU_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0xff,

	  .fstr = "arm_ac8::CPU_CYCLES",

	},

	{ SRC_LINE,

	  .name = "arm_ac8::CPU_CYCLES_HALTED",

	  .ret  = PFM_ERR_NOTFOUND,

	},

	{ SRC_LINE,

	  .name = "arm_ac9::CPU_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0xff,

	  .fstr = "arm_ac9::CPU_CYCLES",

	},

	{ SRC_LINE,

	  .name = "arm_ac9::DMB_DEP_STALL_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x86,

	  .fstr = "arm_ac9::DMB_DEP_STALL_CYCLES",

	},

	{ SRC_LINE,

	  .name = "arm_ac9::CPU_CYCLES:u",

	  .ret  = PFM_ERR_ATTR,

	},

	{ SRC_LINE,

	  .name = "arm_ac9::JAVA_HW_BYTECODE_EXEC",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x40,

	  .fstr = "arm_ac9::JAVA_HW_BYTECODE_EXEC",

	},

	{ SRC_LINE,

	  .name = "arm_ac15::CPU_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000011,

	  .fstr = "arm_ac15::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac15::CPU_CYCLES:k",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x88000011,

	  .fstr = "arm_ac15::CPU_CYCLES:k=1:u=0:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac15::CPU_CYCLES:k:u",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000011,

	  .fstr = "arm_ac15::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac15::INST_RETIRED",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000008,

	  .fstr = "arm_ac15::INST_RETIRED:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_1176::CPU_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0xff,

	  .fstr = "arm_1176::CPU_CYCLES",

	},

	{ SRC_LINE,

	  .name = "arm_1176::CPU_CYCLES:k",

	  .ret  = PFM_ERR_ATTR,

	},

	{ SRC_LINE,

	  .name = "arm_1176::INSTR_EXEC",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x07,

	  .fstr = "arm_1176::INSTR_EXEC",

	},

	{ SRC_LINE,

	  .name = "qcom_krait::CPU_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x80000ff,

	  .fstr = "qcom_krait::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "qcom_krait::CPU_CYCLES:k:u",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x80000ff,

	  .fstr = "qcom_krait::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "qcom_krait::CPU_CYCLES:u",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x480000ff,

	  .fstr = "qcom_krait::CPU_CYCLES:k=0:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac57::CPU_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000011,

	  .fstr = "arm_ac57::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac57::CPU_CYCLES:k",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x88000011,

	  .fstr = "arm_ac57::CPU_CYCLES:k=1:u=0:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac57::CPU_CYCLES:k:u",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000011,

	  .fstr = "arm_ac57::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac57::INST_RETIRED",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000008,

	  .fstr = "arm_ac57::INST_RETIRED:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac53::CPU_CYCLES",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000011,

	  .fstr = "arm_ac53::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac53::CPU_CYCLES:k",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x88000011,

	  .fstr = "arm_ac53::CPU_CYCLES:k=1:u=0:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac53::CPU_CYCLES:k:u",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000011,

	  .fstr = "arm_ac53::CPU_CYCLES:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac53::INST_RETIRED",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000008,

	  .fstr = "arm_ac53::INST_RETIRED:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac53::LD_RETIRED",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000006,

	  .fstr = "arm_ac53::LD_RETIRED:k=1:u=1:hv=0",

	},

	{ SRC_LINE,

	  .name = "arm_ac53::ST_RETIRED",

	  .ret  = PFM_SUCCESS,

	  .count = 1,

	  .codes[0] = 0x8000007,

	  .fstr = "arm_ac53::ST_RETIRED:k=1:u=1:hv=0",

	},

};

#define NUM_TEST_EVENTS (int)(sizeof(arm_test_events)/sizeof(test_event_t))

static int check_test_events(FILE *fp)

{

	const test_event_t *e;

	char *fstr;

	uint64_t *codes;

	int count, i, j;

	int ret, errors = 0;

	for (i = 0, e = arm_test_events; i < NUM_TEST_EVENTS; i++, e++) {

		codes = NULL;

		count = 0;

		fstr = NULL;

		ret = pfm_get_event_encoding(e->name, PFM_PLM0 | PFM_PLM3, &fstr, NULL, &codes, &count);

		if (ret != e->ret) {

			fprintf(fp,"Event%d %s, ret=%s(%d) expected %s(%d)\n", i, e->name, pfm_strerror(ret), ret, pfm_strerror(e->ret), e->ret);

			errors++;

		} else {

			if (ret != PFM_SUCCESS) {

				if (fstr) {

					fprintf(fp,"Event%d %s, expected fstr NULL but it is not\n", i, e->name);

					errors++;

				}

				if (count != 0) {

					fprintf(fp,"Event%d %s, expected count=0 instead of %d\n", i, e->name, count);

					errors++;

				}

				if (codes) {

					fprintf(fp,"Event%d %s, expected codes[] NULL but it is not\n", i, e->name);

					errors++;

				}

			} else {

				if (count != e->count) {

					fprintf(fp,"Event%d %s, count=%d expected %d\n", i, e->name, count, e->count);

					errors++;

				}

				for (j=0; j < count; j++) {

					if (codes[j] != e->codes[j]) {

						fprintf(fp,"Event%d %s, codes[%d]=%#"PRIx64" expected %#"PRIx64"\n", i, e->name, j, codes[j], e->codes[j]);

						errors++;

					}

				}

				if (e->fstr && strcmp(fstr, e->fstr)) {

					fprintf(fp,"Event%d %s, fstr=%s expected %s\n", i, e->name, fstr, e->fstr);

					errors++;

				}

			}

		}

		if (codes)

			free(codes);

		if (fstr)

			free(fstr);

	}

	printf("\t %d ARM events: %d errors\n", i, errors);

	return errors;

}

int

validate_arch(FILE *fp)

{

	return check_test_events(fp);

}