test: cover hidden secret keys, mask no-op, no_keymap, pointer and modifier allocations
- commit
- bfb1f6d032ad021f122906c7c9bdf01f0035e629
- author
- brice · · 2026-10-01 18:57 UTC
- parent
- 869d03d
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
3 files · +146 -15
M alloc_test.go +3 -1
| @@ -17,7 +17,7 @@ import ( | |||
| 17 | 17 | type countingHandler struct { | |
| 18 | 18 | neferclient.NopHandler | |
| 19 | 19 | fdReady, errs, frames int | |
| 20 | - | keys int | |
| 20 | + | keys, pointers int | |
| 21 | 21 | lastText string // set only by the allocation-free comparison below | |
| 22 | 22 | } | |
| 23 | 23 | ||
| @@ -25,6 +25,8 @@ func (h *countingHandler) FDReady(uint64) { h.fdReady++ } | |||
| 25 | 25 | func (h *countingHandler) Error(error) { h.errs++ } | |
| 26 | 26 | func (h *countingHandler) Frame(neferclient.SurfaceID) { h.frames++ } | |
| 27 | 27 | ||
| 28 | + | func (h *countingHandler) Pointer(*neferclient.PointerEvent) { h.pointers++ } | |
| 29 | + | ||
| 28 | 30 | // Key records the text through a comparison that does not allocate: the | |
| 29 | 31 | // string is only built the first time a different text shows up. | |
| 30 | 32 | func (h *countingHandler) Key(ev *neferclient.KeyEvent) { | |
| @@ -17,7 +17,7 @@ import ( | |||||
| 17 | type countingHandler struct { | 17 | type countingHandler struct { | ||
| 18 | neferclient.NopHandler | 18 | neferclient.NopHandler | ||
| 19 | fdReady, errs, frames int | 19 | fdReady, errs, frames int | ||
| 20 | - | keys int | 20 | + | keys, pointers int |
| 21 | lastText string // set only by the allocation-free comparison below | 21 | lastText string // set only by the allocation-free comparison below | ||
| 22 | } | 22 | } | ||
| 23 | 23 | ||||
| @@ -25,6 +25,8 @@ func (h *countingHandler) FDReady(uint64) { h.fdReady++ } | |||||
| 25 | func (h *countingHandler) Error(error) { h.errs++ } | 25 | func (h *countingHandler) Error(error) { h.errs++ } | ||
| 26 | func (h *countingHandler) Frame(neferclient.SurfaceID) { h.frames++ } | 26 | func (h *countingHandler) Frame(neferclient.SurfaceID) { h.frames++ } | ||
| 27 | 27 | ||||
| 28 | + | func (h *countingHandler) Pointer(*neferclient.PointerEvent) { h.pointers++ } | |||
| 29 | + | ||||
| 28 | // Key records the text through a comparison that does not allocate: the | 30 | // Key records the text through a comparison that does not allocate: the | ||
| 29 | // string is only built the first time a different text shows up. | 31 | // string is only built the first time a different text shows up. | ||
| 30 | func (h *countingHandler) Key(ev *neferclient.KeyEvent) { | 32 | func (h *countingHandler) Key(ev *neferclient.KeyEvent) { | ||
M keyboard_test.go +67 -8
| @@ -126,14 +126,14 @@ func TestKeyboardComposeAndFocus(t *testing.T) { | |||
| 126 | 126 | ||
| 127 | 127 | pressKey(t, k, keyCircum) | |
| 128 | 128 | k.setFocus(false) | |
| 129 | - | _, ok := pressKey2(k, keyE) | |
| 129 | + | _, ok := pressUnchecked(k, keyE) | |
| 130 | 130 | require.False(t, ok, "no key without focus") | |
| 131 | 131 | k.setFocus(true) | |
| 132 | 132 | ev, _ := pressKey(t, k, keyE) | |
| 133 | 133 | require.Equal(t, "e", string(ev.Text), "focus loss resets compose") | |
| 134 | 134 | } | |
| 135 | 135 | ||
| 136 | - | func pressKey2(k *keyboard, code uint32) (KeyEvent, bool) { | |
| 136 | + | func pressUnchecked(k *keyboard, code uint32) (KeyEvent, bool) { | |
| 137 | 137 | var ev KeyEvent | |
| 138 | 138 | ok, _ := k.press(code, &ev) | |
| 139 | 139 | return ev, ok | |
| @@ -193,16 +193,27 @@ func TestSecretKeysNeverReachText(t *testing.T) { | |||
| 193 | 193 | ev, ok := pressKey(t, k, code) | |
| 194 | 194 | require.True(t, ok) | |
| 195 | 195 | require.Nil(t, ev.Text, "secret mode never fills KeyEvent.Text") | |
| 196 | - | releaseKey(k, code) | |
| 196 | + | rel, ok := releaseKey(k, code) | |
| 197 | + | require.True(t, ok) | |
| 198 | + | require.Equal(t, ev.Secret, rel.Secret, "the release is hidden like the press") | |
| 199 | + | if ev.Secret { | |
| 200 | + | require.Zero(t, rel.Keycode) | |
| 201 | + | require.Zero(t, rel.Keysym) | |
| 202 | + | } | |
| 197 | 203 | return ev | |
| 198 | 204 | } | |
| 199 | - | press(keyQ) | |
| 200 | - | press(keyCircum) // dead key | |
| 201 | - | press(keyE) // composes ê | |
| 205 | + | for _, code := range []uint32{keyQ, keyCircum, keyE} { // text, dead key, composed ê | |
| 206 | + | ev := press(code) | |
| 207 | + | require.True(t, ev.Secret, "text keys are hidden") | |
| 208 | + | require.Zero(t, ev.Keycode) | |
| 209 | + | require.Zero(t, ev.Keysym) | |
| 210 | + | } | |
| 202 | 211 | require.Equal(t, "qê", string(buf.Bytes())) | |
| 203 | 212 | require.Equal(t, 2, buf.Len()) | |
| 204 | 213 | ||
| 205 | - | press(keyBackspace) | |
| 214 | + | bs := press(keyBackspace) | |
| 215 | + | require.False(t, bs.Secret) | |
| 216 | + | require.Equal(t, uint32(raw.XKB_KEY_BackSpace), bs.Keysym, "BackSpace keeps its keysym") | |
| 206 | 217 | require.Equal(t, 1, buf.Len(), "backspace removes one code point") | |
| 207 | 218 | press(keyBackspace) | |
| 208 | 219 | press(keyBackspace) // empty: nothing to remove | |
| @@ -210,6 +221,7 @@ func TestSecretKeysNeverReachText(t *testing.T) { | |||
| 210 | 221 | ||
| 211 | 222 | press(keyQ) | |
| 212 | 223 | enter := press(keyEnter) | |
| 224 | + | require.False(t, enter.Secret) | |
| 213 | 225 | require.Equal(t, uint32(raw.XKB_KEY_Return), enter.Keysym) | |
| 214 | 226 | require.Equal(t, 1, buf.Len(), "Enter is delivered, not typed") | |
| 215 | 227 | ||
| @@ -218,6 +230,8 @@ func TestSecretKeysNeverReachText(t *testing.T) { | |||
| 218 | 230 | require.NoError(t, err) | |
| 219 | 231 | require.NoError(t, k.setMask(1<<idx, 0, 0, 0)) | |
| 220 | 232 | ev := press(keyU) | |
| 233 | + | require.False(t, ev.Secret) | |
| 234 | + | require.NotZero(t, ev.Keysym, "Control combinations keep their keysym") | |
| 221 | 235 | require.Equal(t, ModCtrl, ev.Modifiers) | |
| 222 | 236 | require.Equal(t, 1, buf.Len()) | |
| 223 | 237 | require.NoError(t, k.setMask(0, 0, 0, 0)) | |
| @@ -228,11 +242,16 @@ func TestSecretKeysNeverReachText(t *testing.T) { | |||
| 228 | 242 | } | |
| 229 | 243 | require.Equal(t, 8, buf.Len()) | |
| 230 | 244 | ||
| 231 | - | // Scratch is wiped after use. | |
| 245 | + | // Scratch and the work area are wiped after use. | |
| 232 | 246 | require.Equal(t, make([]byte, scratchSize), k.scratch[:]) | |
| 247 | + | require.Equal(t, secretWork{}, k.w) | |
| 248 | + | for _, h := range k.held { | |
| 249 | + | require.Zero(t, h, "no stale held key") | |
| 250 | + | } | |
| 233 | 251 | ||
| 234 | 252 | k.setSecret(nil) | |
| 235 | 253 | ev, _ = pressKey(t, k, keyQ) | |
| 254 | + | require.False(t, ev.Secret) | |
| 236 | 255 | require.Equal(t, "q", string(ev.Text), "ordinary text again once the buffer is removed") | |
| 237 | 256 | } | |
| 238 | 257 | ||
| @@ -281,3 +300,43 @@ func TestSecretRepeat(t *testing.T) { | |||
| 281 | 300 | require.True(t, ok) | |
| 282 | 301 | require.Equal(t, 1, buf.Len()) | |
| 283 | 302 | } | |
| 303 | + | ||
| 304 | + | func TestSecretRepeatIsHiddenToo(t *testing.T) { | |
| 305 | + | k := testKeyboard(t, "C", "us") | |
| 306 | + | k.setSecret(NewSecretBuffer(8)) | |
| 307 | + | k.setRepeat(100, 1) | |
| 308 | + | pressKey(t, k, keyQ) | |
| 309 | + | require.Eventually(t, k.expired, 2e9, 1e6) | |
| 310 | + | var ev KeyEvent | |
| 311 | + | ok, err := k.repeat(&ev) | |
| 312 | + | require.NoError(t, err) | |
| 313 | + | require.True(t, ok) | |
| 314 | + | require.True(t, ev.Secret) | |
| 315 | + | require.Zero(t, ev.Keycode) | |
| 316 | + | require.Zero(t, ev.Keysym) | |
| 317 | + | } | |
| 318 | + | ||
| 319 | + | func TestKeyboardHeldTailAndResetAreCleared(t *testing.T) { | |
| 320 | + | k := testKeyboard(t, "C", "us") | |
| 321 | + | k.setSecret(NewSecretBuffer(8)) | |
| 322 | + | pressKey(t, k, keyQ) | |
| 323 | + | pressKey(t, k, keyE) | |
| 324 | + | releaseKey(k, keyQ) | |
| 325 | + | require.Equal(t, heldKey{}, k.held[:cap(k.held)][1], "vacated slot cleared") | |
| 326 | + | k.setFocus(false) | |
| 327 | + | for _, h := range k.held[:cap(k.held)] { | |
| 328 | + | require.Zero(t, h) | |
| 329 | + | } | |
| 330 | + | } | |
| 331 | + | ||
| 332 | + | func TestKeyboardIdenticalMaskIsNoOp(t *testing.T) { | |
| 333 | + | k := testKeyboard(t, "C", "us") | |
| 334 | + | idx, err := k.keymap.ModIndex("Shift") | |
| 335 | + | require.NoError(t, err) | |
| 336 | + | require.NoError(t, k.setMask(1<<idx, 0, 0, 0)) | |
| 337 | + | require.Equal(t, ModShift, k.mods) | |
| 338 | + | require.NoError(t, k.setMask(1<<idx, 0, 0, 0)) | |
| 339 | + | require.Equal(t, ModShift, k.mods) | |
| 340 | + | require.NoError(t, k.setMask(0, 0, 0, 0)) | |
| 341 | + | require.Zero(t, k.mods) | |
| 342 | + | } | |
| @@ -126,14 +126,14 @@ func TestKeyboardComposeAndFocus(t *testing.T) { | |||||
| 126 | 126 | ||||
| 127 | pressKey(t, k, keyCircum) | 127 | pressKey(t, k, keyCircum) | ||
| 128 | k.setFocus(false) | 128 | k.setFocus(false) | ||
| 129 | - | _, ok := pressKey2(k, keyE) | 129 | + | _, ok := pressUnchecked(k, keyE) |
| 130 | require.False(t, ok, "no key without focus") | 130 | require.False(t, ok, "no key without focus") | ||
| 131 | k.setFocus(true) | 131 | k.setFocus(true) | ||
| 132 | ev, _ := pressKey(t, k, keyE) | 132 | ev, _ := pressKey(t, k, keyE) | ||
| 133 | require.Equal(t, "e", string(ev.Text), "focus loss resets compose") | 133 | require.Equal(t, "e", string(ev.Text), "focus loss resets compose") | ||
| 134 | } | 134 | } | ||
| 135 | 135 | ||||
| 136 | - | func pressKey2(k *keyboard, code uint32) (KeyEvent, bool) { | 136 | + | func pressUnchecked(k *keyboard, code uint32) (KeyEvent, bool) { |
| 137 | var ev KeyEvent | 137 | var ev KeyEvent | ||
| 138 | ok, _ := k.press(code, &ev) | 138 | ok, _ := k.press(code, &ev) | ||
| 139 | return ev, ok | 139 | return ev, ok | ||
| @@ -193,16 +193,27 @@ func TestSecretKeysNeverReachText(t *testing.T) { | |||||
| 193 | ev, ok := pressKey(t, k, code) | 193 | ev, ok := pressKey(t, k, code) | ||
| 194 | require.True(t, ok) | 194 | require.True(t, ok) | ||
| 195 | require.Nil(t, ev.Text, "secret mode never fills KeyEvent.Text") | 195 | require.Nil(t, ev.Text, "secret mode never fills KeyEvent.Text") | ||
| 196 | - | releaseKey(k, code) | 196 | + | rel, ok := releaseKey(k, code) |
| 197 | + | require.True(t, ok) | |||
| 198 | + | require.Equal(t, ev.Secret, rel.Secret, "the release is hidden like the press") | |||
| 199 | + | if ev.Secret { | |||
| 200 | + | require.Zero(t, rel.Keycode) | |||
| 201 | + | require.Zero(t, rel.Keysym) | |||
| 202 | + | } | |||
| 197 | return ev | 203 | return ev | ||
| 198 | } | 204 | } | ||
| 199 | - | press(keyQ) | 205 | + | for _, code := range []uint32{keyQ, keyCircum, keyE} { // text, dead key, composed ê |
| 200 | - | press(keyCircum) // dead key | 206 | + | ev := press(code) |
| 201 | - | press(keyE) // composes ê | 207 | + | require.True(t, ev.Secret, "text keys are hidden") |
| 208 | + | require.Zero(t, ev.Keycode) | |||
| 209 | + | require.Zero(t, ev.Keysym) | |||
| 210 | + | } | |||
| 202 | require.Equal(t, "qê", string(buf.Bytes())) | 211 | require.Equal(t, "qê", string(buf.Bytes())) | ||
| 203 | require.Equal(t, 2, buf.Len()) | 212 | require.Equal(t, 2, buf.Len()) | ||
| 204 | 213 | ||||
| 205 | - | press(keyBackspace) | 214 | + | bs := press(keyBackspace) |
| 215 | + | require.False(t, bs.Secret) | |||
| 216 | + | require.Equal(t, uint32(raw.XKB_KEY_BackSpace), bs.Keysym, "BackSpace keeps its keysym") | |||
| 206 | require.Equal(t, 1, buf.Len(), "backspace removes one code point") | 217 | require.Equal(t, 1, buf.Len(), "backspace removes one code point") | ||
| 207 | press(keyBackspace) | 218 | press(keyBackspace) | ||
| 208 | press(keyBackspace) // empty: nothing to remove | 219 | press(keyBackspace) // empty: nothing to remove | ||
| @@ -210,6 +221,7 @@ func TestSecretKeysNeverReachText(t *testing.T) { | |||||
| 210 | 221 | ||||
| 211 | press(keyQ) | 222 | press(keyQ) | ||
| 212 | enter := press(keyEnter) | 223 | enter := press(keyEnter) | ||
| 224 | + | require.False(t, enter.Secret) | |||
| 213 | require.Equal(t, uint32(raw.XKB_KEY_Return), enter.Keysym) | 225 | require.Equal(t, uint32(raw.XKB_KEY_Return), enter.Keysym) | ||
| 214 | require.Equal(t, 1, buf.Len(), "Enter is delivered, not typed") | 226 | require.Equal(t, 1, buf.Len(), "Enter is delivered, not typed") | ||
| 215 | 227 | ||||
| @@ -218,6 +230,8 @@ func TestSecretKeysNeverReachText(t *testing.T) { | |||||
| 218 | require.NoError(t, err) | 230 | require.NoError(t, err) | ||
| 219 | require.NoError(t, k.setMask(1<<idx, 0, 0, 0)) | 231 | require.NoError(t, k.setMask(1<<idx, 0, 0, 0)) | ||
| 220 | ev := press(keyU) | 232 | ev := press(keyU) | ||
| 233 | + | require.False(t, ev.Secret) | |||
| 234 | + | require.NotZero(t, ev.Keysym, "Control combinations keep their keysym") | |||
| 221 | require.Equal(t, ModCtrl, ev.Modifiers) | 235 | require.Equal(t, ModCtrl, ev.Modifiers) | ||
| 222 | require.Equal(t, 1, buf.Len()) | 236 | require.Equal(t, 1, buf.Len()) | ||
| 223 | require.NoError(t, k.setMask(0, 0, 0, 0)) | 237 | require.NoError(t, k.setMask(0, 0, 0, 0)) | ||
| @@ -228,11 +242,16 @@ func TestSecretKeysNeverReachText(t *testing.T) { | |||||
| 228 | } | 242 | } | ||
| 229 | require.Equal(t, 8, buf.Len()) | 243 | require.Equal(t, 8, buf.Len()) | ||
| 230 | 244 | ||||
| 231 | - | // Scratch is wiped after use. | 245 | + | // Scratch and the work area are wiped after use. |
| 232 | require.Equal(t, make([]byte, scratchSize), k.scratch[:]) | 246 | require.Equal(t, make([]byte, scratchSize), k.scratch[:]) | ||
| 247 | + | require.Equal(t, secretWork{}, k.w) | |||
| 248 | + | for _, h := range k.held { | |||
| 249 | + | require.Zero(t, h, "no stale held key") | |||
| 250 | + | } | |||
| 233 | 251 | ||||
| 234 | k.setSecret(nil) | 252 | k.setSecret(nil) | ||
| 235 | ev, _ = pressKey(t, k, keyQ) | 253 | ev, _ = pressKey(t, k, keyQ) | ||
| 254 | + | require.False(t, ev.Secret) | |||
| 236 | require.Equal(t, "q", string(ev.Text), "ordinary text again once the buffer is removed") | 255 | require.Equal(t, "q", string(ev.Text), "ordinary text again once the buffer is removed") | ||
| 237 | } | 256 | } | ||
| 238 | 257 | ||||
| @@ -281,3 +300,43 @@ func TestSecretRepeat(t *testing.T) { | |||||
| 281 | require.True(t, ok) | 300 | require.True(t, ok) | ||
| 282 | require.Equal(t, 1, buf.Len()) | 301 | require.Equal(t, 1, buf.Len()) | ||
| 283 | } | 302 | } | ||
| 303 | + | ||||
| 304 | + | func TestSecretRepeatIsHiddenToo(t *testing.T) { | |||
| 305 | + | k := testKeyboard(t, "C", "us") | |||
| 306 | + | k.setSecret(NewSecretBuffer(8)) | |||
| 307 | + | k.setRepeat(100, 1) | |||
| 308 | + | pressKey(t, k, keyQ) | |||
| 309 | + | require.Eventually(t, k.expired, 2e9, 1e6) | |||
| 310 | + | var ev KeyEvent | |||
| 311 | + | ok, err := k.repeat(&ev) | |||
| 312 | + | require.NoError(t, err) | |||
| 313 | + | require.True(t, ok) | |||
| 314 | + | require.True(t, ev.Secret) | |||
| 315 | + | require.Zero(t, ev.Keycode) | |||
| 316 | + | require.Zero(t, ev.Keysym) | |||
| 317 | + | } | |||
| 318 | + | ||||
| 319 | + | func TestKeyboardHeldTailAndResetAreCleared(t *testing.T) { | |||
| 320 | + | k := testKeyboard(t, "C", "us") | |||
| 321 | + | k.setSecret(NewSecretBuffer(8)) | |||
| 322 | + | pressKey(t, k, keyQ) | |||
| 323 | + | pressKey(t, k, keyE) | |||
| 324 | + | releaseKey(k, keyQ) | |||
| 325 | + | require.Equal(t, heldKey{}, k.held[:cap(k.held)][1], "vacated slot cleared") | |||
| 326 | + | k.setFocus(false) | |||
| 327 | + | for _, h := range k.held[:cap(k.held)] { | |||
| 328 | + | require.Zero(t, h) | |||
| 329 | + | } | |||
| 330 | + | } | |||
| 331 | + | ||||
| 332 | + | func TestKeyboardIdenticalMaskIsNoOp(t *testing.T) { | |||
| 333 | + | k := testKeyboard(t, "C", "us") | |||
| 334 | + | idx, err := k.keymap.ModIndex("Shift") | |||
| 335 | + | require.NoError(t, err) | |||
| 336 | + | require.NoError(t, k.setMask(1<<idx, 0, 0, 0)) | |||
| 337 | + | require.Equal(t, ModShift, k.mods) | |||
| 338 | + | require.NoError(t, k.setMask(1<<idx, 0, 0, 0)) | |||
| 339 | + | require.Equal(t, ModShift, k.mods) | |||
| 340 | + | require.NoError(t, k.setMask(0, 0, 0, 0)) | |||
| 341 | + | require.Zero(t, k.mods) | |||
| 342 | + | } | |||
M seat_wire_test.go +76 -6
| @@ -6,6 +6,7 @@ import ( | |||
| 6 | 6 | "runtime" | |
| 7 | 7 | "sync" | |
| 8 | 8 | "testing" | |
| 9 | + | "time" | |
| 9 | 10 | ||
| 10 | 11 | "github.com/stretchr/testify/mock" | |
| 11 | 12 | "github.com/stretchr/testify/require" | |
| @@ -282,12 +283,19 @@ func TestSeatKeymapFDClosedOnClose(t *testing.T) { | |||
| 282 | 283 | require.Equal(t, without, run(true), "descriptor closed with the connection") | |
| 283 | 284 | } | |
| 284 | 285 | ||
| 285 | - | // TestSeatKeymapFDClosedOnBadFormat: an unsupported keymap is closed, not leaked. | |
| 286 | + | // TestSeatKeymapFDClosedOnBadFormat: an unknown keymap format is reported and | |
| 287 | + | // its descriptor closed; no_keymap (0) is closed silently. | |
| 286 | 288 | func TestSeatKeymapFDClosedOnBadFormat(t *testing.T) { | |
| 287 | 289 | c, _, peer, _ := seatSetup(t) | |
| 288 | 290 | _, kb := peer.ids() | |
| 289 | 291 | before := openFDs(t) | |
| 290 | - | peer.keymap(kb, 0) // XKB_V1 is 1; 0 is no_keymap | |
| 292 | + | ||
| 293 | + | peer.keymap(kb, 0) // no_keymap: no error, no leak | |
| 294 | + | require.NoError(t, c.Roundtrip()) | |
| 295 | + | require.NoError(t, c.Dispatch(neferclientmocks.NewMockHandler(t))) // any Handler call fails | |
| 296 | + | require.Equal(t, before, openFDs(t)) | |
| 297 | + | ||
| 298 | + | peer.keymap(kb, 7) // unknown format | |
| 291 | 299 | require.NoError(t, c.Roundtrip()) | |
| 292 | 300 | var errs int | |
| 293 | 301 | h := neferclientmocks.NewMockHandler(t) | |
| @@ -320,7 +328,6 @@ func TestSeatCapabilityLossReleasesDevices(t *testing.T) { | |||
| 320 | 328 | peer.mu.Lock() | |
| 321 | 329 | require.True(t, peer.pointerReleased) | |
| 322 | 330 | peer.mu.Unlock() | |
| 323 | - | _ = srv | |
| 324 | 331 | } | |
| 325 | 332 | ||
| 326 | 333 | // TestSeatRepeatThroughEpoll: the repeat timerfd is watched by the connection's | |
| @@ -350,9 +357,7 @@ func TestSeatRepeatThroughEpoll(t *testing.T) { | |||
| 350 | 357 | require.NoError(t, c.Roundtrip()) | |
| 351 | 358 | require.NoError(t, c.Dispatch(h)) | |
| 352 | 359 | n := repeats | |
| 353 | - | for range 5 { | |
| 354 | - | runtime.Gosched() | |
| 355 | - | } | |
| 360 | + | time.Sleep(50 * time.Millisecond) // five repeat intervals at 100/s | |
| 356 | 361 | require.NoError(t, c.Dispatch(h)) | |
| 357 | 362 | require.Equal(t, n, repeats, "release stops the repeat") | |
| 358 | 363 | } | |
| @@ -366,6 +371,10 @@ func TestSeatRepeatThroughEpoll(t *testing.T) { | |||
| 366 | 371 | // cost so a regression above it shows. | |
| 367 | 372 | const xkbAllocsPerPress = 20 | |
| 368 | 373 | ||
| 374 | + | // xkbAllocsPerMask bounds a mask change: update_mask, serialize_mods and | |
| 375 | + | // serialize_layout, boxed the same way. | |
| 376 | + | const xkbAllocsPerMask = 12 | |
| 377 | + | ||
| 369 | 378 | // TestAllocKey measures the steady-state key path over a real socketpair, on | |
| 370 | 379 | // the real code path (no mocks): key frames in, reader decode, queue, Dispatch | |
| 371 | 380 | // with xkb state and translation, and the Handler call. | |
| @@ -425,6 +434,23 @@ func TestAllocKey(t *testing.T) { | |||
| 425 | 434 | require.LessOrEqual(t, text, float64(pairs*xkbAllocsPerPress)) | |
| 426 | 435 | require.Equal(t, "a", h.lastText) | |
| 427 | 436 | ||
| 437 | + | // Modifier masks: an identical mask is a no-op and allocates nothing; a | |
| 438 | + | // changing one updates the xkb state (purego-xkbcommon calls, bounded). | |
| 439 | + | mods := func(depressed uint32) []byte { | |
| 440 | + | b := appendU32(appendU32(nil, 1), depressed) | |
| 441 | + | return frame(kb, 4, appendU32(appendU32(appendU32(b, 0), 0), 0)) | |
| 442 | + | } | |
| 443 | + | var same, changing []byte | |
| 444 | + | for range 100 { | |
| 445 | + | same = append(same, mods(0)...) | |
| 446 | + | } | |
| 447 | + | for i := range 100 { | |
| 448 | + | changing = append(changing, mods(uint32(i%2))...) | |
| 449 | + | } | |
| 450 | + | require.Zero(t, measure("modifiers, 100 identical masks", run(same, 100)), "identical masks cost nothing") | |
| 451 | + | changes := measure("modifiers, 100 alternating masks", run(changing, 100)) | |
| 452 | + | require.LessOrEqual(t, changes, float64(100*xkbAllocsPerMask)) | |
| 453 | + | ||
| 428 | 454 | buf := neferclient.NewSecretBuffer(4096) | |
| 429 | 455 | c.Seat().SetSecret(buf) | |
| 430 | 456 | secret := measure("secret, 50 presses + releases", step) | |
| @@ -434,3 +460,47 @@ func TestAllocKey(t *testing.T) { | |||
| 434 | 460 | buf.Wipe() | |
| 435 | 461 | require.Zero(t, h.errs) | |
| 436 | 462 | } | |
| 463 | + | ||
| 464 | + | // TestAllocPointer measures the pointer path over a real socketpair: a batch | |
| 465 | + | // of motion, button and axis frames in, reader decode, queue, Dispatch and the | |
| 466 | + | // Handler call. Pointer events need no xkb, so the whole path allocates | |
| 467 | + | // nothing. | |
| 468 | + | func TestAllocPointer(t *testing.T) { | |
| 469 | + | skipUnderRace(t) | |
| 470 | + | c, srv, peer, s := seatSetup(t) | |
| 471 | + | pointer, _ := peer.ids() | |
| 472 | + | enter := appendU32(appendU32(nil, 5), s.SurfaceObjectID()) | |
| 473 | + | srv.write(frame(pointer, 0, appendU32(appendU32(enter, fixed(1)), fixed(1)))) | |
| 474 | + | require.NoError(t, c.Roundtrip()) | |
| 475 | + | h := &countingHandler{} | |
| 476 | + | require.NoError(t, c.Dispatch(h)) | |
| 477 | + | require.Equal(t, 1, h.pointers) | |
| 478 | + | ||
| 479 | + | const rounds = 40 | |
| 480 | + | var batch []byte | |
| 481 | + | for i := range rounds { | |
| 482 | + | batch = append(batch, frame(pointer, 2, append(appendU32(appendU32(nil, 0), fixed(float64(i))), appendU32(nil, fixed(2))...))...) | |
| 483 | + | batch = append(batch, frame(pointer, 3, appendU32(appendU32(appendU32(appendU32(nil, 6), 0), 0x110), uint32(i%2)))...) | |
| 484 | + | batch = append(batch, frame(pointer, 4, appendU32(appendU32(appendU32(nil, 0), 0), fixed(2)))...) | |
| 485 | + | batch = append(batch, frame(pointer, 9, appendU32(appendU32(nil, 0), 120))...) | |
| 486 | + | } | |
| 487 | + | step := func() { | |
| 488 | + | if _, err := srv.conn.Write(batch); err != nil { | |
| 489 | + | t.Fatal(err) | |
| 490 | + | } | |
| 491 | + | for c.QueueLen() < 4*rounds { | |
| 492 | + | runtime.Gosched() | |
| 493 | + | } | |
| 494 | + | if err := c.Dispatch(h); err != nil { | |
| 495 | + | t.Fatal(err) | |
| 496 | + | } | |
| 497 | + | } | |
| 498 | + | step() | |
| 499 | + | step() | |
| 500 | + | before := h.pointers | |
| 501 | + | allocs := testing.AllocsPerRun(20, step) | |
| 502 | + | t.Logf("allocs per Dispatch of %d pointer events: %v", 4*rounds, allocs) | |
| 503 | + | require.Zero(t, allocs) | |
| 504 | + | require.Greater(t, h.pointers, before) | |
| 505 | + | require.Zero(t, h.errs) | |
| 506 | + | } | |
| @@ -6,6 +6,7 @@ import ( | |||||
| 6 | "runtime" | 6 | "runtime" | ||
| 7 | "sync" | 7 | "sync" | ||
| 8 | "testing" | 8 | "testing" | ||
| 9 | + | "time" | |||
| 9 | 10 | ||||
| 10 | "github.com/stretchr/testify/mock" | 11 | "github.com/stretchr/testify/mock" | ||
| 11 | "github.com/stretchr/testify/require" | 12 | "github.com/stretchr/testify/require" | ||
| @@ -282,12 +283,19 @@ func TestSeatKeymapFDClosedOnClose(t *testing.T) { | |||||
| 282 | require.Equal(t, without, run(true), "descriptor closed with the connection") | 283 | require.Equal(t, without, run(true), "descriptor closed with the connection") | ||
| 283 | } | 284 | } | ||
| 284 | 285 | ||||
| 285 | - | // TestSeatKeymapFDClosedOnBadFormat: an unsupported keymap is closed, not leaked. | 286 | + | // TestSeatKeymapFDClosedOnBadFormat: an unknown keymap format is reported and |
| 287 | + | // its descriptor closed; no_keymap (0) is closed silently. | |||
| 286 | func TestSeatKeymapFDClosedOnBadFormat(t *testing.T) { | 288 | func TestSeatKeymapFDClosedOnBadFormat(t *testing.T) { | ||
| 287 | c, _, peer, _ := seatSetup(t) | 289 | c, _, peer, _ := seatSetup(t) | ||
| 288 | _, kb := peer.ids() | 290 | _, kb := peer.ids() | ||
| 289 | before := openFDs(t) | 291 | before := openFDs(t) | ||
| 290 | - | peer.keymap(kb, 0) // XKB_V1 is 1; 0 is no_keymap | 292 | + | |
| 293 | + | peer.keymap(kb, 0) // no_keymap: no error, no leak | |||
| 294 | + | require.NoError(t, c.Roundtrip()) | |||
| 295 | + | require.NoError(t, c.Dispatch(neferclientmocks.NewMockHandler(t))) // any Handler call fails | |||
| 296 | + | require.Equal(t, before, openFDs(t)) | |||
| 297 | + | ||||
| 298 | + | peer.keymap(kb, 7) // unknown format | |||
| 291 | require.NoError(t, c.Roundtrip()) | 299 | require.NoError(t, c.Roundtrip()) | ||
| 292 | var errs int | 300 | var errs int | ||
| 293 | h := neferclientmocks.NewMockHandler(t) | 301 | h := neferclientmocks.NewMockHandler(t) | ||
| @@ -320,7 +328,6 @@ func TestSeatCapabilityLossReleasesDevices(t *testing.T) { | |||||
| 320 | peer.mu.Lock() | 328 | peer.mu.Lock() | ||
| 321 | require.True(t, peer.pointerReleased) | 329 | require.True(t, peer.pointerReleased) | ||
| 322 | peer.mu.Unlock() | 330 | peer.mu.Unlock() | ||
| 323 | - | _ = srv | |||
| 324 | } | 331 | } | ||
| 325 | 332 | ||||
| 326 | // TestSeatRepeatThroughEpoll: the repeat timerfd is watched by the connection's | 333 | // TestSeatRepeatThroughEpoll: the repeat timerfd is watched by the connection's | ||
| @@ -350,9 +357,7 @@ func TestSeatRepeatThroughEpoll(t *testing.T) { | |||||
| 350 | require.NoError(t, c.Roundtrip()) | 357 | require.NoError(t, c.Roundtrip()) | ||
| 351 | require.NoError(t, c.Dispatch(h)) | 358 | require.NoError(t, c.Dispatch(h)) | ||
| 352 | n := repeats | 359 | n := repeats | ||
| 353 | - | for range 5 { | 360 | + | time.Sleep(50 * time.Millisecond) // five repeat intervals at 100/s |
| 354 | - | runtime.Gosched() | |||
| 355 | - | } | |||
| 356 | require.NoError(t, c.Dispatch(h)) | 361 | require.NoError(t, c.Dispatch(h)) | ||
| 357 | require.Equal(t, n, repeats, "release stops the repeat") | 362 | require.Equal(t, n, repeats, "release stops the repeat") | ||
| 358 | } | 363 | } | ||
| @@ -366,6 +371,10 @@ func TestSeatRepeatThroughEpoll(t *testing.T) { | |||||
| 366 | // cost so a regression above it shows. | 371 | // cost so a regression above it shows. | ||
| 367 | const xkbAllocsPerPress = 20 | 372 | const xkbAllocsPerPress = 20 | ||
| 368 | 373 | ||||
| 374 | + | // xkbAllocsPerMask bounds a mask change: update_mask, serialize_mods and | |||
| 375 | + | // serialize_layout, boxed the same way. | |||
| 376 | + | const xkbAllocsPerMask = 12 | |||
| 377 | + | ||||
| 369 | // TestAllocKey measures the steady-state key path over a real socketpair, on | 378 | // TestAllocKey measures the steady-state key path over a real socketpair, on | ||
| 370 | // the real code path (no mocks): key frames in, reader decode, queue, Dispatch | 379 | // the real code path (no mocks): key frames in, reader decode, queue, Dispatch | ||
| 371 | // with xkb state and translation, and the Handler call. | 380 | // with xkb state and translation, and the Handler call. | ||
| @@ -425,6 +434,23 @@ func TestAllocKey(t *testing.T) { | |||||
| 425 | require.LessOrEqual(t, text, float64(pairs*xkbAllocsPerPress)) | 434 | require.LessOrEqual(t, text, float64(pairs*xkbAllocsPerPress)) | ||
| 426 | require.Equal(t, "a", h.lastText) | 435 | require.Equal(t, "a", h.lastText) | ||
| 427 | 436 | ||||
| 437 | + | // Modifier masks: an identical mask is a no-op and allocates nothing; a | |||
| 438 | + | // changing one updates the xkb state (purego-xkbcommon calls, bounded). | |||
| 439 | + | mods := func(depressed uint32) []byte { | |||
| 440 | + | b := appendU32(appendU32(nil, 1), depressed) | |||
| 441 | + | return frame(kb, 4, appendU32(appendU32(appendU32(b, 0), 0), 0)) | |||
| 442 | + | } | |||
| 443 | + | var same, changing []byte | |||
| 444 | + | for range 100 { | |||
| 445 | + | same = append(same, mods(0)...) | |||
| 446 | + | } | |||
| 447 | + | for i := range 100 { | |||
| 448 | + | changing = append(changing, mods(uint32(i%2))...) | |||
| 449 | + | } | |||
| 450 | + | require.Zero(t, measure("modifiers, 100 identical masks", run(same, 100)), "identical masks cost nothing") | |||
| 451 | + | changes := measure("modifiers, 100 alternating masks", run(changing, 100)) | |||
| 452 | + | require.LessOrEqual(t, changes, float64(100*xkbAllocsPerMask)) | |||
| 453 | + | ||||
| 428 | buf := neferclient.NewSecretBuffer(4096) | 454 | buf := neferclient.NewSecretBuffer(4096) | ||
| 429 | c.Seat().SetSecret(buf) | 455 | c.Seat().SetSecret(buf) | ||
| 430 | secret := measure("secret, 50 presses + releases", step) | 456 | secret := measure("secret, 50 presses + releases", step) | ||
| @@ -434,3 +460,47 @@ func TestAllocKey(t *testing.T) { | |||||
| 434 | buf.Wipe() | 460 | buf.Wipe() | ||
| 435 | require.Zero(t, h.errs) | 461 | require.Zero(t, h.errs) | ||
| 436 | } | 462 | } | ||
| 463 | + | ||||
| 464 | + | // TestAllocPointer measures the pointer path over a real socketpair: a batch | |||
| 465 | + | // of motion, button and axis frames in, reader decode, queue, Dispatch and the | |||
| 466 | + | // Handler call. Pointer events need no xkb, so the whole path allocates | |||
| 467 | + | // nothing. | |||
| 468 | + | func TestAllocPointer(t *testing.T) { | |||
| 469 | + | skipUnderRace(t) | |||
| 470 | + | c, srv, peer, s := seatSetup(t) | |||
| 471 | + | pointer, _ := peer.ids() | |||
| 472 | + | enter := appendU32(appendU32(nil, 5), s.SurfaceObjectID()) | |||
| 473 | + | srv.write(frame(pointer, 0, appendU32(appendU32(enter, fixed(1)), fixed(1)))) | |||
| 474 | + | require.NoError(t, c.Roundtrip()) | |||
| 475 | + | h := &countingHandler{} | |||
| 476 | + | require.NoError(t, c.Dispatch(h)) | |||
| 477 | + | require.Equal(t, 1, h.pointers) | |||
| 478 | + | ||||
| 479 | + | const rounds = 40 | |||
| 480 | + | var batch []byte | |||
| 481 | + | for i := range rounds { | |||
| 482 | + | batch = append(batch, frame(pointer, 2, append(appendU32(appendU32(nil, 0), fixed(float64(i))), appendU32(nil, fixed(2))...))...) | |||
| 483 | + | batch = append(batch, frame(pointer, 3, appendU32(appendU32(appendU32(appendU32(nil, 6), 0), 0x110), uint32(i%2)))...) | |||
| 484 | + | batch = append(batch, frame(pointer, 4, appendU32(appendU32(appendU32(nil, 0), 0), fixed(2)))...) | |||
| 485 | + | batch = append(batch, frame(pointer, 9, appendU32(appendU32(nil, 0), 120))...) | |||
| 486 | + | } | |||
| 487 | + | step := func() { | |||
| 488 | + | if _, err := srv.conn.Write(batch); err != nil { | |||
| 489 | + | t.Fatal(err) | |||
| 490 | + | } | |||
| 491 | + | for c.QueueLen() < 4*rounds { | |||
| 492 | + | runtime.Gosched() | |||
| 493 | + | } | |||
| 494 | + | if err := c.Dispatch(h); err != nil { | |||
| 495 | + | t.Fatal(err) | |||
| 496 | + | } | |||
| 497 | + | } | |||
| 498 | + | step() | |||
| 499 | + | step() | |||
| 500 | + | before := h.pointers | |||
| 501 | + | allocs := testing.AllocsPerRun(20, step) | |||
| 502 | + | t.Logf("allocs per Dispatch of %d pointer events: %v", 4*rounds, allocs) | |||
| 503 | + | require.Zero(t, allocs) | |||
| 504 | + | require.Greater(t, h.pointers, before) | |||
| 505 | + | require.Zero(t, h.errs) | |||
| 506 | + | } | |||