File: cycle-expected.cc

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 6,122,156 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (104 lines) | stat: -rw-r--r-- 3,171 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <tuple>

#include "base/containers/span.h"
#include "third_party/do_not_rewrite/third_party_api.h"

int UnsafeIndex();  // Return out-of-bounds index.
bool Bool();        // Unknown boolean value.

// Expected rewrite:
// base::span<int> GetFirstPartyBuffer() {
base::span<int> GetFirstPartyBuffer() {
  return new int[10];
}

void test_cycle_isolated() {
  // An isolated cycle with no dependencies.
  //
  // As of today, it gets rewritten, because nothing prevents it from being
  // rewritten, and some of its dependents would like to be spanified.

  // Expected rewrite:
  // base::span<int> cycle_1;
  base::span<int> cycle_1;
  // Expected rewrite:
  // base::span<int> cycle_2;
  base::span<int> cycle_2;
  cycle_1 = cycle_2;
  cycle_2 = cycle_1;

  // Expected rewrite:
  // base::span<int> output;
  base::span<int> output;
  if (Bool()) {
    output = GetFirstPartyBuffer();
  } else {
    output = cycle_1;
  }
  std::ignore = output[UnsafeIndex()];
}

void test_cycle_depending_on_first_party_buffer() {
  // A cycle that can be rewritten, because it depends on something that can be
  // rewritten, and dependants would like to be spanified.

  // Expected rewrite:
  // base::span<int> cycle_1 = GetFirstPartyBuffer();
  base::span<int> cycle_1 = GetFirstPartyBuffer();
  // Expected rewrite:
  // base::span<int> cycle_2;
  base::span<int> cycle_2;
  cycle_1 = cycle_2;
  cycle_2 = cycle_1;

  // Expected rewrite:
  // base::span<int> output;
  base::span<int> output;
  if (Bool()) {
    output = GetFirstPartyBuffer();
  } else {
    output = cycle_1;
  }
  std::ignore = output[UnsafeIndex()];
}

void test_cycle_depending_on_third_party_buffer() {
  // A cycle that can't be rewritten, because it depends on something that can't
  // be rewritten.

  // The current implementation of the spanifier tool assumes that all third-
  // party functions tell the size someway. The implementation is below.
  // https://source.chromium.org/chromium/chromium/src/+/main:tools/clang/spanify/Spanifier.cpp;drc=f240549b481969cf1442aac67a9086bfd639787c;l=2190-2191
  //
  // This test case was originally introduced to test that a buffer returned by
  // a third-party function shouldn't be rewritten to base::span, but it's not
  // been the intended behavior. A bug caused that the buffer doesn't get
  // rewritten, but the bug was fixed in https://crrev.com/c/6348037.
  //
  // TODO: Revisit this point and determine whether buffers returned by third-
  // party functions must be spanified unconditionally or in a certain
  // condition.
  //
  // Expected rewrite:
  // base::span<int> cycle_1 = GetThirdPartyBuffer();
  base::span<int> cycle_1 = GetThirdPartyBuffer();
  // Expected rewrite:
  // base::span<int> cycle_2;
  base::span<int> cycle_2;
  cycle_1 = cycle_2;
  cycle_2 = cycle_1;

  // Expected rewrite:
  // base::span<int> output;
  base::span<int> output;
  if (Bool()) {
    output = GetFirstPartyBuffer();
  } else {
    output = cycle_1;
  }
  std::ignore = output[UnsafeIndex()];
}