Debugging

[cwbuck]

Is there some sort of method for debugging IBM i programs and stepping through in VS Code? Thanks!

[worksofliam]

@cwbuck An age-old question. No. There is not. IBM will not share any details on the remote debugger and we have no idea what their plans are with that. No one from IBM is able to offer any public insight. I am aware that someone was working on a debugging, not specifically for VS Code, but one we could utilize. I am not sure of the status of that.

This discussion makes me very frustrated because there isn't much I can do on my own here.

[worksofliam]

Yes! A debugger for ILE applications (COBOL, RPGLE, C, etc) is coming. I have not got a concrete timeline for you, but I can tell you I have used it and it is working good from Code for IBM i.

[rcronin]

That is amazing news! Thanks Liam

[beckhamrryyaann]

Great news!

[rainierio]

Awesome, can't wait to try

[andreas-prouza]

You made my day! Thank you so much! 🥲

[rcronin]

@worksofliam - any update on this front now that the TR has been released?

[worksofliam]

TR has been released but PTF not yet available. Even when the PTF becomes available, it won't be available in VS Code right away. We're aiming to make it usable inside of VS Code some time in January.

[rcronin]

@worksofliam - just grabbed the new debugging feature today. First off, congrats on integrating this huge feature! This is very impressive. I know this is the initial release. What enhancements do you have in store for debugging? Will there be the ability to debug an active job at some point?

[worksofliam]

Hi! Thanks you. I am happy with it so far and the people working on it are happy to see that you are happy too.

Yes, the next major thing is adding the ability to debug a different job. You'll likely see a job selector in which then you'll be able to debug programs in that job.

[chrjorgensen]

@worksofliam Is the debug feature complete or still under development? Should we report any errors encountered, like the ones I get when trying to debug:

EQAVS1007E dkncbm05 on port 8005 could not be connected.
Message received: self signed certificate

?

[worksofliam]

@chrjorgensen did you get this issue after using the walkthrough to setup the certs?

Also, are you using an ip address or hostname to connect to the system?

Share those details in a new issue please :)

[chrjorgensen]

@worksofliam Issue #1053 has been created.

[m-tyler]

With the debugging extension active, I have a small issue when doing source merge actions. Where would I create an issue for this? Here or someplace else?

The issue is when I am using the merge function to remove lines on the right side that has been removed from the left side, the breakpoint marker is set.

Disabling the debug extension, the above does not happen.

[chrjorgensen]

@m-tyler You can't have two processes using the same TCP/IP port, so one of your applications - GoAnywhere and Debug Service - has to yield...

For GoAnywhere, have you GA administrator change the port.
For the Debug Service, follow the instructions here: https://codefori.github.io/docs/#/pages/developing/debug/debug?id=debug-service-ports

[m-tyler]

Thanks for the assistance, but The GA tool port usage will not be changed just to get debugging from VS Code to work. There are other options for debugging at this time that don't require GA tool to be modified, STRDBG or RDi debugging.

[worksofliam]

@mkwan01 Is there any public docs on changing the port? I know there is an environment file where we can change it. Is that documented somewhere?

[m-tyler]

There is in the document link referenced by @chrjorgensen. I changed those values and the next step is to restart the debug server but I need to do that after hours or early morning before I know if it works. Its taken a bit of time to make certain what the ports are being used by the GoAnywhere tool and what other ports could be used instead.

[mkwan01]

@worksofliam Please see the answer for question "How can I change the port numbers for the debug service" from the link below:
https://www.ibm.com/docs/en/merlin/1.0?topic=environment-debugging

[NorskieRider]

The debugger is pretty slick ;-) Thanks - Code for IBM i is getting closer to replacing RDi in our org!

When debugging c it displays the variable and it's pointer, like this:

argv: SPP:FD32B06598002E80

Using strdbg interactively we dereference the pointer and cast/display in a specific formats, like this:

eval *argv[2]:s 100

or

eval *argv[2]:x 100

Is there something equivalent in Code for IBM i's debugger?

[mkwan01]

You can add the expression "*argv[2]" to the Watch view. It will do the same thing as the eval command in strdbg.

