Tool support for inspecting the code quality of HPC apps

Transcription

1 Tool support for inspecting the code quality of HPC apps Thomas Panas, Dan Quinlan Center for Applied Scientific Computing (CASC) Lawrence Livermore National Laboratory Richard Vuduc LLNL / Georgia Tech 3 rd Workshop on Software Engineering for HPC Apps

2 Research motivation and goals Context: HPC development is often ad hoc, not formal Unknown requirements at project start No training in (or time for) formal processes Developer or team may be sole customer initially Correctness and performance first, maintenance later Whether maintenance considered or not, codes have long lifetimes Goal: Communicate code quality unobtrusively Provide on-demand feedback to dev. team Integrate naturally into dev. process Use interactive visualization when appropriate Incorporate team-specific coding guidelines/requirements Panas, et al. - UCRL-PRES

3 ROSE-VA: A code quality inspection tool prototype Reports code quality metrics Maintainability Component reusability Software metrics Visualizes judiciously File or module coherence as static images Software architecture in interactive views Implemented using extensible tools ROSE: Source-to-source compiler for C, C++ (Fortran in progress) VizzAnalyzer / Vizz3D: Interactive software viz framework This talk: Overview, status, and example (SMG2000) Panas, et al. - UCRL-PRES

4 Architecture-level viz of call graph (SMG2k) Panas, et al. - UCRL-PRES

5 Architecture-level viz of call graph (SMG2k) Panas, et al. - UCRL-PRES

6 Categories of code quality information Simple statistics E.g., lines of code, global variable count, no. of security violations Context-insensitive, so displayed as text Coherence reports E.g., global variables and files in which they appear Shows simple contextual relationships Shown as text or 2-D static images Architecture-level information overviews E.g., module dependencies Visualized interactively, using physical metaphors Panas, et al. - UCRL-PRES

7 Sample application : SMG2k SMG2000: A semicoarsening multigrid benchmark C program from ASC Purple Benchmark suite ~46 KLOC in 5 modules and ~70 files Small but interesting example of one-shot app Intended for single-use Contains subset of hypre library, so should be well-structured Panas, et al. - UCRL-PRES

8 Simple statistics Global statistics Lines of code; abstract syntax tree (AST) statistics No. of files, types of files (e.g., source vs. header) No. and type of classes No. of function calls (static) Simple analysis summaries Security or API violations (e.g., sprintf, new-delete) Cyclomatic complexity per function or file Global variable analysis Cyclic dependencies Naming convention violations Degree of documentation Arithmetic complexity Panas, et al. - UCRL-PRES

9 Simple analysis results for SMG2k Analysis Security / API misuse Cyclomatic complexity per function Global variables LOC per function Cyclic file dependencies Naming convention violations Threshold 0 < 20 0 < # of violations Panas, et al. - UCRL-PRES

10 Coherence reporting Relationships between a few pieces of information, rendered in 2-D static images Example: Where are the global variables? And can we eliminate them? Relate files, global variable references, variable types (static vs. true global) Panas, et al. - UCRL-PRES

11 Panas, et al. - UCRL-PRES

12 Files Panas, et al. - UCRL-PRES

13 File-scoped global Panas, et al. - UCRL-PRES

14 True globals Panas, et al. - UCRL-PRES

15 Example: Source and header dependencies (File-include graph) Panas, et al. - UCRL-PRES

16 Architecture-level information overviews For viewing lots of information in context of software architecture Our approach: Interactive viz with natural metaphors Interactive 3-D view of graphs Islands (modules), cities (files), bulidings (functions) Example: Where is the code becoming complex? Large functions and modules? Cyclic module dependencies, based on call graph? Panas, et al. - UCRL-PRES

17 Classical call graph viz (SMG2K) Panas, et al. - UCRL-PRES

18 Architecture-level viz of call graph (SMG2K) Panas, et al. - UCRL-PRES

19 Architecture-level viz of call graph (SMG2K) Panas, et al. - UCRL-PRES

