Skip to content

Commit 26b037d

Browse files
xiaostxiaost
authored
refactor: disable JIT by default (#70)
1 parent e25b2fb commit 26b037d

10 files changed

Lines changed: 170 additions & 164 deletions

File tree

‎.github/workflows/tests.yml‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Tests
33
on: [ push, pull_request ]
44

55
jobs:
6-
compatibility-test-amd64:
6+
unittest-amd64:
77
strategy:
88
matrix:
99
go: [ "1.18", "1.19", "1.20", "1.21", "1.22", "1.23" ]
@@ -23,7 +23,7 @@ jobs:
2323
- name: Test Benchmark
2424
run: go test -bench=. -benchmem -run=none ./... -benchtime=100ms
2525

26-
compatibility-test-arm64:
26+
unittest-arm64:
2727
strategy:
2828
matrix:
2929
go: [ "1.18", "1.19", "1.20", "1.21", "1.22", "1.23" ]
@@ -42,3 +42,21 @@ jobs:
4242
run: cd tests && go test -race
4343
- name: Test Benchmark
4444
run: go test -bench=. -benchmem -run=none ./internal/reflect -benchtime=100ms
45+
46+
buildtag-amd64:
47+
strategy:
48+
matrix:
49+
go: [ "1.18", "1.23" ]
50+
os: [ X64 ]
51+
runs-on: ${{ matrix.os }}
52+
steps:
53+
- uses: actions/checkout@v4
54+
- name: Set up Go
55+
uses: actions/setup-go@v5
56+
with:
57+
go-version: ${{ matrix.go }}
58+
cache: false # don't use cache for self-hosted runners
59+
- name: Build without frugal_jit
60+
run: go build -v ./...
61+
- name: Build with frugal_jit
62+
run: go build -v -tags=frugal_jit ./...

‎debug/debug_jit.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//go:build !go1.24 && amd64 && !windows
1+
//go:build frugal_jit
22

33
/*
44
* Copyright 2022 CloudWeGo Authors

debug/debug_go124.go renamed to debug/debug_nojit.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//go:build go1.24 || !amd64 || windows
1+
//go:build !frugal_jit
22

33
/*
44
* Copyright 2024 CloudWeGo Authors

‎frugal.go‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,13 @@ package frugal
1919
import (
2020
"fmt"
2121

22-
"github.com/cloudwego/frugal/internal/opts"
2322
"github.com/cloudwego/frugal/internal/reflect"
2423
"github.com/cloudwego/gopkg/protocol/thrift"
2524
)
2625

2726
// EncodedSize measures the encoded size of val.
2827
func EncodedSize(val interface{}) int {
29-
if !jit || opts.NoJIT {
28+
if nojit {
3029
return reflect.EncodedSize(val)
3130
}
3231
return jitEncodedSize(val)
@@ -35,7 +34,7 @@ func EncodedSize(val interface{}) int {
3534
// EncodeObject serializes val into buf with Thrift Binary Protocol, with optional Zero-Copy thrift.NocopyWriter.
3635
// buf must be large enough to contain the entire serialization result.
3736
func EncodeObject(buf []byte, w thrift.NocopyWriter, val interface{}) (int, error) {
38-
if !jit || opts.NoJIT {
37+
if nojit {
3938
ret, err := reflect.Append(buf[:0], val)
4039
if len(ret) > len(buf) {
4140
return 0, fmt.Errorf("index out of range [%d] with length %d.\n"+
@@ -49,7 +48,7 @@ func EncodeObject(buf []byte, w thrift.NocopyWriter, val interface{}) (int, erro
4948

5049
// DecodeObject deserializes buf into val with Thrift Binary Protocol.
5150
func DecodeObject(buf []byte, val interface{}) (int, error) {
52-
if !jit || opts.NoJIT {
51+
if nojit {
5352
return reflect.Decode(buf, val)
5453
}
5554
return jitDecodeObject(buf, val)

‎frugal_jit.go‎

Lines changed: 4 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//go:build !go1.24 && amd64 && !windows
1+
//go:build frugal_jit
22

33
/*
44
* Copyright 2024 CloudWeGo Authors
@@ -20,17 +20,15 @@ package frugal
2020

2121
import (
2222
"reflect"
23-
"sync"
2423

24+
"github.com/cloudwego/frugal/internal/jit"
2525
"github.com/cloudwego/frugal/internal/jit/decoder"
2626
"github.com/cloudwego/frugal/internal/jit/encoder"
27-
"github.com/cloudwego/frugal/internal/jit/rt"
28-
"github.com/cloudwego/frugal/internal/jit/utils"
2927
"github.com/cloudwego/frugal/internal/opts"
3028
"github.com/cloudwego/gopkg/protocol/thrift"
3129
)
3230

33-
const jit = true
31+
const nojit = false
3432

3533
func jitEncodedSize(val interface{}) int {
3634
return encoder.EncodedSize(val)
@@ -44,79 +42,10 @@ func jitDecodeObject(buf []byte, val interface{}) (int, error) {
4442
return decoder.DecodeObject(buf, val)
4543
}
4644

47-
type _Ty struct {
48-
d int
49-
ty *rt.GoType
50-
}
51-
52-
var (
53-
typool sync.Pool
54-
)
55-
56-
func newty(ty *rt.GoType, d int) *_Ty {
57-
if v := typool.Get(); v == nil {
58-
return &_Ty{d, ty}
59-
} else {
60-
r := v.(*_Ty)
61-
r.d, r.ty = d, ty
62-
return r
63-
}
64-
}
65-
66-
// Pretouch compiles vt ahead-of-time to avoid JIT compilation on-the-fly, in
67-
// order to reduce the first-hit latency.
6845
func Pretouch(vt reflect.Type, options ...Option) error {
69-
if opts.NoJIT {
70-
return nil
71-
}
72-
d := 0
7346
o := opts.GetDefaultOptions()
74-
75-
/* apply all the options */
7647
for _, fn := range options {
7748
fn(&o)
7849
}
79-
80-
/* unpack the type */
81-
v := make(map[*rt.GoType]bool)
82-
t := rt.Dereference(rt.UnpackType(vt))
83-
84-
/* add the root type */
85-
q := utils.NewQueue()
86-
q.Enqueue(newty(t, 1))
87-
88-
/* BFS the type tree */
89-
for !q.Empty() {
90-
ty := q.Dequeue().(*_Ty)
91-
tv, err := decoder.Pretouch(ty.ty, o)
92-
93-
/* also pretouch the encoder */
94-
if err == nil {
95-
err = encoder.Pretouch(ty.ty, o)
96-
}
97-
98-
/* mark the type as been visited */
99-
d, v[ty.ty] = ty.d, true
100-
typool.Put(ty)
101-
102-
/* check for errors */
103-
if err != nil {
104-
return err
105-
}
106-
107-
/* check for cutoff conditions */
108-
if !o.CanPretouch(d) {
109-
continue
110-
}
111-
112-
/* add all the not visited sub-types */
113-
for s := range tv {
114-
if t = rt.UnpackType(s); !v[t] {
115-
q.Enqueue(newty(t, d+1))
116-
}
117-
}
118-
}
119-
120-
/* completed with no errors */
121-
return nil
50+
return jit.Pretouch(vt, o)
12251
}