[NorskieRider]

Very nice - thank you! There seems to be some differences as it relates to dereferencing pointers, but I'll play with it.

[jhullsdc]

Hey! Thanks so much for making this.
I'm having an issue where after I get my server and services up and running without any issue,
I still receive a EQAVS1007E error when I try to debug.

EQAVS1007E  on port 8005 could not be connected. 
Message received:

I don't know exactly why since the message received is blank.

Here's how my port for 8005 is set up on the AS400

     Remote           Remote  Local                    
Opt  Address           Port    Port  Idle Time  State    
         *               *     8005  003:34:09  Listen 
                            (vsc-debug)

In my DebugServices.env, I have the secured port set to 8005.
DBGSRV_SECURED_PORT=8005

What could be causing this to not find the port?

[sebjulliand]

If the port is actually opened on the IBM i but your workstation fails to reach it, it's probably due to a network issue (i.e. a firewall prevents connections from the outside to your IBM i on port 8005). At least, it's what it seems since error EQAVS1007E doesn't give much more details.
You can test the connectivity by opening this URL in your browser: https://ibmi_address:8005
The browser should be able to connect to the URL and then complain it's unsecure (because the service uses a self-signed certificate).

If the browser manages to connect, then the error lies elsewhere. There may be some error traces in these files: /QIBM/UserData/IBMiDebugService/startDebugService_workspace/.metadata/.log and /QIBM/UserData/IBMiDebugService/DebugService_log.txt

[GROBINSO]

Hi I had version 1 of IBM i debugger working nicely but really wanted to use service entry points so could target more than just batch programs but on adding Java 11 (option 19) to our V7R5 machine and PTF SI86229 (and its prerequisite PTF SI81035) but I am still getting the error below when trying to set a service entry point or debug a batch program. I ended the version 1 debug service job and then uncommented the Java 11 Home variable in startDebugService.sh to ensure Java 11 is being used and then regenerated the certificates?

The only thing I havent done is install PTF SI83666 but this seems to fix a bug in Kerberos authentication and that is not being used.

Created IBM i connection (host: LOCALHOST, user: ROBINSONG)
Connected to host LOCALHOST
Your debug server version is not up to date. IBM i Debug Service requires a host PTF update.
Created IBM i connection for SEP (host: LOCALHOST, user: ROBINSONG)
Connected to host LOCALHOST
Your debug server version is not up to date. IBM i Debug Service requires a host PTF update.

Any help would be much apprepreciated as adding debugging would make code for i would be the cherry on the cake for already excellent tool!

[sebjulliand]

Based on the fact that the Debug Service v2 is basically RDi 9.8 debugger running as an HTTP server, they must have the same prerequisites.
Check out if this one is installed for your 7.5 system: SI82343

[GROBINSO]

Thanks for getting back so quickly @sebjulliand no it is not installed, I will arrange to get it installed and update with progress, many thanks!

[sebjulliand]

You're welcome! If it proves to be the missing one, I'll update our documentation 😉

[GROBINSO]

Hi @sebjulliand it was that PTF made all the difference, if you want to add it to your documentation!

Thanks very much for your assistance, it looks great so far!!

[sebjulliand]

Lovely! Thanks for the feedback!

[GROBINSO]

Has anybody succesfully used Service Entry Points to debug ODBC jobs? I have it working fine for interactive and for trigger programs when doing the inserts via the green screen but when doing an insert via an ODBC job the process is stopping on the SEP but the source code is not coming up to debug? After a time of about 60 seconds it times out and the update takes place succesfully? I cannot see any errors job logs on the ODBC or the debug server job. Not sure what the SELF setting does? Does it increase the number of trace statements produced when tracign the SQL job? Could that help? I know there is an issue where the UPDPROD parameter is not being set at the moment for SEPs but it is a test library set to *TEST so shouldn't be an issue. My user profile I am testing on has *ALLOBJ etc. Has anybody any ideas? Many thanks!

[worksofliam]

Right now, SEP will only listen on other jobs under the same user. Ensure your ODBC connections are using the user profile that is setting the breakpoint.

[GROBINSO]

Thanks for replying @worksofliam

