src/cpus/generate_head.c

/*
 *  Copyright (C) 2005-2006  Anders Gavare.  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *
 *
 *  $Id: generate_head.c,v 1.17 2006/06/24 21:47:23 debug Exp $
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>


/*  NOTE:  Static return buffer, so calling it multiple times in the
        same printf statement with the same argument works :-)  but not
        with different args. Hahaha. Really ugly.  */
char *uppercase(char *l)
{
        static char staticbuf[1000];
        size_t i = 0;

        while (*l && i < sizeof(staticbuf)) {
                char u = *l++;
                if (u >= 'a' && u <= 'z')
                        u -= 32;
                staticbuf[i++] = u;
        }
        if (i == sizeof(staticbuf))
                i--;
        staticbuf[i] = 0;
        return staticbuf;
}


int main(int argc, char *argv[])
{
        char *a, *b;

        if (argc != 3) {
                fprintf(stderr, "usage: %s arch Arch\n", argv[0]);
                fprintf(stderr, "Example: %s alpha Alpha\n", argv[0]);
                fprintf(stderr, "     or: %s arm ARM\n", argv[0]);
                exit(1);
        }

        a = argv[1];
        b = argv[2];


        printf("\n/*  AUTOMATICALLY GENERATED! Do not edit.  */\n\n");

        printf("#include <assert.h>\n");
        printf("#include \"debugger.h\"\n");

        printf("#define DYNTRANS_MAX_VPH_TLB_ENTRIES "
            "%s_MAX_VPH_TLB_ENTRIES\n", uppercase(a));
        printf("#define DYNTRANS_ARCH %s\n", a);
        printf("#define DYNTRANS_%s\n", uppercase(a));

        /*  For 64-bit platforms, arch_L2N, and arch_L3N must be defined.  */
        printf("#ifndef DYNTRANS_32\n");
        printf("#define DYNTRANS_L2N %s_L2N\n"
            "#define DYNTRANS_L3N %s_L3N\n"
            "#if !defined(%s_L2N) || !defined(%s_L3N)\n"
            "#error arch_L2N, and arch_L3N must be defined for this arch!\n"
            "#endif\n",
            uppercase(a), uppercase(a), uppercase(a), uppercase(a));
        printf("#define DYNTRANS_L2_64_TABLE %s_l2_64_table\n"
            "#define DYNTRANS_L3_64_TABLE %s_l3_64_table\n", a, a);
        printf("#endif\n");

        /*  Default pagesize is 4KB.  */
        printf("#ifndef DYNTRANS_PAGESIZE\n"
            "#define DYNTRANS_PAGESIZE 4096\n"
            "#endif\n");

        printf("#define DYNTRANS_IC %s_instr_call\n", a);
        printf("#define DYNTRANS_IC_ENTRIES_PER_PAGE "
            "%s_IC_ENTRIES_PER_PAGE\n", uppercase(a));
        printf("#define DYNTRANS_INSTR_ALIGNMENT_SHIFT "
            "%s_INSTR_ALIGNMENT_SHIFT\n", uppercase(a));
        printf("#define DYNTRANS_TC_PHYSPAGE %s_tc_physpage\n", a);
        printf("#define DYNTRANS_INVALIDATE_TLB_ENTRY "
            "%s_invalidate_tlb_entry\n", a);
        printf("#define DYNTRANS_ADDR_TO_PAGENR %s_ADDR_TO_PAGENR\n",
            uppercase(a));
        printf("#define DYNTRANS_PC_TO_IC_ENTRY %s_PC_TO_IC_ENTRY\n",
            uppercase(a));
        printf("#define DYNTRANS_TC_ALLOCATE "
            "%s_tc_allocate_default_page\n", a);
        printf("#define DYNTRANS_TC_PHYSPAGE %s_tc_physpage\n", a);
        printf("#define DYNTRANS_PC_TO_POINTERS %s_pc_to_pointers\n", a);
        printf("#define DYNTRANS_PC_TO_POINTERS_GENERIC "
            "%s_pc_to_pointers_generic\n", a);
        printf("#define COMBINE_INSTRUCTIONS %s_combine_instructions\n", a);
        printf("#define DISASSEMBLE %s_cpu_disassemble_instr\n", a);

        printf("\nextern volatile int single_step, single_step_breakpoint;"
            "\nextern int debugger_n_steps_left_before_interaction;\n"
            "extern int old_show_trace_tree;\n"
            "extern int old_instruction_trace;\n"
            "extern int old_quiet_mode;\n"
            "extern int quiet_mode;\n");

        printf("\n/* instr uses the same names as in "
            "cpu_%s_instr.c */\n#define instr(n) %s_instr_ ## n\n\n", a, a);

        printf("#ifdef DYNTRANS_DUALMODE_32\n"
            "#define instr32(n) %s32_instr_ ## n\n\n", a);
        printf("#endif\n\n");

        printf("/*  This is for marking a physical page as containing"
            "\n    combined instructions:  */\n");
        printf("#define combined (cpu->cd.%s.cur_physpage->flags "
            "|= COMBINATIONS)\n", a);

        printf("\n#define X(n) void %s_instr_ ## n(struct cpu *cpu, \\\n"
            " struct %s_instr_call *ic)\n", a, a);

        printf("\n/*\n *  nothing:  Do nothing.\n *\n"
            " *  The difference between this function and a \"nop\" "
            "instruction is that\n *  this function does not increase "
            "the program counter or the number of\n *  translated "
            "instructions.  It is used to \"get out\" of running in "
            "translated\n *  mode.\n *\n"
            " *  IMPORTANT NOTE: Do a   cpu->running_translated = 0;\n"
            " *                  before setting cpu->cd.%s.next_ic = "
            "&nothing_call;\n */\n", a);
        printf("X(nothing)\n{\n");
        printf("\tcpu->n_translated_instrs --;\n");
        printf("\tcpu->cd.%s.next_ic --;\n", a);
        printf("}\n\n");

        printf("#ifdef DYNTRANS_VARIABLE_INSTRUCTION_LENGTH\n");
        printf("static struct %s_instr_call nothing_call = { "
            "instr(nothing), {0,0,0} };\n", a);
        printf("#else\n");
        printf("static struct %s_instr_call nothing_call = { "
            "instr(nothing), {0,0,0} };\n", a);
        printf("#endif\n");

        printf("\n");

        return 0;
}
1	dpavlin	14	/*
2	dpavlin	24	* Copyright (C) 2005-2006 Anders Gavare. All rights reserved.
3	dpavlin	14	*
4			* Redistribution and use in source and binary forms, with or without
5			* modification, are permitted provided that the following conditions are met:
6			*
7			* 1. Redistributions of source code must retain the above copyright
8			* notice, this list of conditions and the following disclaimer.
9			* 2. Redistributions in binary form must reproduce the above copyright
10			* notice, this list of conditions and the following disclaimer in the
11			* documentation and/or other materials provided with the distribution.
12			* 3. The name of the author may not be used to endorse or promote products
13			* derived from this software without specific prior written permission.
14			*
15			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18			* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19			* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25			* SUCH DAMAGE.
26			*
27			*
28	dpavlin	26	* $Id: generate_head.c,v 1.17 2006/06/24 21:47:23 debug Exp $
29	dpavlin	14	*/
30
31			#include <stdio.h>
32			#include <stdlib.h>
33			#include <string.h>
34
35
36	dpavlin	24	/* NOTE: Static return buffer, so calling it multiple times in the
37			same printf statement with the same argument works :-) but not
38			with different args. Hahaha. Really ugly. */
39	dpavlin	14	char uppercase(char l)
40			{
41			static char staticbuf[1000];
42	dpavlin	22	size_t i = 0;
43	dpavlin	14
44			while (*l && i < sizeof(staticbuf)) {
45			char u = *l++;
46			if (u >= 'a' && u <= 'z')
47			u -= 32;
48			staticbuf[i++] = u;
49			}
50			if (i == sizeof(staticbuf))
51			i--;
52			staticbuf[i] = 0;
53			return staticbuf;
54			}
55
56
57			int main(int argc, char *argv[])
58			{
59			char a, b;
60
61			if (argc != 3) {
62			fprintf(stderr, "usage: %s arch Arch\n", argv[0]);
63			fprintf(stderr, "Example: %s alpha Alpha\n", argv[0]);
64			fprintf(stderr, " or: %s arm ARM\n", argv[0]);
65			exit(1);
66			}
67
68			a = argv[1];
69			b = argv[2];
70
71	dpavlin	24
72	dpavlin	14	printf("\n/* AUTOMATICALLY GENERATED! Do not edit. */\n\n");
73
74	dpavlin	26	printf("#include <assert.h>\n");
75			printf("#include \"debugger.h\"\n");
76
77	dpavlin	14	printf("#define DYNTRANS_MAX_VPH_TLB_ENTRIES "
78			"%s_MAX_VPH_TLB_ENTRIES\n", uppercase(a));
79			printf("#define DYNTRANS_ARCH %s\n", a);
80			printf("#define DYNTRANS_%s\n", uppercase(a));
81	dpavlin	24
82			/* For 64-bit platforms, arch_L2N, and arch_L3N must be defined. */
83			printf("#ifndef DYNTRANS_32\n");
84			printf("#define DYNTRANS_L2N %s_L2N\n"
85			"#define DYNTRANS_L3N %s_L3N\n"
86			"#if !defined(%s_L2N) \|\| !defined(%s_L3N)\n"
87			"#error arch_L2N, and arch_L3N must be defined for this arch!\n"
88			"#endif\n",
89			uppercase(a), uppercase(a), uppercase(a), uppercase(a));
90			printf("#define DYNTRANS_L2_64_TABLE %s_l2_64_table\n"
91			"#define DYNTRANS_L3_64_TABLE %s_l3_64_table\n", a, a);
92			printf("#endif\n");
93
94			/* Default pagesize is 4KB. */
95	dpavlin	14	printf("#ifndef DYNTRANS_PAGESIZE\n"
96			"#define DYNTRANS_PAGESIZE 4096\n"
97			"#endif\n");
98	dpavlin	24
99	dpavlin	14	printf("#define DYNTRANS_IC %s_instr_call\n", a);
100			printf("#define DYNTRANS_IC_ENTRIES_PER_PAGE "
101			"%s_IC_ENTRIES_PER_PAGE\n", uppercase(a));
102			printf("#define DYNTRANS_INSTR_ALIGNMENT_SHIFT "
103			"%s_INSTR_ALIGNMENT_SHIFT\n", uppercase(a));
104			printf("#define DYNTRANS_TC_PHYSPAGE %s_tc_physpage\n", a);
105			printf("#define DYNTRANS_INVALIDATE_TLB_ENTRY "
106			"%s_invalidate_tlb_entry\n", a);
107			printf("#define DYNTRANS_ADDR_TO_PAGENR %s_ADDR_TO_PAGENR\n",
108			uppercase(a));
109			printf("#define DYNTRANS_PC_TO_IC_ENTRY %s_PC_TO_IC_ENTRY\n",
110			uppercase(a));
111			printf("#define DYNTRANS_TC_ALLOCATE "
112			"%s_tc_allocate_default_page\n", a);
113			printf("#define DYNTRANS_TC_PHYSPAGE %s_tc_physpage\n", a);
114			printf("#define DYNTRANS_PC_TO_POINTERS %s_pc_to_pointers\n", a);
115			printf("#define DYNTRANS_PC_TO_POINTERS_GENERIC "
116			"%s_pc_to_pointers_generic\n", a);
117			printf("#define COMBINE_INSTRUCTIONS %s_combine_instructions\n", a);
118			printf("#define DISASSEMBLE %s_cpu_disassemble_instr\n", a);
119
120			printf("\nextern volatile int single_step, single_step_breakpoint;"
121			"\nextern int debugger_n_steps_left_before_interaction;\n"
122			"extern int old_show_trace_tree;\n"
123			"extern int old_instruction_trace;\n"
124			"extern int old_quiet_mode;\n"
125			"extern int quiet_mode;\n");
126
127			printf("\n/* instr uses the same names as in "
128			"cpu_%s_instr.c */\n#define instr(n) %s_instr_ ## n\n\n", a, a);
129
130			printf("#ifdef DYNTRANS_DUALMODE_32\n"
131			"#define instr32(n) %s32_instr_ ## n\n\n", a);
132			printf("#endif\n\n");
133
134	dpavlin	18	printf("/* This is for marking a physical page as containing"
135			"\n combined instructions: */\n");
136	dpavlin	14	printf("#define combined (cpu->cd.%s.cur_physpage->flags "
137			"\|= COMBINATIONS)\n", a);
138
139			printf("\n#define X(n) void %s_instr_ ## n(struct cpu *cpu, \\\n"
140			" struct %s_instr_call *ic)\n", a, a);
141
142			printf("\n/\n nothing: Do nothing.\n *\n"
143			" * The difference between this function and a \"nop\" "
144			"instruction is that\n * this function does not increase "
145			"the program counter or the number of\n * translated "
146			"instructions. It is used to \"get out\" of running in "
147			"translated\n * mode.\n *\n"
148			" * IMPORTANT NOTE: Do a cpu->running_translated = 0;\n"
149			" * before setting cpu->cd.%s.next_ic = "
150			"&nothing_call;\n */\n", a);
151			printf("X(nothing)\n{\n");
152			printf("\tcpu->n_translated_instrs --;\n");
153			printf("\tcpu->cd.%s.next_ic --;\n", a);
154			printf("}\n\n");
155
156	dpavlin	22	printf("#ifdef DYNTRANS_VARIABLE_INSTRUCTION_LENGTH\n");
157			printf("static struct %s_instr_call nothing_call = { "
158			"instr(nothing), {0,0,0} };\n", a);
159			printf("#else\n");
160			printf("static struct %s_instr_call nothing_call = { "
161			"instr(nothing), {0,0,0} };\n", a);
162			printf("#endif\n");
163	dpavlin	14
164			printf("\n");
165
166			return 0;
167			}