Skip to content

Commit c0bd6ec

Browse files
dciabrindciabrin
committed
This new package aims at being consumed by ngdevkit or by any other emulator willing to expose debugging capability.
0 parents  commit c0bd6ec

14 files changed

+911
-0
lines changed

‎AUTHORS

Whitespace-only changes.

‎COPYING

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎ChangeLog

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2018-10-29 Damien Ciabrini <[email protected]>
2+
3+
* Initial version, to allow basic instrumentation.
4+

‎Makefile.am

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
SUBDIRS = src
2+
3+
pkgconfig_DATA = emudbg.pc

‎NEWS

Whitespace-only changes.

‎README

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
emudbg - emulator-agnostic source-level debugging API
2+
Copyright (c) 2015-2019 Damien Ciabrini
3+
4+
emudbg defines a simple debugging API that can be implemented by
5+
emulators to expose simple step-by-step execution and memory
6+
inspection capabilities over a standard GDB remote serial protocol [1]
7+
8+
emudbg implements a generic RSP server that can be targeted by any
9+
debugger implementing the GDB remote serial protocol. It controls
10+
the execution of the emulated software by calling the debugging API
11+
whose implementation has to be provided by the emulator.
12+
13+
[1] https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html

‎configure.ac

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
AC_INIT([libemudbg], [0.2])
2+
AC_CANONICAL_TARGET
3+
AM_INIT_AUTOMAKE([-Wall])
4+
PKG_INSTALLDIR
5+
AC_PROG_CC
6+
AM_PROG_AR
7+
AC_PROG_RANLIB
8+
9+
case $target_os in
10+
*mingw*)
11+
EMUDBG_PKGLIB="$EMUDBG_PKGLIB -lws2_32"
12+
;;
13+
esac
14+
15+
dnl AC_CONFIG_HEADERS([config.h])
16+
AC_CONFIG_FILES([
17+
emudbg.pc
18+
Makefile
19+
src/Makefile
20+
])
21+
AC_SUBST(EMUDBG_PKGLIB)
22+
AC_OUTPUT

‎emudbg.pc.in

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# emudbg pkg-config source file
2+
3+
prefix=@prefix@
4+
exec_prefix=@exec_prefix@
5+
libdir=@libdir@
6+
includedir=@includedir@
7+
8+
Name: emudbg
9+
Description: emulator-agnostic source level debugging API and server
10+
Version: @VERSION@
11+
Requires:
12+
Conflicts:
13+
Libs: -L${libdir} -lemudbg @EMUDBG_PKGLIB@
14+
Cflags: -I${includedir}

‎src/Makefile.am

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
lib_LIBRARIES = libemudbg.a
2+
libemudbg_a_SOURCES = emudbg.c gdbserver.c
3+
4+
include_HEADERS = emudbg.h