It is definitely the same userid because for testing I was using the db2 for i extension in vscode to do the insert on the same connection I had just set the SEP with.

The job paused and looking at the bottom of the call stack of the ODBC job I could see and IBM SEP program, so it was halting on the SEP but some reason the debug session wasn't starting. I'll try and send more information tomorrow, it feels like a blocked connection somehow but it is working when I DFU a record in!

Thanks for the great tools by the way, I work in a office with a bunch of guys doing Angular and React on VSCode and it is nice not to look like the dinosaur in the corner on the green screen when coding! 😃

[GROBINSO]

Yes unforunately still not working, getting stuck with SEP ran through DB2 CL command. Created a trivially simple CL program with one var that had its value changed to strip things right back but no luck! One strange thing that seems to happen when you disable the SEP in VS Code by unchecking it, the save as dialogue opens for my unsaved SQL code!

I only seem to get these entries for 5250 sessions nothing for QZDASOINIT jobs?

EQARD1067I Remote Debug Service has generated the following trace files:
/QIBM/UserData/IBMIDEBUGSERVICE/startDebugService_workspace/PDT_DAAS_20240823_160413_0508_1_DAP.txt
/QIBM/UserData/IBMIDEBUGSERVICE/startDebugService_workspace/PDT_DAAS_20240823_160413_0508_1_EPDC.hex

20240823_160426_0112 ->{"type":"event","seq":9,"event":"capabilities","body":{"capabilities":{"supportsFunctionBreakpoints":false,"supportsConditionalBreakpoints":true,"supportsHitConditionalBreakpoints":true,"supportsEvaluateForHovers":true,"supportsSetVariable":true,"supportsValueFormattingOptions":true,"supportsModulesRequest":true,"supportsSetExpression":true,"supportsRestartRequest":true,"supportsTerminateRequest":true}}}
20240823_160426_0112 ->{"type":"response","seq":10,"request_seq":2,"success":true,"command":"attach"}
20240823_160426_0113 ->{"type":"event","seq":11,"event":"process","body":{"name":"Process: 793155/ROBINSONG/QPADEV00BH Program: SEPTEST","isLocalProcess":false,"startMethod":"launch"}}
20240823_160426_0113 ->{"type":"event","seq":12,"event":"module","body":{"reason":"new","module":{"id":1,"name":"*PGM ROBINSONG/SEPTEST"}}}
20240823_160426_0114 ->{"type":"event","seq":13,"event":"session","body":{"reason":"new","sessions":[]}}

                          Display All Messages                              
                                                         System:   PRODUCT  

Job . . : QZDASOINIT User . . : QUSER Number . . . : 793061

 Job 793061/QUSER/QZDASOINIT started on 23/08/24 at 15:37:09 in subsystem   
   QODBC1 in QGPL. Job entered system on 23/08/24 at 15:37:09.              
 User ROBINSONG from client 127.0.0.1 connected to server.                  
 Library *CRTDFT not found.                                                 
 Library list not replaced.                                                 
 The following special registers have been set: CLIENT_ACCTNG: location:    
   file:/home/ROBINSONG/.vscode/codeforiserver-1.4.9.jar, CLIENT_APPLNAME:  
   vscode-db2i 1.2.0, CLIENT_PROGRAMID: VSCode connector | Version 1.4.9,   
   CLIENT_USERID: robinsong, CLIENT_WRKSTNNAME: 192.168.221.145             
                                                                     Bottom 

Press Enter to continue.

F3=Exit F5=Refresh F12=Cancel F17=Top F18=Bottom

Already at bottom of area.

[mkwan01]

@GROBINSO If you also have RDi, you can try the same ODBC debug scenario in RDi and report the RDi debug behaviour with your program. RDi and vscode debug share the same QB5 debug server component on the host. If RDi also has the same problem, then it is likely to be a problem in the debug server.

[GROBINSO]

Thanks for the tip @mkwan01, I dont have RDi installed at present but I think there is a spare license for it in our department, I'll get it installed and get it a try next week.

[JWigh]

@worksofliam Question when is the debugger 2.0.0 is released or if it has been released?

[sebjulliand]

