├── .gitignore ├── EspExceptionDecoder.png ├── LICENSE ├── README.md ├── esp32-exception.png ├── make.sh └── src └── EspExceptionDecoder.java /.gitignore: -------------------------------------------------------------------------------- 1 | bin/ 2 | dist/ 3 | -------------------------------------------------------------------------------- /EspExceptionDecoder.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/me-no-dev/EspExceptionDecoder/ff4fc36bdaf0bfd6e750086ac01554867ede76d3/EspExceptionDecoder.png -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Arduino ESP8266/ESP32 Exception Stack Trace Decoder [![Build Status](https://travis-ci.org/me-no-dev/EspExceptionDecoder.svg?branch=master)](https://travis-ci.org/me-no-dev/EspExceptionDecoder) 2 | 3 | Arduino plugin which lets you get a more meaningful explanation of the stack traces you get on ESP8266/ESP32. 4 | 5 | 6 | ## Installation 7 | - Make sure you use one of the supported versions of Arduino IDE and have ESP8266/ESP32 core installed. 8 | - Download the tool archive from [releases page](https://github.com/me-no-dev/EspExceptionDecoder/releases/latest). 9 | - In your Arduino sketchbook directory, create tools directory if it doesn't exist yet. 10 | - Unpack the tool into tools directory (the path will look like `/Arduino/tools/EspExceptionDecoder/tool/EspExceptionDecoder.jar)`. 11 | - On newer versions of linux (Ubuntu 20.04), you may need to install the libncurses5 and libpython2.7 packages: `sudo apt install libncurses5 libpython2.7` 12 | - Restart Arduino IDE. 13 | 14 | ## Usage 15 | - Open a sketch and build it. 16 | - Upload the sketch and monitor the Serial port for Exceptions 17 | - When you get an Exception, open *Tools > ESP Exception Decoder* menu item. This will open a new window. 18 | - Paste the stack trace into the window's top pane and the result will show in the bottom. 19 | - Every time you enter new address or stack trace, the results will refresh 20 | 21 | ![EspExceptionDecoder.png](EspExceptionDecoder.png) 22 | 23 | ### Exception decoded on ESP32 24 | 25 | ![esp32-exception.png](esp32-exception.png) 26 | 27 | ## Gedit Highlighting 28 | You can use the *StackTrace* utility to have gedit highlight the above stack trace for easy viewing. More details can be found here: https://github.com/electronicsguy/ESP8266/tree/master/Misc/StackTrace 29 | 30 | ## Credits and license 31 | 32 | - Copyright (c) 2015 Hristo Gochkov (ficeto at ficeto dot com) 33 | - Licensed under GPL v2 ([text](LICENSE)) 34 | 35 | ## Command line version 36 | If you are searching for a command line version, look at [EspStackTraceDecoder] (https://github.com/littleyoda/EspStackTraceDecoder). EspStackTraceDecoder is based on the EspExceptionDecoder, but was completely rewritten for the command line usage. 37 | -------------------------------------------------------------------------------- /esp32-exception.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/me-no-dev/EspExceptionDecoder/ff4fc36bdaf0bfd6e750086ac01554867ede76d3/esp32-exception.png -------------------------------------------------------------------------------- /make.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | PROJECT=EspExceptionDecoder 4 | 5 | if [[ -z "$INSTALLDIR" ]]; then 6 | INSTALLDIR="$HOME/Documents/Arduino" 7 | fi 8 | echo "INSTALLDIR: $INSTALLDIR" 9 | 10 | pde_path=`find ../../../ -name pde.jar` 11 | core_path=`find ../../../ -name arduino-core.jar` 12 | lib_path=`find ../../../ -name commons-codec-1.7.jar` 13 | if [[ -z "$core_path" || -z "$pde_path" ]]; then 14 | echo "Some java libraries have not been built yet (did you run ant build?)" 15 | return 1 16 | fi 17 | echo "pde_path: $pde_path" 18 | echo "core_path: $core_path" 19 | echo "lib_path: $lib_path" 20 | 21 | set -e 22 | 23 | mkdir -p bin 24 | /Library/Java/JavaVirtualMachines/openlogic-openjdk-8.jdk/Contents/Home/bin/javac -target 1.8 -cp "$pde_path:$core_path:$lib_path" -d bin src/$PROJECT.java 25 | 26 | pushd bin 27 | mkdir -p $INSTALLDIR/tools 28 | rm -rf $INSTALLDIR/tools/$PROJECT 29 | mkdir -p $INSTALLDIR/tools/$PROJECT/tool 30 | zip -r $INSTALLDIR/tools/$PROJECT/tool/$PROJECT.jar * 31 | popd 32 | 33 | dist=$PWD/dist 34 | rev=$(git describe --tags) 35 | mkdir -p $dist 36 | pushd $INSTALLDIR/tools 37 | zip -r $dist/$PROJECT-$rev.zip $PROJECT/ 38 | popd 39 | -------------------------------------------------------------------------------- /src/EspExceptionDecoder.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2015 Hristo Gochkov (ficeto at ficeto dot com) 3 | 4 | This program is free software; you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation; either version 2 of the License, or 7 | (at your option) any later version. 8 | 9 | This program is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with this program; if not, write to the Free Software Foundation, 16 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 17 | */ 18 | package com.ficeto.esp; 19 | import cc.arduino.files.DeleteFilesOnShutdown; 20 | import java.awt.*; 21 | import java.awt.event.*; 22 | import java.awt.event.ActionEvent; 23 | import java.io.BufferedReader; 24 | import java.io.File; 25 | import java.io.IOException; 26 | import java.io.InputStreamReader; 27 | import java.lang.reflect.Field; 28 | import java.lang.reflect.InvocationTargetException; 29 | import java.text.SimpleDateFormat; 30 | import java.util.*; 31 | import java.util.regex.*; 32 | import javax.swing.*; 33 | import javax.swing.filechooser.*; 34 | import javax.swing.event.DocumentEvent; 35 | import javax.swing.event.DocumentListener; 36 | import org.apache.commons.codec.digest.DigestUtils; 37 | import processing.app.Base; 38 | import processing.app.BaseNoGui; 39 | import processing.app.Editor; 40 | import processing.app.Platform; 41 | import processing.app.PreferencesData; 42 | import processing.app.Sketch; 43 | //import processing.app.SketchData; 44 | import processing.app.debug.TargetPlatform; 45 | import processing.app.helpers.FileUtils; 46 | import processing.app.helpers.OSUtils; 47 | import processing.app.helpers.ProcessUtils; 48 | import processing.app.tools.Tool; 49 | 50 | public class EspExceptionDecoder implements Tool, DocumentListener { 51 | Editor editor; 52 | JTextPane outputArea; 53 | String outputText; 54 | JTextArea inputArea; 55 | JFrame frame; 56 | File tool; 57 | File elf; 58 | 59 | private static String[] exceptions = { 60 | "Illegal instruction", 61 | "SYSCALL instruction", 62 | "InstructionFetchError: Processor internal physical address or data error during instruction fetch", 63 | "LoadStoreError: Processor internal physical address or data error during load or store", 64 | "Level1Interrupt: Level-1 interrupt as indicated by set level-1 bits in the INTERRUPT register", 65 | "Alloca: MOVSP instruction, if caller's registers are not in the register file", 66 | "IntegerDivideByZero: QUOS, QUOU, REMS, or REMU divisor operand is zero", 67 | "reserved", 68 | "Privileged: Attempt to execute a privileged operation when CRING ? 0", 69 | "LoadStoreAlignmentCause: Load or store to an unaligned address", 70 | "reserved", 71 | "reserved", 72 | "InstrPIFDataError: PIF data error during instruction fetch", 73 | "LoadStorePIFDataError: Synchronous PIF data error during LoadStore access", 74 | "InstrPIFAddrError: PIF address error during instruction fetch", 75 | "LoadStorePIFAddrError: Synchronous PIF address error during LoadStore access", 76 | "InstTLBMiss: Error during Instruction TLB refill", 77 | "InstTLBMultiHit: Multiple instruction TLB entries matched", 78 | "InstFetchPrivilege: An instruction fetch referenced a virtual address at a ring level less than CRING", 79 | "reserved", 80 | "InstFetchProhibited: An instruction fetch referenced a page mapped with an attribute that does not permit instruction fetch", 81 | "reserved", 82 | "reserved", 83 | "reserved", 84 | "LoadStoreTLBMiss: Error during TLB refill for a load or store", 85 | "LoadStoreTLBMultiHit: Multiple TLB entries matched for a load or store", 86 | "LoadStorePrivilege: A load or store referenced a virtual address at a ring level less than CRING", 87 | "reserved", 88 | "LoadProhibited: A load referenced a page mapped with an attribute that does not permit loads", 89 | "StoreProhibited: A store referenced a page mapped with an attribute that does not permit stores" 90 | }; 91 | 92 | public void init(Editor editor) { 93 | this.editor = editor; 94 | } 95 | 96 | public String getMenuTitle() { 97 | return "ESP Exception Decoder"; 98 | } 99 | 100 | private void printLine(String line){ 101 | String s = prettyPrintGDBLine(line); 102 | if (s != null) 103 | outputText += s +"\n"; 104 | } 105 | 106 | private void printLogLine(String line, String color){ 107 | outputText += ""+line+"\n"; 108 | } 109 | 110 | private void printError(String line){ 111 | printLogLine(line, "red"); 112 | } 113 | 114 | // Original code from processing.app.helpers.ProcessUtils.exec() 115 | // Need custom version to redirect STDERR to STDOUT for GDB processing 116 | public static Process execRedirected(String[] command) throws IOException { 117 | ProcessBuilder pb; 118 | 119 | // No problems on linux and mac 120 | if (!OSUtils.isWindows()) { 121 | pb = new ProcessBuilder(command); 122 | } else { 123 | // Brutal hack to workaround windows command line parsing. 124 | // http://stackoverflow.com/questions/5969724/java-runtime-exec-fails-to-escape-characters-properly 125 | // http://msdn.microsoft.com/en-us/library/a1y7w461.aspx 126 | // http://bugs.sun.com/view_bug.do?bug_id=6468220 127 | // http://bugs.sun.com/view_bug.do?bug_id=6518827 128 | String[] cmdLine = new String[command.length]; 129 | for (int i = 0; i < command.length; i++) 130 | cmdLine[i] = command[i].replace("\"", "\\\""); 131 | pb = new ProcessBuilder(cmdLine); 132 | Map env = pb.environment(); 133 | env.put("CYGWIN", "nodosfilewarning"); 134 | } 135 | pb.redirectErrorStream(true); 136 | 137 | return pb.start(); 138 | } 139 | 140 | private int listenOnProcess(String[] arguments){ 141 | try { 142 | final Process p = execRedirected(arguments); 143 | Thread thread = new Thread() { 144 | public void run() { 145 | try { 146 | InputStreamReader reader = new InputStreamReader(p.getInputStream()); 147 | int c; 148 | String line = ""; 149 | while ((c = reader.read()) != -1){ 150 | if((char)c == '\r') 151 | continue; 152 | if((char)c == '\n'){ 153 | printLine(line); 154 | line = ""; 155 | } else { 156 | line += (char)c; 157 | } 158 | } 159 | printLine(line); 160 | reader.close(); 161 | 162 | reader = new InputStreamReader(p.getErrorStream()); 163 | while ((c = reader.read()) != -1) 164 | System.err.print((char) c); 165 | reader.close(); 166 | } catch (Exception e){ 167 | printError("Run Exception: "+e.getMessage()); 168 | } 169 | } 170 | }; 171 | thread.start(); 172 | int res = p.waitFor(); 173 | thread.join(); 174 | if(res != 0){ 175 | printError("Decode Failed"); 176 | } 177 | return res; 178 | } catch (Exception e){ 179 | printError("Decode Exception: "+e.getMessage()); 180 | } 181 | return -1; 182 | } 183 | 184 | private void sysExec(final String[] arguments){ 185 | Thread thread = new Thread() { 186 | public void run() { 187 | try { 188 | if(listenOnProcess(arguments) != 0){ 189 | editor.statusError("Decode Failed"); 190 | } else { 191 | editor.statusNotice("Decode Success"); 192 | } 193 | } catch (Exception e){ 194 | editor.statusError("Decode Exception"); 195 | printError("Decode Exception: "+e.getMessage()); 196 | } 197 | outputArea.setText(outputText); 198 | } 199 | }; 200 | thread.start(); 201 | } 202 | 203 | private String getBuildFolderPath(Sketch s) { 204 | // first of all try the getBuildPath() function introduced with IDE 1.6.12 205 | // see commit arduino/Arduino#fd1541eb47d589f9b9ea7e558018a8cf49bb6d03 206 | try { 207 | String buildpath = s.getBuildPath().getAbsolutePath(); 208 | return buildpath; 209 | } 210 | catch (IOException er) { 211 | editor.statusError(er); 212 | } 213 | catch (Exception er) { 214 | try { 215 | File buildFolder = FileUtils.createTempFolder("build", DigestUtils.md5Hex(s.getMainFilePath()) + ".tmp"); 216 | //DeleteFilesOnShutdown.add(buildFolder); 217 | return buildFolder.getAbsolutePath(); 218 | } 219 | catch (IOException e) { 220 | editor.statusError(e); 221 | } 222 | catch (Exception e) { 223 | // Arduino 1.6.5 doesn't have FileUtils.createTempFolder 224 | // String buildPath = BaseNoGui.getBuildFolder().getAbsolutePath(); 225 | java.lang.reflect.Method method; 226 | try { 227 | method = BaseNoGui.class.getMethod("getBuildFolder"); 228 | File f = (File) method.invoke(null); 229 | return f.getAbsolutePath(); 230 | } catch (SecurityException ex) { 231 | editor.statusError(ex); 232 | } catch (IllegalAccessException ex) { 233 | editor.statusError(ex); 234 | } catch (InvocationTargetException ex) { 235 | editor.statusError(ex); 236 | } catch (NoSuchMethodException ex) { 237 | editor.statusError(ex); 238 | } 239 | } 240 | } 241 | return ""; 242 | } 243 | 244 | 245 | private long getIntPref(String name){ 246 | String data = BaseNoGui.getBoardPreferences().get(name); 247 | if(data == null || data.contentEquals("")) return 0; 248 | if(data.startsWith("0x")) return Long.parseLong(data.substring(2), 16); 249 | else return Integer.parseInt(data); 250 | } 251 | 252 | class ElfFilter extends FileFilter { 253 | public String getExtension(File f) { 254 | String ext = null; 255 | String s = f.getName(); 256 | int i = s.lastIndexOf('.'); 257 | if (i > 0 && i < s.length() - 1) { 258 | ext = s.substring(i+1).toLowerCase(); 259 | } 260 | return ext; 261 | } 262 | public boolean accept(File f) { 263 | if (f.isDirectory()) { 264 | return true; 265 | } 266 | String extension = getExtension(f); 267 | if (extension != null) { 268 | return extension.equals("elf"); 269 | } 270 | return false; 271 | } 272 | public String getDescription() { 273 | return "*.elf files"; 274 | } 275 | } 276 | 277 | private void createAndUpload(){ 278 | if(!PreferencesData.get("target_platform").contentEquals("esp8266") && !PreferencesData.get("target_platform").contentEquals("esp32") && !PreferencesData.get("target_platform").contentEquals("ESP31B")){ 279 | System.err.println(); 280 | editor.statusError("Not Supported on "+PreferencesData.get("target_platform")); 281 | return; 282 | } 283 | 284 | String core = PreferencesData.get("target_platform"); 285 | String tarch = "xtensa"; 286 | String target = "lx106"; 287 | 288 | if(core.contentEquals("esp32")){ 289 | try { 290 | tarch = BaseNoGui.getBoardPreferences().get("build.tarch"); 291 | if(tarch == null || tarch.contentEquals("")){ 292 | editor.statusError("Arch Not Found for '"+BaseNoGui.getBoardPreferences().get("name")+"'. Defaulting to 'xtensa'"); 293 | tarch = "xtensa"; 294 | } 295 | target = BaseNoGui.getBoardPreferences().get("build.target"); 296 | if(target == null || target.contentEquals("")){ 297 | editor.statusError("Target Not Found for '"+BaseNoGui.getBoardPreferences().get("name")+"'. Defaulting to 'esp32'"); 298 | target = "esp32"; 299 | } 300 | } catch(Exception e){ 301 | editor.statusError(e); 302 | return; 303 | } 304 | } 305 | 306 | TargetPlatform platform = BaseNoGui.getTargetPlatform(); 307 | String tc = tarch+"-"+target+"-elf"; 308 | String tcgdb = tarch+"-esp-elf-gdb"; 309 | String tools = platform.getFolder() + "/tools/"; 310 | 311 | String gdb; 312 | if(PreferencesData.get("runtime.os").contentEquals("windows")) 313 | gdb = tc+"-gdb.exe"; 314 | else 315 | gdb = tc+"-gdb"; 316 | 317 | // Search for GDB 318 | // First check if the GDB package is installed locally (v2.0.8+) 319 | tool = new File(tools + tcgdb + "/bin", gdb); 320 | if (!tool.exists() || !tool.isFile()){ 321 | //System.err.println("tools/"+tcgdb+"/bin/"+gdb+" not found"); 322 | // Then check if the toolchain is installed locally 323 | tool = new File(tools + tc + "/bin", gdb); 324 | if (!tool.exists() || !tool.isFile()){ 325 | //System.err.println("tools/"+tc+"/bin/"+gdb+" not found"); 326 | // Then check if the GDB package is installed (v2.0.8+) 327 | String gdbPath = PreferencesData.get("runtime.tools."+tcgdb+".path"); 328 | if(gdbPath == null || gdbPath.contentEquals("")){ 329 | //System.err.println("runtime.tools."+tcgdb+".path not found"); 330 | // Then check if the toolchain is installed 331 | gdbPath = PreferencesData.get("runtime.tools."+tc+"-gcc.path"); 332 | } 333 | if(gdbPath == null || gdbPath.contentEquals("")){ 334 | //System.err.println("runtime.tools."+tc+"-gcc.path not found"); 335 | // If still fails, offer the local toolchain folder 336 | gdbPath = tools+tc; 337 | } 338 | System.err.println("gdbPath: "+gdbPath+"/bin/"+gdb); 339 | tool = new File(gdbPath + "/bin", gdb); 340 | } else { 341 | System.err.println("gdbPath: "+tools+tc+"/bin/"+gdb); 342 | } 343 | } else { 344 | System.err.println("gdbPath: "+tools+tcgdb+"/bin/"+gdb); 345 | } 346 | System.err.println(); 347 | 348 | if (!tool.exists() || !tool.isFile()) { 349 | System.err.println(); 350 | editor.statusError("ERROR: "+gdb+" not found!"); 351 | return; 352 | } 353 | 354 | elf = new File(getBuildFolderPath(editor.getSketch()), editor.getSketch().getName() + ".ino.elf"); 355 | if (!elf.exists() || !elf.isFile()) { 356 | elf = new File(getBuildFolderPath(editor.getSketch()), editor.getSketch().getName() + ".cpp.elf"); 357 | if (!elf.exists() || !elf.isFile()){ 358 | //lets give the user a chance to select the elf 359 | final JFileChooser fc = new JFileChooser(); 360 | fc.addChoosableFileFilter(new ElfFilter()); 361 | fc.setAcceptAllFileFilterUsed(false); 362 | int returnVal = fc.showDialog(editor, "Select ELF"); 363 | if (returnVal == JFileChooser.APPROVE_OPTION) { 364 | elf = fc.getSelectedFile(); 365 | } else { 366 | editor.statusError("ERROR: elf was not found!"); 367 | System.err.println("Open command cancelled by user."); 368 | return; 369 | } 370 | } 371 | } 372 | 373 | JFrame.setDefaultLookAndFeelDecorated(true); 374 | frame = new JFrame("Exception Decoder"); 375 | frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE); 376 | 377 | inputArea = new JTextArea("Paste your stack trace here", 16, 60); 378 | inputArea.setLineWrap(true); 379 | inputArea.setWrapStyleWord(true); 380 | inputArea.getInputMap().put(KeyStroke.getKeyStroke("ENTER"), "commit"); 381 | inputArea.getActionMap().put("commit", new CommitAction()); 382 | inputArea.getDocument().addDocumentListener(this); 383 | frame.getContentPane().add(new JScrollPane(inputArea), BorderLayout.PAGE_START); 384 | 385 | outputText = ""; 386 | outputArea = new JTextPane(); 387 | outputArea.setContentType("text/html"); 388 | outputArea.setEditable(false); 389 | outputArea.setBackground(null); 390 | outputArea.setBorder(null); 391 | outputArea.putClientProperty(JEditorPane.HONOR_DISPLAY_PROPERTIES, true); 392 | outputArea.setText(outputText); 393 | 394 | JScrollPane outputScrollPane = new JScrollPane(outputArea); 395 | outputScrollPane.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_ALWAYS); 396 | outputScrollPane.setPreferredSize(new Dimension(640, 200)); 397 | outputScrollPane.setMinimumSize(new Dimension(10, 10)); 398 | frame.getContentPane().add(outputScrollPane, BorderLayout.CENTER); 399 | 400 | frame.pack(); 401 | frame.setVisible(true); 402 | } 403 | 404 | private String prettyPrintGDBLine(String line) { 405 | String address = "", method = "", file = "", fileline = "", html = ""; 406 | 407 | if (!line.startsWith("0x")) { 408 | return null; 409 | } 410 | 411 | address = line.substring(0, line.indexOf(' ')); 412 | line = line.substring(line.indexOf(' ') + 1); 413 | 414 | int atIndex = line.indexOf("is in "); 415 | if(atIndex == -1) { 416 | return null; 417 | } 418 | try { 419 | method = line.substring(atIndex + 6, line.lastIndexOf('(') - 1); 420 | fileline = line.substring(line.lastIndexOf('(') + 1, line.lastIndexOf(')')); 421 | file = fileline.substring(0, fileline.lastIndexOf(':')); 422 | line = fileline.substring(fileline.lastIndexOf(':') + 1); 423 | if(file.length() > 0){ 424 | int lastfs = file.lastIndexOf('/'); 425 | int lastbs = file.lastIndexOf('\\'); 426 | int slash = (lastfs > lastbs)?lastfs:lastbs; 427 | if(slash != -1){ 428 | String filename = file.substring(slash+1); 429 | file = file.substring(0,slash+1) + "" + filename + ""; 430 | } 431 | } 432 | html = "" + address + ": " + 433 | "" + method + " at " + 434 | file + " line " + line + ""; 435 | } catch (Exception e) { 436 | // Something weird in the GDB output format, report what we can 437 | html = "" + address + ": " + line; 438 | } 439 | 440 | return html; 441 | } 442 | 443 | public void run() { 444 | createAndUpload(); 445 | } 446 | 447 | private void parseException(){ 448 | String content = inputArea.getText(); 449 | Pattern p = Pattern.compile("Exception \\(([0-9]*)\\):"); 450 | Matcher m = p.matcher(content); 451 | if(m.find()){ 452 | int exception = Integer.parseInt(m.group(1)); 453 | if(exception < 0 || exception > 29){ 454 | return; 455 | } 456 | outputText += "Exception "+exception+": "+exceptions[exception]+"\n"; 457 | } 458 | } 459 | 460 | // Strip out just the STACK lines or BACKTRACE line, and generate the reference log 461 | private void parseStackOrBacktrace(String regexp, boolean multiLine, String stripAfter) { 462 | String content = inputArea.getText(); 463 | 464 | Pattern strip; 465 | if (multiLine) strip = Pattern.compile(regexp, Pattern.DOTALL); 466 | else strip = Pattern.compile(regexp); 467 | Matcher stripMatch = strip.matcher(content); 468 | if (!stripMatch.find()) { 469 | return; // Didn't find it in the text box. 470 | } 471 | 472 | // Strip out just the interesting bits to make RexExp sane 473 | content = content.substring(stripMatch.start(), stripMatch.end()); 474 | 475 | if (stripAfter != null) { 476 | Pattern after = Pattern.compile(stripAfter); 477 | Matcher afterMatch = after.matcher(content); 478 | if (afterMatch.find()) { 479 | content = content.substring(0, afterMatch.start()); 480 | } 481 | } 482 | 483 | // Anything looking like an instruction address, dump! 484 | Pattern p = Pattern.compile("4[0-3](\\d|[a-f]|[A-F]){6}\\b"); 485 | int count = 0; 486 | Matcher m = p.matcher(content); 487 | while(m.find()) { 488 | count ++; 489 | } 490 | if(count == 0){ 491 | return; 492 | } 493 | String command[] = new String[7 + count*2]; 494 | int i = 0; 495 | command[i++] = tool.getAbsolutePath(); 496 | command[i++] = "--batch"; 497 | command[i++] = elf.getAbsolutePath(); 498 | command[i++] = "-ex"; 499 | command[i++] = "set listsize 1"; 500 | m = p.matcher(content); 501 | while(m.find()) { 502 | command[i++] = "-ex"; 503 | command[i++] = "l *0x"+content.substring(m.start(), m.end()); 504 | } 505 | command[i++] = "-ex"; 506 | command[i++] = "q"; 507 | System.out.println("\""+String.join("\" \"", command)+"\""); 508 | outputText += "\nDecoding stack results\n"; 509 | sysExec(command); 510 | } 511 | 512 | // Heavyweight call GDB, run list on address, and return result if it succeeded 513 | private String decodeFunctionAtAddress( String addr ) { 514 | String command[] = new String[9]; 515 | command[0] = tool.getAbsolutePath(); 516 | command[1] = "--batch"; 517 | command[2] = elf.getAbsolutePath(); 518 | command[3] = "-ex"; 519 | command[4] = "set listsize 1"; 520 | command[5] = "-ex"; 521 | command[6] = "l *0x" + addr; 522 | command[7] = "-ex"; 523 | command[8] = "q"; 524 | System.out.println("\""+String.join("\" \"", command)+"\""); 525 | 526 | try { 527 | final Process proc = execRedirected(command); 528 | InputStreamReader reader = new InputStreamReader(proc.getInputStream()); 529 | int c; 530 | String line = ""; 531 | while ((c = reader.read()) != -1){ 532 | if((char)c == '\r') 533 | continue; 534 | if((char)c == '\n' && line != ""){ 535 | reader.close(); 536 | return prettyPrintGDBLine(line); 537 | } else { 538 | line += (char)c; 539 | } 540 | } 541 | reader.close(); 542 | } catch (Exception e) { 543 | // Something went wrong 544 | System.err.println("Function Decode Exception: "+e.getMessage()); 545 | } 546 | return null; 547 | } 548 | 549 | // Scan and report the last failed memory allocation attempt, if present on the ESP8266 550 | private void parseAlloc() { 551 | String content = inputArea.getText(); 552 | Pattern p = Pattern.compile("last failed alloc call: 4[0-3](\\d|[a-f]|[A-F]){6}\\((\\d)+\\)"); 553 | Matcher m = p.matcher(content); 554 | if (m.find()) { 555 | String fs = content.substring(m.start(), m.end()); 556 | Pattern p2 = Pattern.compile("4[0-3](\\d|[a-f]|[A-F]){6}\\b"); 557 | Matcher m2 = p2.matcher(fs); 558 | if (m2.find()) { 559 | String addr = fs.substring(m2.start(), m2.end()); 560 | Pattern p3 = Pattern.compile("\\((\\d)+\\)"); 561 | Matcher m3 = p3.matcher(fs); 562 | if (m3.find()) { 563 | String size = fs.substring(m3.start()+1, m3.end()-1); 564 | String line = decodeFunctionAtAddress(addr); 565 | if (line != null) { 566 | outputText += "Memory allocation of " + size + " bytes failed at " + line + "\n"; 567 | } 568 | } 569 | } 570 | } 571 | } 572 | 573 | // Filter out a register output given a regex (ESP8266/ESP32 differ in format) 574 | private void parseRegister(String regName, String prettyName) { 575 | String content = inputArea.getText(); 576 | Pattern p = Pattern.compile(regName + "(\\d|[a-f]|[A-F]){8}\\b"); 577 | Matcher m = p.matcher(content); 578 | if (m.find()) { 579 | String fs = content.substring(m.start(), m.end()); 580 | Pattern p2 = Pattern.compile("(\\d|[a-f]|[A-F]){8}\\b"); 581 | Matcher m2 = p2.matcher(fs); 582 | if (m2.find()) { 583 | String addr = fs.substring(m2.start(), m2.end()); 584 | String line = decodeFunctionAtAddress(addr); 585 | if (line != null) { 586 | outputText += prettyName + ": " + line + "\n"; 587 | } else { 588 | outputText += prettyName + ": 0x" + addr + "\n"; 589 | } 590 | } 591 | } 592 | } 593 | 594 | private void runParser(){ 595 | outputText = "
\n";
596 |     // Main error cause
597 |     parseException();
598 |     // ESP8266 register format
599 |     parseRegister("epc1=0x", "PC");
600 |     parseRegister("excvaddr=0x", "EXCVADDR");
601 |     // ESP32 register format
602 |     parseRegister("PC\\s*:\\s*(0x)?", "PC");
603 |     parseRegister("EXCVADDR\\s*:\\s*(0x)?", "EXCVADDR");
604 |     // Last memory allocation failure
605 |     parseAlloc();
606 |     // The stack on ESP8266, multiline
607 |     parseStackOrBacktrace(">>>stack>>>(.)*", true, "<<