analyzer

func CapabilityGraph ¶

func CapabilityGraph(pkgs []*packages.Package,
	queriedPackages map[*types.Package]struct{},
	config *Config,
	outputNode GraphOutputNodeFn,
	outputCall GraphOutputCallFn,
	outputCapability GraphOutputCapabilityFn,
	filter func(capability cpb.Capability) bool,
)

CapabilityGraph analyzes the callgraph for the packages in pkgs.

It outputs the graph containing all paths from a function belonging to one of the packages in queriedPackages to a function which has some capability.

outputNode is called for each node in the graph. Along with the node itself, it is passed the state of the BFS search from the queried packages, and the state of the BFS search from functions with a capability, so that the user can reconstruct an example call path including the node.

outputCall is called for each edge between two nodes.

outputCapability is called for each node in the graph that has some capability.

If filter is non-nil, it is called once for each capability. If it returns true, then CapabilityGraph generates a call graph for that individual capability and calls the relevant output functions, before proceeding to the next capability. If filter is nil, a single graph is generated including paths for all capabilities.

func GetCapabilityCounts ¶

func GetCapabilityCounts(pkgs []*packages.Package, queriedPackages map[*types.Package]struct{}, config *Config) *cpb.CapabilityCountList

GetCapabilityCount analyzes the packages in pkgs. For each function in those packages which have a path in the callgraph to an "interesting" function (see the "interesting" package), we give an aggregate count of the capability usage.

func GetCapabilityInfo ¶

func GetCapabilityInfo(pkgs []*packages.Package, queriedPackages map[*types.Package]struct{}, config *Config) *cpb.CapabilityInfoList

GetCapabilityInfo analyzes the packages in pkgs. For each function in those packages which have a path in the callgraph to an "interesting" function (see the "interesting" package), we log details of the capability usage.

One CapabilityInfo is returned for every (function, capability) pair, with one example path in the callgraph that demonstrates that capability.

func GetCapabilityStats ¶

func GetCapabilityStats(pkgs []*packages.Package, queriedPackages map[*types.Package]struct{}, config *Config) *cpb.CapabilityStatList

GetCapabilityStats analyzes the packages in pkgs. For each function in those packages which have a path in the callgraph to an "interesting" function (see the "interesting" package), we give aggregated statistics about the capability usage.

func GetClassifier ¶

func GetClassifier(excludeUnanalyzed bool) *interesting.Classifier

GetClassifier returns a classifier for mapping packages and functions to the appropriate capability. If excludedUnanalyzed is true, the UNANALYZED capability is never returned.

func GetQueriedPackages ¶

func GetQueriedPackages(pkgs []*packages.Package) map[*types.Package]struct{}

GetQueriedPackages builds a set of *types.Package matching the input query so that we can limit the output to only functions in these packages, not their dependencies too.

func LoadPackages ¶

func LoadPackages(packageNames []string, lcfg LoadConfig) ([]*packages.Package, error)

func RunCapslock ¶

func RunCapslock(args []string, output string, pkgs []*packages.Package, queriedPackages map[*types.Package]struct{},
	config *Config) error