Debugger v2 has been released a few months ago 😊
Check out the requirements if you intend to use it: https://codefori.github.io/docs/developing/debug/#required-ptfs

[JWigh]

@sebjulliand Thanks now I know and and realise why it havent arrived in my Rig yet we are running old JAVA

[sebjulliand]

Yep, you'll need Java 11 and a bunch of PTF + a (free) licensed product.
Also, if you had generated a certificate for Debugger v1 you'll have to regenerate it once everything's been installed.

[JWigh]

The JAVA will be an issue we use some legacy JAVA things to create EXCEL sheets

[sebjulliand]

Multiple Java version can cohabit on your LPAR. Installing Java 11 won't make it the default unless you make it so. Your legacy stuff can still use Java 8, you don't have to make any modification to the default JAVA_HOME or whatever. The debug service knows where to find Java 11 😉

[rogersonra]

I finally got the PTFs loaded and it appears everything's started ok.

But when I try to debug a simple test I get

When I look at the userid for the Debug Service it is TFLORES not TROGERSONR. Is this the issue?

Thanks

[rogersonra]

@mkwan01 I turned on the Debug trace

The Debug Console is now populated.

From client: initialize({"clientID":"vscode","clientName":"Visual Studio Code","adapterID":"IBMiDebug","pathFormat":"path","linesStartAt1":true,"columnsStartAt1":true,"supportsVariableType":true,"supportsVariablePaging":true,"supportsRunInTerminalRequest":true,"locale":"en","supportsProgressReporting":true,"supportsInvalidatedEvent":true,"supportsMemoryReferences":true,"supportsArgsCanBeInterpretedByShell":true,"supportsMemoryEvent":true,"supportsStartDebuggingRequest":true})
To client: {"seq":0,"type":"response","request_seq":1,"command":"initialize","success":true,"body":{"supportsEvaluateForHovers":true,"supportsSetVariable":true,"supportsValueFormattingOptions":true,"supportsModulesRequest":true,"supportTerminateDebuggee":true,"supportsFunctionBreakpoints":true,"supportsConfigurationDoneRequest":true}}
From client: launch({"type":"IBMiDebug","request":"launch","subType":"sep","action":"get_list","name":"Service Entry Point","user":"trogersonr","password":"","host":"10.11.1.30","port":8006,"secure":true,"ignoreCertificateErrors":false,"trace":true,"workbenchSettings":{"updateProductionFiles":false,"enableDebugTracing":false},"__sessionId":"030cbeb0-d988-4d7a-803d-c814c5092030"})
To client: {"type":"event","seq":2,"event":"initialized"}
From client: setBreakpoints({"source":{"name":"DEBUGDEMO.RPGLE","path":"member:/VROGERSONR/QRPGLESRC/DEBUGDEMO.RPGLE?readonly%3Dfalse%26position%3D"},"lines":[12],"breakpoints":[{"line":12}],"sourceModified":false})
From client: setFunctionBreakpoints({"breakpoints":[]})
To client: {"type":"response","seq":0,"request_seq":3,"success":true,"command":"setBreakpoints","body":{"breakpoints":[{"line":12,"id":"1","verified":false,"message":"EQARD1050I Breakpoint processing is waiting for debug session initialization..."}]}}
To client: {"type":"response","seq":0,"request_seq":4,"success":true,"command":"setFunctionBreakpoints","body":{"breakpoints":[]}}
From client: configurationDone(undefined)
To client: {"type":"response","seq":0,"request_seq":5,"success":true,"command":"configurationDone"}
From client: threads(undefined)
To client: {"type":"response","seq":0,"request_seq":6,"success":true,"command":"threads","body":{"threads":[]}}
To client: {"type":"event","seq":7,"event":"exited","body":{"exitcode":0,"message":"DBGM0019I Retrieve the list of service entry points from host 10.11.1.30 for user TROGERSONR.","sepList":"[{\"host\": \"10.11.1.30\", \"user\": \"TROGERSONR\", \"library\": \"VROGERSONR\", \"program\": \"DEBUGDEMO\", \"programType\": \"*PGM\", \"module\": \"*ALL\", \"procedure\": \"*ALL\", \"isEnabled\": true, \"condition\": \"\"}]"}}
To client: {"type":"event","seq":8,"event":"terminated"}
To client: {"type":"response","seq":0,"request_seq":2,"success":true,"command":"launch"}
From client: disconnect({"restart":false,"terminateDebuggee":false})
To client: {"type":"response","seq":0,"request_seq":5,"success":false,"command":"configurationDone","body":{"error":{"id":"8999","format":"java.lang.NullPointerException\n\tat com.ibm.debug.pdt.daas.internal.dap.DAPSession.getVersionJSON(DAPSession.java:439)\n\tat com.ibm.debug.pdt.daas.internal.dap.events.DAPEvent.getEvent(DAPEvent.java:117)\n\tat com.ibm.debug.pdt.daas.internal.dap.requests.DAPConfigurationDoneRequest.generateEvents(DAPConfigurationDoneRequest.java:123)\n\tat com.ibm.debug.pdt.daas.internal.dap.requests.DAPRequest.process(DAPRequest.java:139)\n\tat com.ibm.debug.pdt.daas.internal.dap.requests.DAPRequest.process(DAPRequest.java:97)\n\tat com.ibm.debug.pdt.daas.internal.dap.DAPRequestProcessor$1.run(DAPRequestProcessor.java:119)\n\tat org.eclipse.core.internal.jobs.Worker.run(Worker.java:63)\n"}}}