20 void P DE::Compute_Residuals () // The decision to implement the residual computation seperately is a design preference. if (DEBUG > 0) p rintf ("Compute Residuals! \n"); Residual = 0.0; double Scaling_Factor = 1.0 / (M esh_size * Mesh_Size) ; if (Problem_Dimension == 1) Residual (I) = R ight_hand_side (I) + Scaling_Factor * ( Solution (I+1) + Solution (I-1) * Solution (I) ); if (Problem_Dimension == 2) if (F ully_variational) Solution (I,J+1) + Solution (I-1,J-1) - Residual (I,J) = Right_Hand_Side (I,J) + Scaling_Factor * ( #ifdef GRAPHICS #endif Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I+1,J+1) + Solution (I-1,J+1) + Solution (I+1,J-1) * Solution (I,J) ); Residual (I,J) = Right_Hand_Side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) * Solution (I,J) ); Graphics_Object.setProperty(TOPLABEL,"Residual" ); Graphics_Object.setProperty(CONTSTYLE,2); Graphics_Object.setProperty(NSTEPS,10); Graphics_Object.contour(Residual); if (P roblem_dimension == 3) if (F ully_variational) Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( // Center face Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I+1,J+1,K) + Solution (I-1,J+1,K) + Solution (I+1,J-1,K) + Solution (I-1,J-1,K) + // Inner face Solution (I+1,J,K-1) + Solution (I-1,J,K-1) + Solution (I,J-1,K-1) + Solution (I,J+1,K-1) + Solution (I+1,J+1,K-1) + Solution (I-1,J+1,K-1) + Solution (I+1,J-1,K-1) + Solution (I-1,J-1,K-1) + // Outer face Solution (I+1,J,K+1) + Solution (I-1,J,K+1) + Solution (I,J-1,K+1) + Solution (I,J+1,K+1) + Solution (I+1,J+1,K+1) + Solution (I-1,J+1,K+1) + Solution (I+1,J-1,K+1) + Solution (I-1,J-1,K+1) + // Center point of Inner and Outer faces Solution (I,J,K-1) + Solution (I,J,K+1) - // Center point 26.0 * Solution (I,J,K) ); Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( if (DEBUG > 0) p rintf ("Leaving Compute Residuals! \n"); // Swap sign for test! // Residual = -Residual; Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I,J,K-1) + Solution (I,J,K+1) * Solution (I,J,K) ); void P DE::Compute_Residuals () // The decision to implement the residual computation seperately is a design preference. if (DEBUG > 0) p rintf ("Compute Residuals! \n"); Residual = 0.0; double Scaling_Factor = 1.0 / (M esh_size * Mesh_Size) ; if (Problem_Dimension == 1) Residual (I) = R ight_hand_side (I) + Scaling_Factor * ( (I,J+1) + Solution (I+1) + Solution (I-1) * Solution (I) ); if (Problem_Dimension == 2) if (F ully_variational) Solution (I-1,J-1) - Residual (I,J) = Right_Hand_Side (I,J) + Scaling_Factor * ( #ifdef GRAPHICS #endif Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution Solution (I+1,J+1) + Solution (I-1,J+1) + Solution (I+1,J-1) * Solution (I,J) ); Residual (I,J) = Right_Hand_Side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) * Solution (I,J) ); Graphics_Object.setProperty(TOPLABEL,"Residual" ); Graphics_Object.setProperty(CONTSTYLE,2); Graphics_Object.setProperty(NSTEPS,10); Graphics_Object.contour(Residual); if (P roblem_dimension == 3) if (F ully_variational) Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( // Center face Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I+1,J+1,K) + Solution (I-1,J+1,K) + Solution (I+1,J-1,K) + Solution (I-1,J-1,K) + // Inner face Solution (I+1,J,K-1) + Solution (I-1,J,K-1) + Solution (I,J-1,K-1) + Solution (I,J+1,K-1) + Solution (I+1,J+1,K-1) + Solution (I-1,J+1,K-1) + Solution (I+1,J-1,K-1) + Solution (I-1,J-1,K-1) + // Outer face Solution (I+1,J,K+1) + Solution (I-1,J,K+1) + Solution (I,J-1,K+1) + Solution (I,J+1,K+1) + Solution (I+1,J+1,K+1) + Solution (I-1,J+1,K+1) + Solution (I+1,J-1,K+1) + Solution (I-1,J-1,K+1) + // Center point of Inner and Outer faces Solution (I,J,K-1) + Solution (I,J,K+1) - // Center point 26.0 * Solution (I,J,K) ); Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( if (DEBUG > 0) p rintf ("Leaving Compute Residuals! \n"); // Swap sign for test! // Residual = -Residual; Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I,J,K-1) + Solution (I,J,K+1) * Solution (I,J,K) ); Implementation: ROSE-VA combines compiler & viz tools parse: ROSE analyze: ROSE visualize: Vizz3D Source Code Source Code Main() asdf sdfs; sdfs Asdfs Main() asdf sdfs; sdfs Asdfs Panas, et al. - UCRL-PRES

