|
| 1 | +# ------------------------------------------------------------------------------ |
| 2 | +# CodeHawk C Analyzer |
| 3 | +# Author: Henny Sipma |
| 4 | +# ------------------------------------------------------------------------------ |
| 5 | +# The MIT License (MIT) |
| 6 | +# |
| 7 | +# Copyright (c) 2025 Aarno Labs LLC |
| 8 | +# |
| 9 | +# Permission is hereby granted, free of charge, to any person obtaining a copy |
| 10 | +# of this software and associated documentation files (the "Software"), to deal |
| 11 | +# in the Software without restriction, including without limitation the rights |
| 12 | +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 13 | +# copies of the Software, and to permit persons to whom the Software is |
| 14 | +# furnished to do so, subject to the following conditions: |
| 15 | +# |
| 16 | +# The above copyright notice and this permission notice shall be included in all |
| 17 | +# copies or substantial portions of the Software. |
| 18 | +# |
| 19 | +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 20 | +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 21 | +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 22 | +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 23 | +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 24 | +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 25 | +# SOFTWARE. |
| 26 | +# ------------------------------------------------------------------------------ |
| 27 | + |
| 28 | +import xml.etree.ElementTree as ET |
| 29 | + |
| 30 | +from typing import List, Optional, TYPE_CHECKING |
| 31 | + |
| 32 | +from chc.proof.CandidateOutputParameter import CandidateOutputParameter |
| 33 | +from chc.proof.OutputParameterCalleeCallsite import OutputParameterCalleeCallsite |
| 34 | + |
| 35 | + |
| 36 | +if TYPE_CHECKING: |
| 37 | + from chc.app.CFile import CFile |
| 38 | + from chc.app.CFileDeclarations import CFileDeclarations |
| 39 | + from chc.app.CFunction import CFunction |
| 40 | + from chc.app.CVarInfo import CVarInfo |
| 41 | + from chc.proof.CFunPODictionary import CFunPODictionary |
| 42 | + |
| 43 | + |
| 44 | +class CFunctionAnalysisDigest: |
| 45 | + |
| 46 | + def __init__(self, cfun: "CFunction", xnode: ET.Element) -> None: |
| 47 | + self.xnode = xnode # analysis-digest node in adg file |
| 48 | + self._cfun = cfun |
| 49 | + |
| 50 | + @property |
| 51 | + def cfun(self) -> "CFunction": |
| 52 | + return self._cfun |
| 53 | + |
| 54 | + @property |
| 55 | + def cfile(self) -> "CFile": |
| 56 | + return self.cfun.cfile |
| 57 | + |
| 58 | + |
| 59 | +class CFunctionOutputParameterAnalysisDigest(CFunctionAnalysisDigest): |
| 60 | + |
| 61 | + def __init__(self, cfun: "CFunction", xnode: ET.Element) -> None: |
| 62 | + CFunctionAnalysisDigest.__init__(self, cfun, xnode) |
| 63 | + self._candidate_parameters: Optional[List[CandidateOutputParameter]] = None |
| 64 | + self._callee_callsites: Optional[List[OutputParameterCalleeCallsite]] = None |
| 65 | + |
| 66 | + @property |
| 67 | + def parameters(self) -> List[CandidateOutputParameter]: |
| 68 | + if self._candidate_parameters is None: |
| 69 | + self._candidate_parameters = [] |
| 70 | + xparams = self.xnode.find("candidate-parameters") |
| 71 | + if xparams is not None: |
| 72 | + for xparam in xparams.findall("param"): |
| 73 | + cparam = CandidateOutputParameter(self, xparam) |
| 74 | + self._candidate_parameters.append(cparam) |
| 75 | + return self._candidate_parameters |
| 76 | + |
| 77 | + @property |
| 78 | + def callee_callsites(self) -> List[OutputParameterCalleeCallsite]: |
| 79 | + if self._callee_callsites is None: |
| 80 | + self._callee_callsites = [] |
| 81 | + xsites = self.xnode.find("callee-callsites") |
| 82 | + if xsites is not None: |
| 83 | + for xsite in xsites.findall("ccs"): |
| 84 | + ccsite = OutputParameterCalleeCallsite(self, xsite) |
| 85 | + self._callee_callsites.append(ccsite) |
| 86 | + return self._callee_callsites |
| 87 | + |
| 88 | + def __str__(self) -> str: |
| 89 | + lines: List[str] = [] |
| 90 | + for p in self.parameters: |
| 91 | + lines.append(str(p)) |
| 92 | + if len(self.callee_callsites) > 0: |
| 93 | + lines.append("\nCallee-callsites:") |
| 94 | + for ccs in self.callee_callsites: |
| 95 | + lines.append(" " + str(ccs)) |
| 96 | + return "\n".join(lines) |
| 97 | + |
| 98 | + |
| 99 | +class CFunctionAnalysisDigests: |
| 100 | + |
| 101 | + def __init__(self, cfun: "CFunction", xnode: Optional[ET.Element]) -> None: |
| 102 | + self._cfun = cfun |
| 103 | + self.xnode = xnode # analysis-digests node |
| 104 | + self._digests: Optional[List[CFunctionAnalysisDigest]] = None |
| 105 | + |
| 106 | + @property |
| 107 | + def cfun(self) -> "CFunction": |
| 108 | + return self._cfun |
| 109 | + |
| 110 | + @property |
| 111 | + def digests(self) -> List[CFunctionAnalysisDigest]: |
| 112 | + if self._digests is None: |
| 113 | + self._digests = [] |
| 114 | + if self.xnode is not None: |
| 115 | + for xdigest in self.xnode.findall("analysis-digest"): |
| 116 | + digestkind = xdigest.get("name", "none") |
| 117 | + if digestkind == "output parameters": |
| 118 | + digest = CFunctionOutputParameterAnalysisDigest( |
| 119 | + self.cfun, xdigest) |
| 120 | + self._digests.append(digest) |
| 121 | + else: |
| 122 | + print("DEBUG: xnode is none") |
| 123 | + return self._digests |
| 124 | + |
| 125 | + def __str__(self) -> str: |
| 126 | + lines: List[str] = [] |
| 127 | + for digest in self.digests: |
| 128 | + lines.append(str(digest)) |
| 129 | + return "\n".join(lines) |
0 commit comments