I also see files being populated. /ibmidebugservice/debugservice_log.txt used to be blank

And /QIBM/UserData/IBMIDEBUGSERVICE/startDebugService_workspace/.metadata/.log now exists and is populated.

!SESSION 2024-09-17 12:47:44.859 -----------------------------------------------
eclipse.buildId=unknown
java.fullversion=11.0.19+7
JRE 11 OS/400 ppc64-64-Bit Compressed References 20230620_000000 (JIT enabled, AOT enabled)
OpenJ9   - d57d05932
OMR      - 855813495
JCL      - 61e8703a10 based on jdk-11.0.19+7
BootLoader constants: OS=os/400, ARCH=ppc64, WS=unknown, NL=en_US
Framework arguments:  -application com.ibm.etools.iseries.daas.application -localonly -secureport=8006 -port=8001 -sepdaemonport=8008 -keystore=/QIBM/UserData/IBMiDebugService/certs/debug_service.pfx -keystorepassword=vuphCbDsboJGO/EdVHEWRn0nudBYNofevJbfnogaDOMoFFUiJ+OCpt0OYftm4bPM/0WnlSN874GHuor73M5afg==
Command-line arguments:  -application com.ibm.etools.iseries.daas.application -data /QIBM/UserData/IBMiDebugService/startDebugService_workspace -localonly -secureport=8006 -port=8001 -sepdaemonport=8008 -keystore=/QIBM/UserData/IBMiDebugService/certs/debug_service.pfx -keystorepassword=vuphCbDsboJGO/EdVHEWRn0nudBYNofevJbfnogaDOMoFFUiJ+OCpt0OYftm4bPM/0WnlSN874GHuor73M5afg==

!ENTRY com.ibm.etools.iseries.services.qsys 1 0 2024-09-17 12:49:21.398
!MESSAGE ToolboxConnectorService.internalConnect: connecting LOCALHOST

!ENTRY com.ibm.etools.iseries.services.qsys 1 0 2024-09-17 12:49:21.438
!MESSAGE ToolboxConnectorService.internalConnect(): Login with IBM i UserID and Password

!ENTRY com.ibm.etools.iseries.services.qsys 1 0 2024-09-17 12:49:21.597
!MESSAGE ToolboxConnectorService.internalConnect: connected LOCALHOST

!ENTRY com.ibm.debug.pdt.daas.application 2 0 2024-09-17 12:49:24.959
!MESSAGE unable to configure termination, default termination used

