This document outlines a process for extracting an architectural model from source code. It begins with understanding dependencies between classes and creating a class dependency graph. This graph is then clustered using the Bunch tool to group related classes. The clusters are then modeled in Rational Rose to extract and visualize the architectural design. The goal is to recover an implicit architecture when documentation is unavailable or outdated.

1. Extracting Architectural Model
from Source Code
By:
Morteza Zakeri – Mohsen Amirian
Advanced Software Engineering Course
Iran University of Science and Technology
Winter 2017

2. Outline
• What is Software Reverse Engineering (SRE)?
• Two Different Dimensions
• Motivation
• SRE Tools
• Modularity Principles
• Extracting Architectural Model Step by Step
• Practical Case Study
• References
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 2 of 38

3. What is Software Reverse Engineering?
• Software Reverse Engineering (SRE) is the practice
of analyzing a software system, either in whole or in
part, to extract design and implementation
information [1].
• [1] Cipresso, T. (2009). Software Reverse Engineering
Education, (August), 120.
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 3 of 38

4. Two Different Dimensions
• Binary Code Reverse Engineering
• To obtain source code from executable object.
• Source Code Reverse Engineering
• To extract architectural features.
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 4 of 38

5. Motivation
1. Old software systems are often not documented
or very less documentation is available.
• Even in the systems where documentation is available
there is no explicit mention of the architecture that the
code possesses.
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 5 of 38

6. Motivation
2. New changes to the system need a knowledge
of implicit architecture that the system possess.
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 6 of 38

7. Motivation
3. Legacy Transformation
• It is a tough task to convert a 10,000 line COBOL code
to C/C++ code if the programmer is unaware of the
underlying architecture.
• As around 70% of world’s source code is in COBOL and
in scientific communities FORTRAN has been the
obvious choice [2].
• [2] Ali, M. R. (2005). Why teach reverse engineering? SIGSOFT
Softw. Eng. Notes, 30(4), 1–4.
https://doi.org/10.1145/1082983.1083004
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 7 of 38

8. Motivation
4. System evolution
• As system evolves , it tends to drift from it’s original
architecture.
• So it is very important to recover or reconstruct the
architecture of the system in the spirit that new
changes to the system do not affect the existing
working model.
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 8 of 38

9. Motivation
5. Software Testing and Security
• Techniques are used to debug and find bugs and
errors.
• Techniques are used to make sure that the system does
not have any major vulnerabilities and security flaws.
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 9 of 38

10. Binary Code Reverse Engineering Tools
• Disassemblers
• Debuggers
• Hex Editors
• PE and Resource Viewer
• Example:
• IAD Pro, OllyDBG, WinDBG, etc.
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 10 of 38

11. Source Code Reverse Engineering Tools
• Calculate some software metrics.
• Lines of code (LoC)
• Number of Class, Functions, Statements, etc.
• Visualize source code architecture to optimize software
design.
• Sometimes we need higher level of abstraction.
• e.g. Component Diagram.
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 11 of 38

12. Modularity Principles
• Cohesion
• Refers to the degree to which the elements of a
module belong together.
• Coupling
• The degree of interdependence between software
modules.
• Good Design: High cohesion (↑), loose coupling (↓).
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 12 of 38

13. Reversing Steps
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 13 of 38

14. Understand
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 14 of 38

15. Bunch
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
• Bunch is a graph clustering tools.
• As part of Ph.D. thesis in Computer Science at
Drexel University.
• By: Brian Mitchell
• Using heuristic searching such as
• Genetic Algorithm,
• Hill Climbing,
• …
Page 15 of 38

16. ‫ساده‬ ‫مثال‬ ‫یک‬ ‫بررسی‬
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
•‫برنامه‬‫بر‬ ‫مشتمل‬ ‫ای‬5‫کالس‬a, b, c, e, f‫بگیرید‬ ‫نظر‬ ‫در‬ ‫را‬.
•‫با‬‫بررسی‬ ‫یک‬‫دستی‬‫کال‬ ‫هر‬ ‫متدهای‬ ‫های‬ ‫دستیابی‬ ‫تعداد‬ ‫از‬ ‫اطالعاتی‬ ‫ما‬‫بهه‬ ‫س‬
‫آوریم‬ ‫می‬ ‫دست‬ ‫به‬ ‫دیگر‬ ‫کالس‬ ‫متدهای‬.‫ک‬ ‫در‬ ‫که‬ ‫کنیم‬ ‫می‬ ‫مشاهده‬ ‫مثال‬ ‫برای‬‫الس‬
a‫کالس‬ ‫متدهای‬ ‫بار‬ ‫دو‬b‫است‬ ‫شده‬ ‫فراخوانی‬.
•‫این‬ ‫ما‬‫دهیم‬ ‫می‬ ‫نشان‬ ‫زیر‬ ‫صورت‬ ‫به‬ ‫را‬ ‫اطالع‬:
• a b 2
Page 16 of 38

17. ‫اول‬ ‫گام‬:‫کالس‬ ‫وابستگی‬ ‫گراف‬ ‫قالب‬ ‫در‬ ‫ارتباطی‬ ‫مدل‬ ‫استخراج‬‫ی‬
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 17 of 38