21 ROSE-VA combines compiler & viz tools parse: ROSE Source Code void P DE::Compute_Residuals () // The decision to implement the residual computation seperately is a design preference. if (DEBUG > 0) p rintf ("Compute Residuals! \n"); analyze: ROSE visualize: Vizz3D Source Code void P DE::Compute_Residuals () // The decision to implement the residual computation seperately is a design preference. if (DEBUG > 0) p rintf ("Compute Residuals! \n"); Residual = 0.0; Residual = 0.0; double S caling_factor = 1.0 / ( M esh_size * Mesh_Size) ; if (P roblem_dimension == 1) Residual (I) = R ight_hand_side (I) + Scaling_Factor * ( Solution (I+1) + Solution (I-1) * Solution (I) ); if (Problem_Dimension == 2) if (F ully_variational) Residual (I,J) = R ight_hand_side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) + Solution (I+1,J+1) + Solution (I-1,J+1) + Solution (I+1,J-1) + Solution (I-1,J-1) 8.0 * Solution (I,J) ); Residual (I,J) = R ight_hand_side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) * Solution (I,J) ); #ifdef GRAPHICS G raphics_object.setproperty(toplabel,"residual " ); Graphics_Object.setProperty(CONTSTYLE,2); Graphics_Object.setProperty(NSTEPS,10); G raphics_object.contour(residual); #e ndif if (P roblem_dimension == 3) if (F ully_variational ) Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( // Center face Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I+1,J+1,K) + Solution (I-1,J+1,K) + Solution (I+1,J-1,K) + Solution (I-1,J-1,K) + // Inner face Solution (I+1,J,K-1) + Solution (I-1,J,K-1) + Solution (I,J-1,K-1) + Solution (I,J+1,K-1) + Solution (I+1,J+1,K-1) + Solution (I-1,J+1,K-1) + Solution (I+1,J-1,K-1) + Solution (I-1,J-1,K-1) + // Outer face Solution (I+1,J,K+1) + Solution (I-1,J,K+1) + Solution (I,J-1,K+1) + Solution (I,J+1,K+1) + Solution (I+1,J+1,K+1) + Solution (I-1,J+1,K+1) + Solution (I+1,J-1,K+1) + Solution (I-1,J-1,K+1) + // Center point of Inner and Outer faces Solution (I,J,K-1) + Solution (I,J,K+1) // Center point 26.0 * Solution (I,J,K) ); Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I,J,K-1) + Solution (I,J,K+1) * Solution (I,J,K) ); double S caling_factor = 1.0 / ( M esh_size * Mesh_Size) ; if (P roblem_dimension == 1) Residual (I) = R ight_hand_side (I) + Scaling_Factor * ( Solution (I+1) + Solution (I-1) * Solution (I) ); if (Problem_Dimension == 2) if (F ully_variational) Residual (I,J) = R ight_hand_side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) + Solution (I+1,J+1) + Solution (I-1,J+1) + Solution (I+1,J-1) + Solution (I-1,J-1) 8.0 * Solution (I,J) ); Residual (I,J) = R ight_hand_side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) * Solution (I,J) ); #ifdef GRAPHICS G raphics_object.setproperty(toplabel,"residual " ); Graphics_Object.setProperty(CONTSTYLE,2); Graphics_Object.setProperty(NSTEPS,10); G raphics_object.contour(residual); #e ndif if (P roblem_dimension == 3) if (F ully_variational ) Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( // Center face Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I+1,J+1,K) + Solution (I-1,J+1,K) + Solution (I+1,J-1,K) + Solution (I-1,J-1,K) + // Inner face Solution (I+1,J,K-1) + Solution (I-1,J,K-1) + Solution (I,J-1,K-1) + Solution (I,J+1,K-1) + Solution (I+1,J+1,K-1) + Solution (I-1,J+1,K-1) + Solution (I+1,J-1,K-1) + Solution (I-1,J-1,K-1) + // Outer face Solution (I+1,J,K+1) + Solution (I-1,J,K+1) + Solution (I,J-1,K+1) + Solution (I,J+1,K+1) + Solution (I+1,J+1,K+1) + Solution (I-1,J+1,K+1) + Solution (I+1,J-1,K+1) + Solution (I-1,J-1,K+1) + // Center point of Inner and Outer faces Solution (I,J,K-1) + Solution (I,J,K+1) // Center point 26.0 * Solution (I,J,K) ); Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I,J,K-1) + Solution (I,J,K+1) * Solution (I,J,K) ); if (DEBUG > 0) p rintf ("Leaving Compute Residuals! \n"); if (DEBUG > 0) p rintf ("Leaving Compute Residuals! \n"); // Swap sign for test! // Residual = -Residual; // Swap sign for test! // Residual = -Residual; Main() asdf sdfs; sdfs Asdfs Main() asdf sdfs; sdfs Asdfs Panas, et al. - UCRL-PRES

