1 /* Main simulator entry points specific to the eBPF.
2 Copyright (C) 2020-2021 Free Software Foundation, Inc.
4 This file is part of GDB, the GNU debugger.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 /* This must come before any other includes. */
24 #include "sim/callback.h"
26 #include "sim-options.h"
27 #include "libiberty.h"
32 /* String with the name of the section containing the BPF program to
34 static char *bpf_program_section
= NULL
;
36 extern uint64_t skb_data_offset
;
39 /* Handle BPF-specific options. */
41 static SIM_RC
bpf_option_handler (SIM_DESC
, sim_cpu
*, int, char *, int);
45 OPTION_BPF_SET_PROGRAM
= OPTION_START
,
46 OPTION_BPF_LIST_PROGRAMS
,
47 OPTION_BPF_VERIFY_PROGRAM
,
48 OPTION_BPF_SKB_DATA_OFFSET
,
51 static const OPTION bpf_options
[] =
53 { {"bpf-set-program", required_argument
, NULL
, OPTION_BPF_SET_PROGRAM
},
54 '\0', "SECTION_NAME", "Set the entry point",
56 { {"bpf-list-programs", no_argument
, NULL
, OPTION_BPF_LIST_PROGRAMS
},
57 '\0', "", "List loaded bpf programs",
59 { {"bpf-verify-program", required_argument
, NULL
, OPTION_BPF_VERIFY_PROGRAM
},
60 '\0', "PROGRAM", "Run the verifier on the given BPF program",
62 { {"skb-data-offset", required_argument
, NULL
, OPTION_BPF_SKB_DATA_OFFSET
},
63 '\0', "OFFSET", "Configure offsetof(struct sk_buff, data)",
66 { {NULL
, no_argument
, NULL
, 0}, '\0', NULL
, NULL
, NULL
, NULL
}
70 bpf_option_handler (SIM_DESC sd
, sim_cpu
*cpu ATTRIBUTE_UNUSED
, int opt
,
71 char *arg
, int is_command ATTRIBUTE_UNUSED
)
73 switch ((BPF_OPTION
) opt
)
75 case OPTION_BPF_VERIFY_PROGRAM
:
76 /* XXX call the verifier. */
77 sim_io_printf (sd
, "Verifying BPF program %s...\n", arg
);
80 case OPTION_BPF_LIST_PROGRAMS
:
81 /* XXX list programs. */
82 sim_io_printf (sd
, "BPF programs available:\n");
85 case OPTION_BPF_SET_PROGRAM
:
86 /* XXX: check that the section exists and tell the user about a
88 bpf_program_section
= xstrdup (arg
);
91 case OPTION_BPF_SKB_DATA_OFFSET
:
92 skb_data_offset
= strtoul (arg
, NULL
, 0);
96 sim_io_eprintf (sd
, "Unknown option `%s'\n", arg
);
103 /* Like sim_state_free, but free the cpu buffers as well. */
106 bpf_free_state (SIM_DESC sd
)
108 if (STATE_MODULES (sd
) != NULL
)
109 sim_module_uninstall (sd
);
111 sim_cpu_free_all (sd
);
115 extern const SIM_MACH
* const bpf_sim_machs
[];
117 /* Create an instance of the simulator. */
120 sim_open (SIM_OPEN_KIND kind
,
121 host_callback
*callback
,
125 /* XXX Analyze the program, and collect per-function information
126 like the kernel verifier does. The implementation of the CALL
127 instruction will need that information, to update %fp. */
129 SIM_DESC sd
= sim_state_alloc (kind
, callback
);
131 /* Set default options before parsing user options. */
132 STATE_MACHS (sd
) = bpf_sim_machs
;
133 STATE_MODEL_NAME (sd
) = "bpf-def";
135 if (sim_cpu_alloc_all (sd
, 1) != SIM_RC_OK
)
138 if (sim_pre_argv_init (sd
, argv
[0]) != SIM_RC_OK
)
141 /* Add the BPF-specific option list to the simulator. */
142 if (sim_add_option_table (sd
, NULL
, bpf_options
) != SIM_RC_OK
)
148 if (sim_parse_args (sd
, argv
) != SIM_RC_OK
)
151 if (sim_analyze_program (sd
, STATE_PROG_FILE (sd
), abfd
) != SIM_RC_OK
)
154 if (sim_config (sd
) != SIM_RC_OK
)
157 if (sim_post_argv_init (sd
) != SIM_RC_OK
)
162 /* Initialize the CPU descriptors and the disassemble in the cpu
163 descriptor table entries. */
166 CGEN_CPU_DESC cd
= bpf_cgen_cpu_open_1 (STATE_ARCHITECTURE (sd
)->printable_name
,
169 /* We have one cpu per installed program! MAX_NR_PROCESSORS is an
170 arbitrary upper limit. XXX where is it defined? */
171 for (i
= 0; i
< MAX_NR_PROCESSORS
; ++i
)
173 SIM_CPU
*cpu
= STATE_CPU (sd
, i
);
175 CPU_CPU_DESC (cpu
) = cd
;
176 CPU_DISASSEMBLER (cpu
) = sim_cgen_disassemble_insn
;
179 bpf_cgen_init_dis (cd
);
182 /* XXX do eBPF sim specific initializations. */
193 sim_create_inferior (SIM_DESC sd
, struct bfd
*abfd
,
194 char *const *argv
, char *const *env
)
196 SIM_CPU
*current_cpu
= STATE_CPU (sd
, 0);
197 host_callback
*cb
= STATE_CALLBACK (sd
);
200 /* Determine the start address.
202 XXX acknowledge bpf_program_section. If it is NULL, emit a
203 warning explaining that we are using the ELF file start address,
204 which often is not what is actually wanted. */
206 addr
= bfd_get_start_address (abfd
);
210 sim_pc_set (current_cpu
, addr
);
212 if (STATE_PROG_ARGV (sd
) != argv
)
214 freeargv (STATE_PROG_ARGV (sd
));
215 STATE_PROG_ARGV (sd
) = dupargv (argv
);
218 if (STATE_PROG_ENVP (sd
) != env
)
220 freeargv (STATE_PROG_ENVP (sd
));
221 STATE_PROG_ENVP (sd
) = dupargv (env
);
224 cb
->argv
= STATE_PROG_ARGV (sd
);
225 cb
->envp
= STATE_PROG_ENVP (sd
);