frugal_jit_go124.go renamed to frugal_nojit.go

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//go:build go1.24 || !amd64 || windows
1+
//go:build !frugal_jit
22

33
/*
44
* Copyright 2024 CloudWeGo Authors
@@ -21,27 +21,21 @@ package frugal
2121
import (
2222
"reflect"
2323

24-
"github.com/cloudwego/frugal/internal/opts"
2524
"github.com/cloudwego/gopkg/protocol/thrift"
2625
)
2726

28-
const jit = false // not implemented for go1.24 || !amd64 || windows
29-
30-
func init() {
31-
// force set opts.NoJIT true coz jit not available
32-
opts.NoJIT = true
33-
}
27+
const nojit = true
3428

3529
func jitEncodedSize(val interface{}) int {
36-
panic("not support JIT for Go version >= go1.24")
30+
panic("not supported")
3731
}
3832

3933
func jitEncodeObject(buf []byte, w thrift.NocopyWriter, val interface{}) (int, error) {
40-
panic("not support JIT for Go version >= go1.24")
34+
panic("not supported")
4135
}
4236

4337
func jitDecodeObject(buf []byte, val interface{}) (int, error) {
44-
panic("not support JIT for Go version >= go1.24")
38+
panic("not supported")
4539
}
4640

4741
// Pretouch compiles vt ahead-of-time to avoid JIT compilation on-the-fly, in

‎go.sum‎

Lines changed: 0 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -12,74 +12,19 @@ github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8Yc
1212
github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
1313
github.com/knz/go-libedit v1.10.1/go.mod h1:MZTVkCWyz0oBc7JOWP3wNAzd002ZbM/5hgShxwh4x8M=
1414
github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
15-
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
16-
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
17-
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
1815
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
1916
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
2017
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
2118
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
2219
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
23-
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
24-
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
25-
github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
2620
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
27-
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
28-
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
29-
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
3021
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
3122
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
32-
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
3323
golang.org/x/arch v0.2.0 h1:W1sUEHXiJTfjaFJ5SLo0N6lZn+0eO5gWD1MFeTGqQEY=
3424
golang.org/x/arch v0.2.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
35-
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
36-
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
37-
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
38-
golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M=
39-
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
40-
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
41-
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
42-
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
43-
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
44-
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
45-
golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
46-
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
47-
golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8=
48-
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
49-
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
50-
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
51-
golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
52-
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
53-
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
54-
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
55-
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
56-
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
57-
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
58-
golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
59-
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
60-
golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
61-
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
62-
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
63-
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
64-
golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
65-
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
66-
golang.org/x/term v0.19.0/go.mod h1:2CuTdWZ7KHSQwUzKva0cbMg6q2DMI3Mmxp+gKJbskEk=
67-
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
68-
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
69-
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
70-
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
71-
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
72-
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
73-
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
74-
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
75-
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
76-
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
77-
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
7825
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
7926
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
80-
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
8127
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
8228
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
8329
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
8430
nullprogram.com/x/optparse v1.0.0/go.mod h1:KdyPE+Igbe0jQUrVfMqDMeJQIJZEuyV7pjYmp6pbG50=
85-
rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=

0 commit comments

Comments
 (0)