sarif_gen.ml 2.61 KB
Newer Older
1
2
3
4
5
6
7
8
open Sarif

let frama_c_sarif =
  let name = "frama-c" in
  let version = Config.version_and_codename in
  let semanticVersion = Config.version in
  let fullName = name ^ "-" ^ version in
  let downloadUri = "https://frama-c.com/download.html" in
9
  let sarifLoggerVersion = Mdr_version.version in
10
11
12
13
  Tool.create
    ~name ~version ~semanticVersion
    ~fullName ~downloadUri ~sarifLoggerVersion ()

14

15
16
17
18
19
let get_remarks () =
  let f = Mdr_params.Remarks.get () in
  if f <> "" then Parse_remarks.get_remarks f
  else Datatype.String.Map.empty

20
21
22
23
24
let get_remark remarks label =
  match Datatype.String.Map.find_opt label remarks with
  | None -> []
  | Some l -> l

25
26
27
28
29
let gen_invocation () =
  let commandLine = Array.fold_right (fun s acc -> s ^ " " ^ acc) Sys.argv "" in
  let arguments = List.tl (Array.to_list Sys.argv) in
  Invocation.create ~commandLine ~arguments ()

30
31
32
33
34
35
36
37
38
39
40
let make_message alarm annot remark =
  let open Markdown in
  let kind = plain (Alarms.get_name alarm ^ ":") in
  let descr = codelines "acsl" Printer.pp_code_annotation annot in
  let summary = Block [Text kind; descr] in
  let markdown = summary :: remark in
  Message.markdown ~markdown ()

let gen_results remarks =
  let treat_alarm _e _kf s ~rank:_ alarm annot (i, content) =
    let label = "Alarm-" ^ string_of_int i in
41
    let level = Result_level.warning in
42
43
44
45
46
47
48
49
50
51
52
    let remark = get_remark remarks label in
    let message = make_message alarm annot remark in
    let locations = [ Location.of_loc (Cil_datatype.Stmt.loc s) ] in
    let res =
      Sarif_result.create ~level ~message ~locations ()
    in
    (i+1, res :: content)
  in
  let _, content = Alarms.fold treat_alarm (0, []) in
  List.rev content

53
54
55
56
57
58
59
60
61
62
let gen_files () =
  let add_src_file f =
    let key = Filename.chop_extension (Filename.basename f) in
    let fileLocation = FileLocation.create ~uri:(Filepath.normalize f) () in
    let roles = [ Role.analysisTarget ] in
    let mimeType = "text/x-csrc" in
    key, File.create ~fileLocation ~roles ~mimeType ()
  in
  List.map add_src_file (Kernel.Files.get ())

63
let gen_run remarks =
64
  let tool = frama_c_sarif in
65
  let invocations = [gen_invocation ()] in
66
  let results = gen_results remarks in
67
68
  let files = gen_files () in
  Run.create ~tool ~invocations ~results ~files ()
69
70

let generate () =
71
72
  let remarks = get_remarks () in
  let runs = [ gen_run remarks ] in
73
74
75
76
77
78
79
80
81
82
83
  let json = Schema.create ~runs () in
  let out = Mdr_params.Output.get () in
  let chan =
    if out = "" then stdout
    else begin
      try open_out out
      with Sys_error s ->
        Mdr_params.abort "Unable to open output file %s: %s" out s
    end
  in
  Yojson.Safe.to_channel chan (Schema.to_yojson json)