22 ROSE-VA combines compiler & viz tools parse: ROSE Source Code void P DE::Compute_Residuals () // The decision to implement the residual computation seperately is a design preference. if (DEBUG > 0) p rintf ("Compute Residuals! \n"); visualize: Vizz3D analyze: ROSE Source Code void P DE::Compute_Residuals () // The decision to implement the residual computation seperately is a design preference. if (DEBUG > 0) p rintf ("Compute Residuals! \n"); Residual = 0.0; Residual = 0.0; double S caling_factor = 1.0 / ( M esh_size * Mesh_Size) ; if (P roblem_dimension == 1) Residual (I) = R ight_hand_side (I) + Scaling_Factor * ( Solution (I+1) + Solution (I-1) * Solution (I) ); if (Problem_Dimension == 2) if (F ully_variational) Residual (I,J) = R ight_hand_side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) + Solution (I+1,J+1) + Solution (I-1,J+1) + Solution (I+1,J-1) + Solution (I-1,J-1) 8.0 * Solution (I,J) ); Residual (I,J) = R ight_hand_side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) * Solution (I,J) ); #ifdef GRAPHICS G raphics_object.setproperty(toplabel,"residual " ); Graphics_Object.setProperty(CONTSTYLE,2); Graphics_Object.setProperty(NSTEPS,10); G raphics_object.contour(residual); #e ndif if (P roblem_dimension == 3) if (F ully_variational ) Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( // Center face Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I+1,J+1,K) + Solution (I-1,J+1,K) + Solution (I+1,J-1,K) + Solution (I-1,J-1,K) + // Inner face Solution (I+1,J,K-1) + Solution (I-1,J,K-1) + Solution (I,J-1,K-1) + Solution (I,J+1,K-1) + Solution (I+1,J+1,K-1) + Solution (I-1,J+1,K-1) + Solution (I+1,J-1,K-1) + Solution (I-1,J-1,K-1) + // Outer face Solution (I+1,J,K+1) + Solution (I-1,J,K+1) + Solution (I,J-1,K+1) + Solution (I,J+1,K+1) + Solution (I+1,J+1,K+1) + Solution (I-1,J+1,K+1) + Solution (I+1,J-1,K+1) + Solution (I-1,J-1,K+1) + // Center point of Inner and Outer faces Solution (I,J,K-1) + Solution (I,J,K+1) // Center point 26.0 * Solution (I,J,K) ); Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I,J,K-1) + Solution (I,J,K+1) * Solution (I,J,K) ); double S caling_factor = 1.0 / ( M esh_size * Mesh_Size) ; if (P roblem_dimension == 1) Residual (I) = R ight_hand_side (I) + Scaling_Factor * ( Solution (I+1) + Solution (I-1) * Solution (I) ); if (Problem_Dimension == 2) if (F ully_variational) Residual (I,J) = R ight_hand_side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) + Solution (I+1,J+1) + Solution (I-1,J+1) + Solution (I+1,J-1) + Solution (I-1,J-1) 8.0 * Solution (I,J) ); Residual (I,J) = R ight_hand_side (I,J) + Scaling_Factor * ( Solution (I+1,J) + Solution (I-1,J) + Solution (I,J-1) + Solution (I,J+1) * Solution (I,J) ); #ifdef GRAPHICS G raphics_object.setproperty(toplabel,"residual " ); Graphics_Object.setProperty(CONTSTYLE,2); Graphics_Object.setProperty(NSTEPS,10); G raphics_object.contour(residual); #e ndif if (P roblem_dimension == 3) if (F ully_variational ) Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( // Center face Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I+1,J+1,K) + Solution (I-1,J+1,K) + Solution (I+1,J-1,K) + Solution (I-1,J-1,K) + // Inner face Solution (I+1,J,K-1) + Solution (I-1,J,K-1) + Solution (I,J-1,K-1) + Solution (I,J+1,K-1) + Solution (I+1,J+1,K-1) + Solution (I-1,J+1,K-1) + Solution (I+1,J-1,K-1) + Solution (I-1,J-1,K-1) + // Outer face Solution (I+1,J,K+1) + Solution (I-1,J,K+1) + Solution (I,J-1,K+1) + Solution (I,J+1,K+1) + Solution (I+1,J+1,K+1) + Solution (I-1,J+1,K+1) + Solution (I+1,J-1,K+1) + Solution (I-1,J-1,K+1) + // Center point of Inner and Outer faces Solution (I,J,K-1) + Solution (I,J,K+1) // Center point 26.0 * Solution (I,J,K) ); Residual (I,J,K) = Right_Hand_Side (I,J,K) + S caling_factor * ( Solution (I+1,J,K) + Solution (I-1,J,K) + Solution (I,J-1,K) + Solution (I,J+1,K) + Solution (I,J,K-1) + Solution (I,J,K+1) * Solution (I,J,K) ); if (DEBUG > 0) p rintf ("Leaving Compute Residuals! \n"); if (DEBUG > 0) p rintf ("Leaving Compute Residuals! \n"); // Swap sign for test! // Residual = -Residual; // Swap sign for test! // Residual = -Residual; Main() asdf sdfs; sdfs Asdfs Main() asdf sdfs; sdfs Asdfs Panas, et al. - UCRL-PRES