18. ‫اول‬ ‫گام‬:‫کالس‬ ‫وابستگی‬ ‫گراف‬ ‫قالب‬ ‫در‬ ‫ارتباطی‬ ‫مدل‬ ‫استخراج‬‫ی‬
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 18 of 38

19. ‫دوم‬ ‫گام‬:‫خروجی‬ ‫تبدیل‬Understand‫ورودی‬ ‫به‬Bunch
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
•‫ورودی‬ ،‫است‬ ‫دار‬ ‫جهت‬ ‫دار‬ ‫وزن‬ ‫گراف‬ ‫که‬ ‫قبل‬ ‫گام‬ ‫خروجی‬ ‫واقع‬ ‫در‬Bunch‫قرار‬
‫گیرد‬ ‫می‬.
Page 19 of 38

20. ‫دوم‬ ‫گام‬:‫خروجی‬ ‫تبدیل‬Understand‫ورودی‬ ‫به‬Bunch
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 20 of 38

21. ‫گام‬‫سوم‬:‫بندی‬ ‫خوشه‬
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 21 of 38

22. Measuring Modularization Quality (MQ)
• Basic MQ
• Inter-connectivity
• (i.e., connections between the components of two
distinct clusters)
• Intra-connectivity
• (i.e., connections between the components of the
same cluster) [3].
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 22 of 38

23. Measuring Modularization Quality (MQ)
• Intra-connectivity measurement 𝐴𝑖 of cluster i
consisting of 𝑁𝑖 components and 𝜇𝑖 intra-edge
relations as:
• 𝐴𝑖 =
𝜇 𝑖
𝑁𝑖
2
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 23 of 38

24. Measuring Modularization Quality (MQ)
• Inter-connectivity 𝐸𝑖,𝑗 between clusters i and j
consisting of 𝑁𝑖 and 𝑁𝑗 components, respectively,
and with 𝜀𝑖 inter-edge dependencies as:
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 24 of 38

25. Measuring Modularization Quality (MQ)
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 25 of 38

26. Measuring Modularization Quality (MQ)
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 26 of 38

27. The BasicMQ Measurement
• The BasicMQ measurement demonstrates the
tradeoff between inter-connectivity and intra-
connectivity by rewarding the creation of highly-
cohesive clusters, while penalizing the creation of
too many inter-edges (k is number of subsystems):
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 27 of 38

28. The BasicMQ Measurement
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 28 of 38

29. ‫گام‬‫سوم‬:‫بندی‬ ‫خوشه‬
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 29 of 38

30. ‫گام‬‫سوم‬:‫خوشه‬‫بندی‬(‫در‬ ‫نمایش‬Graphviz)
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 30 of 38

31. ‫گام‬‫چهارم‬:‫معماری‬ ‫طرح‬ ‫استخراج‬
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
• IBM Rational Rose
• rationalrose.tlb
• ProgramFilesRationalRoserationalrose.tlb
•
Page 31 of 38

32. ‫چهارم‬ ‫گام‬:‫طرح‬ ‫استخراج‬‫معماری‬(‫ابزار‬Package View)
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 32 of 38

33. ‫چهارم‬ ‫گام‬:‫عملیاتی‬ ‫محیط‬ ‫در‬ ‫نمایش‬Rational Rose
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 33 of 38

34. ‫چهارم‬ ‫گام‬:‫عملیاتی‬ ‫محیط‬ ‫در‬ ‫نمایش‬Rational Rose
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 34 of 38

35. ‫آتی‬ ‫کارهای‬
•‫یافته‬ ‫ساخت‬ ‫های‬ ‫برنامه‬ ‫معماری‬ ‫استخراج‬ ‫برای‬ ‫برنامه‬ ‫تعمیم‬
•‫گرا‬ ‫شی‬ ‫به‬ ‫یافته‬ ‫ساخت‬ ‫های‬ ‫برنامه‬ ‫خودکار‬ ‫تبدیل‬
•‫منبع‬ ‫کد‬ ‫از‬ ‫طراحی‬ ‫نمودارهای‬ ‫سایر‬ ‫استخراج‬ ‫نحوه‬ ‫بررسی‬
•‫مشابه‬ ‫های‬ ‫محیط‬ ‫دیگر‬ ‫در‬ ‫نمایش‬‫نظیر‬Visual Paradigm،Oracle
Designer‫و‬. ...
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 35 of 38

36. References
• [1] Cipresso, T. (2009). Software Reverse Engineering Education,
(August), 120.
• [2] Ali, M. R. (2005). Why teach reverse engineering? SIGSOFT Softw.
Eng. Notes, 30(4), 1–4. https://doi.org/10.1145/1082983.1083004
• [3] Mitchell, B. S. (2002). A Heuristic Search Approach to Solving the
Software Clustering Problem, (March).
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 36 of 38

37. Tools
• Understand
• https://scitools.com/
• Bunch
• https://www.cs.drexel.edu/~spiros/bunch/
• Graphviz
• http://www.graphviz.org
• IBM Rational Rose Enterprise
• http://www-03.ibm.com/software/products/en/enterprise
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 37 of 38

38. IUST Tools
• Understand 2 Bunch
• Bunch 2 Rational (Package Viewer)
21 February 2017
Extracting Architecture from Source Code -
M.Zakeri, M.Amirian
Page 38 of 38