Documentation and debugging for developers

[PedroLSF]

Dear @mortbopet and developers,

I have some doubts at different points, I will describe them here.
Firstly, I used Docker to try to explore the project, so far so good.

I basically changed the endpoint to use CLI mode

But I went looking for read syscall and couldn't find it. (I used the value 5/63 to read integers, but it doesn't work)

This was the first point that raised my doubts, is there somewhere with this documented or is there documentation for developers to fully understand the project?

Finally, my last question is to know how to debug, as I didn't find the documentation, I wanted to debug or put some prints to see the data moving between the methods and variables.

Ripes/src/syscall/systemio.h

Line 458 in 0faf41b

void putStdInData(const QByteArray &data) {

For example, in the line above I would like to see the value that is arriving at &data through a print or debug, can you help me at this point too?

Thank you very much in advance.

[federicovilla55]

As described in the ecalls.md file in the docs folder, all supported syscall are described in the Help-> System calls menù.

Trying to execute the following code in the GUI version, the input is read and in the x10 (a0) register it is returned the number of read bytes.

addi x10 x0 0
addi x17 x0 63
addi x12 x0, 255
ecall
addi x17 x0 10
ecall

If you want to observe the value arriving at &data, one approach is to include a qDebug() statement for each variable you wish to print, like so:

void putStdInData(const QByteArray &data) {
    qDebug() << data;
    ...
}

Then build your local version of Ripes as described here.

[PedroLSF]

@federicovilla55 Thanks for the answer!
I understood about the ecalls, I'll take a look.

Regarding qDebug(), I still haven't been able to handle it correctly.

I'm inside my fork, I used qDebug() as you mentioned, I committed and did docker build again and finally I ran it with docker run, but without success when using the console, as shown below:

So, since it didn't work, does that mean I can't use docker to use the console and I have to build Ripes manually? (I would very much like to stay with docker)

Note: It is worth mentioning that I am only using it in CLI mode, as I need to connect with a type of Online Judge

[federicovilla55]

@PedroLSF
Unfortunately in the current version there's no option to handle system input from CLI.
I've created an issue explaining the problem and proposing a solution to handle stdin from CLI. Issue #353

The problem you found wasn't related to Docker, just to the current implementation of Ripes.

If you modify puStdInData() you modify a method called by the console, which is created only in the GUI mode.

Hope this helps.

[PedroLSF]

@federicovilla55
Yes, I understand that.
I wanted to see something about this Issue, but I'm not that familiar with the project and it was very difficult to understand or develop something without being able to debug or see how the data is moving within the code.
I would be very happy to help or contribute something.