| @@ -1,213 +0,0 @@ |
| 1 | | - | package wayland |
| 2 | | - | |
| 3 | | - | import ( |
| 4 | | - | "bytes" |
| 5 | | - | "encoding/json" |
| 6 | | - | "fmt" |
| 7 | | - | "strings" |
| 8 | | - | "testing" |
| 9 | | - | "time" |
| 10 | | - | |
| 11 | | - | "bnema.dev/zerowrap" |
| 12 | | - | ) |
| 13 | | - | |
| 14 | | - | func TestDropSyncDeferredLifecycle(t *testing.T) { |
| 15 | | - | for _, outcome := range []string{"ready", "failed", "acquire_destroyed", "release_destroyed", "shutdown", "client_gone", "already_ready", "already_ready_destroyed"} { |
| 16 | | - | t.Run(outcome, func(t *testing.T) { |
| 17 | | - | var out bytes.Buffer |
| 18 | | - | dev := newMocksyncobjDevice(t) |
| 19 | | - | srv := &Server{syncWait: &syncWaiter{}, log: zerowrap.New(zerowrap.Config{Level: "debug", Format: "json", Output: &out}).WithField("component", "wayland")} |
| 20 | | - | surf := &surface{server: srv} |
| 21 | | - | surf.sub.parent = &surface{server: srv, x11win: &window{id: 42, mapped: true}} |
| 22 | | - | acquire := &timeline{dev: dev, handle: 7, alive: true, uses: 1} |
| 23 | | - | release := &timeline{dev: dev, handle: 8, alive: true, uses: 1} |
| 24 | | - | w := &syncWait{explicit: true, efd: -1, done: (outcome == "already_ready" || outcome == "already_ready_destroyed")} |
| 25 | | - | cs := commitSync{acquire: syncPoint{tl: acquire, point: 11}, release: syncPoint{tl: release, point: 12}, wait: w} |
| 26 | | - | signals := outcome == "ready" || outcome == "acquire_destroyed" || outcome == "release_destroyed" || outcome == "already_ready" || outcome == "already_ready_destroyed" |
| 27 | | - | if signals { |
| 28 | | - | dev.EXPECT().signal(uint32(8), uint64(12)).Return(nil).Once() |
| 29 | | - | } |
| 30 | | - | if outcome == "already_ready_destroyed" { |
| 31 | | - | acquire.alive = false |
| 32 | | - | release.alive = false |
| 33 | | - | dev.EXPECT().destroy(uint32(7)).Return(nil).Once() |
| 34 | | - | dev.EXPECT().destroy(uint32(8)).Return(nil).Once() |
| 35 | | - | } |
| 36 | | - | surf.dropSync(&cs) |
| 37 | | - | if outcome != "already_ready" && outcome != "already_ready_destroyed" { |
| 38 | | - | if surf.releasePointsDeferred != 1 { |
| 39 | | - | t.Fatal("deferred counter not incremented") |
| 40 | | - | } |
| 41 | | - | var event map[string]any |
| 42 | | - | if err := json.NewDecoder(bytes.NewReader(out.Bytes())).Decode(&event); err != nil { |
| 43 | | - | t.Fatal(err) |
| 44 | | - | } |
| 45 | | - | if event["level"] != "debug" || event["window"] != float64(42) || event["sub"] != true { |
| 46 | | - | t.Fatalf("deferred attribution: %v", event) |
| 47 | | - | } |
| 48 | | - | if len(srv.deferredReleases) != 1 || w.done || acquire.uses != 1 || release.uses != 1 || surf.releasePointsDropped != 0 { |
| 49 | | - | t.Fatalf("ownership not retained: deferred=%d done=%v uses=%d/%d dropped=%d", len(srv.deferredReleases), w.done, acquire.uses, release.uses, surf.releasePointsDropped) |
| 50 | | - | } |
| 51 | | - | // Retiring/reusing the original update must not change deferred points. |
| 52 | | - | cs = commitSync{} |
| 53 | | - | srv.drainDeferredReleases(false) |
| 54 | | - | if len(srv.deferredReleases) != 1 { |
| 55 | | - | t.Fatal("unready acquire was drained") |
| 56 | | - | } |
| 57 | | - | switch outcome { |
| 58 | | - | case "ready": |
| 59 | | - | w.done = true |
| 60 | | - | case "failed": |
| 61 | | - | w.done, w.failed = true, true |
| 62 | | - | case "client_gone": |
| 63 | | - | surf.syncClient.gone = true |
| 64 | | - | case "acquire_destroyed": |
| 65 | | - | acquire.alive = false |
| 66 | | - | dev.EXPECT().destroy(uint32(7)).Return(nil).Once() |
| 67 | | - | case "release_destroyed": |
| 68 | | - | release.alive = false |
| 69 | | - | dev.EXPECT().destroy(uint32(8)).Return(nil).Once() |
| 70 | | - | } |
| 71 | | - | if outcome == "acquire_destroyed" || outcome == "release_destroyed" { |
| 72 | | - | srv.drainDeferredReleases(false) |
| 73 | | - | if len(srv.deferredReleases) != 1 { |
| 74 | | - | t.Fatal("protocol timeline destruction cancelled committed point") |
| 75 | | - | } |
| 76 | | - | w.done = true |
| 77 | | - | } |
| 78 | | - | srv.drainDeferredReleases(outcome == "shutdown") |
| 79 | | - | } |
| 80 | | - | srv.drainDeferredReleases(false) |
| 81 | | - | if len(srv.deferredReleases) != 0 || acquire.uses != 0 || release.uses != 0 || !w.done { |
| 82 | | - | t.Fatalf("ownership leaked: deferred=%d uses=%d/%d done=%v", len(srv.deferredReleases), acquire.uses, release.uses, w.done) |
| 83 | | - | } |
| 84 | | - | if signals { |
| 85 | | - | if surf.releasePointsSignalled != 1 || surf.releasePointsDropped != 0 { |
| 86 | | - | t.Fatal("signal accounting") |
| 87 | | - | } |
| 88 | | - | if bytes.Contains(out.Bytes(), []byte("surface release point dropped without signal")) { |
| 89 | | - | t.Fatalf("successful release warned: %s", out.String()) |
| 90 | | - | } |
| 91 | | - | } else { |
| 92 | | - | if surf.releasePointsSignalled != 0 || surf.releasePointsDropped != 1 { |
| 93 | | - | t.Fatal("abandon accounting") |
| 94 | | - | } |
| 95 | | - | if n := bytes.Count(out.Bytes(), []byte("surface release point dropped without signal")); n != 1 { |
| 96 | | - | t.Fatalf("warnings=%d: %s", n, out.String()) |
| 97 | | - | } |
| 98 | | - | } |
| 99 | | - | if !signals { |
| 100 | | - | want := "client_gone" |
| 101 | | - | if outcome == "failed" { |
| 102 | | - | want = "wait_failed" |
| 103 | | - | } |
| 104 | | - | if outcome == "shutdown" { |
| 105 | | - | want = "shutdown" |
| 106 | | - | } |
| 107 | | - | dec := json.NewDecoder(bytes.NewReader(out.Bytes())) |
| 108 | | - | var deferred, warning map[string]any |
| 109 | | - | if err := dec.Decode(&deferred); err != nil { |
| 110 | | - | t.Fatal(err) |
| 111 | | - | } |
| 112 | | - | if err := dec.Decode(&warning); err != nil { |
| 113 | | - | t.Fatal(err) |
| 114 | | - | } |
| 115 | | - | if warning["reason"] != want || warning["window"] != float64(42) || warning["sub"] != true { |
| 116 | | - | t.Fatalf("abandon diagnostic: %v", warning) |
| 117 | | - | } |
| 118 | | - | } |
| 119 | | - | if (outcome == "already_ready" || outcome == "already_ready_destroyed") && surf.releasePointsDeferred != 0 { |
| 120 | | - | t.Fatal("ready release counted as deferred") |
| 121 | | - | } |
| 122 | | - | // Destroy remaining live timelines after the references have retired. |
| 123 | | - | if acquire.alive { |
| 124 | | - | dev.EXPECT().destroy(uint32(7)).Return(nil).Once() |
| 125 | | - | acquire.alive = false |
| 126 | | - | srv.dropTimeline(acquire) |
| 127 | | - | } |
| 128 | | - | if release.alive { |
| 129 | | - | dev.EXPECT().destroy(uint32(8)).Return(nil).Once() |
| 130 | | - | release.alive = false |
| 131 | | - | srv.dropTimeline(release) |
| 132 | | - | } |
| 133 | | - | if acquire.handle != 0 || release.handle != 0 { |
| 134 | | - | t.Fatal("timeline handles leaked") |
| 135 | | - | } |
| 136 | | - | }) |
| 137 | | - | } |
| 138 | | - | } |
| 139 | | - | |
| 140 | | - | func TestDropSyncMissingWaitWarns(t *testing.T) { |
| 141 | | - | var out bytes.Buffer |
| 142 | | - | srv := &Server{log: zerowrap.New(zerowrap.Config{Format: "json", Output: &out}).WithField("component", "wayland")} |
| 143 | | - | surf := &surface{server: srv} |
| 144 | | - | tl := &timeline{alive: true, uses: 2} |
| 145 | | - | surf.dropSync(&commitSync{acquire: syncPoint{tl: tl, point: 11}, release: syncPoint{tl: tl, point: 12}}) |
| 146 | | - | surf.dropSync(nil) |
| 147 | | - | var event map[string]any |
| 148 | | - | if err := json.Unmarshal(out.Bytes(), &event); err != nil { |
| 149 | | - | t.Fatal(err) |
| 150 | | - | } |
| 151 | | - | if event["reason"] != "no_wait" || event["sub"] != false { |
| 152 | | - | t.Fatalf("missing wait diagnostic: %v", event) |
| 153 | | - | } |
| 154 | | - | if tl.uses != 0 || surf.releasePointsDropped != 1 || !bytes.Contains(out.Bytes(), []byte("surface release point dropped without signal")) { |
| 155 | | - | t.Fatal("missing wait must be abandoned and warned") |
| 156 | | - | } |
| 157 | | - | } |
| 158 | | - | |
| 159 | | - | //testpolicy:realtime client disconnect is delivered by the real Wayland display loop |
| 160 | | - | func TestDeferredReleaseClientTeardownAndBudget(t *testing.T) { |
| 161 | | - | for _, budget := range []bool{false, true} { |
| 162 | | - | t.Run(fmt.Sprint(budget), func(t *testing.T) { |
| 163 | | - | h := newSyncHarness(t) |
| 164 | | - | var out lockedBuffer |
| 165 | | - | var client *deferredClient |
| 166 | | - | gone := make(chan struct{}) |
| 167 | | - | h.s.display.Do(func() { |
| 168 | | - | h.s.log = zerowrap.New(zerowrap.Config{Format: "json", Output: &out}).WithField("component", "wayland") |
| 169 | | - | var surf *surface |
| 170 | | - | for _, s := range h.s.surfaces { |
| 171 | | - | if s.wl.ID() == h.surf { |
| 172 | | - | surf = s |
| 173 | | - | } |
| 174 | | - | } |
| 175 | | - | client = surf.syncClient |
| 176 | | - | client.client.OnDestroy(func() { close(gone) }) |
| 177 | | - | n := 1 |
| 178 | | - | if budget { |
| 179 | | - | n = maxDeferredReleasesPerClient + 1 |
| 180 | | - | } |
| 181 | | - | tl := &timeline{dev: h.dev, handle: 7, alive: true, uses: 2 * n} |
| 182 | | - | for range n { |
| 183 | | - | surf.dropSync(&commitSync{acquire: syncPoint{tl: tl, point: 11}, release: syncPoint{tl: tl, point: 12}, wait: &syncWait{explicit: true, efd: -1}}) |
| 184 | | - | } |
| 185 | | - | if budget && (client.count != 0 || tl.uses != 0 || len(h.s.deferredReleases) != 0) { |
| 186 | | - | t.Error("budget cleanup leaked") |
| 187 | | - | } |
| 188 | | - | }) |
| 189 | | - | if budget { |
| 190 | | - | if err := h.c.Roundtrip(); err == nil { |
| 191 | | - | t.Fatal("budget did not post a protocol error") |
| 192 | | - | } |
| 193 | | - | } |
| 194 | | - | _ = h.c.Close() |
| 195 | | - | select { |
| 196 | | - | case <-gone: |
| 197 | | - | case <-waylandDeadline(2 * time.Second): |
| 198 | | - | t.Fatal("client teardown not observed") |
| 199 | | - | } |
| 200 | | - | h.s.display.Do(func() { |
| 201 | | - | if client.count != 0 || len(h.s.deferredReleases) != 0 { |
| 202 | | - | t.Error("client releases leaked") |
| 203 | | - | } |
| 204 | | - | if _, ok := h.s.deferredClients[client.client]; ok { |
| 205 | | - | t.Error("client state retained") |
| 206 | | - | } |
| 207 | | - | }) |
| 208 | | - | if !strings.Contains(out.String(), `"reason":"client_gone"`) { |
| 209 | | - | t.Fatalf("missing client_gone: %s", out.String()) |
| 210 | | - | } |
| 211 | | - | }) |
| 212 | | - | } |
| 213 | | - | } |