23 ROSE-VA combines compiler & viz tools ROSE: An infrastructure for building customized sourceto-source tools Full open-source compiler with basic analysis Support for C, C++ (Fortran 90 in progress) Targets non-compiler audience VizzAnalyzer / Vizz3D: Graph visualization framework Software analysis + information visualization Plug-in architecture Babel connects ROSE (C++) and VA (Java) Panas, et al. - UCRL-PRES

24 Re-engineering example: Refactoring ROSE Panas, et al. - UCRL-PRES

25 Re-engineering example: Refactoring ROSE Panas, et al. - UCRL-PRES

26 Summary and future work Prototype analysis and viz tool Targets understanding, maintenance, and re-engineering tasks Flexible, unobtrusive, developer-driven usage HPC-specific metrics and analyses? Utility? Next steps: External evaluation + custom analyses Applying to larger applications + specific coding guidelines Specifying and finding patterns Including dynamic information (HPCToolkit, Open SpeedShop) Mining and incorporating source-repository Adding more metrics, e.g., productivity (size, time), defect density Panas, et al. - UCRL-PRES

27 End Demo?

28 Collaborators DOE Laboratories: LLNL ( A-Div (Kull), B-Div (ALE3D, Ares), Overture, Babel) ANL (Paul Hovland) ORNL DOE Research Programs: PERC (SLAC, TSTT, C/C++ Optimization, UT, ANL, Dyninst Binary Rewriting) Collaborations: Texas A&M (Lawrence Rauchwerger, Bjarne Stroustrup) Rice University (Ken Kennedy, John Mellnor-Crummey) IBM Haifa (Shmuel Ur) Vienna University of Technology (Markus Schordan) University of Tennessee (Jack Dongarra s group) Cornell University (Sally McKee, Brian White) Indiana University (Andrew Lumsdaine, Jeremiah Willcock) University of California at Berkeley (UPC, Kathy Yelick) University of Oslo (Hans, Andreas, Are) University of Maryland (Jeff Hollingsworth, Chadd Williams) Friedrich-Alexander-University Erlangen-Nuremberg (Markus Kowarschik, Nils Thurey) University of Texas at Austin (Calvin Lin) USCD (Scott Baden) London Imperial College (Olav Beckman, Paul Kelly) UC Davis (Su, Bishop) Panas, et al. - UCRL-PRES