‎src/emudbg.c

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
/*
2+
* emudbg - emulator-agnostic source level debugging API
3+
* Copyright (c) 2015-2018 Damien Ciabrini
4+
* This file is part of ngdevkit
5+
*
6+
* ngdevkit is free software: you can redistribute it and/or modify
7+
* it under the terms of the GNU Lesser General Public License as
8+
* published by the Free Software Foundation, either version 3 of the
9+
* License, or (at your option) any later version.
10+
*
11+
* ngdevkit 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 Lesser General Public License for more details.
15+
*
16+
* You should have received a copy of the GNU Lesser General Public License
17+
* along with ngdevkit. If not, see <http://www.gnu.org/licenses/>.
18+
*/
19+
20+
#include <stdbool.h>
21+
#include <stdio.h>
22+
#include <stdlib.h>
23+
#include <string.h>
24+
#include <unistd.h>
25+
26+
#include "emudbg.h"
27+
#include "emudbg_ctx.h"
28+
#include "gdbserver.h"
29+
30+
#if defined(__WIN32__)
31+
#include <ws2tcpip.h>
32+
#define IOCTL ioctlsocket
33+
#define BYTES_AVAIL_T u_long
34+
#define NO_SOCKET_YET INVALID_SOCKET
35+
#else
36+
#include <sys/ioctl.h>
37+
#include <sys/types.h>
38+
#include <sys/socket.h>
39+
#include <netinet/in.h>
40+
#include <arpa/inet.h>
41+
#define IOCTL ioctl
42+
#define BYTES_AVAIL_T int
43+
#define NO_SOCKET_YET 0
44+
#endif
45+
46+
#define DEFAULT_HOST "127.0.0.1"
47+
#define DEFAULT_PORT 2159
48+
49+
int emudbg_init(struct emudbg_api_t *impl, void **emudbg_ctx)
50+
{
51+
#if defined(__WIN32__)
52+
WORD version;
53+
WSADATA data;
54+
version = MAKEWORD(2, 2);
55+
56+
int err = WSAStartup(version, &data);
57+
if (err != 0) { return 1; }
58+
#endif
59+
60+
struct emudbg_ctx_t *ctx = malloc(sizeof(struct emudbg_ctx_t));
61+
ctx->listen_socket = NO_SOCKET_YET;
62+
ctx->client_socket = NO_SOCKET_YET;
63+
memset(ctx->data, 0, sizeof(ctx->data));
64+
memset(ctx->send_data, 0, sizeof(ctx->send_data));
65+
ctx->next_cmd_ptr = NULL;
66+
ctx->debugger_impl = impl;
67+
68+
*emudbg_ctx = ctx;
69+
70+
return 0;
71+
}
72+
73+
74+
int emudbg_wait_for_client(void *emudbg_ctx)
75+
{
76+
struct emudbg_ctx_t *ctx=(struct emudbg_ctx_t*)emudbg_ctx;
77+
78+
struct sockaddr_in listen_addr;
79+
int r=0;
80+
listen_addr.sin_family = AF_INET;
81+
listen_addr.sin_addr.s_addr = inet_addr(DEFAULT_HOST);
82+
listen_addr.sin_port = htons(DEFAULT_PORT);
83+
84+
ctx->listen_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
85+
r=bind(ctx->listen_socket, (struct sockaddr *)&listen_addr, sizeof(listen_addr));
86+
// printf("BOUND SOCKET: %x - %d (errno: %d)\n", ctx->listen_socket, r, EMUDBG_SOCKET_ERRNO);
87+
88+
// printf("LISTEN:\n");
89+
r=listen(ctx->listen_socket, SOMAXCONN);
90+
// printf("LISTEN FINISHED: %d (errno: %d) - %d\n", r, EMUDBG_SOCKET_ERRNO, SOCKET_ERROR);
91+
92+
struct sockaddr client_addr;
93+
socklen_t addrlen=sizeof(client_addr);
94+
ctx->client_socket = accept(ctx->listen_socket, &client_addr, &addrlen);
95+
// printf("ACCEPTED CLIENT SOCKET: %x (errno: %d)\n", ctx->client_socket, EMUDBG_SOCKET_ERRNO);
96+
97+
}
98+
99+
100+
int emudbg_client_command_pending(void *emudbg_ctx)
101+
{
102+
struct emudbg_ctx_t *ctx=(struct emudbg_ctx_t*)emudbg_ctx;
103+
104+
BYTES_AVAIL_T bytes_avail=0;
105+
if (ctx->client_socket != FD_NONE) {
106+
IOCTL(ctx->client_socket, FIONREAD, &bytes_avail);
107+
if (bytes_avail>0) {
108+
// printf("bytes avail: %d\n",bytes_avail);
109+
}
110+
}
111+
return bytes_avail>0;
112+
}
113+
114+
115+
int emudbg_server_loop(void *emudbg_ctx, int emu_suspended, struct emudbg_cmd_t *next_cmd)
116+
{
117+
return emudbg_gdb_server_loop(emudbg_ctx, emu_suspended, next_cmd);
118+
}
119+
120+
121+
void emudbg_disconnect_from_client(void *emudbg_ctx)
122+
{
123+
struct emudbg_ctx_t *ctx=(struct emudbg_ctx_t*)emudbg_ctx;
124+
125+
close(ctx->client_socket);
126+
ctx->client_socket;
127+
close(ctx->listen_socket);
128+
ctx->listen_socket;
129+
130+
free(ctx);
131+
}

0 commit comments

Comments
 (0)