!ENTRY com.ibm.debug.pdt.daas.application 4 0 2024-09-17 12:49:25.016
!MESSAGE NullPointerException
!STACK 0
java.lang.NullPointerException
	at com.ibm.debug.pdt.daas.internal.dap.DAPSession.getVersionJSON(DAPSession.java:439)
	at com.ibm.debug.pdt.daas.internal.dap.events.DAPEvent.getEvent(DAPEvent.java:117)
	at com.ibm.debug.pdt.daas.internal.dap.requests.DAPConfigurationDoneRequest.generateEvents(DAPConfigurationDoneRequest.java:123)
	at com.ibm.debug.pdt.daas.internal.dap.requests.DAPRequest.process(DAPRequest.java:139)
	at com.ibm.debug.pdt.daas.internal.dap.requests.DAPRequest.process(DAPRequest.java:97)
	at com.ibm.debug.pdt.daas.internal.dap.DAPRequestProcessor$1.run(DAPRequestProcessor.java:119)
	at org.eclipse.core.internal.jobs.Worker.run(Worker.java:63)

!ENTRY com.ibm.debug.pdt.daas.application 2 0 2024-09-17 13:04:29.098
!MESSAGE unable to configure termination, default termination used

!ENTRY com.ibm.debug.pdt.daas.application 4 0 2024-09-17 13:04:29.129
!MESSAGE NullPointerException
!STACK 0
java.lang.NullPointerException
	at com.ibm.debug.pdt.daas.internal.dap.DAPSession.getVersionJSON(DAPSession.java:439)
	at com.ibm.debug.pdt.daas.internal.dap.events.DAPEvent.getEvent(DAPEvent.java:117)
	at com.ibm.debug.pdt.daas.internal.dap.requests.DAPConfigurationDoneRequest.generateEvents(DAPConfigurationDoneRequest.java:123)
	at com.ibm.debug.pdt.daas.internal.dap.requests.DAPRequest.process(DAPRequest.java:139)
	at com.ibm.debug.pdt.daas.internal.dap.requests.DAPRequest.process(DAPRequest.java:97)
	at com.ibm.debug.pdt.daas.internal.dap.DAPRequestProcessor$1.run(DAPRequestProcessor.java:119)
	at org.eclipse.core.internal.jobs.Worker.run(Worker.java:63)

!ENTRY com.ibm.debug.pdt.daas.application 2 0 2024-09-17 13:05:24.222
!MESSAGE unable to configure termination, default termination used

!ENTRY com.ibm.debug.pdt.daas.application 4 0 2024-09-17 13:05:24.288
!MESSAGE NullPointerException
!STACK 0
java.lang.NullPointerException
	at com.ibm.debug.pdt.daas.internal.dap.DAPSession.getVersionJSON(DAPSession.java:439)
	at com.ibm.debug.pdt.daas.internal.dap.events.DAPEvent.getEvent(DAPEvent.java:117)
	at com.ibm.debug.pdt.daas.internal.dap.requests.DAPConfigurationDoneRequest.generateEvents(DAPConfigurationDoneRequest.java:123)
	at com.ibm.debug.pdt.daas.internal.dap.requests.DAPRequest.process(DAPRequest.java:139)
	at com.ibm.debug.pdt.daas.internal.dap.requests.DAPRequest.process(DAPRequest.java:97)
	at com.ibm.debug.pdt.daas.internal.dap.DAPRequestProcessor$1.run(DAPRequestProcessor.java:119)
	at org.eclipse.core.internal.jobs.Worker.run(Worker.java:63)

[mkwan01]

@rogersonra The entries in launch.json are launch configuration templates, which are generated when the debug extension is installed. They cannot be used as is, unless you fill in all the required attributes.

The recommended debug solution is to use the integrated actions provided by code-for-i. After making a connection, you can create a filter in the Object Browser view, then expand to show the target program. You can right click on the program and select Starting Debugging > Debug as Batch.

[mkwan01]

@rogersonra If debug still fails with this solution, you can attach the DAP trace for the debug session. There is no associated debug session in your original DAP trace.

[rogersonra]

@mkwan01 Yippee it's working. Thanks tons...

Question...
Should I turn off the trace now?

Once again, thanks for all your help 😄

[mkwan01]

@rogersonra Trace is normally only turned on to diagnose a debug problem. You can turn it off when debug is working correctly.