facebookincubator / gloo
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
txt
cmake
in
gitmodules
  • 12 extensions are included in analyses: cc, h, txt, md, cmake, py, cu, in, gitignore, json, yml, gitmodules
  • 4 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (7 files).
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (3 files).
    • exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
    • exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.

  • The main category contains all manually created source code files that are being used in the production.
  • Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
  • Test source code files are used only for testing of the product. These files are normally not deployed to production.
  • Build and deployment source code files are used to configure or support build and deployment process.
  • Generated source code files are automatically generated files that have not been manually changed after generation.
  • While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
  • Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.

main26606 LOC (84%) 180 files
test3659 LOC (11%) 31 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other1233 LOC (3%) 23 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
cmake
in
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 180 files match defined criteria (26,606 lines of code, 100.0% vs. main code):
    • 68 *.cc files (9,513 lines of code)
    • 5 *.py files (8,180 lines of code)
    • 93 *.h files (7,358 lines of code)
    • 3 *.cu files (818 lines of code)
    • 8 *.cmake files (665 lines of code)
    • 3 *.in files (72 lines of code)
  • " *.cc" is biggest, containing 35.76% of code.
  • " *.in" is smallest, containing 0.27% of code.


*.cc9513 LOC (35%) 68 files
*.py8180 LOC (30%) 5 files
*.h7358 LOC (27%) 93 files
*.cu818 LOC (3%) 3 files
*.cmake665 LOC (2%) 8 files
*.in72 LOC (<1%) 3 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*_test[.].*".
  • 31 files match defined criteria (3,659 lines of code, 13.8% vs. main code):
    • 26 *.cc files (3,065 lines of code)
    • 4 *.h files (565 lines of code)
    • 1 *.cu files (29 lines of code)
  • " *.cc" is biggest, containing 83.77% of code.
  • " *.cu" is smallest, containing 0.79% of code.


*.cc3065 LOC (83%) 26 files
*.h565 LOC (15%) 4 files
*.cu29 LOC (<1%) 1 files
Other Code
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
  • 23 files match defined criteria (1,233 lines of code, 4.6% vs. main code):
    • 15 *.txt files (652 lines of code)
    • 4 *.cc files (311 lines of code)
    • 3 *.md files (198 lines of code)
    • 1 *.json files (72 lines of code)
  • " *.txt" is biggest, containing 52.88% of code.
  • " *.json" is smallest, containing 5.84% of code.


*.txt652 LOC (52%) 15 files
*.cc311 LOC (25%) 4 files
*.md198 LOC (16%) 3 files
*.json72 LOC (5%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.cc files are analyzed with CppAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Advanced heuristic dependency analysis
  • *.py files are analyzed with PythonAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Basic heuristic dependency analysis
  • *.h files are analyzed with CppAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Advanced heuristic dependency analysis
  • *.cu files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.cmake files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.in files are analyzed with RustAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • No dependency analysis


2022-04-15 01:21