Skip to content

Commit

Permalink
emudbg: use autoconf and provide static lib to build on mingw
Browse files Browse the repository at this point in the history
This is the last commit to bring feature parity between Linux/macOS and
mingw build (windows 10 + WSL)

Resolves: #3
  • Loading branch information
dciabrin committed Oct 29, 2018
1 parent 9f763fc commit 5ea65d2
Show file tree
Hide file tree
Showing 14 changed files with 911 additions and 0 deletions.
Empty file added debugger/AUTHORS
Empty file.
165 changes: 165 additions & 0 deletions debugger/COPYING
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
4 changes: 4 additions & 0 deletions debugger/ChangeLog
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
2018-10-29 Damien Ciabrini <damien.ciabrini@gmail.com>

* Initial version, to allow basic instrumentation.

3 changes: 3 additions & 0 deletions debugger/Makefile.am
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SUBDIRS = src

pkgconfig_DATA = emudbg.pc
Empty file added debugger/NEWS
Empty file.
13 changes: 13 additions & 0 deletions debugger/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
emudbg - emulator-agnostic source-level debugging API
Copyright (c) 2015-2018 Damien Ciabrini

emudbg defines a simple debugging API that can be implemented by
emulators to expose simple step-by-step execution and memory
inspection capabilities over a standard GDB remote serial protocol [1]

emudbg implements a generic RSP server that can be targeted by any
debugger implementing the GDB remote serial protocol. It controls
the execution of the emulated software by calling the debugging API
whose implementation has to be provided by the emulator.

[1] https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html
22 changes: 22 additions & 0 deletions debugger/configure.ac
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
AC_INIT([libemudbg], [0.2])
AC_CANONICAL_TARGET
AM_INIT_AUTOMAKE([-Wall])
PKG_INSTALLDIR
AC_PROG_CC
AM_PROG_AR
AC_PROG_RANLIB

case $target_os in
*mingw*)
EMUDBG_PKGLIB="$EMUDBG_PKGLIB -lws2_32"
;;
esac

dnl AC_CONFIG_HEADERS([config.h])
AC_CONFIG_FILES([
emudbg.pc
Makefile
src/Makefile
])
AC_SUBST(EMUDBG_PKGLIB)
AC_OUTPUT
14 changes: 14 additions & 0 deletions debugger/emudbg.pc.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# emudbg pkg-config source file

prefix=@prefix@
exec_prefix=@exec_prefix@
libdir=@libdir@
includedir=@includedir@

Name: emudbg
Description: emulator-agnostic source level debugging API and server
Version: @VERSION@
Requires:
Conflicts:
Libs: -L${libdir} -lemudbg @EMUDBG_PKGLIB@
Cflags: -I${includedir}
4 changes: 4 additions & 0 deletions debugger/src/Makefile.am
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
lib_LIBRARIES = libemudbg.a
libemudbg_a_SOURCES = emudbg.c gdbserver.c

include_HEADERS = emudbg.h
131 changes: 131 additions & 0 deletions debugger/src/emudbg.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
/*
* emudbg - emulator-agnostic source level debugging API
* Copyright (c) 2015-2018 Damien Ciabrini
* This file is part of ngdevkit
*
* ngdevkit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* ngdevkit is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with ngdevkit. If not, see <http://www.gnu.org/licenses/>.
*/

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

#include "emudbg.h"
#include "emudbg_ctx.h"
#include "gdbserver.h"

#if defined(__WIN32__)
#include <ws2tcpip.h>
#define IOCTL ioctlsocket
#define BYTES_AVAIL_T u_long
#define NO_SOCKET_YET INVALID_SOCKET
#else
#include <sys/ioctl.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#define IOCTL ioctl
#define BYTES_AVAIL_T int
#define NO_SOCKET_YET 0
#endif

#define DEFAULT_HOST "127.0.0.1"
#define DEFAULT_PORT 2159

int emudbg_init(struct emudbg_api_t *impl, void **emudbg_ctx)
{
#if defined(__WIN32__)
WORD version;
WSADATA data;
version = MAKEWORD(2, 2);

int err = WSAStartup(version, &data);
if (err != 0) { return 1; }
#endif

struct emudbg_ctx_t *ctx = malloc(sizeof(struct emudbg_ctx_t));
ctx->listen_socket = NO_SOCKET_YET;
ctx->client_socket = NO_SOCKET_YET;
memset(ctx->data, 0, sizeof(ctx->data));
memset(ctx->send_data, 0, sizeof(ctx->send_data));
ctx->next_cmd_ptr = NULL;
ctx->debugger_impl = impl;

*emudbg_ctx = ctx;

return 0;
}


int emudbg_wait_for_client(void *emudbg_ctx)
{
struct emudbg_ctx_t *ctx=(struct emudbg_ctx_t*)emudbg_ctx;

struct sockaddr_in listen_addr;
int r=0;
listen_addr.sin_family = AF_INET;
listen_addr.sin_addr.s_addr = inet_addr(DEFAULT_HOST);
listen_addr.sin_port = htons(DEFAULT_PORT);

ctx->listen_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
r=bind(ctx->listen_socket, (struct sockaddr *)&listen_addr, sizeof(listen_addr));
// printf("BOUND SOCKET: %x - %d (errno: %d)\n", ctx->listen_socket, r, EMUDBG_SOCKET_ERRNO);

// printf("LISTEN:\n");
r=listen(ctx->listen_socket, SOMAXCONN);
// printf("LISTEN FINISHED: %d (errno: %d) - %d\n", r, EMUDBG_SOCKET_ERRNO, SOCKET_ERROR);

struct sockaddr client_addr;
socklen_t addrlen=sizeof(client_addr);
ctx->client_socket = accept(ctx->listen_socket, &client_addr, &addrlen);
// printf("ACCEPTED CLIENT SOCKET: %x (errno: %d)\n", ctx->client_socket, EMUDBG_SOCKET_ERRNO);

}


int emudbg_client_command_pending(void *emudbg_ctx)
{
struct emudbg_ctx_t *ctx=(struct emudbg_ctx_t*)emudbg_ctx;

BYTES_AVAIL_T bytes_avail=0;
if (ctx->client_socket != FD_NONE) {
IOCTL(ctx->client_socket, FIONREAD, &bytes_avail);
if (bytes_avail>0) {
// printf("bytes avail: %d\n",bytes_avail);
}
}
return bytes_avail>0;
}


int emudbg_server_loop(void *emudbg_ctx, int emu_suspended, struct emudbg_cmd_t *next_cmd)
{
return emudbg_gdb_server_loop(emudbg_ctx, emu_suspended, next_cmd);
}


void emudbg_disconnect_from_client(void *emudbg_ctx)
{
struct emudbg_ctx_t *ctx=(struct emudbg_ctx_t*)emudbg_ctx;

close(ctx->client_socket);
ctx->client_socket;
close(ctx->listen_socket);
ctx->listen_socket;

free(ctx);
}
Loading

0 comments on commit 5ea65d2

Please sign in to comment.