mirror of
https://github.com/restic/rest-server.git
synced 2026-09-26 05:51:24 -07:00
Vendor dependencies
This commit is contained in:
committed by
Zlatko Čalušić
parent
2f0a16d8b7
commit
6054876201
Generated
+15
@@ -0,0 +1,15 @@
|
|||||||
|
hash: 14108917f401ac37008f72af7995f8f364ba4bf2a4094128b67c3564ac7273c3
|
||||||
|
updated: 2016-12-28T21:38:22.564108839+01:00
|
||||||
|
imports:
|
||||||
|
- name: goji.io
|
||||||
|
version: 0d89ff54b2c18c9c4ba530e32496aef902d3c6cd
|
||||||
|
subpackages:
|
||||||
|
- internal
|
||||||
|
- middleware
|
||||||
|
- pat
|
||||||
|
- pattern
|
||||||
|
- name: golang.org/x/net
|
||||||
|
version: 45e771701b814666a7eb299e6c7a57d0b1799e91
|
||||||
|
subpackages:
|
||||||
|
- context
|
||||||
|
testImports: []
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
package: .
|
||||||
|
import:
|
||||||
|
- package: goji.io
|
||||||
+11
@@ -0,0 +1,11 @@
|
|||||||
|
go_import_path: goji.io
|
||||||
|
language: go
|
||||||
|
sudo: false
|
||||||
|
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- go: 1.7
|
||||||
|
- go: tip
|
||||||
|
|
||||||
|
script:
|
||||||
|
- go test -cover -race ./...
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
Copyright (c) 2015, 2016 Carl Jackson (carl@avtok.com)
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||||
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||||
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
+87
@@ -0,0 +1,87 @@
|
|||||||
|
Goji
|
||||||
|
====
|
||||||
|
|
||||||
|
[](https://godoc.org/goji.io) [](https://travis-ci.org/goji/goji)
|
||||||
|
|
||||||
|
Goji is a HTTP request multiplexer, similar to [`net/http.ServeMux`][servemux].
|
||||||
|
It compares incoming requests to a list of registered [Patterns][pattern], and
|
||||||
|
dispatches to the [http.Handler][handler] that corresponds to the first matching
|
||||||
|
Pattern. Goji also supports [Middleware][middleware] (composable shared
|
||||||
|
functionality applied to every request) and uses the standard
|
||||||
|
[`context`][context] package to store request-scoped values.
|
||||||
|
|
||||||
|
[servemux]: https://golang.org/pkg/net/http/#ServeMux
|
||||||
|
[pattern]: https://godoc.org/goji.io#Pattern
|
||||||
|
[handler]: https://golang.org/pkg/net/http/#Handler
|
||||||
|
[middleware]: https://godoc.org/goji.io#Mux.Use
|
||||||
|
[context]: https://golang.org/pkg/context
|
||||||
|
|
||||||
|
|
||||||
|
Quick Start
|
||||||
|
-----------
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"goji.io"
|
||||||
|
"goji.io/pat"
|
||||||
|
)
|
||||||
|
|
||||||
|
func hello(w http.ResponseWriter, r *http.Request) {
|
||||||
|
name := pat.Param(r, "name")
|
||||||
|
fmt.Fprintf(w, "Hello, %s!", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
mux := goji.NewMux()
|
||||||
|
mux.HandleFunc(pat.Get("/hello/:name"), hello)
|
||||||
|
|
||||||
|
http.ListenAndServe("localhost:8000", mux)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Please refer to [Goji's GoDoc Documentation][godoc] for a full API reference.
|
||||||
|
|
||||||
|
[godoc]: https://godoc.org/goji.io
|
||||||
|
|
||||||
|
|
||||||
|
Stability
|
||||||
|
---------
|
||||||
|
|
||||||
|
Goji's API was recently updated to use the new `net/http` and `context`
|
||||||
|
integration, and is therefore some of its interfaces are in a state of flux. We
|
||||||
|
don't expect any further changes to the API, and expect to be able to announce
|
||||||
|
API stability soon. Goji is suitable for use in production.
|
||||||
|
|
||||||
|
Prior to Go 1.7, Goji promised API stability with a different API to the one
|
||||||
|
that is offered today. The author broke this promise, and does not take this
|
||||||
|
breach of trust lightly. While stability is obviously extremely important, the
|
||||||
|
author and community have decided to follow the broader Go community in
|
||||||
|
standardizing on the standard library copy of the `context` package.
|
||||||
|
|
||||||
|
Users of the old API can find that familiar API on the `net-context` branch. The
|
||||||
|
author promises to maintain both the `net-context` branch and `master` for the
|
||||||
|
forseeable future.
|
||||||
|
|
||||||
|
|
||||||
|
Community / Contributing
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
Goji maintains a mailing list, [gojiberries][berries], where you should feel
|
||||||
|
welcome to ask questions about the project (no matter how simple!), to announce
|
||||||
|
projects or libraries built on top of Goji, or to talk about Goji more
|
||||||
|
generally. Goji's author (Carl Jackson) also loves to hear from users directly
|
||||||
|
at his personal email address, which is available on his GitHub profile page.
|
||||||
|
|
||||||
|
Contributions to Goji are welcome, however please be advised that due to Goji's
|
||||||
|
stability guarantees interface changes are unlikely to be accepted.
|
||||||
|
|
||||||
|
All interactions in the Goji community will be held to the high standard of the
|
||||||
|
broader Go community's [Code of Conduct][conduct].
|
||||||
|
|
||||||
|
[berries]: https://groups.google.com/forum/#!forum/gojiberries
|
||||||
|
[conduct]: https://golang.org/conduct
|
||||||
+19
@@ -0,0 +1,19 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
type dispatch struct{}
|
||||||
|
|
||||||
|
func (d dispatch) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||||
|
ctx := r.Context()
|
||||||
|
h := ctx.Value(internal.Handler)
|
||||||
|
if h == nil {
|
||||||
|
http.NotFound(w, r)
|
||||||
|
} else {
|
||||||
|
h.(http.Handler).ServeHTTP(w, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
+32
@@ -0,0 +1,32 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestDispatch(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var d dispatch
|
||||||
|
|
||||||
|
w, r := wr()
|
||||||
|
d.ServeHTTP(w, r)
|
||||||
|
if w.Code != 404 {
|
||||||
|
t.Errorf("status: expected %d, got %d", 404, w.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
w, r = wr()
|
||||||
|
h := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(123)
|
||||||
|
})
|
||||||
|
ctx := context.WithValue(context.Background(), internal.Handler, h)
|
||||||
|
r = r.WithContext(ctx)
|
||||||
|
d.ServeHTTP(w, r)
|
||||||
|
if w.Code != 123 {
|
||||||
|
t.Errorf("status: expected %d, got %d", 123, w.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
+63
@@ -0,0 +1,63 @@
|
|||||||
|
/*
|
||||||
|
Package goji is a minimalistic and flexible HTTP request multiplexer.
|
||||||
|
|
||||||
|
Goji itself has very few features: it is first and foremost a standard set of
|
||||||
|
interfaces for writing web applications. Several subpackages are distributed
|
||||||
|
with Goji to provide standard production-ready implementations of several of the
|
||||||
|
interfaces, however users are also encouraged to implement the interfaces on
|
||||||
|
their own, especially if their needs are unusual.
|
||||||
|
*/
|
||||||
|
package goji
|
||||||
|
|
||||||
|
import "net/http"
|
||||||
|
|
||||||
|
/*
|
||||||
|
Pattern determines whether a given request matches some criteria. Goji users
|
||||||
|
looking for a concrete type that implements this interface should consider
|
||||||
|
Goji's "pat" sub-package, which implements a small domain specific language for
|
||||||
|
HTTP routing.
|
||||||
|
|
||||||
|
Patterns typically only examine a small portion of incoming requests, most
|
||||||
|
commonly the HTTP method and the URL's RawPath. As an optimization, Goji can
|
||||||
|
elide calls to your Pattern for requests it knows cannot match. Pattern authors
|
||||||
|
who wish to take advantage of this functionality (and in some cases an
|
||||||
|
asymptotic performance improvement) can augment their Pattern implementations
|
||||||
|
with any of the following methods:
|
||||||
|
|
||||||
|
// HTTPMethods returns a set of HTTP methods that this Pattern matches,
|
||||||
|
// or nil if it's not possible to determine which HTTP methods might be
|
||||||
|
// matched. Put another way, requests with HTTP methods not in the
|
||||||
|
// returned set are guaranteed to never match this Pattern.
|
||||||
|
HTTPMethods() map[string]struct{}
|
||||||
|
|
||||||
|
// PathPrefix returns a string which all RawPaths that match this
|
||||||
|
// Pattern must have as a prefix. Put another way, requests with
|
||||||
|
// RawPaths that do not contain the returned string as a prefix are
|
||||||
|
// guaranteed to never match this Pattern.
|
||||||
|
PathPrefix() string
|
||||||
|
|
||||||
|
The presence or lack of these performance improvements should be viewed as an
|
||||||
|
implementation detail and are not part of Goji's API compatibility guarantee. It
|
||||||
|
is the responsibility of Pattern authors to ensure that their Match function
|
||||||
|
always returns correct results, even if these optimizations are not performed.
|
||||||
|
|
||||||
|
All operations on Patterns must be safe for concurrent use by multiple
|
||||||
|
goroutines.
|
||||||
|
*/
|
||||||
|
type Pattern interface {
|
||||||
|
// Match examines the input Request to determine if it matches some
|
||||||
|
// criteria, and if so returns a non-nil output Request. This returned
|
||||||
|
// Request will be passed to the middleware stack and the final Handler.
|
||||||
|
//
|
||||||
|
// Patterns often extract variables from the Request, for instance from
|
||||||
|
// the URL or from HTTP headers. In this case, it is common for the
|
||||||
|
// Request returned from the Match function to be derived from the input
|
||||||
|
// Request using the WithContext function, with a Context that contains
|
||||||
|
// those variable bindings. If no variable bindings are necessary,
|
||||||
|
// another common choice is to return the input Request unchanged.
|
||||||
|
//
|
||||||
|
// Match must not mutate the passed request if it returns nil.
|
||||||
|
// Implementers are also strongly discouraged from mutating the input
|
||||||
|
// Request even in the event of a match; instead, prefer making a copy.
|
||||||
|
Match(*http.Request) *http.Request
|
||||||
|
}
|
||||||
+37
@@ -0,0 +1,37 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import "net/http"
|
||||||
|
|
||||||
|
/*
|
||||||
|
Handle adds a new route to the Mux. Requests that match the given Pattern will
|
||||||
|
be dispatched to the given http.Handler.
|
||||||
|
|
||||||
|
Routing is performed in the order in which routes are added: the first route
|
||||||
|
with a matching Pattern will be used. In particular, Goji guarantees that
|
||||||
|
routing is performed in a manner that is indistinguishable from the following
|
||||||
|
algorithm:
|
||||||
|
|
||||||
|
// Assume routes is a slice that every call to Handle appends to
|
||||||
|
for _, route := range routes {
|
||||||
|
// For performance, Patterns can opt out of this call to Match.
|
||||||
|
// See the documentation for Pattern for more.
|
||||||
|
if r2 := route.pattern.Match(r); r2 != nil {
|
||||||
|
route.handler.ServeHTTP(w, r2)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
It is not safe to concurrently register routes from multiple goroutines, or to
|
||||||
|
register routes concurrently with requests.
|
||||||
|
*/
|
||||||
|
func (m *Mux) Handle(p Pattern, h http.Handler) {
|
||||||
|
m.router.add(p, h)
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
HandleFunc adds a new route to the Mux. It is equivalent to calling Handle on a
|
||||||
|
handler wrapped with http.HandlerFunc, and is provided only for convenience.
|
||||||
|
*/
|
||||||
|
func (m *Mux) HandleFunc(p Pattern, h func(http.ResponseWriter, *http.Request)) {
|
||||||
|
m.Handle(p, http.HandlerFunc(h))
|
||||||
|
}
|
||||||
+40
@@ -0,0 +1,40 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestHandle(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
m := NewMux()
|
||||||
|
called := false
|
||||||
|
fn := func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
called = true
|
||||||
|
}
|
||||||
|
m.Handle(boolPattern(true), http.HandlerFunc(fn))
|
||||||
|
|
||||||
|
w, r := wr()
|
||||||
|
m.ServeHTTP(w, r)
|
||||||
|
if !called {
|
||||||
|
t.Error("expected handler to be called")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleFunc(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
m := NewMux()
|
||||||
|
called := false
|
||||||
|
fn := func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
called = true
|
||||||
|
}
|
||||||
|
m.HandleFunc(boolPattern(true), fn)
|
||||||
|
|
||||||
|
w, r := wr()
|
||||||
|
m.ServeHTTP(w, r)
|
||||||
|
if !called {
|
||||||
|
t.Error("expected handler to be called")
|
||||||
|
}
|
||||||
|
}
|
||||||
+17
@@ -0,0 +1,17 @@
|
|||||||
|
package internal
|
||||||
|
|
||||||
|
// ContextKey is a type used for Goji's context.Context keys.
|
||||||
|
type ContextKey int
|
||||||
|
|
||||||
|
var (
|
||||||
|
// Path is the context key used to store the path Goji uses for its
|
||||||
|
// PathPrefix optimization.
|
||||||
|
Path interface{} = ContextKey(0)
|
||||||
|
// Pattern is the context key used to store the Pattern that Goji last
|
||||||
|
// matched.
|
||||||
|
Pattern interface{} = ContextKey(1)
|
||||||
|
// Handler is the context key used to store the Handler that Goji last
|
||||||
|
// mached (and will therefore dispatch to at the end of the middleware
|
||||||
|
// stack).
|
||||||
|
Handler interface{} = ContextKey(2)
|
||||||
|
)
|
||||||
+13
@@ -0,0 +1,13 @@
|
|||||||
|
/*
|
||||||
|
Package internal is a private package that allows Goji to expose a less
|
||||||
|
confusing interface to its users. This package must not be used outside of Goji;
|
||||||
|
every piece of its functionality has been exposed by one of Goji's subpackages.
|
||||||
|
|
||||||
|
The problem this package solves is to allow Goji to internally agree on types
|
||||||
|
and secret values between its packages without introducing import cycles. Goji
|
||||||
|
needs to agree on these types and values in order to organize its public API
|
||||||
|
into audience-specific subpackages (for instance, a package for pattern authors,
|
||||||
|
a package for middleware authors, and a main package for routing users) without
|
||||||
|
exposing implementation details in any of the packages.
|
||||||
|
*/
|
||||||
|
package internal
|
||||||
+75
@@ -0,0 +1,75 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import "net/http"
|
||||||
|
|
||||||
|
/*
|
||||||
|
Use appends a middleware to the Mux's middleware stack.
|
||||||
|
|
||||||
|
Middleware are composable pieces of functionality that augment http.Handlers.
|
||||||
|
Common examples of middleware include request loggers, authentication checkers,
|
||||||
|
and metrics gatherers.
|
||||||
|
|
||||||
|
Middleware are evaluated in the reverse order in which they were added, but the
|
||||||
|
resulting http.Handlers execute in "normal" order (i.e., the http.Handler
|
||||||
|
returned by the first Middleware to be added gets called first).
|
||||||
|
|
||||||
|
For instance, given middleware A, B, and C, added in that order, Goji will
|
||||||
|
behave similarly to this snippet:
|
||||||
|
|
||||||
|
augmentedHandler := A(B(C(yourHandler)))
|
||||||
|
augmentedHandler.ServeHTTP(w, r)
|
||||||
|
|
||||||
|
Assuming each of A, B, and C look something like this:
|
||||||
|
|
||||||
|
func A(inner http.Handler) http.Handler {
|
||||||
|
log.Print("A: called")
|
||||||
|
mw := func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
log.Print("A: before")
|
||||||
|
inner.ServeHTTP(w, r)
|
||||||
|
log.Print("A: after")
|
||||||
|
}
|
||||||
|
return http.HandlerFunc(mw)
|
||||||
|
}
|
||||||
|
|
||||||
|
we'd expect to see the following in the log:
|
||||||
|
|
||||||
|
C: called
|
||||||
|
B: called
|
||||||
|
A: called
|
||||||
|
---
|
||||||
|
A: before
|
||||||
|
B: before
|
||||||
|
C: before
|
||||||
|
yourHandler: called
|
||||||
|
C: after
|
||||||
|
B: after
|
||||||
|
A: after
|
||||||
|
|
||||||
|
Note that augmentedHandler will called many times, producing the log output
|
||||||
|
below the divider, while the outer middleware functions (the log output above
|
||||||
|
the divider) will only be called a handful of times at application boot.
|
||||||
|
|
||||||
|
Middleware in Goji is called after routing has been performed. Therefore it is
|
||||||
|
possible to examine any routing information placed into the Request context by
|
||||||
|
Patterns, or to view or modify the http.Handler that will be routed to.
|
||||||
|
Middleware authors should read the documentation for the "middleware" subpackage
|
||||||
|
for more information about how this is done.
|
||||||
|
|
||||||
|
The http.Handler returned by the given middleware must be safe for concurrent
|
||||||
|
use by multiple goroutines. It is not safe to concurrently register middleware
|
||||||
|
from multiple goroutines, or to register middleware concurrently with requests.
|
||||||
|
*/
|
||||||
|
func (m *Mux) Use(middleware func(http.Handler) http.Handler) {
|
||||||
|
m.middleware = append(m.middleware, middleware)
|
||||||
|
m.buildChain()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pre-compile a http.Handler for us to use during dispatch. Yes, this means
|
||||||
|
// that adding middleware is quadratic, but it (a) happens during configuration
|
||||||
|
// time, not at "runtime", and (b) n should ~always be small.
|
||||||
|
func (m *Mux) buildChain() {
|
||||||
|
m.handler = dispatch{}
|
||||||
|
for i := len(m.middleware) - 1; i >= 0; i-- {
|
||||||
|
m.handler = m.middleware[i](m.handler)
|
||||||
|
}
|
||||||
|
}
|
||||||
+60
@@ -0,0 +1,60 @@
|
|||||||
|
/*
|
||||||
|
Package middleware contains utilities for Goji Middleware authors.
|
||||||
|
|
||||||
|
Unless you are writing middleware for your application, you should avoid
|
||||||
|
importing this package. Instead, use the abstractions provided by your
|
||||||
|
middleware package.
|
||||||
|
*/
|
||||||
|
package middleware
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"goji.io"
|
||||||
|
"goji.io/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
/*
|
||||||
|
Pattern returns the most recently matched Pattern, or nil if no pattern was
|
||||||
|
matched.
|
||||||
|
*/
|
||||||
|
func Pattern(ctx context.Context) goji.Pattern {
|
||||||
|
p := ctx.Value(internal.Pattern)
|
||||||
|
if p == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return p.(goji.Pattern)
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
SetPattern returns a new context in which the given Pattern is used as the most
|
||||||
|
recently matched pattern.
|
||||||
|
*/
|
||||||
|
func SetPattern(ctx context.Context, p goji.Pattern) context.Context {
|
||||||
|
return context.WithValue(ctx, internal.Pattern, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Handler returns the handler corresponding to the most recently matched Pattern,
|
||||||
|
or nil if no pattern was matched.
|
||||||
|
|
||||||
|
The handler returned by this function is the one that will be dispatched to at
|
||||||
|
the end of the middleware stack. If the returned Handler is nil, http.NotFound
|
||||||
|
will be used instead.
|
||||||
|
*/
|
||||||
|
func Handler(ctx context.Context) http.Handler {
|
||||||
|
h := ctx.Value(internal.Handler)
|
||||||
|
if h == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return h.(http.Handler)
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
SetHandler returns a new context in which the given Handler was most recently
|
||||||
|
matched and which consequently will be dispatched to.
|
||||||
|
*/
|
||||||
|
func SetHandler(ctx context.Context, h http.Handler) context.Context {
|
||||||
|
return context.WithValue(ctx, internal.Handler, h)
|
||||||
|
}
|
||||||
+48
@@ -0,0 +1,48 @@
|
|||||||
|
package middleware
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
type testPattern bool
|
||||||
|
|
||||||
|
func (t testPattern) Match(r *http.Request) *http.Request {
|
||||||
|
if t {
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type testHandler struct{}
|
||||||
|
|
||||||
|
func (t testHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {}
|
||||||
|
|
||||||
|
func TestPattern(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
pat := testPattern(true)
|
||||||
|
ctx := SetPattern(context.Background(), pat)
|
||||||
|
if pat2 := Pattern(ctx); pat2 != pat {
|
||||||
|
t.Errorf("got ctx=%v, expected %v", pat2, pat)
|
||||||
|
}
|
||||||
|
|
||||||
|
if pat2 := Pattern(context.Background()); pat2 != nil {
|
||||||
|
t.Errorf("got ctx=%v, expecte nil", pat2)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandler(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
h := testHandler{}
|
||||||
|
ctx := SetHandler(context.Background(), h)
|
||||||
|
if h2 := Handler(ctx); h2 != h {
|
||||||
|
t.Errorf("got handler=%v, expected %v", h2, h)
|
||||||
|
}
|
||||||
|
|
||||||
|
if h2 := Handler(context.Background()); h2 != nil {
|
||||||
|
t.Errorf("got handler=%v, expected nil", h2)
|
||||||
|
}
|
||||||
|
}
|
||||||
+80
@@ -0,0 +1,80 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func expectSequence(t *testing.T, ch chan string, seq ...string) {
|
||||||
|
for i, str := range seq {
|
||||||
|
if msg := <-ch; msg != str {
|
||||||
|
t.Errorf("[%d] expected %s, got %s", i, str, msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMiddleware(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
m := NewMux()
|
||||||
|
ch := make(chan string, 10)
|
||||||
|
m.Use(func(h http.Handler) http.Handler {
|
||||||
|
fn := func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
ch <- "before one"
|
||||||
|
h.ServeHTTP(w, r)
|
||||||
|
ch <- "after one"
|
||||||
|
}
|
||||||
|
return http.HandlerFunc(fn)
|
||||||
|
})
|
||||||
|
m.Use(func(h http.Handler) http.Handler {
|
||||||
|
fn := func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
ch <- "before two"
|
||||||
|
h.ServeHTTP(w, r)
|
||||||
|
ch <- "after two"
|
||||||
|
}
|
||||||
|
return http.HandlerFunc(fn)
|
||||||
|
})
|
||||||
|
m.Handle(boolPattern(true), http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
ch <- "handler"
|
||||||
|
}))
|
||||||
|
|
||||||
|
m.ServeHTTP(wr())
|
||||||
|
|
||||||
|
expectSequence(t, ch, "before one", "before two", "handler", "after two", "after one")
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeMiddleware(ch chan string, name string) func(http.Handler) http.Handler {
|
||||||
|
return func(h http.Handler) http.Handler {
|
||||||
|
fn := func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
ch <- "before " + name
|
||||||
|
h.ServeHTTP(w, r)
|
||||||
|
ch <- "after " + name
|
||||||
|
}
|
||||||
|
return http.HandlerFunc(fn)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMiddlewareReconfigure(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
m := NewMux()
|
||||||
|
ch := make(chan string, 10)
|
||||||
|
m.Use(makeMiddleware(ch, "one"))
|
||||||
|
m.Use(makeMiddleware(ch, "two"))
|
||||||
|
m.Handle(boolPattern(true), http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
ch <- "handler"
|
||||||
|
}))
|
||||||
|
|
||||||
|
w, r := wr()
|
||||||
|
m.ServeHTTP(w, r)
|
||||||
|
|
||||||
|
expectSequence(t, ch, "before one", "before two", "handler", "after two", "after one")
|
||||||
|
|
||||||
|
m.Use(makeMiddleware(ch, "three"))
|
||||||
|
|
||||||
|
w, r = wr()
|
||||||
|
m.ServeHTTP(w, r)
|
||||||
|
|
||||||
|
expectSequence(t, ch, "before one", "before two", "before three",
|
||||||
|
"handler", "after three", "after two", "after one")
|
||||||
|
}
|
||||||
+77
@@ -0,0 +1,77 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
/*
|
||||||
|
Mux is a HTTP multiplexer / router similar to net/http.ServeMux.
|
||||||
|
|
||||||
|
Muxes multiplex traffic between many http.Handlers by selecting the first
|
||||||
|
applicable Pattern. They then call a common middleware stack, finally passing
|
||||||
|
control to the selected http.Handler. See the documentation on the Handle
|
||||||
|
function for more information about how routing is performed, the documentation
|
||||||
|
on the Pattern type for more information about request matching, and the
|
||||||
|
documentation for the Use method for more about middleware.
|
||||||
|
|
||||||
|
Muxes cannot be configured concurrently from multiple goroutines, nor can they
|
||||||
|
be configured concurrently with requests.
|
||||||
|
*/
|
||||||
|
type Mux struct {
|
||||||
|
handler http.Handler
|
||||||
|
middleware []func(http.Handler) http.Handler
|
||||||
|
router router
|
||||||
|
root bool
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
NewMux returns a new Mux with no configured middleware or routes.
|
||||||
|
*/
|
||||||
|
func NewMux() *Mux {
|
||||||
|
m := SubMux()
|
||||||
|
m.root = true
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
SubMux returns a new Mux with no configured middleware or routes, and which
|
||||||
|
inherits routing information from the passed context. This is especially useful
|
||||||
|
when using one Mux as a http.Handler registered to another "parent" Mux.
|
||||||
|
|
||||||
|
For example, a common pattern is to organize applications in a way that mirrors
|
||||||
|
the structure of its URLs: a photo-sharing site might have URLs that start with
|
||||||
|
"/users/" and URLs that start with "/albums/", and might be organized using
|
||||||
|
three Muxes:
|
||||||
|
|
||||||
|
root := NewMux()
|
||||||
|
users := SubMux()
|
||||||
|
root.Handle(pat.New("/users/*"), users)
|
||||||
|
albums := SubMux()
|
||||||
|
root.Handle(pat.New("/albums/*"), albums)
|
||||||
|
|
||||||
|
// e.g., GET /users/carl
|
||||||
|
users.Handle(pat.Get("/:name"), renderProfile)
|
||||||
|
// e.g., POST /albums/
|
||||||
|
albums.Handle(pat.Post("/"), newAlbum)
|
||||||
|
*/
|
||||||
|
func SubMux() *Mux {
|
||||||
|
m := &Mux{}
|
||||||
|
m.buildChain()
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
// ServeHTTP implements net/http.Handler.
|
||||||
|
func (m *Mux) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if m.root {
|
||||||
|
ctx := r.Context()
|
||||||
|
ctx = context.WithValue(ctx, internal.Path, r.URL.EscapedPath())
|
||||||
|
r = r.WithContext(ctx)
|
||||||
|
}
|
||||||
|
r = m.router.route(r)
|
||||||
|
m.handler.ServeHTTP(w, r)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ http.Handler = &Mux{}
|
||||||
+39
@@ -0,0 +1,39 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestMuxExistingPath(t *testing.T) {
|
||||||
|
m := NewMux()
|
||||||
|
handler := func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
ctx := r.Context()
|
||||||
|
if path := ctx.Value(internal.Path).(string); path != "/" {
|
||||||
|
t.Errorf("expected path=/, got %q", path)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m.HandleFunc(boolPattern(true), handler)
|
||||||
|
w, r := wr()
|
||||||
|
ctx := context.WithValue(context.Background(), internal.Path, "/hello")
|
||||||
|
r = r.WithContext(ctx)
|
||||||
|
m.ServeHTTP(w, r)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSubMuxExistingPath(t *testing.T) {
|
||||||
|
m := SubMux()
|
||||||
|
handler := func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
ctx := r.Context()
|
||||||
|
if path := ctx.Value(internal.Path).(string); path != "/hello" {
|
||||||
|
t.Errorf("expected path=/hello, got %q", path)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m.HandleFunc(boolPattern(true), handler)
|
||||||
|
w, r := wr()
|
||||||
|
ctx := context.WithValue(context.Background(), internal.Path, "/hello")
|
||||||
|
r = r.WithContext(ctx)
|
||||||
|
m.ServeHTTP(w, r)
|
||||||
|
}
|
||||||
+51
@@ -0,0 +1,51 @@
|
|||||||
|
package pat
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"sort"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
"goji.io/pattern"
|
||||||
|
)
|
||||||
|
|
||||||
|
type match struct {
|
||||||
|
context.Context
|
||||||
|
pat *Pattern
|
||||||
|
matches []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m match) Value(key interface{}) interface{} {
|
||||||
|
switch key {
|
||||||
|
case pattern.AllVariables:
|
||||||
|
var vs map[pattern.Variable]interface{}
|
||||||
|
if vsi := m.Context.Value(key); vsi == nil {
|
||||||
|
if len(m.pat.pats) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
vs = make(map[pattern.Variable]interface{}, len(m.matches))
|
||||||
|
} else {
|
||||||
|
vs = vsi.(map[pattern.Variable]interface{})
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, p := range m.pat.pats {
|
||||||
|
vs[p.name] = m.matches[p.idx]
|
||||||
|
}
|
||||||
|
return vs
|
||||||
|
case internal.Path:
|
||||||
|
if len(m.matches) == len(m.pat.pats)+1 {
|
||||||
|
return m.matches[len(m.matches)-1]
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
if k, ok := key.(pattern.Variable); ok {
|
||||||
|
i := sort.Search(len(m.pat.pats), func(i int) bool {
|
||||||
|
return m.pat.pats[i].name >= k
|
||||||
|
})
|
||||||
|
if i < len(m.pat.pats) && m.pat.pats[i].name == k {
|
||||||
|
return m.matches[m.pat.pats[i].idx]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return m.Context.Value(key)
|
||||||
|
}
|
||||||
+60
@@ -0,0 +1,60 @@
|
|||||||
|
package pat
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"goji.io/pattern"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestExistingContext(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
pat := New("/hi/:c/:a/:r/:l")
|
||||||
|
req, err := http.NewRequest("GET", "/hi/foo/bar/baz/quux", nil)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
ctx = pattern.SetPath(ctx, req.URL.EscapedPath())
|
||||||
|
ctx = context.WithValue(ctx, pattern.AllVariables, map[pattern.Variable]interface{}{
|
||||||
|
"hello": "world",
|
||||||
|
"c": "nope",
|
||||||
|
})
|
||||||
|
ctx = context.WithValue(ctx, pattern.Variable("user"), "carl")
|
||||||
|
|
||||||
|
req = req.WithContext(ctx)
|
||||||
|
req = pat.Match(req)
|
||||||
|
if req == nil {
|
||||||
|
t.Fatalf("expected pattern to match")
|
||||||
|
}
|
||||||
|
ctx = req.Context()
|
||||||
|
|
||||||
|
expected := map[pattern.Variable]interface{}{
|
||||||
|
"c": "foo",
|
||||||
|
"a": "bar",
|
||||||
|
"r": "baz",
|
||||||
|
"l": "quux",
|
||||||
|
}
|
||||||
|
for k, v := range expected {
|
||||||
|
if p := Param(req, string(k)); p != v {
|
||||||
|
t.Errorf("expected %s=%q, got %q", k, v, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
expected["hello"] = "world"
|
||||||
|
all := ctx.Value(pattern.AllVariables).(map[pattern.Variable]interface{})
|
||||||
|
if !reflect.DeepEqual(all, expected) {
|
||||||
|
t.Errorf("expected %v, got %v", expected, all)
|
||||||
|
}
|
||||||
|
|
||||||
|
if path := pattern.Path(ctx); path != "" {
|
||||||
|
t.Errorf("expected path=%q, got %q", "", path)
|
||||||
|
}
|
||||||
|
|
||||||
|
if user := ctx.Value(pattern.Variable("user")); user != "carl" {
|
||||||
|
t.Errorf("expected user=%q, got %q", "carl", user)
|
||||||
|
}
|
||||||
|
}
|
||||||
+51
@@ -0,0 +1,51 @@
|
|||||||
|
package pat
|
||||||
|
|
||||||
|
/*
|
||||||
|
Delete returns a Pat route that only matches the DELETE HTTP method.
|
||||||
|
*/
|
||||||
|
func Delete(pat string) *Pattern {
|
||||||
|
return newWithMethods(pat, "DELETE")
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Get returns a Pat route that only matches the GET and HEAD HTTP method. HEAD
|
||||||
|
requests are handled transparently by net/http.
|
||||||
|
*/
|
||||||
|
func Get(pat string) *Pattern {
|
||||||
|
return newWithMethods(pat, "GET", "HEAD")
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Head returns a Pat route that only matches the HEAD HTTP method.
|
||||||
|
*/
|
||||||
|
func Head(pat string) *Pattern {
|
||||||
|
return newWithMethods(pat, "HEAD")
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Options returns a Pat route that only matches the OPTIONS HTTP method.
|
||||||
|
*/
|
||||||
|
func Options(pat string) *Pattern {
|
||||||
|
return newWithMethods(pat, "OPTIONS")
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Patch returns a Pat route that only matches the PATCH HTTP method.
|
||||||
|
*/
|
||||||
|
func Patch(pat string) *Pattern {
|
||||||
|
return newWithMethods(pat, "PATCH")
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Post returns a Pat route that only matches the POST HTTP method.
|
||||||
|
*/
|
||||||
|
func Post(pat string) *Pattern {
|
||||||
|
return newWithMethods(pat, "POST")
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Put returns a Pat route that only matches the PUT HTTP method.
|
||||||
|
*/
|
||||||
|
func Put(pat string) *Pattern {
|
||||||
|
return newWithMethods(pat, "PUT")
|
||||||
|
}
|
||||||
+83
@@ -0,0 +1,83 @@
|
|||||||
|
package pat
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
func TestDelete(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
pat := Delete("/")
|
||||||
|
if pat.Match(mustReq("GET", "/")) != nil {
|
||||||
|
t.Errorf("pattern was DELETE, but matched GET")
|
||||||
|
}
|
||||||
|
if pat.Match(mustReq("DELETE", "/")) == nil {
|
||||||
|
t.Errorf("pattern didn't match DELETE")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGet(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
pat := Get("/")
|
||||||
|
if pat.Match(mustReq("POST", "/")) != nil {
|
||||||
|
t.Errorf("pattern was GET, but matched POST")
|
||||||
|
}
|
||||||
|
if pat.Match(mustReq("GET", "/")) == nil {
|
||||||
|
t.Errorf("pattern didn't match GET")
|
||||||
|
}
|
||||||
|
if pat.Match(mustReq("HEAD", "/")) == nil {
|
||||||
|
t.Errorf("pattern didn't match HEAD")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHead(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
pat := Head("/")
|
||||||
|
if pat.Match(mustReq("GET", "/")) != nil {
|
||||||
|
t.Errorf("pattern was HEAD, but matched GET")
|
||||||
|
}
|
||||||
|
if pat.Match(mustReq("HEAD", "/")) == nil {
|
||||||
|
t.Errorf("pattern didn't match HEAD")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOptions(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
pat := Options("/")
|
||||||
|
if pat.Match(mustReq("GET", "/")) != nil {
|
||||||
|
t.Errorf("pattern was OPTIONS, but matched GET")
|
||||||
|
}
|
||||||
|
if pat.Match(mustReq("OPTIONS", "/")) == nil {
|
||||||
|
t.Errorf("pattern didn't match OPTIONS")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPatch(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
pat := Patch("/")
|
||||||
|
if pat.Match(mustReq("GET", "/")) != nil {
|
||||||
|
t.Errorf("pattern was PATCH, but matched GET")
|
||||||
|
}
|
||||||
|
if pat.Match(mustReq("PATCH", "/")) == nil {
|
||||||
|
t.Errorf("pattern didn't match PATCH")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPost(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
pat := Post("/")
|
||||||
|
if pat.Match(mustReq("GET", "/")) != nil {
|
||||||
|
t.Errorf("pattern was POST, but matched GET")
|
||||||
|
}
|
||||||
|
if pat.Match(mustReq("POST", "/")) == nil {
|
||||||
|
t.Errorf("pattern didn't match POST")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPut(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
pat := Put("/")
|
||||||
|
if pat.Match(mustReq("GET", "/")) != nil {
|
||||||
|
t.Errorf("pattern was PUT, but matched GET")
|
||||||
|
}
|
||||||
|
if pat.Match(mustReq("PUT", "/")) == nil {
|
||||||
|
t.Errorf("pattern didn't match PUT")
|
||||||
|
}
|
||||||
|
}
|
||||||
+302
@@ -0,0 +1,302 @@
|
|||||||
|
/*
|
||||||
|
Package pat is a URL-matching domain-specific language for Goji.
|
||||||
|
|
||||||
|
|
||||||
|
Quick Reference
|
||||||
|
|
||||||
|
The following table gives an overview of the language this package accepts. See
|
||||||
|
the subsequent sections for a more detailed explanation of what each pattern
|
||||||
|
does.
|
||||||
|
|
||||||
|
Pattern Matches Does Not Match
|
||||||
|
|
||||||
|
/ / /hello
|
||||||
|
|
||||||
|
/hello /hello /hi
|
||||||
|
/hello/
|
||||||
|
|
||||||
|
/user/:name /user/carl /user/carl/photos
|
||||||
|
/user/alice /user/carl/
|
||||||
|
/user/
|
||||||
|
|
||||||
|
/:file.:ext /data.json /.json
|
||||||
|
/info.txt /data.
|
||||||
|
/data.tar.gz /data.json/download
|
||||||
|
|
||||||
|
/user/* /user/ /user
|
||||||
|
/user/carl
|
||||||
|
/user/carl/photos
|
||||||
|
|
||||||
|
|
||||||
|
Static Paths
|
||||||
|
|
||||||
|
Most URL paths may be specified directly: the pattern "/hello" matches URLs with
|
||||||
|
precisely that path ("/hello/", for instance, is treated as distinct).
|
||||||
|
|
||||||
|
Note that this package operates on raw (i.e., escaped) paths (see the
|
||||||
|
documentation for net/url.URL.EscapedPath). In order to match a character that
|
||||||
|
can appear escaped in a URL path, use its percent-encoded form.
|
||||||
|
|
||||||
|
|
||||||
|
Named Matches
|
||||||
|
|
||||||
|
Named matches allow URL paths to contain any value in a particular path segment.
|
||||||
|
Such matches are denoted by a leading ":", for example ":name" in the rule
|
||||||
|
"/user/:name", and permit any non-empty value in that position. For instance, in
|
||||||
|
the previous "/user/:name" example, the path "/user/carl" is matched, while
|
||||||
|
"/user/" or "/user/carl/" (note the trailing slash) are not matched. Pat rules
|
||||||
|
can contain any number of named matches.
|
||||||
|
|
||||||
|
Named matches set URL variables by comparing pattern names to the segments they
|
||||||
|
matched. In our "/user/:name" example, a request for "/user/carl" would bind the
|
||||||
|
"name" variable to the value "carl". Use the Param function to extract these
|
||||||
|
variables from the request context. Variable names in a single pattern must be
|
||||||
|
unique.
|
||||||
|
|
||||||
|
Matches are ordinarily delimited by slashes ("/"), but several other characters
|
||||||
|
are accepted as delimiters (with slightly different semantics): the period
|
||||||
|
("."), semicolon (";"), and comma (",") characters. For instance, given the
|
||||||
|
pattern "/:file.:ext", the request "/data.json" would match, binding "file" to
|
||||||
|
"data" and "ext" to "json". Note that these special characters are treated
|
||||||
|
slightly differently than slashes: the above pattern also matches the path
|
||||||
|
"/data.tar.gz", with "ext" getting set to "tar.gz"; and the pattern "/:file"
|
||||||
|
matches names with dots in them (like "data.json").
|
||||||
|
|
||||||
|
|
||||||
|
Prefix Matches
|
||||||
|
|
||||||
|
Pat can also match prefixes of routes using wildcards. Prefix wildcard routes
|
||||||
|
end with "/*", and match just the path segments preceding the asterisk. For
|
||||||
|
instance, the pattern "/user/*" will match "/user/" and "/user/carl/photos" but
|
||||||
|
not "/user" (note the lack of a trailing slash).
|
||||||
|
|
||||||
|
The unmatched suffix, including the leading slash ("/"), are placed into the
|
||||||
|
request context, which allows subsequent routing (e.g., a subrouter) to continue
|
||||||
|
from where this pattern left off. For instance, in the "/user/*" pattern from
|
||||||
|
above, a request for "/user/carl/photos" will consume the "/user" prefix,
|
||||||
|
leaving the path "/carl/photos" for subsequent patterns to handle. A subrouter
|
||||||
|
pattern for "/:name/photos" would match this remaining path segment, for
|
||||||
|
instance.
|
||||||
|
*/
|
||||||
|
package pat
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"regexp"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"goji.io/pattern"
|
||||||
|
)
|
||||||
|
|
||||||
|
type patNames []struct {
|
||||||
|
name pattern.Variable
|
||||||
|
idx int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p patNames) Len() int {
|
||||||
|
return len(p)
|
||||||
|
}
|
||||||
|
func (p patNames) Less(i, j int) bool {
|
||||||
|
return p[i].name < p[j].name
|
||||||
|
}
|
||||||
|
func (p patNames) Swap(i, j int) {
|
||||||
|
p[i], p[j] = p[j], p[i]
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Pattern implements goji.Pattern using a path-matching domain specific language.
|
||||||
|
See the package documentation for more information about the semantics of this
|
||||||
|
object.
|
||||||
|
*/
|
||||||
|
type Pattern struct {
|
||||||
|
raw string
|
||||||
|
methods map[string]struct{}
|
||||||
|
// These are parallel arrays of each pattern string (sans ":"), the
|
||||||
|
// breaks each expect afterwords (used to support e.g., "." dividers),
|
||||||
|
// and the string literals in between every pattern. There is always one
|
||||||
|
// more literal than pattern, and they are interleaved like this:
|
||||||
|
// <literal> <pattern> <literal> <pattern> <literal> etc...
|
||||||
|
pats patNames
|
||||||
|
breaks []byte
|
||||||
|
literals []string
|
||||||
|
wildcard bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// "Break characters" are characters that can end patterns. They are not allowed
|
||||||
|
// to appear in pattern names. "/" was chosen because it is the standard path
|
||||||
|
// separator, and "." was chosen because it often delimits file extensions. ";"
|
||||||
|
// and "," were chosen because Section 3.3 of RFC 3986 suggests their use.
|
||||||
|
const bc = "/.;,"
|
||||||
|
|
||||||
|
var patternRe = regexp.MustCompile(`[` + bc + `]:([^` + bc + `]+)`)
|
||||||
|
|
||||||
|
/*
|
||||||
|
New returns a new Pattern from the given Pat route. See the package
|
||||||
|
documentation for more information about what syntax is accepted by this
|
||||||
|
function.
|
||||||
|
*/
|
||||||
|
func New(pat string) *Pattern {
|
||||||
|
p := &Pattern{raw: pat}
|
||||||
|
|
||||||
|
if strings.HasSuffix(pat, "/*") {
|
||||||
|
pat = pat[:len(pat)-1]
|
||||||
|
p.wildcard = true
|
||||||
|
}
|
||||||
|
|
||||||
|
matches := patternRe.FindAllStringSubmatchIndex(pat, -1)
|
||||||
|
numMatches := len(matches)
|
||||||
|
p.pats = make(patNames, numMatches)
|
||||||
|
p.breaks = make([]byte, numMatches)
|
||||||
|
p.literals = make([]string, numMatches+1)
|
||||||
|
|
||||||
|
n := 0
|
||||||
|
for i, match := range matches {
|
||||||
|
a, b := match[2], match[3]
|
||||||
|
p.literals[i] = pat[n : a-1] // Need to leave off the colon
|
||||||
|
p.pats[i].name = pattern.Variable(pat[a:b])
|
||||||
|
p.pats[i].idx = i
|
||||||
|
if b == len(pat) {
|
||||||
|
p.breaks[i] = '/'
|
||||||
|
} else {
|
||||||
|
p.breaks[i] = pat[b]
|
||||||
|
}
|
||||||
|
n = b
|
||||||
|
}
|
||||||
|
p.literals[numMatches] = pat[n:]
|
||||||
|
|
||||||
|
sort.Sort(p.pats)
|
||||||
|
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
func newWithMethods(pat string, methods ...string) *Pattern {
|
||||||
|
p := New(pat)
|
||||||
|
|
||||||
|
methodSet := make(map[string]struct{}, len(methods))
|
||||||
|
for _, method := range methods {
|
||||||
|
methodSet[method] = struct{}{}
|
||||||
|
}
|
||||||
|
p.methods = methodSet
|
||||||
|
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Match runs the Pat pattern on the given request, returning a non-nil output
|
||||||
|
request if the input request matches the pattern.
|
||||||
|
|
||||||
|
This function satisfies goji.Pattern.
|
||||||
|
*/
|
||||||
|
func (p *Pattern) Match(r *http.Request) *http.Request {
|
||||||
|
if p.methods != nil {
|
||||||
|
if _, ok := p.methods[r.Method]; !ok {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check Path
|
||||||
|
ctx := r.Context()
|
||||||
|
path := pattern.Path(ctx)
|
||||||
|
var scratch []string
|
||||||
|
if p.wildcard {
|
||||||
|
scratch = make([]string, len(p.pats)+1)
|
||||||
|
} else if len(p.pats) > 0 {
|
||||||
|
scratch = make([]string, len(p.pats))
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := range p.pats {
|
||||||
|
sli := p.literals[i]
|
||||||
|
if !strings.HasPrefix(path, sli) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
path = path[len(sli):]
|
||||||
|
|
||||||
|
m := 0
|
||||||
|
bc := p.breaks[i]
|
||||||
|
for ; m < len(path); m++ {
|
||||||
|
if path[m] == bc || path[m] == '/' {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if m == 0 {
|
||||||
|
// Empty strings are not matches, otherwise routes like
|
||||||
|
// "/:foo" would match the path "/"
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
scratch[i] = path[:m]
|
||||||
|
path = path[m:]
|
||||||
|
}
|
||||||
|
|
||||||
|
// There's exactly one more literal than pat.
|
||||||
|
tail := p.literals[len(p.pats)]
|
||||||
|
if p.wildcard {
|
||||||
|
if !strings.HasPrefix(path, tail) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
scratch[len(p.pats)] = path[len(tail)-1:]
|
||||||
|
} else if path != tail {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := range p.pats {
|
||||||
|
var err error
|
||||||
|
scratch[i], err = unescape(scratch[i])
|
||||||
|
if err != nil {
|
||||||
|
// If we encounter an encoding error here, there's
|
||||||
|
// really not much we can do about it with our current
|
||||||
|
// API, and I'm not really interested in supporting
|
||||||
|
// clients that misencode URLs anyways.
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return r.WithContext(&match{ctx, p, scratch})
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
PathPrefix returns a string prefix that the Paths of all requests that this
|
||||||
|
Pattern accepts must contain.
|
||||||
|
|
||||||
|
This function satisfies goji's PathPrefix Pattern optimization.
|
||||||
|
*/
|
||||||
|
func (p *Pattern) PathPrefix() string {
|
||||||
|
return p.literals[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
HTTPMethods returns a set of HTTP methods that all requests that this
|
||||||
|
Pattern matches must be in, or nil if it's not possible to determine
|
||||||
|
which HTTP methods might be matched.
|
||||||
|
|
||||||
|
This function satisfies goji's HTTPMethods Pattern optimization.
|
||||||
|
*/
|
||||||
|
func (p *Pattern) HTTPMethods() map[string]struct{} {
|
||||||
|
return p.methods
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
String returns the pattern string that was used to create this Pattern.
|
||||||
|
*/
|
||||||
|
func (p *Pattern) String() string {
|
||||||
|
return p.raw
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Param returns the bound parameter with the given name. For instance, given the
|
||||||
|
route:
|
||||||
|
|
||||||
|
/user/:name
|
||||||
|
|
||||||
|
and the URL Path:
|
||||||
|
|
||||||
|
/user/carl
|
||||||
|
|
||||||
|
a call to Param(r, "name") would return the string "carl". It is the caller's
|
||||||
|
responsibility to ensure that the variable has been bound. Attempts to access
|
||||||
|
variables that have not been set (or which have been invalidly set) are
|
||||||
|
considered programmer errors and will trigger a panic.
|
||||||
|
*/
|
||||||
|
func Param(r *http.Request, name string) string {
|
||||||
|
return r.Context().Value(pattern.Variable(name)).(string)
|
||||||
|
}
|
||||||
+170
@@ -0,0 +1,170 @@
|
|||||||
|
package pat
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"goji.io/pattern"
|
||||||
|
)
|
||||||
|
|
||||||
|
func mustReq(method, path string) *http.Request {
|
||||||
|
req, err := http.NewRequest(method, path, nil)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
ctx := pattern.SetPath(context.Background(), req.URL.EscapedPath())
|
||||||
|
return req.WithContext(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
type PatTest struct {
|
||||||
|
pat string
|
||||||
|
req string
|
||||||
|
match bool
|
||||||
|
vars map[pattern.Variable]interface{}
|
||||||
|
path string
|
||||||
|
}
|
||||||
|
|
||||||
|
type pv map[pattern.Variable]interface{}
|
||||||
|
|
||||||
|
var PatTests = []PatTest{
|
||||||
|
{"/", "/", true, nil, ""},
|
||||||
|
{"/", "/hello", false, nil, ""},
|
||||||
|
{"/hello", "/hello", true, nil, ""},
|
||||||
|
|
||||||
|
{"/:name", "/carl", true, pv{"name": "carl"}, ""},
|
||||||
|
{"/:name", "/carl/", false, nil, ""},
|
||||||
|
{"/:name", "/", false, nil, ""},
|
||||||
|
{"/:name/", "/carl/", true, pv{"name": "carl"}, ""},
|
||||||
|
{"/:name/", "/carl/no", false, nil, ""},
|
||||||
|
{"/:name/hi", "/carl/hi", true, pv{"name": "carl"}, ""},
|
||||||
|
{"/:name/:color", "/carl/red", true, pv{"name": "carl", "color": "red"}, ""},
|
||||||
|
{"/:name/:color", "/carl/", false, nil, ""},
|
||||||
|
{"/:name/:color", "/carl.red", false, nil, ""},
|
||||||
|
|
||||||
|
{"/:file.:ext", "/data.json", true, pv{"file": "data", "ext": "json"}, ""},
|
||||||
|
{"/:file.:ext", "/data.tar.gz", true, pv{"file": "data", "ext": "tar.gz"}, ""},
|
||||||
|
{"/:file.:ext", "/data", false, nil, ""},
|
||||||
|
{"/:file.:ext", "/data.", false, nil, ""},
|
||||||
|
{"/:file.:ext", "/.gitconfig", false, nil, ""},
|
||||||
|
{"/:file.:ext", "/data.json/", false, nil, ""},
|
||||||
|
{"/:file.:ext", "/data/json", false, nil, ""},
|
||||||
|
{"/:file.:ext", "/data;json", false, nil, ""},
|
||||||
|
{"/hello.:ext", "/hello.json", true, pv{"ext": "json"}, ""},
|
||||||
|
{"/:file.json", "/hello.json", true, pv{"file": "hello"}, ""},
|
||||||
|
{"/:file.json", "/hello.world.json", false, nil, ""},
|
||||||
|
{"/file;:version", "/file;1", true, pv{"version": "1"}, ""},
|
||||||
|
{"/file;:version", "/file,1", false, nil, ""},
|
||||||
|
{"/file,:version", "/file,1", true, pv{"version": "1"}, ""},
|
||||||
|
{"/file,:version", "/file;1", false, nil, ""},
|
||||||
|
|
||||||
|
{"/*", "/", true, nil, "/"},
|
||||||
|
{"/*", "/hello", true, nil, "/hello"},
|
||||||
|
{"/users/*", "/", false, nil, ""},
|
||||||
|
{"/users/*", "/users", false, nil, ""},
|
||||||
|
{"/users/*", "/users/", true, nil, "/"},
|
||||||
|
{"/users/*", "/users/carl", true, nil, "/carl"},
|
||||||
|
{"/users/*", "/profile/carl", false, nil, ""},
|
||||||
|
{"/:name/*", "/carl", false, nil, ""},
|
||||||
|
{"/:name/*", "/carl/", true, pv{"name": "carl"}, "/"},
|
||||||
|
{"/:name/*", "/carl/photos", true, pv{"name": "carl"}, "/photos"},
|
||||||
|
{"/:name/*", "/carl/photos%2f2015", true, pv{"name": "carl"}, "/photos%2f2015"},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPat(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, test := range PatTests {
|
||||||
|
pat := New(test.pat)
|
||||||
|
|
||||||
|
if str := pat.String(); str != test.pat {
|
||||||
|
t.Errorf("[%q %q] String()=%q, expected=%q", test.pat, test.req, str, test.pat)
|
||||||
|
}
|
||||||
|
|
||||||
|
req := pat.Match(mustReq("GET", test.req))
|
||||||
|
if (req != nil) != test.match {
|
||||||
|
t.Errorf("[%q %q] match=%v, expected=%v", test.pat, test.req, req != nil, test.match)
|
||||||
|
}
|
||||||
|
if req == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := req.Context()
|
||||||
|
if path := pattern.Path(ctx); path != test.path {
|
||||||
|
t.Errorf("[%q %q] path=%q, expected=%q", test.pat, test.req, path, test.path)
|
||||||
|
}
|
||||||
|
|
||||||
|
vars := ctx.Value(pattern.AllVariables)
|
||||||
|
if (vars != nil) != (test.vars != nil) {
|
||||||
|
t.Errorf("[%q %q] vars=%#v, expected=%#v", test.pat, test.req, vars, test.vars)
|
||||||
|
}
|
||||||
|
if vars == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if tvars := vars.(map[pattern.Variable]interface{}); !reflect.DeepEqual(tvars, test.vars) {
|
||||||
|
t.Errorf("[%q %q] vars=%v, expected=%v", test.pat, test.req, tvars, test.vars)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBadPathEncoding(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// This one is hard to fit into the table-driven test above since Go
|
||||||
|
// refuses to have anything to do with poorly encoded URLs.
|
||||||
|
ctx := pattern.SetPath(context.Background(), "/%nope")
|
||||||
|
r, _ := http.NewRequest("GET", "/", nil)
|
||||||
|
if New("/:name").Match(r.WithContext(ctx)) != nil {
|
||||||
|
t.Error("unexpected match")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var PathPrefixTests = []struct {
|
||||||
|
pat string
|
||||||
|
prefix string
|
||||||
|
}{
|
||||||
|
{"/", "/"},
|
||||||
|
{"/hello/:world", "/hello/"},
|
||||||
|
{"/users/:name/profile", "/users/"},
|
||||||
|
{"/users/*", "/users/"},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPathPrefix(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, test := range PathPrefixTests {
|
||||||
|
pat := New(test.pat)
|
||||||
|
if prefix := pat.PathPrefix(); prefix != test.prefix {
|
||||||
|
t.Errorf("%q.PathPrefix() = %q, expected %q", test.pat, prefix, test.prefix)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHTTPMethods(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
pat := New("/foo")
|
||||||
|
if methods := pat.HTTPMethods(); methods != nil {
|
||||||
|
t.Errorf("expected nil with no methods, got %v", methods)
|
||||||
|
}
|
||||||
|
|
||||||
|
pat = Get("/boo")
|
||||||
|
expect := map[string]struct{}{"GET": {}, "HEAD": {}}
|
||||||
|
if methods := pat.HTTPMethods(); !reflect.DeepEqual(expect, methods) {
|
||||||
|
t.Errorf("methods=%v, expected %v", methods, expect)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParam(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
pat := New("/hello/:name")
|
||||||
|
req := pat.Match(mustReq("GET", "/hello/carl"))
|
||||||
|
if req == nil {
|
||||||
|
t.Fatal("expected a match")
|
||||||
|
}
|
||||||
|
if name := Param(req, "name"); name != "carl" {
|
||||||
|
t.Errorf("name=%q, expected %q", name, "carl")
|
||||||
|
}
|
||||||
|
}
|
||||||
+70
@@ -0,0 +1,70 @@
|
|||||||
|
package pat
|
||||||
|
|
||||||
|
import "net/url"
|
||||||
|
|
||||||
|
// Stolen (with modifications) from net/url in the Go stdlib
|
||||||
|
|
||||||
|
func ishex(c byte) bool {
|
||||||
|
switch {
|
||||||
|
case '0' <= c && c <= '9':
|
||||||
|
return true
|
||||||
|
case 'a' <= c && c <= 'f':
|
||||||
|
return true
|
||||||
|
case 'A' <= c && c <= 'F':
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func unhex(c byte) byte {
|
||||||
|
switch {
|
||||||
|
case '0' <= c && c <= '9':
|
||||||
|
return c - '0'
|
||||||
|
case 'a' <= c && c <= 'f':
|
||||||
|
return c - 'a' + 10
|
||||||
|
case 'A' <= c && c <= 'F':
|
||||||
|
return c - 'A' + 10
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
func unescape(s string) (string, error) {
|
||||||
|
// Count %, check that they're well-formed.
|
||||||
|
n := 0
|
||||||
|
for i := 0; i < len(s); {
|
||||||
|
switch s[i] {
|
||||||
|
case '%':
|
||||||
|
n++
|
||||||
|
if i+2 >= len(s) || !ishex(s[i+1]) || !ishex(s[i+2]) {
|
||||||
|
s = s[i:]
|
||||||
|
if len(s) > 3 {
|
||||||
|
s = s[:3]
|
||||||
|
}
|
||||||
|
return "", url.EscapeError(s)
|
||||||
|
}
|
||||||
|
i += 3
|
||||||
|
default:
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if n == 0 {
|
||||||
|
return s, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
t := make([]byte, len(s)-2*n)
|
||||||
|
j := 0
|
||||||
|
for i := 0; i < len(s); {
|
||||||
|
switch s[i] {
|
||||||
|
case '%':
|
||||||
|
t[j] = unhex(s[i+1])<<4 | unhex(s[i+2])
|
||||||
|
j++
|
||||||
|
i += 3
|
||||||
|
default:
|
||||||
|
t[j] = s[i]
|
||||||
|
j++
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return string(t), nil
|
||||||
|
}
|
||||||
+55
@@ -0,0 +1,55 @@
|
|||||||
|
package pat
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/url"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
var HexTexts = []struct {
|
||||||
|
input byte
|
||||||
|
ishex bool
|
||||||
|
unhex byte
|
||||||
|
}{
|
||||||
|
{'0', true, 0},
|
||||||
|
{'4', true, 4},
|
||||||
|
{'a', true, 10},
|
||||||
|
{'F', true, 15},
|
||||||
|
{'h', false, 0},
|
||||||
|
{'^', false, 0},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHex(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, test := range HexTexts {
|
||||||
|
if actual := ishex(test.input); actual != test.ishex {
|
||||||
|
t.Errorf("ishex(%v) == %v, expected %v", test.input, actual, test.ishex)
|
||||||
|
}
|
||||||
|
if actual := unhex(test.input); actual != test.unhex {
|
||||||
|
t.Errorf("unhex(%v) == %v, expected %v", test.input, actual, test.unhex)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var UnescapeTests = []struct {
|
||||||
|
input string
|
||||||
|
err error
|
||||||
|
output string
|
||||||
|
}{
|
||||||
|
{"hello", nil, "hello"},
|
||||||
|
{"file%20one%26two", nil, "file one&two"},
|
||||||
|
{"one/two%2fthree", nil, "one/two/three"},
|
||||||
|
{"this%20is%0not%valid", url.EscapeError("%0n"), ""},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnescape(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, test := range UnescapeTests {
|
||||||
|
if actual, err := unescape(test.input); err != test.err {
|
||||||
|
t.Errorf("unescape(%q) had err %v, expected %q", test.input, err, test.err)
|
||||||
|
} else if actual != test.output {
|
||||||
|
t.Errorf("unescape(%q) = %q, expected %q)", test.input, actual, test.output)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+13
@@ -0,0 +1,13 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
// httpMethods is an internal interface for the HTTPMethods pattern
|
||||||
|
// optimization. See the documentation on Pattern for more.
|
||||||
|
type httpMethods interface {
|
||||||
|
HTTPMethods() map[string]struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// pathPrefix is an internal interface for the PathPrefix pattern optimization.
|
||||||
|
// See the documentation on Pattern for more.
|
||||||
|
type pathPrefix interface {
|
||||||
|
PathPrefix() string
|
||||||
|
}
|
||||||
+67
@@ -0,0 +1,67 @@
|
|||||||
|
/*
|
||||||
|
Package pattern contains utilities for Goji Pattern authors.
|
||||||
|
|
||||||
|
Goji users should not import this package. Instead, use the utilities provided
|
||||||
|
by your Pattern package. If you are looking for an implementation of Pattern,
|
||||||
|
try Goji's pat subpackage, which contains a simple domain specific language for
|
||||||
|
specifying routes.
|
||||||
|
|
||||||
|
For Pattern authors, use of this subpackage is entirely optional. Nevertheless,
|
||||||
|
authors who wish to take advantage of Goji's PathPrefix optimization or who wish
|
||||||
|
to standardize on a few common interfaces may find this package useful.
|
||||||
|
*/
|
||||||
|
package pattern
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
/*
|
||||||
|
Variable is a standard type for the names of Pattern-bound variables, e.g.
|
||||||
|
variables extracted from the URL. Pass the name of a variable, cast to this
|
||||||
|
type, to context.Context.Value to retrieve the value bound to that name.
|
||||||
|
*/
|
||||||
|
type Variable string
|
||||||
|
|
||||||
|
type allVariables struct{}
|
||||||
|
|
||||||
|
/*
|
||||||
|
AllVariables is a standard value which, when passed to context.Context.Value,
|
||||||
|
returns all variable bindings present in the context, with bindings in newer
|
||||||
|
contexts overriding values deeper in the stack. The concrete type
|
||||||
|
|
||||||
|
map[Variable]interface{}
|
||||||
|
|
||||||
|
is used for this purpose. If no variables are bound, nil should be returned
|
||||||
|
instead of an empty map.
|
||||||
|
*/
|
||||||
|
var AllVariables = allVariables{}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Path returns the path that the Goji router uses to perform the PathPrefix
|
||||||
|
optimization. While this function does not distinguish between the absence of a
|
||||||
|
path and an empty path, Goji will automatically extract a path from the request
|
||||||
|
if none is present.
|
||||||
|
|
||||||
|
By convention, paths are stored in their escaped form (i.e., the value returned
|
||||||
|
by net/url.URL.EscapedPath, and not URL.Path) to ensure that Patterns have as
|
||||||
|
much discretion as possible (e.g., to behave differently for '/' and '%2f').
|
||||||
|
*/
|
||||||
|
func Path(ctx context.Context) string {
|
||||||
|
pi := ctx.Value(internal.Path)
|
||||||
|
if pi == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return pi.(string)
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
SetPath returns a new context in which the given path is used by the Goji Router
|
||||||
|
when performing the PathPrefix optimization. See Path for more information about
|
||||||
|
the intended semantics of this path.
|
||||||
|
*/
|
||||||
|
func SetPath(ctx context.Context, path string) context.Context {
|
||||||
|
return context.WithValue(ctx, internal.Path, path)
|
||||||
|
}
|
||||||
+38
@@ -0,0 +1,38 @@
|
|||||||
|
package pattern
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
type boolPattern bool
|
||||||
|
|
||||||
|
func (b boolPattern) Match(ctx context.Context, r *http.Request) context.Context {
|
||||||
|
if b {
|
||||||
|
return ctx
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type prefixPattern string
|
||||||
|
|
||||||
|
func (p prefixPattern) Match(ctx context.Context, r *http.Request) context.Context {
|
||||||
|
return ctx
|
||||||
|
}
|
||||||
|
func (p prefixPattern) PathPrefix() string {
|
||||||
|
return string(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPathRoundTrip(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ctx := SetPath(context.Background(), "hi")
|
||||||
|
if path := Path(ctx); path != "hi" {
|
||||||
|
t.Errorf("expected hi, got %q", path)
|
||||||
|
}
|
||||||
|
|
||||||
|
if path := Path(context.Background()); path != "" {
|
||||||
|
t.Errorf("expected empty path, got %q", path)
|
||||||
|
}
|
||||||
|
}
|
||||||
+27
@@ -0,0 +1,27 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
type match struct {
|
||||||
|
context.Context
|
||||||
|
p Pattern
|
||||||
|
h http.Handler
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m match) Value(key interface{}) interface{} {
|
||||||
|
switch key {
|
||||||
|
case internal.Pattern:
|
||||||
|
return m.p
|
||||||
|
case internal.Handler:
|
||||||
|
return m.h
|
||||||
|
default:
|
||||||
|
return m.Context.Value(key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ context.Context = match{}
|
||||||
+33
@@ -0,0 +1,33 @@
|
|||||||
|
// +build goji_router_simple
|
||||||
|
|
||||||
|
package goji
|
||||||
|
|
||||||
|
import "net/http"
|
||||||
|
|
||||||
|
/*
|
||||||
|
This is the simplest correct router implementation for Goji.
|
||||||
|
*/
|
||||||
|
|
||||||
|
type router []route
|
||||||
|
|
||||||
|
type route struct {
|
||||||
|
Pattern
|
||||||
|
http.Handler
|
||||||
|
}
|
||||||
|
|
||||||
|
func (rt *router) add(p Pattern, h http.Handler) {
|
||||||
|
*rt = append(*rt, route{p, h})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (rt *router) route(r *http.Request) *http.Request {
|
||||||
|
for _, route := range *rt {
|
||||||
|
if r2 := route.Match(r); r2 != nil {
|
||||||
|
return r2.WithContext(&match{
|
||||||
|
Context: r2.Context(),
|
||||||
|
p: route.Pattern,
|
||||||
|
h: route.Handler,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return r.WithContext(&match{Context: r.Context()})
|
||||||
|
}
|
||||||
+153
@@ -0,0 +1,153 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
"goji.io/pattern"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestNoMatch(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var rt router
|
||||||
|
rt.add(boolPattern(false), http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
t.Fatal("did not expect handler to be called")
|
||||||
|
}))
|
||||||
|
_, r := wr()
|
||||||
|
ctx := context.Background()
|
||||||
|
ctx = context.WithValue(ctx, internal.Pattern, boolPattern(true))
|
||||||
|
ctx = context.WithValue(ctx, internal.Pattern, boolPattern(true))
|
||||||
|
ctx = context.WithValue(ctx, pattern.Variable("answer"), 42)
|
||||||
|
ctx = context.WithValue(ctx, internal.Path, "/")
|
||||||
|
|
||||||
|
r = r.WithContext(ctx)
|
||||||
|
r = rt.route(r)
|
||||||
|
ctx = r.Context()
|
||||||
|
|
||||||
|
if p := ctx.Value(internal.Pattern); p != nil {
|
||||||
|
t.Errorf("unexpected pattern %v", p)
|
||||||
|
}
|
||||||
|
if h := ctx.Value(internal.Handler); h != nil {
|
||||||
|
t.Errorf("unexpected handler %v", h)
|
||||||
|
}
|
||||||
|
if h := ctx.Value(pattern.Variable("answer")); h != 42 {
|
||||||
|
t.Errorf("context didn't work: got %v, wanted %v", h, 42)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
These are meant to be end-to-end torture tests of Goji's routing semantics. We
|
||||||
|
generate a list of patterns that can be turned off incrementally with a global
|
||||||
|
"high water mark." We then run a sequence of requests through the router N
|
||||||
|
times, incrementing the mark each time. The net effect is that we can compile
|
||||||
|
the entire set of routes Goji would attempt for every request, ensuring that the
|
||||||
|
router is picking routes in the correct order.
|
||||||
|
*/
|
||||||
|
|
||||||
|
var TestRoutes = []testPattern{
|
||||||
|
testPattern{methods: nil, prefix: "/"},
|
||||||
|
testPattern{methods: nil, prefix: "/a"},
|
||||||
|
testPattern{methods: []string{"POST", "PUT"}, prefix: "/a"},
|
||||||
|
testPattern{methods: []string{"GET", "POST"}, prefix: "/a"},
|
||||||
|
testPattern{methods: []string{"GET"}, prefix: "/b"},
|
||||||
|
testPattern{methods: nil, prefix: "/ab"},
|
||||||
|
testPattern{methods: []string{"POST", "PUT"}, prefix: "/"},
|
||||||
|
testPattern{methods: nil, prefix: "/ba"},
|
||||||
|
testPattern{methods: nil, prefix: "/"},
|
||||||
|
testPattern{methods: []string{}, prefix: "/"},
|
||||||
|
testPattern{methods: nil, prefix: "/carl"},
|
||||||
|
testPattern{methods: []string{"PUT"}, prefix: "/car"},
|
||||||
|
testPattern{methods: nil, prefix: "/cake"},
|
||||||
|
testPattern{methods: nil, prefix: "/car"},
|
||||||
|
testPattern{methods: []string{"GET"}, prefix: "/c"},
|
||||||
|
testPattern{methods: []string{"POST"}, prefix: "/"},
|
||||||
|
testPattern{methods: []string{"PUT"}, prefix: "/"},
|
||||||
|
}
|
||||||
|
|
||||||
|
var RouterTests = []struct {
|
||||||
|
method, path string
|
||||||
|
results []int
|
||||||
|
}{
|
||||||
|
{"GET", "/", []int{0, 8, 8, 8, 8, 8, 8, 8, 8, -1, -1, -1, -1, -1, -1, -1, -1}},
|
||||||
|
{"POST", "/", []int{0, 6, 6, 6, 6, 6, 6, 8, 8, 15, 15, 15, 15, 15, 15, 15, -1}},
|
||||||
|
{"PUT", "/", []int{0, 6, 6, 6, 6, 6, 6, 8, 8, 16, 16, 16, 16, 16, 16, 16, 16}},
|
||||||
|
{"HEAD", "/", []int{0, 8, 8, 8, 8, 8, 8, 8, 8, -1, -1, -1, -1, -1, -1, -1, -1}},
|
||||||
|
{"GET", "/a", []int{0, 1, 3, 3, 8, 8, 8, 8, 8, -1, -1, -1, -1, -1, -1, -1, -1}},
|
||||||
|
{"POST", "/a", []int{0, 1, 2, 3, 6, 6, 6, 8, 8, 15, 15, 15, 15, 15, 15, 15, -1}},
|
||||||
|
{"PUT", "/a", []int{0, 1, 2, 6, 6, 6, 6, 8, 8, 16, 16, 16, 16, 16, 16, 16, 16}},
|
||||||
|
{"HEAD", "/a", []int{0, 1, 8, 8, 8, 8, 8, 8, 8, -1, -1, -1, -1, -1, -1, -1, -1}},
|
||||||
|
{"GET", "/b", []int{0, 4, 4, 4, 4, 8, 8, 8, 8, -1, -1, -1, -1, -1, -1, -1, -1}},
|
||||||
|
{"POST", "/b", []int{0, 6, 6, 6, 6, 6, 6, 8, 8, 15, 15, 15, 15, 15, 15, 15, -1}},
|
||||||
|
{"GET", "/ba", []int{0, 4, 4, 4, 4, 7, 7, 7, 8, -1, -1, -1, -1, -1, -1, -1, -1}},
|
||||||
|
{"GET", "/c", []int{0, 8, 8, 8, 8, 8, 8, 8, 8, 14, 14, 14, 14, 14, 14, -1, -1}},
|
||||||
|
{"POST", "/c", []int{0, 6, 6, 6, 6, 6, 6, 8, 8, 15, 15, 15, 15, 15, 15, 15, -1}},
|
||||||
|
{"GET", "/ab", []int{0, 1, 3, 3, 5, 5, 8, 8, 8, -1, -1, -1, -1, -1, -1, -1, -1}},
|
||||||
|
{"POST", "/ab", []int{0, 1, 2, 3, 5, 5, 6, 8, 8, 15, 15, 15, 15, 15, 15, 15, -1}},
|
||||||
|
{"GET", "/carl", []int{0, 8, 8, 8, 8, 8, 8, 8, 8, 10, 10, 13, 13, 13, 14, -1, -1}},
|
||||||
|
{"POST", "/carl", []int{0, 6, 6, 6, 6, 6, 6, 8, 8, 10, 10, 13, 13, 13, 15, 15, -1}},
|
||||||
|
{"HEAD", "/carl", []int{0, 8, 8, 8, 8, 8, 8, 8, 8, 10, 10, 13, 13, 13, -1, -1, -1}},
|
||||||
|
{"PUT", "/carl", []int{0, 6, 6, 6, 6, 6, 6, 8, 8, 10, 10, 11, 13, 13, 16, 16, 16}},
|
||||||
|
{"GET", "/cake", []int{0, 8, 8, 8, 8, 8, 8, 8, 8, 12, 12, 12, 12, 14, 14, -1, -1}},
|
||||||
|
{"PUT", "/cake", []int{0, 6, 6, 6, 6, 6, 6, 8, 8, 12, 12, 12, 12, 16, 16, 16, 16}},
|
||||||
|
{"OHAI", "/carl", []int{0, 8, 8, 8, 8, 8, 8, 8, 8, 10, 10, 13, 13, 13, -1, -1, -1}},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRouter(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var rt router
|
||||||
|
mark := new(int)
|
||||||
|
for i, p := range TestRoutes {
|
||||||
|
i := i
|
||||||
|
p.index = i
|
||||||
|
p.mark = mark
|
||||||
|
rt.add(p, intHandler(i))
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, test := range RouterTests {
|
||||||
|
r, err := http.NewRequest(test.method, test.path, nil)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
ctx := context.WithValue(context.Background(), internal.Path, test.path)
|
||||||
|
r = r.WithContext(ctx)
|
||||||
|
|
||||||
|
var out []int
|
||||||
|
for *mark = 0; *mark < len(TestRoutes); *mark++ {
|
||||||
|
r := rt.route(r)
|
||||||
|
ctx := r.Context()
|
||||||
|
if h := ctx.Value(internal.Handler); h != nil {
|
||||||
|
out = append(out, int(h.(intHandler)))
|
||||||
|
} else {
|
||||||
|
out = append(out, -1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(out, test.results) {
|
||||||
|
t.Errorf("[%d] expected %v got %v", i, test.results, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type contextPattern struct{}
|
||||||
|
|
||||||
|
func (contextPattern) Match(r *http.Request) *http.Request {
|
||||||
|
return r.WithContext(context.WithValue(r.Context(), pattern.Variable("hello"), "world"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRouterContextPropagation(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var rt router
|
||||||
|
rt.add(contextPattern{}, intHandler(0))
|
||||||
|
_, r := wr()
|
||||||
|
r = r.WithContext(context.WithValue(r.Context(), internal.Path, "/"))
|
||||||
|
r2 := rt.route(r)
|
||||||
|
ctx := r2.Context()
|
||||||
|
if hello := ctx.Value(pattern.Variable("hello")).(string); hello != "world" {
|
||||||
|
t.Fatalf("routed request didn't include correct key from pattern: %q", hello)
|
||||||
|
}
|
||||||
|
}
|
||||||
+176
@@ -0,0 +1,176 @@
|
|||||||
|
// +build !goji_router_simple
|
||||||
|
|
||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
type router struct {
|
||||||
|
routes []route
|
||||||
|
methods map[string]*trieNode
|
||||||
|
wildcard trieNode
|
||||||
|
}
|
||||||
|
|
||||||
|
type route struct {
|
||||||
|
Pattern
|
||||||
|
http.Handler
|
||||||
|
}
|
||||||
|
|
||||||
|
type child struct {
|
||||||
|
prefix string
|
||||||
|
node *trieNode
|
||||||
|
}
|
||||||
|
|
||||||
|
type trieNode struct {
|
||||||
|
routes []int
|
||||||
|
children []child
|
||||||
|
}
|
||||||
|
|
||||||
|
func (rt *router) add(p Pattern, h http.Handler) {
|
||||||
|
i := len(rt.routes)
|
||||||
|
rt.routes = append(rt.routes, route{p, h})
|
||||||
|
|
||||||
|
var prefix string
|
||||||
|
if pp, ok := p.(pathPrefix); ok {
|
||||||
|
prefix = pp.PathPrefix()
|
||||||
|
}
|
||||||
|
|
||||||
|
var methods map[string]struct{}
|
||||||
|
if hm, ok := p.(httpMethods); ok {
|
||||||
|
methods = hm.HTTPMethods()
|
||||||
|
}
|
||||||
|
if methods == nil {
|
||||||
|
rt.wildcard.add(prefix, i)
|
||||||
|
for _, sub := range rt.methods {
|
||||||
|
sub.add(prefix, i)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if rt.methods == nil {
|
||||||
|
rt.methods = make(map[string]*trieNode)
|
||||||
|
}
|
||||||
|
|
||||||
|
for method := range methods {
|
||||||
|
if _, ok := rt.methods[method]; !ok {
|
||||||
|
rt.methods[method] = rt.wildcard.clone()
|
||||||
|
}
|
||||||
|
rt.methods[method].add(prefix, i)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (rt *router) route(r *http.Request) *http.Request {
|
||||||
|
tn := &rt.wildcard
|
||||||
|
if tn2, ok := rt.methods[r.Method]; ok {
|
||||||
|
tn = tn2
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := r.Context()
|
||||||
|
path := ctx.Value(internal.Path).(string)
|
||||||
|
for path != "" {
|
||||||
|
i := sort.Search(len(tn.children), func(i int) bool {
|
||||||
|
return path[0] <= tn.children[i].prefix[0]
|
||||||
|
})
|
||||||
|
if i == len(tn.children) || !strings.HasPrefix(path, tn.children[i].prefix) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
path = path[len(tn.children[i].prefix):]
|
||||||
|
tn = tn.children[i].node
|
||||||
|
}
|
||||||
|
for _, i := range tn.routes {
|
||||||
|
if r2 := rt.routes[i].Match(r); r2 != nil {
|
||||||
|
return r2.WithContext(&match{
|
||||||
|
Context: r2.Context(),
|
||||||
|
p: rt.routes[i].Pattern,
|
||||||
|
h: rt.routes[i].Handler,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return r.WithContext(&match{Context: ctx})
|
||||||
|
}
|
||||||
|
|
||||||
|
// We can be a teensy bit more efficient here: we're maintaining a sorted list,
|
||||||
|
// so we know exactly where to insert the new element. But since that involves
|
||||||
|
// more bookkeeping and makes the code messier, let's cross that bridge when we
|
||||||
|
// come to it.
|
||||||
|
type byPrefix []child
|
||||||
|
|
||||||
|
func (b byPrefix) Len() int {
|
||||||
|
return len(b)
|
||||||
|
}
|
||||||
|
func (b byPrefix) Less(i, j int) bool {
|
||||||
|
return b[i].prefix < b[j].prefix
|
||||||
|
}
|
||||||
|
func (b byPrefix) Swap(i, j int) {
|
||||||
|
b[i], b[j] = b[j], b[i]
|
||||||
|
}
|
||||||
|
|
||||||
|
func longestPrefix(a, b string) string {
|
||||||
|
mlen := len(a)
|
||||||
|
if len(b) < mlen {
|
||||||
|
mlen = len(b)
|
||||||
|
}
|
||||||
|
for i := 0; i < mlen; i++ {
|
||||||
|
if a[i] != b[i] {
|
||||||
|
return a[:i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return a[:mlen]
|
||||||
|
}
|
||||||
|
|
||||||
|
func (tn *trieNode) add(prefix string, idx int) {
|
||||||
|
if len(prefix) == 0 {
|
||||||
|
tn.routes = append(tn.routes, idx)
|
||||||
|
for i := range tn.children {
|
||||||
|
tn.children[i].node.add(prefix, idx)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
ch := prefix[0]
|
||||||
|
i := sort.Search(len(tn.children), func(i int) bool {
|
||||||
|
return ch <= tn.children[i].prefix[0]
|
||||||
|
})
|
||||||
|
|
||||||
|
if i == len(tn.children) || ch != tn.children[i].prefix[0] {
|
||||||
|
routes := append([]int(nil), tn.routes...)
|
||||||
|
tn.children = append(tn.children, child{
|
||||||
|
prefix: prefix,
|
||||||
|
node: &trieNode{routes: append(routes, idx)},
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
lp := longestPrefix(prefix, tn.children[i].prefix)
|
||||||
|
|
||||||
|
if tn.children[i].prefix == lp {
|
||||||
|
tn.children[i].node.add(prefix[len(lp):], idx)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
split := new(trieNode)
|
||||||
|
split.children = []child{
|
||||||
|
{tn.children[i].prefix[len(lp):], tn.children[i].node},
|
||||||
|
}
|
||||||
|
split.routes = append([]int(nil), tn.routes...)
|
||||||
|
split.add(prefix[len(lp):], idx)
|
||||||
|
|
||||||
|
tn.children[i].prefix = lp
|
||||||
|
tn.children[i].node = split
|
||||||
|
}
|
||||||
|
|
||||||
|
sort.Sort(byPrefix(tn.children))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (tn *trieNode) clone() *trieNode {
|
||||||
|
clone := new(trieNode)
|
||||||
|
clone.routes = append(clone.routes, tn.routes...)
|
||||||
|
clone.children = append(clone.children, tn.children...)
|
||||||
|
for i := range clone.children {
|
||||||
|
clone.children[i].node = tn.children[i].node.clone()
|
||||||
|
}
|
||||||
|
return clone
|
||||||
|
}
|
||||||
+71
@@ -0,0 +1,71 @@
|
|||||||
|
package goji
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"goji.io/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
type boolPattern bool
|
||||||
|
|
||||||
|
func (b boolPattern) Match(r *http.Request) *http.Request {
|
||||||
|
if b {
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type testPattern struct {
|
||||||
|
index int
|
||||||
|
mark *int
|
||||||
|
methods []string
|
||||||
|
prefix string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t testPattern) Match(r *http.Request) *http.Request {
|
||||||
|
ctx := r.Context()
|
||||||
|
if t.index < *t.mark {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
path := ctx.Value(internal.Path).(string)
|
||||||
|
if !strings.HasPrefix(path, t.prefix) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if t.methods != nil {
|
||||||
|
if _, ok := t.HTTPMethods()[r.Method]; !ok {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t testPattern) PathPrefix() string {
|
||||||
|
return t.prefix
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t testPattern) HTTPMethods() map[string]struct{} {
|
||||||
|
if t.methods == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
m := make(map[string]struct{})
|
||||||
|
for _, method := range t.methods {
|
||||||
|
m[method] = struct{}{}
|
||||||
|
}
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
type intHandler int
|
||||||
|
|
||||||
|
func (i intHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||||
|
}
|
||||||
|
|
||||||
|
func wr() (*httptest.ResponseRecorder, *http.Request) {
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
r, err := http.NewRequest("GET", "/", nil)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
return w, r
|
||||||
|
}
|
||||||
Generated
+10
@@ -0,0 +1,10 @@
|
|||||||
|
# Treat all files in this repo as binary, with no git magic updating
|
||||||
|
# line endings. Windows users contributing to Go will need to use a
|
||||||
|
# modern version of git and editors capable of LF line endings.
|
||||||
|
#
|
||||||
|
# We'll prevent accidental CRLF line endings from entering the repo
|
||||||
|
# via the git-review gofmt checks.
|
||||||
|
#
|
||||||
|
# See golang.org/issue/9281
|
||||||
|
|
||||||
|
* -text
|
||||||
Generated
+2
@@ -0,0 +1,2 @@
|
|||||||
|
# Add no patterns to .hgignore except for files generated by the build.
|
||||||
|
last-change
|
||||||
+3
@@ -0,0 +1,3 @@
|
|||||||
|
# This source code refers to The Go Authors for copyright purposes.
|
||||||
|
# The master list of authors is in the main Go distribution,
|
||||||
|
# visible at http://tip.golang.org/AUTHORS.
|
||||||
+31
@@ -0,0 +1,31 @@
|
|||||||
|
# Contributing to Go
|
||||||
|
|
||||||
|
Go is an open source project.
|
||||||
|
|
||||||
|
It is the work of hundreds of contributors. We appreciate your help!
|
||||||
|
|
||||||
|
|
||||||
|
## Filing issues
|
||||||
|
|
||||||
|
When [filing an issue](https://golang.org/issue/new), make sure to answer these five questions:
|
||||||
|
|
||||||
|
1. What version of Go are you using (`go version`)?
|
||||||
|
2. What operating system and processor architecture are you using?
|
||||||
|
3. What did you do?
|
||||||
|
4. What did you expect to see?
|
||||||
|
5. What did you see instead?
|
||||||
|
|
||||||
|
General questions should go to the [golang-nuts mailing list](https://groups.google.com/group/golang-nuts) instead of the issue tracker.
|
||||||
|
The gophers there will answer or ask you to file an issue if you've tripped over a bug.
|
||||||
|
|
||||||
|
## Contributing code
|
||||||
|
|
||||||
|
Please read the [Contribution Guidelines](https://golang.org/doc/contribute.html)
|
||||||
|
before sending patches.
|
||||||
|
|
||||||
|
**We do not accept GitHub pull requests**
|
||||||
|
(we use [Gerrit](https://code.google.com/p/gerrit/) instead for code review).
|
||||||
|
|
||||||
|
Unless otherwise noted, the Go source files are distributed under
|
||||||
|
the BSD-style license found in the LICENSE file.
|
||||||
|
|
||||||
+3
@@ -0,0 +1,3 @@
|
|||||||
|
# This source code was written by the Go contributors.
|
||||||
|
# The master list of contributors is in the main Go distribution,
|
||||||
|
# visible at http://tip.golang.org/CONTRIBUTORS.
|
||||||
+27
@@ -0,0 +1,27 @@
|
|||||||
|
Copyright (c) 2009 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above
|
||||||
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
* Neither the name of Google Inc. nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
+22
@@ -0,0 +1,22 @@
|
|||||||
|
Additional IP Rights Grant (Patents)
|
||||||
|
|
||||||
|
"This implementation" means the copyrightable works distributed by
|
||||||
|
Google as part of the Go project.
|
||||||
|
|
||||||
|
Google hereby grants to You a perpetual, worldwide, non-exclusive,
|
||||||
|
no-charge, royalty-free, irrevocable (except as stated in this section)
|
||||||
|
patent license to make, have made, use, offer to sell, sell, import,
|
||||||
|
transfer and otherwise run, modify and propagate the contents of this
|
||||||
|
implementation of Go, where such license applies only to those patent
|
||||||
|
claims, both currently owned or controlled by Google and acquired in
|
||||||
|
the future, licensable by Google that are necessarily infringed by this
|
||||||
|
implementation of Go. This grant does not include claims that would be
|
||||||
|
infringed only as a consequence of further modification of this
|
||||||
|
implementation. If you or your agent or exclusive licensee institute or
|
||||||
|
order or agree to the institution of patent litigation against any
|
||||||
|
entity (including a cross-claim or counterclaim in a lawsuit) alleging
|
||||||
|
that this implementation of Go or any code incorporated within this
|
||||||
|
implementation of Go constitutes direct or contributory patent
|
||||||
|
infringement, or inducement of patent infringement, then any patent
|
||||||
|
rights granted to you under this License for this implementation of Go
|
||||||
|
shall terminate as of the date such litigation is filed.
|
||||||
+3
@@ -0,0 +1,3 @@
|
|||||||
|
This repository holds supplementary Go networking libraries.
|
||||||
|
|
||||||
|
To submit changes to this repository, see http://golang.org/doc/contribute.html.
|
||||||
+41
@@ -0,0 +1,41 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf
|
||||||
|
|
||||||
|
import "fmt"
|
||||||
|
|
||||||
|
// Assemble converts insts into raw instructions suitable for loading
|
||||||
|
// into a BPF virtual machine.
|
||||||
|
//
|
||||||
|
// Currently, no optimization is attempted, the assembled program flow
|
||||||
|
// is exactly as provided.
|
||||||
|
func Assemble(insts []Instruction) ([]RawInstruction, error) {
|
||||||
|
ret := make([]RawInstruction, len(insts))
|
||||||
|
var err error
|
||||||
|
for i, inst := range insts {
|
||||||
|
ret[i], err = inst.Assemble()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("assembling instruction %d: %s", i+1, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ret, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Disassemble attempts to parse raw back into
|
||||||
|
// Instructions. Unrecognized RawInstructions are assumed to be an
|
||||||
|
// extension not implemented by this package, and are passed through
|
||||||
|
// unchanged to the output. The allDecoded value reports whether insts
|
||||||
|
// contains no RawInstructions.
|
||||||
|
func Disassemble(raw []RawInstruction) (insts []Instruction, allDecoded bool) {
|
||||||
|
insts = make([]Instruction, len(raw))
|
||||||
|
allDecoded = true
|
||||||
|
for i, r := range raw {
|
||||||
|
insts[i] = r.Disassemble()
|
||||||
|
if _, ok := insts[i].(RawInstruction); ok {
|
||||||
|
allDecoded = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return insts, allDecoded
|
||||||
|
}
|
||||||
+215
@@ -0,0 +1,215 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf
|
||||||
|
|
||||||
|
// A Register is a register of the BPF virtual machine.
|
||||||
|
type Register uint16
|
||||||
|
|
||||||
|
const (
|
||||||
|
// RegA is the accumulator register. RegA is always the
|
||||||
|
// destination register of ALU operations.
|
||||||
|
RegA Register = iota
|
||||||
|
// RegX is the indirection register, used by LoadIndirect
|
||||||
|
// operations.
|
||||||
|
RegX
|
||||||
|
)
|
||||||
|
|
||||||
|
// An ALUOp is an arithmetic or logic operation.
|
||||||
|
type ALUOp uint16
|
||||||
|
|
||||||
|
// ALU binary operation types.
|
||||||
|
const (
|
||||||
|
ALUOpAdd ALUOp = iota << 4
|
||||||
|
ALUOpSub
|
||||||
|
ALUOpMul
|
||||||
|
ALUOpDiv
|
||||||
|
ALUOpOr
|
||||||
|
ALUOpAnd
|
||||||
|
ALUOpShiftLeft
|
||||||
|
ALUOpShiftRight
|
||||||
|
aluOpNeg // Not exported because it's the only unary ALU operation, and gets its own instruction type.
|
||||||
|
ALUOpMod
|
||||||
|
ALUOpXor
|
||||||
|
)
|
||||||
|
|
||||||
|
// A JumpTest is a comparison operator used in conditional jumps.
|
||||||
|
type JumpTest uint16
|
||||||
|
|
||||||
|
// Supported operators for conditional jumps.
|
||||||
|
const (
|
||||||
|
// K == A
|
||||||
|
JumpEqual JumpTest = iota
|
||||||
|
// K != A
|
||||||
|
JumpNotEqual
|
||||||
|
// K > A
|
||||||
|
JumpGreaterThan
|
||||||
|
// K < A
|
||||||
|
JumpLessThan
|
||||||
|
// K >= A
|
||||||
|
JumpGreaterOrEqual
|
||||||
|
// K <= A
|
||||||
|
JumpLessOrEqual
|
||||||
|
// K & A != 0
|
||||||
|
JumpBitsSet
|
||||||
|
// K & A == 0
|
||||||
|
JumpBitsNotSet
|
||||||
|
)
|
||||||
|
|
||||||
|
// An Extension is a function call provided by the kernel that
|
||||||
|
// performs advanced operations that are expensive or impossible
|
||||||
|
// within the BPF virtual machine.
|
||||||
|
//
|
||||||
|
// Extensions are only implemented by the Linux kernel.
|
||||||
|
//
|
||||||
|
// TODO: should we prune this list? Some of these extensions seem
|
||||||
|
// either broken or near-impossible to use correctly, whereas other
|
||||||
|
// (len, random, ifindex) are quite useful.
|
||||||
|
type Extension int
|
||||||
|
|
||||||
|
// Extension functions available in the Linux kernel.
|
||||||
|
const (
|
||||||
|
// ExtLen returns the length of the packet.
|
||||||
|
ExtLen Extension = 1
|
||||||
|
// ExtProto returns the packet's L3 protocol type.
|
||||||
|
ExtProto = 0
|
||||||
|
// ExtType returns the packet's type (skb->pkt_type in the kernel)
|
||||||
|
//
|
||||||
|
// TODO: better documentation. How nice an API do we want to
|
||||||
|
// provide for these esoteric extensions?
|
||||||
|
ExtType = 4
|
||||||
|
// ExtPayloadOffset returns the offset of the packet payload, or
|
||||||
|
// the first protocol header that the kernel does not know how to
|
||||||
|
// parse.
|
||||||
|
ExtPayloadOffset = 52
|
||||||
|
// ExtInterfaceIndex returns the index of the interface on which
|
||||||
|
// the packet was received.
|
||||||
|
ExtInterfaceIndex = 8
|
||||||
|
// ExtNetlinkAttr returns the netlink attribute of type X at
|
||||||
|
// offset A.
|
||||||
|
ExtNetlinkAttr = 12
|
||||||
|
// ExtNetlinkAttrNested returns the nested netlink attribute of
|
||||||
|
// type X at offset A.
|
||||||
|
ExtNetlinkAttrNested = 16
|
||||||
|
// ExtMark returns the packet's mark value.
|
||||||
|
ExtMark = 20
|
||||||
|
// ExtQueue returns the packet's assigned hardware queue.
|
||||||
|
ExtQueue = 24
|
||||||
|
// ExtLinkLayerType returns the packet's hardware address type
|
||||||
|
// (e.g. Ethernet, Infiniband).
|
||||||
|
ExtLinkLayerType = 28
|
||||||
|
// ExtRXHash returns the packets receive hash.
|
||||||
|
//
|
||||||
|
// TODO: figure out what this rxhash actually is.
|
||||||
|
ExtRXHash = 32
|
||||||
|
// ExtCPUID returns the ID of the CPU processing the current
|
||||||
|
// packet.
|
||||||
|
ExtCPUID = 36
|
||||||
|
// ExtVLANTag returns the packet's VLAN tag.
|
||||||
|
ExtVLANTag = 44
|
||||||
|
// ExtVLANTagPresent returns non-zero if the packet has a VLAN
|
||||||
|
// tag.
|
||||||
|
//
|
||||||
|
// TODO: I think this might be a lie: it reads bit 0x1000 of the
|
||||||
|
// VLAN header, which changed meaning in recent revisions of the
|
||||||
|
// spec - this extension may now return meaningless information.
|
||||||
|
ExtVLANTagPresent = 48
|
||||||
|
// ExtVLANProto returns 0x8100 if the frame has a VLAN header,
|
||||||
|
// 0x88a8 if the frame has a "Q-in-Q" double VLAN header, or some
|
||||||
|
// other value if no VLAN information is present.
|
||||||
|
ExtVLANProto = 60
|
||||||
|
// ExtRand returns a uniformly random uint32.
|
||||||
|
ExtRand = 56
|
||||||
|
)
|
||||||
|
|
||||||
|
// The following gives names to various bit patterns used in opcode construction.
|
||||||
|
|
||||||
|
const (
|
||||||
|
opMaskCls uint16 = 0x7
|
||||||
|
// opClsLoad masks
|
||||||
|
opMaskLoadDest = 0x01
|
||||||
|
opMaskLoadWidth = 0x18
|
||||||
|
opMaskLoadMode = 0xe0
|
||||||
|
// opClsALU
|
||||||
|
opMaskOperandSrc = 0x08
|
||||||
|
opMaskOperator = 0xf0
|
||||||
|
// opClsJump
|
||||||
|
opMaskJumpConst = 0x0f
|
||||||
|
opMaskJumpCond = 0xf0
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// +---------------+-----------------+---+---+---+
|
||||||
|
// | AddrMode (3b) | LoadWidth (2b) | 0 | 0 | 0 |
|
||||||
|
// +---------------+-----------------+---+---+---+
|
||||||
|
opClsLoadA uint16 = iota
|
||||||
|
// +---------------+-----------------+---+---+---+
|
||||||
|
// | AddrMode (3b) | LoadWidth (2b) | 0 | 0 | 1 |
|
||||||
|
// +---------------+-----------------+---+---+---+
|
||||||
|
opClsLoadX
|
||||||
|
// +---+---+---+---+---+---+---+---+
|
||||||
|
// | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 |
|
||||||
|
// +---+---+---+---+---+---+---+---+
|
||||||
|
opClsStoreA
|
||||||
|
// +---+---+---+---+---+---+---+---+
|
||||||
|
// | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 |
|
||||||
|
// +---+---+---+---+---+---+---+---+
|
||||||
|
opClsStoreX
|
||||||
|
// +---------------+-----------------+---+---+---+
|
||||||
|
// | Operator (4b) | OperandSrc (1b) | 1 | 0 | 0 |
|
||||||
|
// +---------------+-----------------+---+---+---+
|
||||||
|
opClsALU
|
||||||
|
// +-----------------------------+---+---+---+---+
|
||||||
|
// | TestOperator (4b) | 0 | 1 | 0 | 1 |
|
||||||
|
// +-----------------------------+---+---+---+---+
|
||||||
|
opClsJump
|
||||||
|
// +---+-------------------------+---+---+---+---+
|
||||||
|
// | 0 | 0 | 0 | RetSrc (1b) | 0 | 1 | 1 | 0 |
|
||||||
|
// +---+-------------------------+---+---+---+---+
|
||||||
|
opClsReturn
|
||||||
|
// +---+-------------------------+---+---+---+---+
|
||||||
|
// | 0 | 0 | 0 | TXAorTAX (1b) | 0 | 1 | 1 | 1 |
|
||||||
|
// +---+-------------------------+---+---+---+---+
|
||||||
|
opClsMisc
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
opAddrModeImmediate uint16 = iota << 5
|
||||||
|
opAddrModeAbsolute
|
||||||
|
opAddrModeIndirect
|
||||||
|
opAddrModeScratch
|
||||||
|
opAddrModePacketLen // actually an extension, not an addressing mode.
|
||||||
|
opAddrModeMemShift
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
opLoadWidth4 uint16 = iota << 3
|
||||||
|
opLoadWidth2
|
||||||
|
opLoadWidth1
|
||||||
|
)
|
||||||
|
|
||||||
|
// Operator defined by ALUOp*
|
||||||
|
|
||||||
|
const (
|
||||||
|
opALUSrcConstant uint16 = iota << 3
|
||||||
|
opALUSrcX
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
opJumpAlways = iota << 4
|
||||||
|
opJumpEqual
|
||||||
|
opJumpGT
|
||||||
|
opJumpGE
|
||||||
|
opJumpSet
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
opRetSrcConstant uint16 = iota << 4
|
||||||
|
opRetSrcA
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
opMiscTAX = 0x00
|
||||||
|
opMiscTXA = 0x80
|
||||||
|
)
|
||||||
+82
@@ -0,0 +1,82 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
/*
|
||||||
|
|
||||||
|
Package bpf implements marshaling and unmarshaling of programs for the
|
||||||
|
Berkeley Packet Filter virtual machine, and provides a Go implementation
|
||||||
|
of the virtual machine.
|
||||||
|
|
||||||
|
BPF's main use is to specify a packet filter for network taps, so that
|
||||||
|
the kernel doesn't have to expensively copy every packet it sees to
|
||||||
|
userspace. However, it's been repurposed to other areas where running
|
||||||
|
user code in-kernel is needed. For example, Linux's seccomp uses BPF
|
||||||
|
to apply security policies to system calls. For simplicity, this
|
||||||
|
documentation refers only to packets, but other uses of BPF have their
|
||||||
|
own data payloads.
|
||||||
|
|
||||||
|
BPF programs run in a restricted virtual machine. It has almost no
|
||||||
|
access to kernel functions, and while conditional branches are
|
||||||
|
allowed, they can only jump forwards, to guarantee that there are no
|
||||||
|
infinite loops.
|
||||||
|
|
||||||
|
The virtual machine
|
||||||
|
|
||||||
|
The BPF VM is an accumulator machine. Its main register, called
|
||||||
|
register A, is an implicit source and destination in all arithmetic
|
||||||
|
and logic operations. The machine also has 16 scratch registers for
|
||||||
|
temporary storage, and an indirection register (register X) for
|
||||||
|
indirect memory access. All registers are 32 bits wide.
|
||||||
|
|
||||||
|
Each run of a BPF program is given one packet, which is placed in the
|
||||||
|
VM's read-only "main memory". LoadAbsolute and LoadIndirect
|
||||||
|
instructions can fetch up to 32 bits at a time into register A for
|
||||||
|
examination.
|
||||||
|
|
||||||
|
The goal of a BPF program is to produce and return a verdict (uint32),
|
||||||
|
which tells the kernel what to do with the packet. In the context of
|
||||||
|
packet filtering, the returned value is the number of bytes of the
|
||||||
|
packet to forward to userspace, or 0 to ignore the packet. Other
|
||||||
|
contexts like seccomp define their own return values.
|
||||||
|
|
||||||
|
In order to simplify programs, attempts to read past the end of the
|
||||||
|
packet terminate the program execution with a verdict of 0 (ignore
|
||||||
|
packet). This means that the vast majority of BPF programs don't need
|
||||||
|
to do any explicit bounds checking.
|
||||||
|
|
||||||
|
In addition to the bytes of the packet, some BPF programs have access
|
||||||
|
to extensions, which are essentially calls to kernel utility
|
||||||
|
functions. Currently, the only extensions supported by this package
|
||||||
|
are the Linux packet filter extensions.
|
||||||
|
|
||||||
|
Examples
|
||||||
|
|
||||||
|
This packet filter selects all ARP packets.
|
||||||
|
|
||||||
|
bpf.Assemble([]bpf.Instruction{
|
||||||
|
// Load "EtherType" field from the ethernet header.
|
||||||
|
bpf.LoadAbsolute{Off: 12, Size: 2},
|
||||||
|
// Skip over the next instruction if EtherType is not ARP.
|
||||||
|
bpf.JumpIf{Cond: bpf.JumpNotEqual, Val: 0x0806, SkipTrue: 1},
|
||||||
|
// Verdict is "send up to 4k of the packet to userspace."
|
||||||
|
bpf.RetConstant{Val: 4096},
|
||||||
|
// Verdict is "ignore packet."
|
||||||
|
bpf.RetConstant{Val: 0},
|
||||||
|
})
|
||||||
|
|
||||||
|
This packet filter captures a random 1% sample of traffic.
|
||||||
|
|
||||||
|
bpf.Assemble([]bpf.Instruction{
|
||||||
|
// Get a 32-bit random number from the Linux kernel.
|
||||||
|
bpf.LoadExtension{Num: bpf.ExtRand},
|
||||||
|
// 1% dice roll?
|
||||||
|
bpf.JumpIf{Cond: bpf.JumpLessThan, Val: 2^32/100, SkipFalse: 1},
|
||||||
|
// Capture.
|
||||||
|
bpf.RetConstant{Val: 4096},
|
||||||
|
// Ignore.
|
||||||
|
bpf.RetConstant{Val: 0},
|
||||||
|
})
|
||||||
|
|
||||||
|
*/
|
||||||
|
package bpf // import "golang.org/x/net/bpf"
|
||||||
+434
@@ -0,0 +1,434 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf
|
||||||
|
|
||||||
|
import "fmt"
|
||||||
|
|
||||||
|
// An Instruction is one instruction executed by the BPF virtual
|
||||||
|
// machine.
|
||||||
|
type Instruction interface {
|
||||||
|
// Assemble assembles the Instruction into a RawInstruction.
|
||||||
|
Assemble() (RawInstruction, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A RawInstruction is a raw BPF virtual machine instruction.
|
||||||
|
type RawInstruction struct {
|
||||||
|
// Operation to execute.
|
||||||
|
Op uint16
|
||||||
|
// For conditional jump instructions, the number of instructions
|
||||||
|
// to skip if the condition is true/false.
|
||||||
|
Jt uint8
|
||||||
|
Jf uint8
|
||||||
|
// Constant parameter. The meaning depends on the Op.
|
||||||
|
K uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (ri RawInstruction) Assemble() (RawInstruction, error) { return ri, nil }
|
||||||
|
|
||||||
|
// Disassemble parses ri into an Instruction and returns it. If ri is
|
||||||
|
// not recognized by this package, ri itself is returned.
|
||||||
|
func (ri RawInstruction) Disassemble() Instruction {
|
||||||
|
switch ri.Op & opMaskCls {
|
||||||
|
case opClsLoadA, opClsLoadX:
|
||||||
|
reg := Register(ri.Op & opMaskLoadDest)
|
||||||
|
sz := 0
|
||||||
|
switch ri.Op & opMaskLoadWidth {
|
||||||
|
case opLoadWidth4:
|
||||||
|
sz = 4
|
||||||
|
case opLoadWidth2:
|
||||||
|
sz = 2
|
||||||
|
case opLoadWidth1:
|
||||||
|
sz = 1
|
||||||
|
default:
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
switch ri.Op & opMaskLoadMode {
|
||||||
|
case opAddrModeImmediate:
|
||||||
|
if sz != 4 {
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
return LoadConstant{Dst: reg, Val: ri.K}
|
||||||
|
case opAddrModeScratch:
|
||||||
|
if sz != 4 || ri.K > 15 {
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
return LoadScratch{Dst: reg, N: int(ri.K)}
|
||||||
|
case opAddrModeAbsolute:
|
||||||
|
return LoadAbsolute{Size: sz, Off: ri.K}
|
||||||
|
case opAddrModeIndirect:
|
||||||
|
return LoadIndirect{Size: sz, Off: ri.K}
|
||||||
|
case opAddrModePacketLen:
|
||||||
|
if sz != 4 {
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
return LoadExtension{Num: ExtLen}
|
||||||
|
case opAddrModeMemShift:
|
||||||
|
return LoadMemShift{Off: ri.K}
|
||||||
|
default:
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
|
||||||
|
case opClsStoreA:
|
||||||
|
if ri.Op != opClsStoreA || ri.K > 15 {
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
return StoreScratch{Src: RegA, N: int(ri.K)}
|
||||||
|
|
||||||
|
case opClsStoreX:
|
||||||
|
if ri.Op != opClsStoreX || ri.K > 15 {
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
return StoreScratch{Src: RegX, N: int(ri.K)}
|
||||||
|
|
||||||
|
case opClsALU:
|
||||||
|
switch op := ALUOp(ri.Op & opMaskOperator); op {
|
||||||
|
case ALUOpAdd, ALUOpSub, ALUOpMul, ALUOpDiv, ALUOpOr, ALUOpAnd, ALUOpShiftLeft, ALUOpShiftRight, ALUOpMod, ALUOpXor:
|
||||||
|
if ri.Op&opMaskOperandSrc != 0 {
|
||||||
|
return ALUOpX{Op: op}
|
||||||
|
}
|
||||||
|
return ALUOpConstant{Op: op, Val: ri.K}
|
||||||
|
case aluOpNeg:
|
||||||
|
return NegateA{}
|
||||||
|
default:
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
|
||||||
|
case opClsJump:
|
||||||
|
if ri.Op&opMaskJumpConst != opClsJump {
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
switch ri.Op & opMaskJumpCond {
|
||||||
|
case opJumpAlways:
|
||||||
|
return Jump{Skip: ri.K}
|
||||||
|
case opJumpEqual:
|
||||||
|
return JumpIf{
|
||||||
|
Cond: JumpEqual,
|
||||||
|
Val: ri.K,
|
||||||
|
SkipTrue: ri.Jt,
|
||||||
|
SkipFalse: ri.Jf,
|
||||||
|
}
|
||||||
|
case opJumpGT:
|
||||||
|
return JumpIf{
|
||||||
|
Cond: JumpGreaterThan,
|
||||||
|
Val: ri.K,
|
||||||
|
SkipTrue: ri.Jt,
|
||||||
|
SkipFalse: ri.Jf,
|
||||||
|
}
|
||||||
|
case opJumpGE:
|
||||||
|
return JumpIf{
|
||||||
|
Cond: JumpGreaterOrEqual,
|
||||||
|
Val: ri.K,
|
||||||
|
SkipTrue: ri.Jt,
|
||||||
|
SkipFalse: ri.Jf,
|
||||||
|
}
|
||||||
|
case opJumpSet:
|
||||||
|
return JumpIf{
|
||||||
|
Cond: JumpBitsSet,
|
||||||
|
Val: ri.K,
|
||||||
|
SkipTrue: ri.Jt,
|
||||||
|
SkipFalse: ri.Jf,
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
|
||||||
|
case opClsReturn:
|
||||||
|
switch ri.Op {
|
||||||
|
case opClsReturn | opRetSrcA:
|
||||||
|
return RetA{}
|
||||||
|
case opClsReturn | opRetSrcConstant:
|
||||||
|
return RetConstant{Val: ri.K}
|
||||||
|
default:
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
|
||||||
|
case opClsMisc:
|
||||||
|
switch ri.Op {
|
||||||
|
case opClsMisc | opMiscTAX:
|
||||||
|
return TAX{}
|
||||||
|
case opClsMisc | opMiscTXA:
|
||||||
|
return TXA{}
|
||||||
|
default:
|
||||||
|
return ri
|
||||||
|
}
|
||||||
|
|
||||||
|
default:
|
||||||
|
panic("unreachable") // switch is exhaustive on the bit pattern
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadConstant loads Val into register Dst.
|
||||||
|
type LoadConstant struct {
|
||||||
|
Dst Register
|
||||||
|
Val uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a LoadConstant) Assemble() (RawInstruction, error) {
|
||||||
|
return assembleLoad(a.Dst, 4, opAddrModeImmediate, a.Val)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadScratch loads scratch[N] into register Dst.
|
||||||
|
type LoadScratch struct {
|
||||||
|
Dst Register
|
||||||
|
N int // 0-15
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a LoadScratch) Assemble() (RawInstruction, error) {
|
||||||
|
if a.N < 0 || a.N > 15 {
|
||||||
|
return RawInstruction{}, fmt.Errorf("invalid scratch slot %d", a.N)
|
||||||
|
}
|
||||||
|
return assembleLoad(a.Dst, 4, opAddrModeScratch, uint32(a.N))
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadAbsolute loads packet[Off:Off+Size] as an integer value into
|
||||||
|
// register A.
|
||||||
|
type LoadAbsolute struct {
|
||||||
|
Off uint32
|
||||||
|
Size int // 1, 2 or 4
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a LoadAbsolute) Assemble() (RawInstruction, error) {
|
||||||
|
return assembleLoad(RegA, a.Size, opAddrModeAbsolute, a.Off)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadIndirect loads packet[X+Off:X+Off+Size] as an integer value
|
||||||
|
// into register A.
|
||||||
|
type LoadIndirect struct {
|
||||||
|
Off uint32
|
||||||
|
Size int // 1, 2 or 4
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a LoadIndirect) Assemble() (RawInstruction, error) {
|
||||||
|
return assembleLoad(RegA, a.Size, opAddrModeIndirect, a.Off)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadMemShift multiplies the first 4 bits of the byte at packet[Off]
|
||||||
|
// by 4 and stores the result in register X.
|
||||||
|
//
|
||||||
|
// This instruction is mainly useful to load into X the length of an
|
||||||
|
// IPv4 packet header in a single instruction, rather than have to do
|
||||||
|
// the arithmetic on the header's first byte by hand.
|
||||||
|
type LoadMemShift struct {
|
||||||
|
Off uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a LoadMemShift) Assemble() (RawInstruction, error) {
|
||||||
|
return assembleLoad(RegX, 1, opAddrModeMemShift, a.Off)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadExtension invokes a linux-specific extension and stores the
|
||||||
|
// result in register A.
|
||||||
|
type LoadExtension struct {
|
||||||
|
Num Extension
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a LoadExtension) Assemble() (RawInstruction, error) {
|
||||||
|
if a.Num == ExtLen {
|
||||||
|
return assembleLoad(RegA, 4, opAddrModePacketLen, 0)
|
||||||
|
}
|
||||||
|
return assembleLoad(RegA, 4, opAddrModeAbsolute, uint32(-0x1000+a.Num))
|
||||||
|
}
|
||||||
|
|
||||||
|
// StoreScratch stores register Src into scratch[N].
|
||||||
|
type StoreScratch struct {
|
||||||
|
Src Register
|
||||||
|
N int // 0-15
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a StoreScratch) Assemble() (RawInstruction, error) {
|
||||||
|
if a.N < 0 || a.N > 15 {
|
||||||
|
return RawInstruction{}, fmt.Errorf("invalid scratch slot %d", a.N)
|
||||||
|
}
|
||||||
|
var op uint16
|
||||||
|
switch a.Src {
|
||||||
|
case RegA:
|
||||||
|
op = opClsStoreA
|
||||||
|
case RegX:
|
||||||
|
op = opClsStoreX
|
||||||
|
default:
|
||||||
|
return RawInstruction{}, fmt.Errorf("invalid source register %v", a.Src)
|
||||||
|
}
|
||||||
|
|
||||||
|
return RawInstruction{
|
||||||
|
Op: op,
|
||||||
|
K: uint32(a.N),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ALUOpConstant executes A = A <Op> Val.
|
||||||
|
type ALUOpConstant struct {
|
||||||
|
Op ALUOp
|
||||||
|
Val uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a ALUOpConstant) Assemble() (RawInstruction, error) {
|
||||||
|
return RawInstruction{
|
||||||
|
Op: opClsALU | opALUSrcConstant | uint16(a.Op),
|
||||||
|
K: a.Val,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ALUOpX executes A = A <Op> X
|
||||||
|
type ALUOpX struct {
|
||||||
|
Op ALUOp
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a ALUOpX) Assemble() (RawInstruction, error) {
|
||||||
|
return RawInstruction{
|
||||||
|
Op: opClsALU | opALUSrcX | uint16(a.Op),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// NegateA executes A = -A.
|
||||||
|
type NegateA struct{}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a NegateA) Assemble() (RawInstruction, error) {
|
||||||
|
return RawInstruction{
|
||||||
|
Op: opClsALU | uint16(aluOpNeg),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Jump skips the following Skip instructions in the program.
|
||||||
|
type Jump struct {
|
||||||
|
Skip uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a Jump) Assemble() (RawInstruction, error) {
|
||||||
|
return RawInstruction{
|
||||||
|
Op: opClsJump | opJumpAlways,
|
||||||
|
K: a.Skip,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// JumpIf skips the following Skip instructions in the program if A
|
||||||
|
// <Cond> Val is true.
|
||||||
|
type JumpIf struct {
|
||||||
|
Cond JumpTest
|
||||||
|
Val uint32
|
||||||
|
SkipTrue uint8
|
||||||
|
SkipFalse uint8
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a JumpIf) Assemble() (RawInstruction, error) {
|
||||||
|
var (
|
||||||
|
cond uint16
|
||||||
|
flip bool
|
||||||
|
)
|
||||||
|
switch a.Cond {
|
||||||
|
case JumpEqual:
|
||||||
|
cond = opJumpEqual
|
||||||
|
case JumpNotEqual:
|
||||||
|
cond, flip = opJumpEqual, true
|
||||||
|
case JumpGreaterThan:
|
||||||
|
cond = opJumpGT
|
||||||
|
case JumpLessThan:
|
||||||
|
cond, flip = opJumpGE, true
|
||||||
|
case JumpGreaterOrEqual:
|
||||||
|
cond = opJumpGE
|
||||||
|
case JumpLessOrEqual:
|
||||||
|
cond, flip = opJumpGT, true
|
||||||
|
case JumpBitsSet:
|
||||||
|
cond = opJumpSet
|
||||||
|
case JumpBitsNotSet:
|
||||||
|
cond, flip = opJumpSet, true
|
||||||
|
default:
|
||||||
|
return RawInstruction{}, fmt.Errorf("unknown JumpTest %v", a.Cond)
|
||||||
|
}
|
||||||
|
jt, jf := a.SkipTrue, a.SkipFalse
|
||||||
|
if flip {
|
||||||
|
jt, jf = jf, jt
|
||||||
|
}
|
||||||
|
return RawInstruction{
|
||||||
|
Op: opClsJump | cond,
|
||||||
|
Jt: jt,
|
||||||
|
Jf: jf,
|
||||||
|
K: a.Val,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RetA exits the BPF program, returning the value of register A.
|
||||||
|
type RetA struct{}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a RetA) Assemble() (RawInstruction, error) {
|
||||||
|
return RawInstruction{
|
||||||
|
Op: opClsReturn | opRetSrcA,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RetConstant exits the BPF program, returning a constant value.
|
||||||
|
type RetConstant struct {
|
||||||
|
Val uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a RetConstant) Assemble() (RawInstruction, error) {
|
||||||
|
return RawInstruction{
|
||||||
|
Op: opClsReturn | opRetSrcConstant,
|
||||||
|
K: a.Val,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TXA copies the value of register X to register A.
|
||||||
|
type TXA struct{}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a TXA) Assemble() (RawInstruction, error) {
|
||||||
|
return RawInstruction{
|
||||||
|
Op: opClsMisc | opMiscTXA,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TAX copies the value of register A to register X.
|
||||||
|
type TAX struct{}
|
||||||
|
|
||||||
|
// Assemble implements the Instruction Assemble method.
|
||||||
|
func (a TAX) Assemble() (RawInstruction, error) {
|
||||||
|
return RawInstruction{
|
||||||
|
Op: opClsMisc | opMiscTAX,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func assembleLoad(dst Register, loadSize int, mode uint16, k uint32) (RawInstruction, error) {
|
||||||
|
var (
|
||||||
|
cls uint16
|
||||||
|
sz uint16
|
||||||
|
)
|
||||||
|
switch dst {
|
||||||
|
case RegA:
|
||||||
|
cls = opClsLoadA
|
||||||
|
case RegX:
|
||||||
|
cls = opClsLoadX
|
||||||
|
default:
|
||||||
|
return RawInstruction{}, fmt.Errorf("invalid target register %v", dst)
|
||||||
|
}
|
||||||
|
switch loadSize {
|
||||||
|
case 1:
|
||||||
|
sz = opLoadWidth1
|
||||||
|
case 2:
|
||||||
|
sz = opLoadWidth2
|
||||||
|
case 4:
|
||||||
|
sz = opLoadWidth4
|
||||||
|
default:
|
||||||
|
return RawInstruction{}, fmt.Errorf("invalid load byte length %d", sz)
|
||||||
|
}
|
||||||
|
return RawInstruction{
|
||||||
|
Op: cls | sz | mode,
|
||||||
|
K: k,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
+184
@@ -0,0 +1,184 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io/ioutil"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// This is a direct translation of the program in
|
||||||
|
// testdata/all_instructions.txt.
|
||||||
|
var allInstructions = []Instruction{
|
||||||
|
LoadConstant{Dst: RegA, Val: 42},
|
||||||
|
LoadConstant{Dst: RegX, Val: 42},
|
||||||
|
|
||||||
|
LoadScratch{Dst: RegA, N: 3},
|
||||||
|
LoadScratch{Dst: RegX, N: 3},
|
||||||
|
|
||||||
|
LoadAbsolute{Off: 42, Size: 1},
|
||||||
|
LoadAbsolute{Off: 42, Size: 2},
|
||||||
|
LoadAbsolute{Off: 42, Size: 4},
|
||||||
|
|
||||||
|
LoadIndirect{Off: 42, Size: 1},
|
||||||
|
LoadIndirect{Off: 42, Size: 2},
|
||||||
|
LoadIndirect{Off: 42, Size: 4},
|
||||||
|
|
||||||
|
LoadMemShift{Off: 42},
|
||||||
|
|
||||||
|
LoadExtension{Num: ExtLen},
|
||||||
|
LoadExtension{Num: ExtProto},
|
||||||
|
LoadExtension{Num: ExtType},
|
||||||
|
LoadExtension{Num: ExtRand},
|
||||||
|
|
||||||
|
StoreScratch{Src: RegA, N: 3},
|
||||||
|
StoreScratch{Src: RegX, N: 3},
|
||||||
|
|
||||||
|
ALUOpConstant{Op: ALUOpAdd, Val: 42},
|
||||||
|
ALUOpConstant{Op: ALUOpSub, Val: 42},
|
||||||
|
ALUOpConstant{Op: ALUOpMul, Val: 42},
|
||||||
|
ALUOpConstant{Op: ALUOpDiv, Val: 42},
|
||||||
|
ALUOpConstant{Op: ALUOpOr, Val: 42},
|
||||||
|
ALUOpConstant{Op: ALUOpAnd, Val: 42},
|
||||||
|
ALUOpConstant{Op: ALUOpShiftLeft, Val: 42},
|
||||||
|
ALUOpConstant{Op: ALUOpShiftRight, Val: 42},
|
||||||
|
ALUOpConstant{Op: ALUOpMod, Val: 42},
|
||||||
|
ALUOpConstant{Op: ALUOpXor, Val: 42},
|
||||||
|
|
||||||
|
ALUOpX{Op: ALUOpAdd},
|
||||||
|
ALUOpX{Op: ALUOpSub},
|
||||||
|
ALUOpX{Op: ALUOpMul},
|
||||||
|
ALUOpX{Op: ALUOpDiv},
|
||||||
|
ALUOpX{Op: ALUOpOr},
|
||||||
|
ALUOpX{Op: ALUOpAnd},
|
||||||
|
ALUOpX{Op: ALUOpShiftLeft},
|
||||||
|
ALUOpX{Op: ALUOpShiftRight},
|
||||||
|
ALUOpX{Op: ALUOpMod},
|
||||||
|
ALUOpX{Op: ALUOpXor},
|
||||||
|
|
||||||
|
NegateA{},
|
||||||
|
|
||||||
|
Jump{Skip: 10},
|
||||||
|
JumpIf{Cond: JumpEqual, Val: 42, SkipTrue: 8, SkipFalse: 9},
|
||||||
|
JumpIf{Cond: JumpNotEqual, Val: 42, SkipTrue: 8},
|
||||||
|
JumpIf{Cond: JumpLessThan, Val: 42, SkipTrue: 7},
|
||||||
|
JumpIf{Cond: JumpLessOrEqual, Val: 42, SkipTrue: 6},
|
||||||
|
JumpIf{Cond: JumpGreaterThan, Val: 42, SkipTrue: 4, SkipFalse: 5},
|
||||||
|
JumpIf{Cond: JumpGreaterOrEqual, Val: 42, SkipTrue: 3, SkipFalse: 4},
|
||||||
|
JumpIf{Cond: JumpBitsSet, Val: 42, SkipTrue: 2, SkipFalse: 3},
|
||||||
|
|
||||||
|
TAX{},
|
||||||
|
TXA{},
|
||||||
|
|
||||||
|
RetA{},
|
||||||
|
RetConstant{Val: 42},
|
||||||
|
}
|
||||||
|
var allInstructionsExpected = "testdata/all_instructions.bpf"
|
||||||
|
|
||||||
|
// Check that we produce the same output as the canonical bpf_asm
|
||||||
|
// linux kernel tool.
|
||||||
|
func TestInterop(t *testing.T) {
|
||||||
|
out, err := Assemble(allInstructions)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("assembly of allInstructions program failed: %s", err)
|
||||||
|
}
|
||||||
|
t.Logf("Assembled program is %d instructions long", len(out))
|
||||||
|
|
||||||
|
bs, err := ioutil.ReadFile(allInstructionsExpected)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("reading %s: %s", allInstructionsExpected, err)
|
||||||
|
}
|
||||||
|
// First statement is the number of statements, last statement is
|
||||||
|
// empty. We just ignore both and rely on slice length.
|
||||||
|
stmts := strings.Split(string(bs), ",")
|
||||||
|
if len(stmts)-2 != len(out) {
|
||||||
|
t.Fatalf("test program lengths don't match: %s has %d, Go implementation has %d", allInstructionsExpected, len(stmts)-2, len(allInstructions))
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, stmt := range stmts[1 : len(stmts)-2] {
|
||||||
|
nums := strings.Split(stmt, " ")
|
||||||
|
if len(nums) != 4 {
|
||||||
|
t.Fatalf("malformed instruction %d in %s: %s", i+1, allInstructionsExpected, stmt)
|
||||||
|
}
|
||||||
|
|
||||||
|
actual := out[i]
|
||||||
|
|
||||||
|
op, err := strconv.ParseUint(nums[0], 10, 16)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("malformed opcode %s in instruction %d of %s", nums[0], i+1, allInstructionsExpected)
|
||||||
|
}
|
||||||
|
if actual.Op != uint16(op) {
|
||||||
|
t.Errorf("opcode mismatch on instruction %d (%#v): got 0x%02x, want 0x%02x", i+1, allInstructions[i], actual.Op, op)
|
||||||
|
}
|
||||||
|
|
||||||
|
jt, err := strconv.ParseUint(nums[1], 10, 8)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("malformed jt offset %s in instruction %d of %s", nums[1], i+1, allInstructionsExpected)
|
||||||
|
}
|
||||||
|
if actual.Jt != uint8(jt) {
|
||||||
|
t.Errorf("jt mismatch on instruction %d (%#v): got %d, want %d", i+1, allInstructions[i], actual.Jt, jt)
|
||||||
|
}
|
||||||
|
|
||||||
|
jf, err := strconv.ParseUint(nums[2], 10, 8)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("malformed jf offset %s in instruction %d of %s", nums[2], i+1, allInstructionsExpected)
|
||||||
|
}
|
||||||
|
if actual.Jf != uint8(jf) {
|
||||||
|
t.Errorf("jf mismatch on instruction %d (%#v): got %d, want %d", i+1, allInstructions[i], actual.Jf, jf)
|
||||||
|
}
|
||||||
|
|
||||||
|
k, err := strconv.ParseUint(nums[3], 10, 32)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("malformed constant %s in instruction %d of %s", nums[3], i+1, allInstructionsExpected)
|
||||||
|
}
|
||||||
|
if actual.K != uint32(k) {
|
||||||
|
t.Errorf("constant mismatch on instruction %d (%#v): got %d, want %d", i+1, allInstructions[i], actual.K, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check that assembly and disassembly match each other.
|
||||||
|
//
|
||||||
|
// Because we offer "fake" jump conditions that don't appear in the
|
||||||
|
// machine code, disassembly won't be a 1:1 match with the original
|
||||||
|
// source, although the behavior will be identical. However,
|
||||||
|
// reassembling the disassembly should produce an identical program.
|
||||||
|
func TestAsmDisasm(t *testing.T) {
|
||||||
|
prog1, err := Assemble(allInstructions)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("assembly of allInstructions program failed: %s", err)
|
||||||
|
}
|
||||||
|
t.Logf("Assembled program is %d instructions long", len(prog1))
|
||||||
|
|
||||||
|
src, allDecoded := Disassemble(prog1)
|
||||||
|
if !allDecoded {
|
||||||
|
t.Errorf("Disassemble(Assemble(allInstructions)) produced unrecognized instructions:")
|
||||||
|
for i, inst := range src {
|
||||||
|
if r, ok := inst.(RawInstruction); ok {
|
||||||
|
t.Logf(" insn %d, %#v --> %#v", i+1, allInstructions[i], r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
prog2, err := Assemble(src)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("assembly of Disassemble(Assemble(allInstructions)) failed: %s", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(prog2) != len(prog1) {
|
||||||
|
t.Fatalf("disassembly changed program size: %d insns before, %d insns after", len(prog1), len(prog2))
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(prog1, prog2) {
|
||||||
|
t.Errorf("program mutated by disassembly:")
|
||||||
|
for i := range prog2 {
|
||||||
|
if !reflect.DeepEqual(prog1[i], prog2[i]) {
|
||||||
|
t.Logf(" insn %d, s: %#v, p1: %#v, p2: %#v", i+1, allInstructions[i], prog1[i], prog2[i])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
50,0 0 0 42,1 0 0 42,96 0 0 3,97 0 0 3,48 0 0 42,40 0 0 42,32 0 0 42,80 0 0 42,72 0 0 42,64 0 0 42,177 0 0 42,128 0 0 0,32 0 0 4294963200,32 0 0 4294963204,32 0 0 4294963256,2 0 0 3,3 0 0 3,4 0 0 42,20 0 0 42,36 0 0 42,52 0 0 42,68 0 0 42,84 0 0 42,100 0 0 42,116 0 0 42,148 0 0 42,164 0 0 42,12 0 0 0,28 0 0 0,44 0 0 0,60 0 0 0,76 0 0 0,92 0 0 0,108 0 0 0,124 0 0 0,156 0 0 0,172 0 0 0,132 0 0 0,5 0 0 10,21 8 9 42,21 0 8 42,53 0 7 42,37 0 6 42,37 4 5 42,53 3 4 42,69 2 3 42,7 0 0 0,135 0 0 0,22 0 0 0,6 0 0 0,
|
||||||
+79
@@ -0,0 +1,79 @@
|
|||||||
|
# This filter is compiled to all_instructions.bpf by the `bpf_asm`
|
||||||
|
# tool, which can be found in the linux kernel source tree under
|
||||||
|
# tools/net.
|
||||||
|
|
||||||
|
# Load immediate
|
||||||
|
ld #42
|
||||||
|
ldx #42
|
||||||
|
|
||||||
|
# Load scratch
|
||||||
|
ld M[3]
|
||||||
|
ldx M[3]
|
||||||
|
|
||||||
|
# Load absolute
|
||||||
|
ldb [42]
|
||||||
|
ldh [42]
|
||||||
|
ld [42]
|
||||||
|
|
||||||
|
# Load indirect
|
||||||
|
ldb [x + 42]
|
||||||
|
ldh [x + 42]
|
||||||
|
ld [x + 42]
|
||||||
|
|
||||||
|
# Load IPv4 header length
|
||||||
|
ldx 4*([42]&0xf)
|
||||||
|
|
||||||
|
# Run extension function
|
||||||
|
ld #len
|
||||||
|
ld #proto
|
||||||
|
ld #type
|
||||||
|
ld #rand
|
||||||
|
|
||||||
|
# Store scratch
|
||||||
|
st M[3]
|
||||||
|
stx M[3]
|
||||||
|
|
||||||
|
# A <op> constant
|
||||||
|
add #42
|
||||||
|
sub #42
|
||||||
|
mul #42
|
||||||
|
div #42
|
||||||
|
or #42
|
||||||
|
and #42
|
||||||
|
lsh #42
|
||||||
|
rsh #42
|
||||||
|
mod #42
|
||||||
|
xor #42
|
||||||
|
|
||||||
|
# A <op> X
|
||||||
|
add x
|
||||||
|
sub x
|
||||||
|
mul x
|
||||||
|
div x
|
||||||
|
or x
|
||||||
|
and x
|
||||||
|
lsh x
|
||||||
|
rsh x
|
||||||
|
mod x
|
||||||
|
xor x
|
||||||
|
|
||||||
|
# !A
|
||||||
|
neg
|
||||||
|
|
||||||
|
# Jumps
|
||||||
|
ja end
|
||||||
|
jeq #42,prev,end
|
||||||
|
jne #42,end
|
||||||
|
jlt #42,end
|
||||||
|
jle #42,end
|
||||||
|
jgt #42,prev,end
|
||||||
|
jge #42,prev,end
|
||||||
|
jset #42,prev,end
|
||||||
|
|
||||||
|
# Register transfers
|
||||||
|
tax
|
||||||
|
txa
|
||||||
|
|
||||||
|
# Returns
|
||||||
|
prev: ret a
|
||||||
|
end: ret #42
|
||||||
+140
@@ -0,0 +1,140 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A VM is an emulated BPF virtual machine.
|
||||||
|
type VM struct {
|
||||||
|
filter []Instruction
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewVM returns a new VM using the input BPF program.
|
||||||
|
func NewVM(filter []Instruction) (*VM, error) {
|
||||||
|
if len(filter) == 0 {
|
||||||
|
return nil, errors.New("one or more Instructions must be specified")
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, ins := range filter {
|
||||||
|
check := len(filter) - (i + 1)
|
||||||
|
switch ins := ins.(type) {
|
||||||
|
// Check for out-of-bounds jumps in instructions
|
||||||
|
case Jump:
|
||||||
|
if check <= int(ins.Skip) {
|
||||||
|
return nil, fmt.Errorf("cannot jump %d instructions; jumping past program bounds", ins.Skip)
|
||||||
|
}
|
||||||
|
case JumpIf:
|
||||||
|
if check <= int(ins.SkipTrue) {
|
||||||
|
return nil, fmt.Errorf("cannot jump %d instructions in true case; jumping past program bounds", ins.SkipTrue)
|
||||||
|
}
|
||||||
|
if check <= int(ins.SkipFalse) {
|
||||||
|
return nil, fmt.Errorf("cannot jump %d instructions in false case; jumping past program bounds", ins.SkipFalse)
|
||||||
|
}
|
||||||
|
// Check for division or modulus by zero
|
||||||
|
case ALUOpConstant:
|
||||||
|
if ins.Val != 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
switch ins.Op {
|
||||||
|
case ALUOpDiv, ALUOpMod:
|
||||||
|
return nil, errors.New("cannot divide by zero using ALUOpConstant")
|
||||||
|
}
|
||||||
|
// Check for unknown extensions
|
||||||
|
case LoadExtension:
|
||||||
|
switch ins.Num {
|
||||||
|
case ExtLen:
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("extension %d not implemented", ins.Num)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Make sure last instruction is a return instruction
|
||||||
|
switch filter[len(filter)-1].(type) {
|
||||||
|
case RetA, RetConstant:
|
||||||
|
default:
|
||||||
|
return nil, errors.New("BPF program must end with RetA or RetConstant")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Though our VM works using disassembled instructions, we
|
||||||
|
// attempt to assemble the input filter anyway to ensure it is compatible
|
||||||
|
// with an operating system VM.
|
||||||
|
_, err := Assemble(filter)
|
||||||
|
|
||||||
|
return &VM{
|
||||||
|
filter: filter,
|
||||||
|
}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run runs the VM's BPF program against the input bytes.
|
||||||
|
// Run returns the number of bytes accepted by the BPF program, and any errors
|
||||||
|
// which occurred while processing the program.
|
||||||
|
func (v *VM) Run(in []byte) (int, error) {
|
||||||
|
var (
|
||||||
|
// Registers of the virtual machine
|
||||||
|
regA uint32
|
||||||
|
regX uint32
|
||||||
|
regScratch [16]uint32
|
||||||
|
|
||||||
|
// OK is true if the program should continue processing the next
|
||||||
|
// instruction, or false if not, causing the loop to break
|
||||||
|
ok = true
|
||||||
|
)
|
||||||
|
|
||||||
|
// TODO(mdlayher): implement:
|
||||||
|
// - NegateA:
|
||||||
|
// - would require a change from uint32 registers to int32
|
||||||
|
// registers
|
||||||
|
|
||||||
|
// TODO(mdlayher): add interop tests that check signedness of ALU
|
||||||
|
// operations against kernel implementation, and make sure Go
|
||||||
|
// implementation matches behavior
|
||||||
|
|
||||||
|
for i := 0; i < len(v.filter) && ok; i++ {
|
||||||
|
ins := v.filter[i]
|
||||||
|
|
||||||
|
switch ins := ins.(type) {
|
||||||
|
case ALUOpConstant:
|
||||||
|
regA = aluOpConstant(ins, regA)
|
||||||
|
case ALUOpX:
|
||||||
|
regA, ok = aluOpX(ins, regA, regX)
|
||||||
|
case Jump:
|
||||||
|
i += int(ins.Skip)
|
||||||
|
case JumpIf:
|
||||||
|
jump := jumpIf(ins, regA)
|
||||||
|
i += jump
|
||||||
|
case LoadAbsolute:
|
||||||
|
regA, ok = loadAbsolute(ins, in)
|
||||||
|
case LoadConstant:
|
||||||
|
regA, regX = loadConstant(ins, regA, regX)
|
||||||
|
case LoadExtension:
|
||||||
|
regA = loadExtension(ins, in)
|
||||||
|
case LoadIndirect:
|
||||||
|
regA, ok = loadIndirect(ins, in, regX)
|
||||||
|
case LoadMemShift:
|
||||||
|
regX, ok = loadMemShift(ins, in)
|
||||||
|
case LoadScratch:
|
||||||
|
regA, regX = loadScratch(ins, regScratch, regA, regX)
|
||||||
|
case RetA:
|
||||||
|
return int(regA), nil
|
||||||
|
case RetConstant:
|
||||||
|
return int(ins.Val), nil
|
||||||
|
case StoreScratch:
|
||||||
|
regScratch = storeScratch(ins, regScratch, regA, regX)
|
||||||
|
case TAX:
|
||||||
|
regX = regA
|
||||||
|
case TXA:
|
||||||
|
regA = regX
|
||||||
|
default:
|
||||||
|
return 0, fmt.Errorf("unknown Instruction at index %d: %T", i, ins)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
+512
@@ -0,0 +1,512 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"golang.org/x/net/bpf"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestVMALUOpAdd(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpAdd,
|
||||||
|
Val: 3,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
8, 2, 3,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 3, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpSub(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.TAX{},
|
||||||
|
bpf.ALUOpX{
|
||||||
|
Op: bpf.ALUOpSub,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
1, 2, 3,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 0, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpMul(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpMul,
|
||||||
|
Val: 2,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
6, 2, 3, 4,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 4, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpDiv(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpDiv,
|
||||||
|
Val: 2,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
20, 2, 3, 4,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 2, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpDivByZeroALUOpConstant(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpDiv,
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "cannot divide by zero using ALUOpConstant" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpDivByZeroALUOpX(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
// Load byte 0 into X
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.TAX{},
|
||||||
|
// Load byte 1 into A
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 9,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
// Attempt to perform 1/0
|
||||||
|
bpf.ALUOpX{
|
||||||
|
Op: bpf.ALUOpDiv,
|
||||||
|
},
|
||||||
|
// Return 4 bytes if program does not terminate
|
||||||
|
bpf.LoadConstant{
|
||||||
|
Val: 12,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1, 3, 4,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 0, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpOr(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 2,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpOr,
|
||||||
|
Val: 0x01,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0x00, 0x10, 0x03, 0x04,
|
||||||
|
0x05, 0x06, 0x07, 0x08,
|
||||||
|
0x09, 0xff,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 9, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpAnd(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 2,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpAnd,
|
||||||
|
Val: 0x0019,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xaa, 0x09,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpShiftLeft(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpShiftLeft,
|
||||||
|
Val: 0x01,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
Val: 0x02,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 9,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0x01, 0xaa,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpShiftRight(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpShiftRight,
|
||||||
|
Val: 0x01,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
Val: 0x04,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 9,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0x08, 0xff, 0xff,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpMod(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpMod,
|
||||||
|
Val: 20,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
30, 0, 0,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 2, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpModByZeroALUOpConstant(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpMod,
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "cannot divide by zero using ALUOpConstant" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpModByZeroALUOpX(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
// Load byte 0 into X
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.TAX{},
|
||||||
|
// Load byte 1 into A
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 9,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
// Attempt to perform 1%0
|
||||||
|
bpf.ALUOpX{
|
||||||
|
Op: bpf.ALUOpMod,
|
||||||
|
},
|
||||||
|
// Return 4 bytes if program does not terminate
|
||||||
|
bpf.LoadConstant{
|
||||||
|
Val: 12,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1, 3, 4,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 0, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpXor(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpXor,
|
||||||
|
Val: 0x0a,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
Val: 0x01,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 9,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0x0b, 0x00, 0x00, 0x00,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMALUOpUnknown(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: bpf.ALUOpAdd,
|
||||||
|
Val: 1,
|
||||||
|
},
|
||||||
|
// Verify that an unknown operation is a no-op
|
||||||
|
bpf.ALUOpConstant{
|
||||||
|
Op: 100,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
Val: 0x02,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 9,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
1,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
+192
@@ -0,0 +1,192 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net"
|
||||||
|
"runtime"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"golang.org/x/net/bpf"
|
||||||
|
"golang.org/x/net/ipv4"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A virtualMachine is a BPF virtual machine which can process an
|
||||||
|
// input packet against a BPF program and render a verdict.
|
||||||
|
type virtualMachine interface {
|
||||||
|
Run(in []byte) (int, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// canUseOSVM indicates if the OS BPF VM is available on this platform.
|
||||||
|
func canUseOSVM() bool {
|
||||||
|
// OS BPF VM can only be used on platforms where x/net/ipv4 supports
|
||||||
|
// attaching a BPF program to a socket.
|
||||||
|
switch runtime.GOOS {
|
||||||
|
case "linux":
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// All BPF tests against both the Go VM and OS VM are assumed to
|
||||||
|
// be used with a UDP socket. As a result, the entire contents
|
||||||
|
// of a UDP datagram is sent through the BPF program, but only
|
||||||
|
// the body after the UDP header will ever be returned in output.
|
||||||
|
|
||||||
|
// testVM sets up a Go BPF VM, and if available, a native OS BPF VM
|
||||||
|
// for integration testing.
|
||||||
|
func testVM(t *testing.T, filter []bpf.Instruction) (virtualMachine, func(), error) {
|
||||||
|
goVM, err := bpf.NewVM(filter)
|
||||||
|
if err != nil {
|
||||||
|
// Some tests expect an error, so this error must be returned
|
||||||
|
// instead of fatally exiting the test
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
mvm := &multiVirtualMachine{
|
||||||
|
goVM: goVM,
|
||||||
|
|
||||||
|
t: t,
|
||||||
|
}
|
||||||
|
|
||||||
|
// If available, add the OS VM for tests which verify that both the Go
|
||||||
|
// VM and OS VM have exactly the same output for the same input program
|
||||||
|
// and packet.
|
||||||
|
done := func() {}
|
||||||
|
if canUseOSVM() {
|
||||||
|
osVM, osVMDone := testOSVM(t, filter)
|
||||||
|
done = func() { osVMDone() }
|
||||||
|
mvm.osVM = osVM
|
||||||
|
}
|
||||||
|
|
||||||
|
return mvm, done, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// udpHeaderLen is the length of a UDP header.
|
||||||
|
const udpHeaderLen = 8
|
||||||
|
|
||||||
|
// A multiVirtualMachine is a virtualMachine which can call out to both the Go VM
|
||||||
|
// and the native OS VM, if the OS VM is available.
|
||||||
|
type multiVirtualMachine struct {
|
||||||
|
goVM virtualMachine
|
||||||
|
osVM virtualMachine
|
||||||
|
|
||||||
|
t *testing.T
|
||||||
|
}
|
||||||
|
|
||||||
|
func (mvm *multiVirtualMachine) Run(in []byte) (int, error) {
|
||||||
|
if len(in) < udpHeaderLen {
|
||||||
|
mvm.t.Fatalf("input must be at least length of UDP header (%d), got: %d",
|
||||||
|
udpHeaderLen, len(in))
|
||||||
|
}
|
||||||
|
|
||||||
|
// All tests have a UDP header as part of input, because the OS VM
|
||||||
|
// packets always will. For the Go VM, this output is trimmed before
|
||||||
|
// being sent back to tests.
|
||||||
|
goOut, goErr := mvm.goVM.Run(in)
|
||||||
|
if goOut >= udpHeaderLen {
|
||||||
|
goOut -= udpHeaderLen
|
||||||
|
}
|
||||||
|
|
||||||
|
// If Go output is larger than the size of the packet, packet filtering
|
||||||
|
// interop tests must trim the output bytes to the length of the packet.
|
||||||
|
// The BPF VM should not do this on its own, as other uses of it do
|
||||||
|
// not trim the output byte count.
|
||||||
|
trim := len(in) - udpHeaderLen
|
||||||
|
if goOut > trim {
|
||||||
|
goOut = trim
|
||||||
|
}
|
||||||
|
|
||||||
|
// When the OS VM is not available, process using the Go VM alone
|
||||||
|
if mvm.osVM == nil {
|
||||||
|
return goOut, goErr
|
||||||
|
}
|
||||||
|
|
||||||
|
// The OS VM will apply its own UDP header, so remove the pseudo header
|
||||||
|
// that the Go VM needs.
|
||||||
|
osOut, err := mvm.osVM.Run(in[udpHeaderLen:])
|
||||||
|
if err != nil {
|
||||||
|
mvm.t.Fatalf("error while running OS VM: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify both VMs return same number of bytes
|
||||||
|
var mismatch bool
|
||||||
|
if goOut != osOut {
|
||||||
|
mismatch = true
|
||||||
|
mvm.t.Logf("output byte count does not match:\n- go: %v\n- os: %v", goOut, osOut)
|
||||||
|
}
|
||||||
|
|
||||||
|
if mismatch {
|
||||||
|
mvm.t.Fatal("Go BPF and OS BPF packet outputs do not match")
|
||||||
|
}
|
||||||
|
|
||||||
|
return goOut, goErr
|
||||||
|
}
|
||||||
|
|
||||||
|
// An osVirtualMachine is a virtualMachine which uses the OS's BPF VM for
|
||||||
|
// processing BPF programs.
|
||||||
|
type osVirtualMachine struct {
|
||||||
|
l net.PacketConn
|
||||||
|
s net.Conn
|
||||||
|
}
|
||||||
|
|
||||||
|
// testOSVM creates a virtualMachine which uses the OS's BPF VM by injecting
|
||||||
|
// packets into a UDP listener with a BPF program attached to it.
|
||||||
|
func testOSVM(t *testing.T, filter []bpf.Instruction) (virtualMachine, func()) {
|
||||||
|
l, err := net.ListenPacket("udp4", "127.0.0.1:0")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to open OS VM UDP listener: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
prog, err := bpf.Assemble(filter)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to compile BPF program: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
p := ipv4.NewPacketConn(l)
|
||||||
|
if err = p.SetBPF(prog); err != nil {
|
||||||
|
t.Fatalf("failed to attach BPF program to listener: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
s, err := net.Dial("udp4", l.LocalAddr().String())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to dial connection to listener: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
done := func() {
|
||||||
|
_ = s.Close()
|
||||||
|
_ = l.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
return &osVirtualMachine{
|
||||||
|
l: l,
|
||||||
|
s: s,
|
||||||
|
}, done
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run sends the input bytes into the OS's BPF VM and returns its verdict.
|
||||||
|
func (vm *osVirtualMachine) Run(in []byte) (int, error) {
|
||||||
|
go func() {
|
||||||
|
_, _ = vm.s.Write(in)
|
||||||
|
}()
|
||||||
|
|
||||||
|
vm.l.SetDeadline(time.Now().Add(50 * time.Millisecond))
|
||||||
|
|
||||||
|
var b [512]byte
|
||||||
|
n, _, err := vm.l.ReadFrom(b[:])
|
||||||
|
if err != nil {
|
||||||
|
// A timeout indicates that BPF filtered out the packet, and thus,
|
||||||
|
// no input should be returned.
|
||||||
|
if nerr, ok := err.(net.Error); ok && nerr.Timeout() {
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return n, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
+49
@@ -0,0 +1,49 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"golang.org/x/net/bpf"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestVMLoadExtensionNotImplemented(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadExtension{
|
||||||
|
Num: 100,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "extension 100 not implemented" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadExtensionExtLen(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadExtension{
|
||||||
|
Num: bpf.ExtLen,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1, 2, 3,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 4, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
+174
@@ -0,0 +1,174 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/binary"
|
||||||
|
"fmt"
|
||||||
|
)
|
||||||
|
|
||||||
|
func aluOpConstant(ins ALUOpConstant, regA uint32) uint32 {
|
||||||
|
return aluOpCommon(ins.Op, regA, ins.Val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func aluOpX(ins ALUOpX, regA uint32, regX uint32) (uint32, bool) {
|
||||||
|
// Guard against division or modulus by zero by terminating
|
||||||
|
// the program, as the OS BPF VM does
|
||||||
|
if regX == 0 {
|
||||||
|
switch ins.Op {
|
||||||
|
case ALUOpDiv, ALUOpMod:
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return aluOpCommon(ins.Op, regA, regX), true
|
||||||
|
}
|
||||||
|
|
||||||
|
func aluOpCommon(op ALUOp, regA uint32, value uint32) uint32 {
|
||||||
|
switch op {
|
||||||
|
case ALUOpAdd:
|
||||||
|
return regA + value
|
||||||
|
case ALUOpSub:
|
||||||
|
return regA - value
|
||||||
|
case ALUOpMul:
|
||||||
|
return regA * value
|
||||||
|
case ALUOpDiv:
|
||||||
|
// Division by zero not permitted by NewVM and aluOpX checks
|
||||||
|
return regA / value
|
||||||
|
case ALUOpOr:
|
||||||
|
return regA | value
|
||||||
|
case ALUOpAnd:
|
||||||
|
return regA & value
|
||||||
|
case ALUOpShiftLeft:
|
||||||
|
return regA << value
|
||||||
|
case ALUOpShiftRight:
|
||||||
|
return regA >> value
|
||||||
|
case ALUOpMod:
|
||||||
|
// Modulus by zero not permitted by NewVM and aluOpX checks
|
||||||
|
return regA % value
|
||||||
|
case ALUOpXor:
|
||||||
|
return regA ^ value
|
||||||
|
default:
|
||||||
|
return regA
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func jumpIf(ins JumpIf, value uint32) int {
|
||||||
|
var ok bool
|
||||||
|
inV := uint32(ins.Val)
|
||||||
|
|
||||||
|
switch ins.Cond {
|
||||||
|
case JumpEqual:
|
||||||
|
ok = value == inV
|
||||||
|
case JumpNotEqual:
|
||||||
|
ok = value != inV
|
||||||
|
case JumpGreaterThan:
|
||||||
|
ok = value > inV
|
||||||
|
case JumpLessThan:
|
||||||
|
ok = value < inV
|
||||||
|
case JumpGreaterOrEqual:
|
||||||
|
ok = value >= inV
|
||||||
|
case JumpLessOrEqual:
|
||||||
|
ok = value <= inV
|
||||||
|
case JumpBitsSet:
|
||||||
|
ok = (value & inV) != 0
|
||||||
|
case JumpBitsNotSet:
|
||||||
|
ok = (value & inV) == 0
|
||||||
|
}
|
||||||
|
|
||||||
|
if ok {
|
||||||
|
return int(ins.SkipTrue)
|
||||||
|
}
|
||||||
|
|
||||||
|
return int(ins.SkipFalse)
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadAbsolute(ins LoadAbsolute, in []byte) (uint32, bool) {
|
||||||
|
offset := int(ins.Off)
|
||||||
|
size := int(ins.Size)
|
||||||
|
|
||||||
|
return loadCommon(in, offset, size)
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadConstant(ins LoadConstant, regA uint32, regX uint32) (uint32, uint32) {
|
||||||
|
switch ins.Dst {
|
||||||
|
case RegA:
|
||||||
|
regA = ins.Val
|
||||||
|
case RegX:
|
||||||
|
regX = ins.Val
|
||||||
|
}
|
||||||
|
|
||||||
|
return regA, regX
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadExtension(ins LoadExtension, in []byte) uint32 {
|
||||||
|
switch ins.Num {
|
||||||
|
case ExtLen:
|
||||||
|
return uint32(len(in))
|
||||||
|
default:
|
||||||
|
panic(fmt.Sprintf("unimplemented extension: %d", ins.Num))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadIndirect(ins LoadIndirect, in []byte, regX uint32) (uint32, bool) {
|
||||||
|
offset := int(ins.Off) + int(regX)
|
||||||
|
size := int(ins.Size)
|
||||||
|
|
||||||
|
return loadCommon(in, offset, size)
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadMemShift(ins LoadMemShift, in []byte) (uint32, bool) {
|
||||||
|
offset := int(ins.Off)
|
||||||
|
|
||||||
|
if !inBounds(len(in), offset, 0) {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mask off high 4 bits and multiply low 4 bits by 4
|
||||||
|
return uint32(in[offset]&0x0f) * 4, true
|
||||||
|
}
|
||||||
|
|
||||||
|
func inBounds(inLen int, offset int, size int) bool {
|
||||||
|
return offset+size <= inLen
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadCommon(in []byte, offset int, size int) (uint32, bool) {
|
||||||
|
if !inBounds(len(in), offset, size) {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
switch size {
|
||||||
|
case 1:
|
||||||
|
return uint32(in[offset]), true
|
||||||
|
case 2:
|
||||||
|
return uint32(binary.BigEndian.Uint16(in[offset : offset+size])), true
|
||||||
|
case 4:
|
||||||
|
return uint32(binary.BigEndian.Uint32(in[offset : offset+size])), true
|
||||||
|
default:
|
||||||
|
panic(fmt.Sprintf("invalid load size: %d", size))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadScratch(ins LoadScratch, regScratch [16]uint32, regA uint32, regX uint32) (uint32, uint32) {
|
||||||
|
switch ins.Dst {
|
||||||
|
case RegA:
|
||||||
|
regA = regScratch[ins.N]
|
||||||
|
case RegX:
|
||||||
|
regX = regScratch[ins.N]
|
||||||
|
}
|
||||||
|
|
||||||
|
return regA, regX
|
||||||
|
}
|
||||||
|
|
||||||
|
func storeScratch(ins StoreScratch, regScratch [16]uint32, regA uint32, regX uint32) [16]uint32 {
|
||||||
|
switch ins.Src {
|
||||||
|
case RegA:
|
||||||
|
regScratch[ins.N] = regA
|
||||||
|
case RegX:
|
||||||
|
regScratch[ins.N] = regX
|
||||||
|
}
|
||||||
|
|
||||||
|
return regScratch
|
||||||
|
}
|
||||||
+380
@@ -0,0 +1,380 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"golang.org/x/net/bpf"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestVMJumpOne(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.Jump{
|
||||||
|
Skip: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 9,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
1,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpOutOfProgram(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.Jump{
|
||||||
|
Skip: 1,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "cannot jump 1 instructions; jumping past program bounds" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfTrueOutOfProgram(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
SkipTrue: 2,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "cannot jump 2 instructions in true case; jumping past program bounds" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfFalseOutOfProgram(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
SkipFalse: 3,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "cannot jump 3 instructions in false case; jumping past program bounds" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfEqual(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
Val: 1,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 9,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
1,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfNotEqual(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpNotEqual,
|
||||||
|
Val: 1,
|
||||||
|
SkipFalse: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 9,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
1,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfGreaterThan(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 4,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpGreaterThan,
|
||||||
|
Val: 0x00010202,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 12,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1, 2, 3,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 4, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfLessThan(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 4,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpLessThan,
|
||||||
|
Val: 0xff010203,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 12,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1, 2, 3,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 4, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfGreaterOrEqual(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 4,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpGreaterOrEqual,
|
||||||
|
Val: 0x00010203,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 12,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1, 2, 3,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 4, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfLessOrEqual(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 4,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpLessOrEqual,
|
||||||
|
Val: 0xff010203,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 12,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1, 2, 3,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 4, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfBitsSet(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 2,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpBitsSet,
|
||||||
|
Val: 0x1122,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 10,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0x01, 0x02,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 2, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMJumpIfBitsNotSet(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 2,
|
||||||
|
},
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpBitsNotSet,
|
||||||
|
Val: 0x1221,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 10,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0x01, 0x02,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 2, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
+246
@@ -0,0 +1,246 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"golang.org/x/net/bpf"
|
||||||
|
"golang.org/x/net/ipv4"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestVMLoadAbsoluteOffsetOutOfBounds(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 100,
|
||||||
|
Size: 2,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1, 2, 3,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 0, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadAbsoluteOffsetPlusSizeOutOfBounds(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 2,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 0, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadAbsoluteBadInstructionSize(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Size: 5,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "assembling instruction 1: invalid load byte length 0" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadConstantOK(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadConstant{
|
||||||
|
Dst: bpf.RegX,
|
||||||
|
Val: 9,
|
||||||
|
},
|
||||||
|
bpf.TXA{},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadIndirectOutOfBounds(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadIndirect{
|
||||||
|
Off: 100,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 0, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadMemShiftOutOfBounds(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadMemShift{
|
||||||
|
Off: 100,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 0, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
dhcp4Port = 53
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestVMLoadMemShiftLoadIndirectNoResult(t *testing.T) {
|
||||||
|
vm, in, done := testDHCPv4(t)
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
// Append mostly empty UDP header with incorrect DHCPv4 port
|
||||||
|
in = append(in, []byte{
|
||||||
|
0, 0,
|
||||||
|
0, dhcp4Port + 1,
|
||||||
|
0, 0,
|
||||||
|
0, 0,
|
||||||
|
}...)
|
||||||
|
|
||||||
|
out, err := vm.Run(in)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 0, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadMemShiftLoadIndirectOK(t *testing.T) {
|
||||||
|
vm, in, done := testDHCPv4(t)
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
// Append mostly empty UDP header with correct DHCPv4 port
|
||||||
|
in = append(in, []byte{
|
||||||
|
0, 0,
|
||||||
|
0, dhcp4Port,
|
||||||
|
0, 0,
|
||||||
|
0, 0,
|
||||||
|
}...)
|
||||||
|
|
||||||
|
out, err := vm.Run(in)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := len(in)-8, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testDHCPv4(t *testing.T) (virtualMachine, []byte, func()) {
|
||||||
|
// DHCPv4 test data courtesy of David Anderson:
|
||||||
|
// https://github.com/google/netboot/blob/master/dhcp4/conn_linux.go#L59-L70
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
// Load IPv4 packet length
|
||||||
|
bpf.LoadMemShift{Off: 8},
|
||||||
|
// Get UDP dport
|
||||||
|
bpf.LoadIndirect{Off: 8 + 2, Size: 2},
|
||||||
|
// Correct dport?
|
||||||
|
bpf.JumpIf{Cond: bpf.JumpEqual, Val: dhcp4Port, SkipFalse: 1},
|
||||||
|
// Accept
|
||||||
|
bpf.RetConstant{Val: 1500},
|
||||||
|
// Ignore
|
||||||
|
bpf.RetConstant{Val: 0},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Minimal requirements to make a valid IPv4 header
|
||||||
|
h := &ipv4.Header{
|
||||||
|
Len: ipv4.HeaderLen,
|
||||||
|
Src: net.IPv4(192, 168, 1, 1),
|
||||||
|
Dst: net.IPv4(192, 168, 1, 2),
|
||||||
|
}
|
||||||
|
hb, err := h.Marshal()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to marshal IPv4 header: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
hb = append([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
}, hb...)
|
||||||
|
|
||||||
|
return vm, hb, done
|
||||||
|
}
|
||||||
+115
@@ -0,0 +1,115 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"golang.org/x/net/bpf"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestVMRetA(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
9,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMRetALargerThanInput(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 2,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 255,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 2, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMRetConstant(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 9,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 1, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMRetConstantLargerThanInput(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 16,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0, 1,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 2, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
+247
@@ -0,0 +1,247 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"golang.org/x/net/bpf"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestVMStoreScratchInvalidScratchRegisterTooSmall(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.StoreScratch{
|
||||||
|
Src: bpf.RegA,
|
||||||
|
N: -1,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "assembling instruction 1: invalid scratch slot -1" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMStoreScratchInvalidScratchRegisterTooLarge(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.StoreScratch{
|
||||||
|
Src: bpf.RegA,
|
||||||
|
N: 16,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "assembling instruction 1: invalid scratch slot 16" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMStoreScratchUnknownSourceRegister(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.StoreScratch{
|
||||||
|
Src: 100,
|
||||||
|
N: 0,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "assembling instruction 1: invalid source register 100" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadScratchInvalidScratchRegisterTooSmall(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadScratch{
|
||||||
|
Dst: bpf.RegX,
|
||||||
|
N: -1,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "assembling instruction 1: invalid scratch slot -1" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadScratchInvalidScratchRegisterTooLarge(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadScratch{
|
||||||
|
Dst: bpf.RegX,
|
||||||
|
N: 16,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "assembling instruction 1: invalid scratch slot 16" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMLoadScratchUnknownDestinationRegister(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadScratch{
|
||||||
|
Dst: 100,
|
||||||
|
N: 0,
|
||||||
|
},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if errStr(err) != "assembling instruction 1: invalid target register 100" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMStoreScratchLoadScratchOneValue(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
// Load byte 255
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
// Copy to X and store in scratch[0]
|
||||||
|
bpf.TAX{},
|
||||||
|
bpf.StoreScratch{
|
||||||
|
Src: bpf.RegX,
|
||||||
|
N: 0,
|
||||||
|
},
|
||||||
|
// Load byte 1
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 9,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
// Overwrite 1 with 255 from scratch[0]
|
||||||
|
bpf.LoadScratch{
|
||||||
|
Dst: bpf.RegA,
|
||||||
|
N: 0,
|
||||||
|
},
|
||||||
|
// Return 255
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
255, 1, 2,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 3, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMStoreScratchLoadScratchMultipleValues(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
// Load byte 10
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 8,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
// Store in scratch[0]
|
||||||
|
bpf.StoreScratch{
|
||||||
|
Src: bpf.RegA,
|
||||||
|
N: 0,
|
||||||
|
},
|
||||||
|
// Load byte 20
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 9,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
// Store in scratch[1]
|
||||||
|
bpf.StoreScratch{
|
||||||
|
Src: bpf.RegA,
|
||||||
|
N: 1,
|
||||||
|
},
|
||||||
|
// Load byte 30
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 10,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
// Store in scratch[2]
|
||||||
|
bpf.StoreScratch{
|
||||||
|
Src: bpf.RegA,
|
||||||
|
N: 2,
|
||||||
|
},
|
||||||
|
// Load byte 1
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: 11,
|
||||||
|
Size: 1,
|
||||||
|
},
|
||||||
|
// Store in scratch[3]
|
||||||
|
bpf.StoreScratch{
|
||||||
|
Src: bpf.RegA,
|
||||||
|
N: 3,
|
||||||
|
},
|
||||||
|
// Load in byte 10 to X
|
||||||
|
bpf.LoadScratch{
|
||||||
|
Dst: bpf.RegX,
|
||||||
|
N: 0,
|
||||||
|
},
|
||||||
|
// Copy X -> A
|
||||||
|
bpf.TXA{},
|
||||||
|
// Verify value is 10
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
Val: 10,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
// Fail test if incorrect
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
// Load in byte 20 to A
|
||||||
|
bpf.LoadScratch{
|
||||||
|
Dst: bpf.RegA,
|
||||||
|
N: 1,
|
||||||
|
},
|
||||||
|
// Verify value is 20
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
Val: 20,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
// Fail test if incorrect
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
// Load in byte 30 to A
|
||||||
|
bpf.LoadScratch{
|
||||||
|
Dst: bpf.RegA,
|
||||||
|
N: 2,
|
||||||
|
},
|
||||||
|
// Verify value is 30
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
Val: 30,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
// Fail test if incorrect
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
// Return first two bytes on success
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 10,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to load BPF program: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
out, err := vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
10, 20, 30, 1,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
if want, got := 2, out; want != got {
|
||||||
|
t.Fatalf("unexpected number of output bytes:\n- want: %d\n- got: %d",
|
||||||
|
want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
+144
@@ -0,0 +1,144 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package bpf_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"golang.org/x/net/bpf"
|
||||||
|
)
|
||||||
|
|
||||||
|
var _ bpf.Instruction = unknown{}
|
||||||
|
|
||||||
|
type unknown struct{}
|
||||||
|
|
||||||
|
func (unknown) Assemble() (bpf.RawInstruction, error) {
|
||||||
|
return bpf.RawInstruction{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMUnknownInstruction(t *testing.T) {
|
||||||
|
vm, done, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadConstant{
|
||||||
|
Dst: bpf.RegA,
|
||||||
|
Val: 100,
|
||||||
|
},
|
||||||
|
// Should terminate the program with an error immediately
|
||||||
|
unknown{},
|
||||||
|
bpf.RetA{},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
defer done()
|
||||||
|
|
||||||
|
_, err = vm.Run([]byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xff, 0xff, 0xff, 0xff,
|
||||||
|
0x00, 0x00,
|
||||||
|
})
|
||||||
|
if errStr(err) != "unknown Instruction at index 1: bpf_test.unknown" {
|
||||||
|
t.Fatalf("unexpected error while running program: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMNoReturnInstruction(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{
|
||||||
|
bpf.LoadConstant{
|
||||||
|
Dst: bpf.RegA,
|
||||||
|
Val: 1,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if errStr(err) != "BPF program must end with RetA or RetConstant" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVMNoInputInstructions(t *testing.T) {
|
||||||
|
_, _, err := testVM(t, []bpf.Instruction{})
|
||||||
|
if errStr(err) != "one or more Instructions must be specified" {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExampleNewVM demonstrates usage of a VM, using an Ethernet frame
|
||||||
|
// as input and checking its EtherType to determine if it should be accepted.
|
||||||
|
func ExampleNewVM() {
|
||||||
|
// Offset | Length | Comment
|
||||||
|
// -------------------------
|
||||||
|
// 00 | 06 | Ethernet destination MAC address
|
||||||
|
// 06 | 06 | Ethernet source MAC address
|
||||||
|
// 12 | 02 | Ethernet EtherType
|
||||||
|
const (
|
||||||
|
etOff = 12
|
||||||
|
etLen = 2
|
||||||
|
|
||||||
|
etARP = 0x0806
|
||||||
|
)
|
||||||
|
|
||||||
|
// Set up a VM to filter traffic based on if its EtherType
|
||||||
|
// matches the ARP EtherType.
|
||||||
|
vm, err := bpf.NewVM([]bpf.Instruction{
|
||||||
|
// Load EtherType value from Ethernet header
|
||||||
|
bpf.LoadAbsolute{
|
||||||
|
Off: etOff,
|
||||||
|
Size: etLen,
|
||||||
|
},
|
||||||
|
// If EtherType is equal to the ARP EtherType, jump to allow
|
||||||
|
// packet to be accepted
|
||||||
|
bpf.JumpIf{
|
||||||
|
Cond: bpf.JumpEqual,
|
||||||
|
Val: etARP,
|
||||||
|
SkipTrue: 1,
|
||||||
|
},
|
||||||
|
// EtherType does not match the ARP EtherType
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 0,
|
||||||
|
},
|
||||||
|
// EtherType matches the ARP EtherType, accept up to 1500
|
||||||
|
// bytes of packet
|
||||||
|
bpf.RetConstant{
|
||||||
|
Val: 1500,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
panic(fmt.Sprintf("failed to load BPF program: %v", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create an Ethernet frame with the ARP EtherType for testing
|
||||||
|
frame := []byte{
|
||||||
|
0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
|
||||||
|
0x00, 0x11, 0x22, 0x33, 0x44, 0x55,
|
||||||
|
0x08, 0x06,
|
||||||
|
// Payload omitted for brevity
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run our VM's BPF program using the Ethernet frame as input
|
||||||
|
out, err := vm.Run(frame)
|
||||||
|
if err != nil {
|
||||||
|
panic(fmt.Sprintf("failed to accept Ethernet frame: %v", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
// BPF VM can return a byte count greater than the number of input
|
||||||
|
// bytes, so trim the output to match the input byte length
|
||||||
|
if out > len(frame) {
|
||||||
|
out = len(frame)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Printf("out: %d bytes", out)
|
||||||
|
|
||||||
|
// Output:
|
||||||
|
// out: 14 bytes
|
||||||
|
}
|
||||||
|
|
||||||
|
// errStr returns the string representation of an error, or
|
||||||
|
// "<nil>" if it is nil.
|
||||||
|
func errStr(err error) string {
|
||||||
|
if err == nil {
|
||||||
|
return "<nil>"
|
||||||
|
}
|
||||||
|
|
||||||
|
return err.Error()
|
||||||
|
}
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
issuerepo: golang/go
|
||||||
+156
@@ -0,0 +1,156 @@
|
|||||||
|
// Copyright 2014 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// Package context defines the Context type, which carries deadlines,
|
||||||
|
// cancelation signals, and other request-scoped values across API boundaries
|
||||||
|
// and between processes.
|
||||||
|
//
|
||||||
|
// Incoming requests to a server should create a Context, and outgoing calls to
|
||||||
|
// servers should accept a Context. The chain of function calls between must
|
||||||
|
// propagate the Context, optionally replacing it with a modified copy created
|
||||||
|
// using WithDeadline, WithTimeout, WithCancel, or WithValue.
|
||||||
|
//
|
||||||
|
// Programs that use Contexts should follow these rules to keep interfaces
|
||||||
|
// consistent across packages and enable static analysis tools to check context
|
||||||
|
// propagation:
|
||||||
|
//
|
||||||
|
// Do not store Contexts inside a struct type; instead, pass a Context
|
||||||
|
// explicitly to each function that needs it. The Context should be the first
|
||||||
|
// parameter, typically named ctx:
|
||||||
|
//
|
||||||
|
// func DoSomething(ctx context.Context, arg Arg) error {
|
||||||
|
// // ... use ctx ...
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Do not pass a nil Context, even if a function permits it. Pass context.TODO
|
||||||
|
// if you are unsure about which Context to use.
|
||||||
|
//
|
||||||
|
// Use context Values only for request-scoped data that transits processes and
|
||||||
|
// APIs, not for passing optional parameters to functions.
|
||||||
|
//
|
||||||
|
// The same Context may be passed to functions running in different goroutines;
|
||||||
|
// Contexts are safe for simultaneous use by multiple goroutines.
|
||||||
|
//
|
||||||
|
// See http://blog.golang.org/context for example code for a server that uses
|
||||||
|
// Contexts.
|
||||||
|
package context // import "golang.org/x/net/context"
|
||||||
|
|
||||||
|
import "time"
|
||||||
|
|
||||||
|
// A Context carries a deadline, a cancelation signal, and other values across
|
||||||
|
// API boundaries.
|
||||||
|
//
|
||||||
|
// Context's methods may be called by multiple goroutines simultaneously.
|
||||||
|
type Context interface {
|
||||||
|
// Deadline returns the time when work done on behalf of this context
|
||||||
|
// should be canceled. Deadline returns ok==false when no deadline is
|
||||||
|
// set. Successive calls to Deadline return the same results.
|
||||||
|
Deadline() (deadline time.Time, ok bool)
|
||||||
|
|
||||||
|
// Done returns a channel that's closed when work done on behalf of this
|
||||||
|
// context should be canceled. Done may return nil if this context can
|
||||||
|
// never be canceled. Successive calls to Done return the same value.
|
||||||
|
//
|
||||||
|
// WithCancel arranges for Done to be closed when cancel is called;
|
||||||
|
// WithDeadline arranges for Done to be closed when the deadline
|
||||||
|
// expires; WithTimeout arranges for Done to be closed when the timeout
|
||||||
|
// elapses.
|
||||||
|
//
|
||||||
|
// Done is provided for use in select statements:
|
||||||
|
//
|
||||||
|
// // Stream generates values with DoSomething and sends them to out
|
||||||
|
// // until DoSomething returns an error or ctx.Done is closed.
|
||||||
|
// func Stream(ctx context.Context, out chan<- Value) error {
|
||||||
|
// for {
|
||||||
|
// v, err := DoSomething(ctx)
|
||||||
|
// if err != nil {
|
||||||
|
// return err
|
||||||
|
// }
|
||||||
|
// select {
|
||||||
|
// case <-ctx.Done():
|
||||||
|
// return ctx.Err()
|
||||||
|
// case out <- v:
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// See http://blog.golang.org/pipelines for more examples of how to use
|
||||||
|
// a Done channel for cancelation.
|
||||||
|
Done() <-chan struct{}
|
||||||
|
|
||||||
|
// Err returns a non-nil error value after Done is closed. Err returns
|
||||||
|
// Canceled if the context was canceled or DeadlineExceeded if the
|
||||||
|
// context's deadline passed. No other values for Err are defined.
|
||||||
|
// After Done is closed, successive calls to Err return the same value.
|
||||||
|
Err() error
|
||||||
|
|
||||||
|
// Value returns the value associated with this context for key, or nil
|
||||||
|
// if no value is associated with key. Successive calls to Value with
|
||||||
|
// the same key returns the same result.
|
||||||
|
//
|
||||||
|
// Use context values only for request-scoped data that transits
|
||||||
|
// processes and API boundaries, not for passing optional parameters to
|
||||||
|
// functions.
|
||||||
|
//
|
||||||
|
// A key identifies a specific value in a Context. Functions that wish
|
||||||
|
// to store values in Context typically allocate a key in a global
|
||||||
|
// variable then use that key as the argument to context.WithValue and
|
||||||
|
// Context.Value. A key can be any type that supports equality;
|
||||||
|
// packages should define keys as an unexported type to avoid
|
||||||
|
// collisions.
|
||||||
|
//
|
||||||
|
// Packages that define a Context key should provide type-safe accessors
|
||||||
|
// for the values stores using that key:
|
||||||
|
//
|
||||||
|
// // Package user defines a User type that's stored in Contexts.
|
||||||
|
// package user
|
||||||
|
//
|
||||||
|
// import "golang.org/x/net/context"
|
||||||
|
//
|
||||||
|
// // User is the type of value stored in the Contexts.
|
||||||
|
// type User struct {...}
|
||||||
|
//
|
||||||
|
// // key is an unexported type for keys defined in this package.
|
||||||
|
// // This prevents collisions with keys defined in other packages.
|
||||||
|
// type key int
|
||||||
|
//
|
||||||
|
// // userKey is the key for user.User values in Contexts. It is
|
||||||
|
// // unexported; clients use user.NewContext and user.FromContext
|
||||||
|
// // instead of using this key directly.
|
||||||
|
// var userKey key = 0
|
||||||
|
//
|
||||||
|
// // NewContext returns a new Context that carries value u.
|
||||||
|
// func NewContext(ctx context.Context, u *User) context.Context {
|
||||||
|
// return context.WithValue(ctx, userKey, u)
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// // FromContext returns the User value stored in ctx, if any.
|
||||||
|
// func FromContext(ctx context.Context) (*User, bool) {
|
||||||
|
// u, ok := ctx.Value(userKey).(*User)
|
||||||
|
// return u, ok
|
||||||
|
// }
|
||||||
|
Value(key interface{}) interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Background returns a non-nil, empty Context. It is never canceled, has no
|
||||||
|
// values, and has no deadline. It is typically used by the main function,
|
||||||
|
// initialization, and tests, and as the top-level Context for incoming
|
||||||
|
// requests.
|
||||||
|
func Background() Context {
|
||||||
|
return background
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO returns a non-nil, empty Context. Code should use context.TODO when
|
||||||
|
// it's unclear which Context to use or it is not yet available (because the
|
||||||
|
// surrounding function has not yet been extended to accept a Context
|
||||||
|
// parameter). TODO is recognized by static analysis tools that determine
|
||||||
|
// whether Contexts are propagated correctly in a program.
|
||||||
|
func TODO() Context {
|
||||||
|
return todo
|
||||||
|
}
|
||||||
|
|
||||||
|
// A CancelFunc tells an operation to abandon its work.
|
||||||
|
// A CancelFunc does not wait for the work to stop.
|
||||||
|
// After the first call, subsequent calls to a CancelFunc do nothing.
|
||||||
|
type CancelFunc func()
|
||||||
+583
@@ -0,0 +1,583 @@
|
|||||||
|
// Copyright 2014 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// +build !go1.7
|
||||||
|
|
||||||
|
package context
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"math/rand"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// otherContext is a Context that's not one of the types defined in context.go.
|
||||||
|
// This lets us test code paths that differ based on the underlying type of the
|
||||||
|
// Context.
|
||||||
|
type otherContext struct {
|
||||||
|
Context
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBackground(t *testing.T) {
|
||||||
|
c := Background()
|
||||||
|
if c == nil {
|
||||||
|
t.Fatalf("Background returned nil")
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case x := <-c.Done():
|
||||||
|
t.Errorf("<-c.Done() == %v want nothing (it should block)", x)
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
if got, want := fmt.Sprint(c), "context.Background"; got != want {
|
||||||
|
t.Errorf("Background().String() = %q want %q", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTODO(t *testing.T) {
|
||||||
|
c := TODO()
|
||||||
|
if c == nil {
|
||||||
|
t.Fatalf("TODO returned nil")
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case x := <-c.Done():
|
||||||
|
t.Errorf("<-c.Done() == %v want nothing (it should block)", x)
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
if got, want := fmt.Sprint(c), "context.TODO"; got != want {
|
||||||
|
t.Errorf("TODO().String() = %q want %q", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithCancel(t *testing.T) {
|
||||||
|
c1, cancel := WithCancel(Background())
|
||||||
|
|
||||||
|
if got, want := fmt.Sprint(c1), "context.Background.WithCancel"; got != want {
|
||||||
|
t.Errorf("c1.String() = %q want %q", got, want)
|
||||||
|
}
|
||||||
|
|
||||||
|
o := otherContext{c1}
|
||||||
|
c2, _ := WithCancel(o)
|
||||||
|
contexts := []Context{c1, o, c2}
|
||||||
|
|
||||||
|
for i, c := range contexts {
|
||||||
|
if d := c.Done(); d == nil {
|
||||||
|
t.Errorf("c[%d].Done() == %v want non-nil", i, d)
|
||||||
|
}
|
||||||
|
if e := c.Err(); e != nil {
|
||||||
|
t.Errorf("c[%d].Err() == %v want nil", i, e)
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
case x := <-c.Done():
|
||||||
|
t.Errorf("<-c.Done() == %v want nothing (it should block)", x)
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cancel()
|
||||||
|
time.Sleep(100 * time.Millisecond) // let cancelation propagate
|
||||||
|
|
||||||
|
for i, c := range contexts {
|
||||||
|
select {
|
||||||
|
case <-c.Done():
|
||||||
|
default:
|
||||||
|
t.Errorf("<-c[%d].Done() blocked, but shouldn't have", i)
|
||||||
|
}
|
||||||
|
if e := c.Err(); e != Canceled {
|
||||||
|
t.Errorf("c[%d].Err() == %v want %v", i, e, Canceled)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParentFinishesChild(t *testing.T) {
|
||||||
|
// Context tree:
|
||||||
|
// parent -> cancelChild
|
||||||
|
// parent -> valueChild -> timerChild
|
||||||
|
parent, cancel := WithCancel(Background())
|
||||||
|
cancelChild, stop := WithCancel(parent)
|
||||||
|
defer stop()
|
||||||
|
valueChild := WithValue(parent, "key", "value")
|
||||||
|
timerChild, stop := WithTimeout(valueChild, 10000*time.Hour)
|
||||||
|
defer stop()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case x := <-parent.Done():
|
||||||
|
t.Errorf("<-parent.Done() == %v want nothing (it should block)", x)
|
||||||
|
case x := <-cancelChild.Done():
|
||||||
|
t.Errorf("<-cancelChild.Done() == %v want nothing (it should block)", x)
|
||||||
|
case x := <-timerChild.Done():
|
||||||
|
t.Errorf("<-timerChild.Done() == %v want nothing (it should block)", x)
|
||||||
|
case x := <-valueChild.Done():
|
||||||
|
t.Errorf("<-valueChild.Done() == %v want nothing (it should block)", x)
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
// The parent's children should contain the two cancelable children.
|
||||||
|
pc := parent.(*cancelCtx)
|
||||||
|
cc := cancelChild.(*cancelCtx)
|
||||||
|
tc := timerChild.(*timerCtx)
|
||||||
|
pc.mu.Lock()
|
||||||
|
if len(pc.children) != 2 || !pc.children[cc] || !pc.children[tc] {
|
||||||
|
t.Errorf("bad linkage: pc.children = %v, want %v and %v",
|
||||||
|
pc.children, cc, tc)
|
||||||
|
}
|
||||||
|
pc.mu.Unlock()
|
||||||
|
|
||||||
|
if p, ok := parentCancelCtx(cc.Context); !ok || p != pc {
|
||||||
|
t.Errorf("bad linkage: parentCancelCtx(cancelChild.Context) = %v, %v want %v, true", p, ok, pc)
|
||||||
|
}
|
||||||
|
if p, ok := parentCancelCtx(tc.Context); !ok || p != pc {
|
||||||
|
t.Errorf("bad linkage: parentCancelCtx(timerChild.Context) = %v, %v want %v, true", p, ok, pc)
|
||||||
|
}
|
||||||
|
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
pc.mu.Lock()
|
||||||
|
if len(pc.children) != 0 {
|
||||||
|
t.Errorf("pc.cancel didn't clear pc.children = %v", pc.children)
|
||||||
|
}
|
||||||
|
pc.mu.Unlock()
|
||||||
|
|
||||||
|
// parent and children should all be finished.
|
||||||
|
check := func(ctx Context, name string) {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
default:
|
||||||
|
t.Errorf("<-%s.Done() blocked, but shouldn't have", name)
|
||||||
|
}
|
||||||
|
if e := ctx.Err(); e != Canceled {
|
||||||
|
t.Errorf("%s.Err() == %v want %v", name, e, Canceled)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
check(parent, "parent")
|
||||||
|
check(cancelChild, "cancelChild")
|
||||||
|
check(valueChild, "valueChild")
|
||||||
|
check(timerChild, "timerChild")
|
||||||
|
|
||||||
|
// WithCancel should return a canceled context on a canceled parent.
|
||||||
|
precanceledChild := WithValue(parent, "key", "value")
|
||||||
|
select {
|
||||||
|
case <-precanceledChild.Done():
|
||||||
|
default:
|
||||||
|
t.Errorf("<-precanceledChild.Done() blocked, but shouldn't have")
|
||||||
|
}
|
||||||
|
if e := precanceledChild.Err(); e != Canceled {
|
||||||
|
t.Errorf("precanceledChild.Err() == %v want %v", e, Canceled)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestChildFinishesFirst(t *testing.T) {
|
||||||
|
cancelable, stop := WithCancel(Background())
|
||||||
|
defer stop()
|
||||||
|
for _, parent := range []Context{Background(), cancelable} {
|
||||||
|
child, cancel := WithCancel(parent)
|
||||||
|
|
||||||
|
select {
|
||||||
|
case x := <-parent.Done():
|
||||||
|
t.Errorf("<-parent.Done() == %v want nothing (it should block)", x)
|
||||||
|
case x := <-child.Done():
|
||||||
|
t.Errorf("<-child.Done() == %v want nothing (it should block)", x)
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
cc := child.(*cancelCtx)
|
||||||
|
pc, pcok := parent.(*cancelCtx) // pcok == false when parent == Background()
|
||||||
|
if p, ok := parentCancelCtx(cc.Context); ok != pcok || (ok && pc != p) {
|
||||||
|
t.Errorf("bad linkage: parentCancelCtx(cc.Context) = %v, %v want %v, %v", p, ok, pc, pcok)
|
||||||
|
}
|
||||||
|
|
||||||
|
if pcok {
|
||||||
|
pc.mu.Lock()
|
||||||
|
if len(pc.children) != 1 || !pc.children[cc] {
|
||||||
|
t.Errorf("bad linkage: pc.children = %v, cc = %v", pc.children, cc)
|
||||||
|
}
|
||||||
|
pc.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
if pcok {
|
||||||
|
pc.mu.Lock()
|
||||||
|
if len(pc.children) != 0 {
|
||||||
|
t.Errorf("child's cancel didn't remove self from pc.children = %v", pc.children)
|
||||||
|
}
|
||||||
|
pc.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// child should be finished.
|
||||||
|
select {
|
||||||
|
case <-child.Done():
|
||||||
|
default:
|
||||||
|
t.Errorf("<-child.Done() blocked, but shouldn't have")
|
||||||
|
}
|
||||||
|
if e := child.Err(); e != Canceled {
|
||||||
|
t.Errorf("child.Err() == %v want %v", e, Canceled)
|
||||||
|
}
|
||||||
|
|
||||||
|
// parent should not be finished.
|
||||||
|
select {
|
||||||
|
case x := <-parent.Done():
|
||||||
|
t.Errorf("<-parent.Done() == %v want nothing (it should block)", x)
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
if e := parent.Err(); e != nil {
|
||||||
|
t.Errorf("parent.Err() == %v want nil", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testDeadline(c Context, wait time.Duration, t *testing.T) {
|
||||||
|
select {
|
||||||
|
case <-time.After(wait):
|
||||||
|
t.Fatalf("context should have timed out")
|
||||||
|
case <-c.Done():
|
||||||
|
}
|
||||||
|
if e := c.Err(); e != DeadlineExceeded {
|
||||||
|
t.Errorf("c.Err() == %v want %v", e, DeadlineExceeded)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeadline(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
const timeUnit = 500 * time.Millisecond
|
||||||
|
c, _ := WithDeadline(Background(), time.Now().Add(1*timeUnit))
|
||||||
|
if got, prefix := fmt.Sprint(c), "context.Background.WithDeadline("; !strings.HasPrefix(got, prefix) {
|
||||||
|
t.Errorf("c.String() = %q want prefix %q", got, prefix)
|
||||||
|
}
|
||||||
|
testDeadline(c, 2*timeUnit, t)
|
||||||
|
|
||||||
|
c, _ = WithDeadline(Background(), time.Now().Add(1*timeUnit))
|
||||||
|
o := otherContext{c}
|
||||||
|
testDeadline(o, 2*timeUnit, t)
|
||||||
|
|
||||||
|
c, _ = WithDeadline(Background(), time.Now().Add(1*timeUnit))
|
||||||
|
o = otherContext{c}
|
||||||
|
c, _ = WithDeadline(o, time.Now().Add(3*timeUnit))
|
||||||
|
testDeadline(c, 2*timeUnit, t)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTimeout(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
const timeUnit = 500 * time.Millisecond
|
||||||
|
c, _ := WithTimeout(Background(), 1*timeUnit)
|
||||||
|
if got, prefix := fmt.Sprint(c), "context.Background.WithDeadline("; !strings.HasPrefix(got, prefix) {
|
||||||
|
t.Errorf("c.String() = %q want prefix %q", got, prefix)
|
||||||
|
}
|
||||||
|
testDeadline(c, 2*timeUnit, t)
|
||||||
|
|
||||||
|
c, _ = WithTimeout(Background(), 1*timeUnit)
|
||||||
|
o := otherContext{c}
|
||||||
|
testDeadline(o, 2*timeUnit, t)
|
||||||
|
|
||||||
|
c, _ = WithTimeout(Background(), 1*timeUnit)
|
||||||
|
o = otherContext{c}
|
||||||
|
c, _ = WithTimeout(o, 3*timeUnit)
|
||||||
|
testDeadline(c, 2*timeUnit, t)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCanceledTimeout(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
const timeUnit = 500 * time.Millisecond
|
||||||
|
c, _ := WithTimeout(Background(), 2*timeUnit)
|
||||||
|
o := otherContext{c}
|
||||||
|
c, cancel := WithTimeout(o, 4*timeUnit)
|
||||||
|
cancel()
|
||||||
|
time.Sleep(1 * timeUnit) // let cancelation propagate
|
||||||
|
select {
|
||||||
|
case <-c.Done():
|
||||||
|
default:
|
||||||
|
t.Errorf("<-c.Done() blocked, but shouldn't have")
|
||||||
|
}
|
||||||
|
if e := c.Err(); e != Canceled {
|
||||||
|
t.Errorf("c.Err() == %v want %v", e, Canceled)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type key1 int
|
||||||
|
type key2 int
|
||||||
|
|
||||||
|
var k1 = key1(1)
|
||||||
|
var k2 = key2(1) // same int as k1, different type
|
||||||
|
var k3 = key2(3) // same type as k2, different int
|
||||||
|
|
||||||
|
func TestValues(t *testing.T) {
|
||||||
|
check := func(c Context, nm, v1, v2, v3 string) {
|
||||||
|
if v, ok := c.Value(k1).(string); ok == (len(v1) == 0) || v != v1 {
|
||||||
|
t.Errorf(`%s.Value(k1).(string) = %q, %t want %q, %t`, nm, v, ok, v1, len(v1) != 0)
|
||||||
|
}
|
||||||
|
if v, ok := c.Value(k2).(string); ok == (len(v2) == 0) || v != v2 {
|
||||||
|
t.Errorf(`%s.Value(k2).(string) = %q, %t want %q, %t`, nm, v, ok, v2, len(v2) != 0)
|
||||||
|
}
|
||||||
|
if v, ok := c.Value(k3).(string); ok == (len(v3) == 0) || v != v3 {
|
||||||
|
t.Errorf(`%s.Value(k3).(string) = %q, %t want %q, %t`, nm, v, ok, v3, len(v3) != 0)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
c0 := Background()
|
||||||
|
check(c0, "c0", "", "", "")
|
||||||
|
|
||||||
|
c1 := WithValue(Background(), k1, "c1k1")
|
||||||
|
check(c1, "c1", "c1k1", "", "")
|
||||||
|
|
||||||
|
if got, want := fmt.Sprint(c1), `context.Background.WithValue(1, "c1k1")`; got != want {
|
||||||
|
t.Errorf("c.String() = %q want %q", got, want)
|
||||||
|
}
|
||||||
|
|
||||||
|
c2 := WithValue(c1, k2, "c2k2")
|
||||||
|
check(c2, "c2", "c1k1", "c2k2", "")
|
||||||
|
|
||||||
|
c3 := WithValue(c2, k3, "c3k3")
|
||||||
|
check(c3, "c2", "c1k1", "c2k2", "c3k3")
|
||||||
|
|
||||||
|
c4 := WithValue(c3, k1, nil)
|
||||||
|
check(c4, "c4", "", "c2k2", "c3k3")
|
||||||
|
|
||||||
|
o0 := otherContext{Background()}
|
||||||
|
check(o0, "o0", "", "", "")
|
||||||
|
|
||||||
|
o1 := otherContext{WithValue(Background(), k1, "c1k1")}
|
||||||
|
check(o1, "o1", "c1k1", "", "")
|
||||||
|
|
||||||
|
o2 := WithValue(o1, k2, "o2k2")
|
||||||
|
check(o2, "o2", "c1k1", "o2k2", "")
|
||||||
|
|
||||||
|
o3 := otherContext{c4}
|
||||||
|
check(o3, "o3", "", "c2k2", "c3k3")
|
||||||
|
|
||||||
|
o4 := WithValue(o3, k3, nil)
|
||||||
|
check(o4, "o4", "", "c2k2", "")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAllocs(t *testing.T) {
|
||||||
|
bg := Background()
|
||||||
|
for _, test := range []struct {
|
||||||
|
desc string
|
||||||
|
f func()
|
||||||
|
limit float64
|
||||||
|
gccgoLimit float64
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
desc: "Background()",
|
||||||
|
f: func() { Background() },
|
||||||
|
limit: 0,
|
||||||
|
gccgoLimit: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: fmt.Sprintf("WithValue(bg, %v, nil)", k1),
|
||||||
|
f: func() {
|
||||||
|
c := WithValue(bg, k1, nil)
|
||||||
|
c.Value(k1)
|
||||||
|
},
|
||||||
|
limit: 3,
|
||||||
|
gccgoLimit: 3,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "WithTimeout(bg, 15*time.Millisecond)",
|
||||||
|
f: func() {
|
||||||
|
c, _ := WithTimeout(bg, 15*time.Millisecond)
|
||||||
|
<-c.Done()
|
||||||
|
},
|
||||||
|
limit: 8,
|
||||||
|
gccgoLimit: 16,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "WithCancel(bg)",
|
||||||
|
f: func() {
|
||||||
|
c, cancel := WithCancel(bg)
|
||||||
|
cancel()
|
||||||
|
<-c.Done()
|
||||||
|
},
|
||||||
|
limit: 5,
|
||||||
|
gccgoLimit: 8,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "WithTimeout(bg, 100*time.Millisecond)",
|
||||||
|
f: func() {
|
||||||
|
c, cancel := WithTimeout(bg, 100*time.Millisecond)
|
||||||
|
cancel()
|
||||||
|
<-c.Done()
|
||||||
|
},
|
||||||
|
limit: 8,
|
||||||
|
gccgoLimit: 25,
|
||||||
|
},
|
||||||
|
} {
|
||||||
|
limit := test.limit
|
||||||
|
if runtime.Compiler == "gccgo" {
|
||||||
|
// gccgo does not yet do escape analysis.
|
||||||
|
// TODO(iant): Remove this when gccgo does do escape analysis.
|
||||||
|
limit = test.gccgoLimit
|
||||||
|
}
|
||||||
|
if n := testing.AllocsPerRun(100, test.f); n > limit {
|
||||||
|
t.Errorf("%s allocs = %f want %d", test.desc, n, int(limit))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSimultaneousCancels(t *testing.T) {
|
||||||
|
root, cancel := WithCancel(Background())
|
||||||
|
m := map[Context]CancelFunc{root: cancel}
|
||||||
|
q := []Context{root}
|
||||||
|
// Create a tree of contexts.
|
||||||
|
for len(q) != 0 && len(m) < 100 {
|
||||||
|
parent := q[0]
|
||||||
|
q = q[1:]
|
||||||
|
for i := 0; i < 4; i++ {
|
||||||
|
ctx, cancel := WithCancel(parent)
|
||||||
|
m[ctx] = cancel
|
||||||
|
q = append(q, ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Start all the cancels in a random order.
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(len(m))
|
||||||
|
for _, cancel := range m {
|
||||||
|
go func(cancel CancelFunc) {
|
||||||
|
cancel()
|
||||||
|
wg.Done()
|
||||||
|
}(cancel)
|
||||||
|
}
|
||||||
|
// Wait on all the contexts in a random order.
|
||||||
|
for ctx := range m {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
case <-time.After(1 * time.Second):
|
||||||
|
buf := make([]byte, 10<<10)
|
||||||
|
n := runtime.Stack(buf, true)
|
||||||
|
t.Fatalf("timed out waiting for <-ctx.Done(); stacks:\n%s", buf[:n])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Wait for all the cancel functions to return.
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
wg.Wait()
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(1 * time.Second):
|
||||||
|
buf := make([]byte, 10<<10)
|
||||||
|
n := runtime.Stack(buf, true)
|
||||||
|
t.Fatalf("timed out waiting for cancel functions; stacks:\n%s", buf[:n])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInterlockedCancels(t *testing.T) {
|
||||||
|
parent, cancelParent := WithCancel(Background())
|
||||||
|
child, cancelChild := WithCancel(parent)
|
||||||
|
go func() {
|
||||||
|
parent.Done()
|
||||||
|
cancelChild()
|
||||||
|
}()
|
||||||
|
cancelParent()
|
||||||
|
select {
|
||||||
|
case <-child.Done():
|
||||||
|
case <-time.After(1 * time.Second):
|
||||||
|
buf := make([]byte, 10<<10)
|
||||||
|
n := runtime.Stack(buf, true)
|
||||||
|
t.Fatalf("timed out waiting for child.Done(); stacks:\n%s", buf[:n])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLayersCancel(t *testing.T) {
|
||||||
|
testLayers(t, time.Now().UnixNano(), false)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLayersTimeout(t *testing.T) {
|
||||||
|
testLayers(t, time.Now().UnixNano(), true)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testLayers(t *testing.T, seed int64, testTimeout bool) {
|
||||||
|
rand.Seed(seed)
|
||||||
|
errorf := func(format string, a ...interface{}) {
|
||||||
|
t.Errorf(fmt.Sprintf("seed=%d: %s", seed, format), a...)
|
||||||
|
}
|
||||||
|
const (
|
||||||
|
timeout = 200 * time.Millisecond
|
||||||
|
minLayers = 30
|
||||||
|
)
|
||||||
|
type value int
|
||||||
|
var (
|
||||||
|
vals []*value
|
||||||
|
cancels []CancelFunc
|
||||||
|
numTimers int
|
||||||
|
ctx = Background()
|
||||||
|
)
|
||||||
|
for i := 0; i < minLayers || numTimers == 0 || len(cancels) == 0 || len(vals) == 0; i++ {
|
||||||
|
switch rand.Intn(3) {
|
||||||
|
case 0:
|
||||||
|
v := new(value)
|
||||||
|
ctx = WithValue(ctx, v, v)
|
||||||
|
vals = append(vals, v)
|
||||||
|
case 1:
|
||||||
|
var cancel CancelFunc
|
||||||
|
ctx, cancel = WithCancel(ctx)
|
||||||
|
cancels = append(cancels, cancel)
|
||||||
|
case 2:
|
||||||
|
var cancel CancelFunc
|
||||||
|
ctx, cancel = WithTimeout(ctx, timeout)
|
||||||
|
cancels = append(cancels, cancel)
|
||||||
|
numTimers++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
checkValues := func(when string) {
|
||||||
|
for _, key := range vals {
|
||||||
|
if val := ctx.Value(key).(*value); key != val {
|
||||||
|
errorf("%s: ctx.Value(%p) = %p want %p", when, key, val, key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
errorf("ctx should not be canceled yet")
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
if s, prefix := fmt.Sprint(ctx), "context.Background."; !strings.HasPrefix(s, prefix) {
|
||||||
|
t.Errorf("ctx.String() = %q want prefix %q", s, prefix)
|
||||||
|
}
|
||||||
|
t.Log(ctx)
|
||||||
|
checkValues("before cancel")
|
||||||
|
if testTimeout {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
case <-time.After(timeout + 100*time.Millisecond):
|
||||||
|
errorf("ctx should have timed out")
|
||||||
|
}
|
||||||
|
checkValues("after timeout")
|
||||||
|
} else {
|
||||||
|
cancel := cancels[rand.Intn(len(cancels))]
|
||||||
|
cancel()
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
default:
|
||||||
|
errorf("ctx should be canceled")
|
||||||
|
}
|
||||||
|
checkValues("after cancel")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCancelRemoves(t *testing.T) {
|
||||||
|
checkChildren := func(when string, ctx Context, want int) {
|
||||||
|
if got := len(ctx.(*cancelCtx).children); got != want {
|
||||||
|
t.Errorf("%s: context has %d children, want %d", when, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, _ := WithCancel(Background())
|
||||||
|
checkChildren("after creation", ctx, 0)
|
||||||
|
_, cancel := WithCancel(ctx)
|
||||||
|
checkChildren("with WithCancel child ", ctx, 1)
|
||||||
|
cancel()
|
||||||
|
checkChildren("after cancelling WithCancel child", ctx, 0)
|
||||||
|
|
||||||
|
ctx, _ = WithCancel(Background())
|
||||||
|
checkChildren("after creation", ctx, 0)
|
||||||
|
_, cancel = WithTimeout(ctx, 60*time.Minute)
|
||||||
|
checkChildren("with WithTimeout child ", ctx, 1)
|
||||||
|
cancel()
|
||||||
|
checkChildren("after cancelling WithTimeout child", ctx, 0)
|
||||||
|
}
|
||||||
+74
@@ -0,0 +1,74 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// +build go1.7
|
||||||
|
|
||||||
|
// Package ctxhttp provides helper functions for performing context-aware HTTP requests.
|
||||||
|
package ctxhttp // import "golang.org/x/net/context/ctxhttp"
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"golang.org/x/net/context"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Do sends an HTTP request with the provided http.Client and returns
|
||||||
|
// an HTTP response.
|
||||||
|
//
|
||||||
|
// If the client is nil, http.DefaultClient is used.
|
||||||
|
//
|
||||||
|
// The provided ctx must be non-nil. If it is canceled or times out,
|
||||||
|
// ctx.Err() will be returned.
|
||||||
|
func Do(ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error) {
|
||||||
|
if client == nil {
|
||||||
|
client = http.DefaultClient
|
||||||
|
}
|
||||||
|
resp, err := client.Do(req.WithContext(ctx))
|
||||||
|
// If we got an error, and the context has been canceled,
|
||||||
|
// the context's error is probably more useful.
|
||||||
|
if err != nil {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
err = ctx.Err()
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return resp, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get issues a GET request via the Do function.
|
||||||
|
func Get(ctx context.Context, client *http.Client, url string) (*http.Response, error) {
|
||||||
|
req, err := http.NewRequest("GET", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return Do(ctx, client, req)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Head issues a HEAD request via the Do function.
|
||||||
|
func Head(ctx context.Context, client *http.Client, url string) (*http.Response, error) {
|
||||||
|
req, err := http.NewRequest("HEAD", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return Do(ctx, client, req)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Post issues a POST request via the Do function.
|
||||||
|
func Post(ctx context.Context, client *http.Client, url string, bodyType string, body io.Reader) (*http.Response, error) {
|
||||||
|
req, err := http.NewRequest("POST", url, body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
req.Header.Set("Content-Type", bodyType)
|
||||||
|
return Do(ctx, client, req)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PostForm issues a POST request via the Do function.
|
||||||
|
func PostForm(ctx context.Context, client *http.Client, url string, data url.Values) (*http.Response, error) {
|
||||||
|
return Post(ctx, client, url, "application/x-www-form-urlencoded", strings.NewReader(data.Encode()))
|
||||||
|
}
|
||||||
+28
@@ -0,0 +1,28 @@
|
|||||||
|
// Copyright 2015 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// +build !plan9,go1.7
|
||||||
|
|
||||||
|
package ctxhttp
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"context"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestGo17Context(t *testing.T) {
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
io.WriteString(w, "ok")
|
||||||
|
}))
|
||||||
|
ctx := context.Background()
|
||||||
|
resp, err := Get(ctx, http.DefaultClient, ts.URL)
|
||||||
|
if resp == nil || err != nil {
|
||||||
|
t.Fatalf("error received from client: %v %v", err, resp)
|
||||||
|
}
|
||||||
|
resp.Body.Close()
|
||||||
|
}
|
||||||
+147
@@ -0,0 +1,147 @@
|
|||||||
|
// Copyright 2015 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// +build !go1.7
|
||||||
|
|
||||||
|
package ctxhttp // import "golang.org/x/net/context/ctxhttp"
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"golang.org/x/net/context"
|
||||||
|
)
|
||||||
|
|
||||||
|
func nop() {}
|
||||||
|
|
||||||
|
var (
|
||||||
|
testHookContextDoneBeforeHeaders = nop
|
||||||
|
testHookDoReturned = nop
|
||||||
|
testHookDidBodyClose = nop
|
||||||
|
)
|
||||||
|
|
||||||
|
// Do sends an HTTP request with the provided http.Client and returns an HTTP response.
|
||||||
|
// If the client is nil, http.DefaultClient is used.
|
||||||
|
// If the context is canceled or times out, ctx.Err() will be returned.
|
||||||
|
func Do(ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error) {
|
||||||
|
if client == nil {
|
||||||
|
client = http.DefaultClient
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO(djd): Respect any existing value of req.Cancel.
|
||||||
|
cancel := make(chan struct{})
|
||||||
|
req.Cancel = cancel
|
||||||
|
|
||||||
|
type responseAndError struct {
|
||||||
|
resp *http.Response
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
result := make(chan responseAndError, 1)
|
||||||
|
|
||||||
|
// Make local copies of test hooks closed over by goroutines below.
|
||||||
|
// Prevents data races in tests.
|
||||||
|
testHookDoReturned := testHookDoReturned
|
||||||
|
testHookDidBodyClose := testHookDidBodyClose
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
resp, err := client.Do(req)
|
||||||
|
testHookDoReturned()
|
||||||
|
result <- responseAndError{resp, err}
|
||||||
|
}()
|
||||||
|
|
||||||
|
var resp *http.Response
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
testHookContextDoneBeforeHeaders()
|
||||||
|
close(cancel)
|
||||||
|
// Clean up after the goroutine calling client.Do:
|
||||||
|
go func() {
|
||||||
|
if r := <-result; r.resp != nil {
|
||||||
|
testHookDidBodyClose()
|
||||||
|
r.resp.Body.Close()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
return nil, ctx.Err()
|
||||||
|
case r := <-result:
|
||||||
|
var err error
|
||||||
|
resp, err = r.resp, r.err
|
||||||
|
if err != nil {
|
||||||
|
return resp, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
c := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
close(cancel)
|
||||||
|
case <-c:
|
||||||
|
// The response's Body is closed.
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
resp.Body = ¬ifyingReader{resp.Body, c}
|
||||||
|
|
||||||
|
return resp, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get issues a GET request via the Do function.
|
||||||
|
func Get(ctx context.Context, client *http.Client, url string) (*http.Response, error) {
|
||||||
|
req, err := http.NewRequest("GET", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return Do(ctx, client, req)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Head issues a HEAD request via the Do function.
|
||||||
|
func Head(ctx context.Context, client *http.Client, url string) (*http.Response, error) {
|
||||||
|
req, err := http.NewRequest("HEAD", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return Do(ctx, client, req)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Post issues a POST request via the Do function.
|
||||||
|
func Post(ctx context.Context, client *http.Client, url string, bodyType string, body io.Reader) (*http.Response, error) {
|
||||||
|
req, err := http.NewRequest("POST", url, body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
req.Header.Set("Content-Type", bodyType)
|
||||||
|
return Do(ctx, client, req)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PostForm issues a POST request via the Do function.
|
||||||
|
func PostForm(ctx context.Context, client *http.Client, url string, data url.Values) (*http.Response, error) {
|
||||||
|
return Post(ctx, client, url, "application/x-www-form-urlencoded", strings.NewReader(data.Encode()))
|
||||||
|
}
|
||||||
|
|
||||||
|
// notifyingReader is an io.ReadCloser that closes the notify channel after
|
||||||
|
// Close is called or a Read fails on the underlying ReadCloser.
|
||||||
|
type notifyingReader struct {
|
||||||
|
io.ReadCloser
|
||||||
|
notify chan<- struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *notifyingReader) Read(p []byte) (int, error) {
|
||||||
|
n, err := r.ReadCloser.Read(p)
|
||||||
|
if err != nil && r.notify != nil {
|
||||||
|
close(r.notify)
|
||||||
|
r.notify = nil
|
||||||
|
}
|
||||||
|
return n, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *notifyingReader) Close() error {
|
||||||
|
err := r.ReadCloser.Close()
|
||||||
|
if r.notify != nil {
|
||||||
|
close(r.notify)
|
||||||
|
r.notify = nil
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
+79
@@ -0,0 +1,79 @@
|
|||||||
|
// Copyright 2015 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// +build !plan9,!go1.7
|
||||||
|
|
||||||
|
package ctxhttp
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"golang.org/x/net/context"
|
||||||
|
)
|
||||||
|
|
||||||
|
// golang.org/issue/14065
|
||||||
|
func TestClosesResponseBodyOnCancel(t *testing.T) {
|
||||||
|
defer func() { testHookContextDoneBeforeHeaders = nop }()
|
||||||
|
defer func() { testHookDoReturned = nop }()
|
||||||
|
defer func() { testHookDidBodyClose = nop }()
|
||||||
|
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
|
||||||
|
defer ts.Close()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
|
||||||
|
// closed when Do enters select case <-ctx.Done()
|
||||||
|
enteredDonePath := make(chan struct{})
|
||||||
|
|
||||||
|
testHookContextDoneBeforeHeaders = func() {
|
||||||
|
close(enteredDonePath)
|
||||||
|
}
|
||||||
|
|
||||||
|
testHookDoReturned = func() {
|
||||||
|
// We now have the result (the Flush'd headers) at least,
|
||||||
|
// so we can cancel the request.
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
// But block the client.Do goroutine from sending
|
||||||
|
// until Do enters into the <-ctx.Done() path, since
|
||||||
|
// otherwise if both channels are readable, select
|
||||||
|
// picks a random one.
|
||||||
|
<-enteredDonePath
|
||||||
|
}
|
||||||
|
|
||||||
|
sawBodyClose := make(chan struct{})
|
||||||
|
testHookDidBodyClose = func() { close(sawBodyClose) }
|
||||||
|
|
||||||
|
tr := &http.Transport{}
|
||||||
|
defer tr.CloseIdleConnections()
|
||||||
|
c := &http.Client{Transport: tr}
|
||||||
|
req, _ := http.NewRequest("GET", ts.URL, nil)
|
||||||
|
_, doErr := Do(ctx, c, req)
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-sawBodyClose:
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("timeout waiting for body to close")
|
||||||
|
}
|
||||||
|
|
||||||
|
if doErr != ctx.Err() {
|
||||||
|
t.Errorf("Do error = %v; want %v", doErr, ctx.Err())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type noteCloseConn struct {
|
||||||
|
net.Conn
|
||||||
|
onceClose sync.Once
|
||||||
|
closefn func()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *noteCloseConn) Close() error {
|
||||||
|
c.onceClose.Do(c.closefn)
|
||||||
|
return c.Conn.Close()
|
||||||
|
}
|
||||||
+105
@@ -0,0 +1,105 @@
|
|||||||
|
// Copyright 2015 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// +build !plan9
|
||||||
|
|
||||||
|
package ctxhttp
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"golang.org/x/net/context"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
requestDuration = 100 * time.Millisecond
|
||||||
|
requestBody = "ok"
|
||||||
|
)
|
||||||
|
|
||||||
|
func okHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
time.Sleep(requestDuration)
|
||||||
|
io.WriteString(w, requestBody)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNoTimeout(t *testing.T) {
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(okHandler))
|
||||||
|
defer ts.Close()
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
res, err := Get(ctx, nil, ts.URL)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer res.Body.Close()
|
||||||
|
slurp, err := ioutil.ReadAll(res.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if string(slurp) != requestBody {
|
||||||
|
t.Errorf("body = %q; want %q", slurp, requestBody)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCancelBeforeHeaders(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
|
||||||
|
blockServer := make(chan struct{})
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
cancel()
|
||||||
|
<-blockServer
|
||||||
|
io.WriteString(w, requestBody)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
defer close(blockServer)
|
||||||
|
|
||||||
|
res, err := Get(ctx, nil, ts.URL)
|
||||||
|
if err == nil {
|
||||||
|
res.Body.Close()
|
||||||
|
t.Fatal("Get returned unexpected nil error")
|
||||||
|
}
|
||||||
|
if err != context.Canceled {
|
||||||
|
t.Errorf("err = %v; want %v", err, context.Canceled)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCancelAfterHangingRequest(t *testing.T) {
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
w.(http.Flusher).Flush()
|
||||||
|
<-w.(http.CloseNotifier).CloseNotify()
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
resp, err := Get(ctx, nil, ts.URL)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error in Get: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Cancel befer reading the body.
|
||||||
|
// Reading Request.Body should fail, since the request was
|
||||||
|
// canceled before anything was written.
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
done := make(chan struct{})
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
b, err := ioutil.ReadAll(resp.Body)
|
||||||
|
if len(b) != 0 || err == nil {
|
||||||
|
t.Errorf(`Read got (%q, %v); want ("", error)`, b, err)
|
||||||
|
}
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-time.After(1 * time.Second):
|
||||||
|
t.Errorf("Test timed out")
|
||||||
|
case <-done:
|
||||||
|
}
|
||||||
|
}
|
||||||
+72
@@ -0,0 +1,72 @@
|
|||||||
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// +build go1.7
|
||||||
|
|
||||||
|
package context
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context" // standard library's context, as of Go 1.7
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
todo = context.TODO()
|
||||||
|
background = context.Background()
|
||||||
|
)
|
||||||
|
|
||||||
|
// Canceled is the error returned by Context.Err when the context is canceled.
|
||||||
|
var Canceled = context.Canceled
|
||||||
|
|
||||||
|
// DeadlineExceeded is the error returned by Context.Err when the context's
|
||||||
|
// deadline passes.
|
||||||
|
var DeadlineExceeded = context.DeadlineExceeded
|
||||||
|
|
||||||
|
// WithCancel returns a copy of parent with a new Done channel. The returned
|
||||||
|
// context's Done channel is closed when the returned cancel function is called
|
||||||
|
// or when the parent context's Done channel is closed, whichever happens first.
|
||||||
|
//
|
||||||
|
// Canceling this context releases resources associated with it, so code should
|
||||||
|
// call cancel as soon as the operations running in this Context complete.
|
||||||
|
func WithCancel(parent Context) (ctx Context, cancel CancelFunc) {
|
||||||
|
ctx, f := context.WithCancel(parent)
|
||||||
|
return ctx, CancelFunc(f)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithDeadline returns a copy of the parent context with the deadline adjusted
|
||||||
|
// to be no later than d. If the parent's deadline is already earlier than d,
|
||||||
|
// WithDeadline(parent, d) is semantically equivalent to parent. The returned
|
||||||
|
// context's Done channel is closed when the deadline expires, when the returned
|
||||||
|
// cancel function is called, or when the parent context's Done channel is
|
||||||
|
// closed, whichever happens first.
|
||||||
|
//
|
||||||
|
// Canceling this context releases resources associated with it, so code should
|
||||||
|
// call cancel as soon as the operations running in this Context complete.
|
||||||
|
func WithDeadline(parent Context, deadline time.Time) (Context, CancelFunc) {
|
||||||
|
ctx, f := context.WithDeadline(parent, deadline)
|
||||||
|
return ctx, CancelFunc(f)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithTimeout returns WithDeadline(parent, time.Now().Add(timeout)).
|
||||||
|
//
|
||||||
|
// Canceling this context releases resources associated with it, so code should
|
||||||
|
// call cancel as soon as the operations running in this Context complete:
|
||||||
|
//
|
||||||
|
// func slowOperationWithTimeout(ctx context.Context) (Result, error) {
|
||||||
|
// ctx, cancel := context.WithTimeout(ctx, 100*time.Millisecond)
|
||||||
|
// defer cancel() // releases resources if slowOperation completes before timeout elapses
|
||||||
|
// return slowOperation(ctx)
|
||||||
|
// }
|
||||||
|
func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc) {
|
||||||
|
return WithDeadline(parent, time.Now().Add(timeout))
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithValue returns a copy of parent in which the value associated with key is
|
||||||
|
// val.
|
||||||
|
//
|
||||||
|
// Use context Values only for request-scoped data that transits processes and
|
||||||
|
// APIs, not for passing optional parameters to functions.
|
||||||
|
func WithValue(parent Context, key interface{}, val interface{}) Context {
|
||||||
|
return context.WithValue(parent, key, val)
|
||||||
|
}
|
||||||
+300
@@ -0,0 +1,300 @@
|
|||||||
|
// Copyright 2014 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// +build !go1.7
|
||||||
|
|
||||||
|
package context
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// An emptyCtx is never canceled, has no values, and has no deadline. It is not
|
||||||
|
// struct{}, since vars of this type must have distinct addresses.
|
||||||
|
type emptyCtx int
|
||||||
|
|
||||||
|
func (*emptyCtx) Deadline() (deadline time.Time, ok bool) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
func (*emptyCtx) Done() <-chan struct{} {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (*emptyCtx) Err() error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (*emptyCtx) Value(key interface{}) interface{} {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *emptyCtx) String() string {
|
||||||
|
switch e {
|
||||||
|
case background:
|
||||||
|
return "context.Background"
|
||||||
|
case todo:
|
||||||
|
return "context.TODO"
|
||||||
|
}
|
||||||
|
return "unknown empty Context"
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
background = new(emptyCtx)
|
||||||
|
todo = new(emptyCtx)
|
||||||
|
)
|
||||||
|
|
||||||
|
// Canceled is the error returned by Context.Err when the context is canceled.
|
||||||
|
var Canceled = errors.New("context canceled")
|
||||||
|
|
||||||
|
// DeadlineExceeded is the error returned by Context.Err when the context's
|
||||||
|
// deadline passes.
|
||||||
|
var DeadlineExceeded = errors.New("context deadline exceeded")
|
||||||
|
|
||||||
|
// WithCancel returns a copy of parent with a new Done channel. The returned
|
||||||
|
// context's Done channel is closed when the returned cancel function is called
|
||||||
|
// or when the parent context's Done channel is closed, whichever happens first.
|
||||||
|
//
|
||||||
|
// Canceling this context releases resources associated with it, so code should
|
||||||
|
// call cancel as soon as the operations running in this Context complete.
|
||||||
|
func WithCancel(parent Context) (ctx Context, cancel CancelFunc) {
|
||||||
|
c := newCancelCtx(parent)
|
||||||
|
propagateCancel(parent, c)
|
||||||
|
return c, func() { c.cancel(true, Canceled) }
|
||||||
|
}
|
||||||
|
|
||||||
|
// newCancelCtx returns an initialized cancelCtx.
|
||||||
|
func newCancelCtx(parent Context) *cancelCtx {
|
||||||
|
return &cancelCtx{
|
||||||
|
Context: parent,
|
||||||
|
done: make(chan struct{}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// propagateCancel arranges for child to be canceled when parent is.
|
||||||
|
func propagateCancel(parent Context, child canceler) {
|
||||||
|
if parent.Done() == nil {
|
||||||
|
return // parent is never canceled
|
||||||
|
}
|
||||||
|
if p, ok := parentCancelCtx(parent); ok {
|
||||||
|
p.mu.Lock()
|
||||||
|
if p.err != nil {
|
||||||
|
// parent has already been canceled
|
||||||
|
child.cancel(false, p.err)
|
||||||
|
} else {
|
||||||
|
if p.children == nil {
|
||||||
|
p.children = make(map[canceler]bool)
|
||||||
|
}
|
||||||
|
p.children[child] = true
|
||||||
|
}
|
||||||
|
p.mu.Unlock()
|
||||||
|
} else {
|
||||||
|
go func() {
|
||||||
|
select {
|
||||||
|
case <-parent.Done():
|
||||||
|
child.cancel(false, parent.Err())
|
||||||
|
case <-child.Done():
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// parentCancelCtx follows a chain of parent references until it finds a
|
||||||
|
// *cancelCtx. This function understands how each of the concrete types in this
|
||||||
|
// package represents its parent.
|
||||||
|
func parentCancelCtx(parent Context) (*cancelCtx, bool) {
|
||||||
|
for {
|
||||||
|
switch c := parent.(type) {
|
||||||
|
case *cancelCtx:
|
||||||
|
return c, true
|
||||||
|
case *timerCtx:
|
||||||
|
return c.cancelCtx, true
|
||||||
|
case *valueCtx:
|
||||||
|
parent = c.Context
|
||||||
|
default:
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// removeChild removes a context from its parent.
|
||||||
|
func removeChild(parent Context, child canceler) {
|
||||||
|
p, ok := parentCancelCtx(parent)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
p.mu.Lock()
|
||||||
|
if p.children != nil {
|
||||||
|
delete(p.children, child)
|
||||||
|
}
|
||||||
|
p.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// A canceler is a context type that can be canceled directly. The
|
||||||
|
// implementations are *cancelCtx and *timerCtx.
|
||||||
|
type canceler interface {
|
||||||
|
cancel(removeFromParent bool, err error)
|
||||||
|
Done() <-chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A cancelCtx can be canceled. When canceled, it also cancels any children
|
||||||
|
// that implement canceler.
|
||||||
|
type cancelCtx struct {
|
||||||
|
Context
|
||||||
|
|
||||||
|
done chan struct{} // closed by the first cancel call.
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
children map[canceler]bool // set to nil by the first cancel call
|
||||||
|
err error // set to non-nil by the first cancel call
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *cancelCtx) Done() <-chan struct{} {
|
||||||
|
return c.done
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *cancelCtx) Err() error {
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
return c.err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *cancelCtx) String() string {
|
||||||
|
return fmt.Sprintf("%v.WithCancel", c.Context)
|
||||||
|
}
|
||||||
|
|
||||||
|
// cancel closes c.done, cancels each of c's children, and, if
|
||||||
|
// removeFromParent is true, removes c from its parent's children.
|
||||||
|
func (c *cancelCtx) cancel(removeFromParent bool, err error) {
|
||||||
|
if err == nil {
|
||||||
|
panic("context: internal error: missing cancel error")
|
||||||
|
}
|
||||||
|
c.mu.Lock()
|
||||||
|
if c.err != nil {
|
||||||
|
c.mu.Unlock()
|
||||||
|
return // already canceled
|
||||||
|
}
|
||||||
|
c.err = err
|
||||||
|
close(c.done)
|
||||||
|
for child := range c.children {
|
||||||
|
// NOTE: acquiring the child's lock while holding parent's lock.
|
||||||
|
child.cancel(false, err)
|
||||||
|
}
|
||||||
|
c.children = nil
|
||||||
|
c.mu.Unlock()
|
||||||
|
|
||||||
|
if removeFromParent {
|
||||||
|
removeChild(c.Context, c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithDeadline returns a copy of the parent context with the deadline adjusted
|
||||||
|
// to be no later than d. If the parent's deadline is already earlier than d,
|
||||||
|
// WithDeadline(parent, d) is semantically equivalent to parent. The returned
|
||||||
|
// context's Done channel is closed when the deadline expires, when the returned
|
||||||
|
// cancel function is called, or when the parent context's Done channel is
|
||||||
|
// closed, whichever happens first.
|
||||||
|
//
|
||||||
|
// Canceling this context releases resources associated with it, so code should
|
||||||
|
// call cancel as soon as the operations running in this Context complete.
|
||||||
|
func WithDeadline(parent Context, deadline time.Time) (Context, CancelFunc) {
|
||||||
|
if cur, ok := parent.Deadline(); ok && cur.Before(deadline) {
|
||||||
|
// The current deadline is already sooner than the new one.
|
||||||
|
return WithCancel(parent)
|
||||||
|
}
|
||||||
|
c := &timerCtx{
|
||||||
|
cancelCtx: newCancelCtx(parent),
|
||||||
|
deadline: deadline,
|
||||||
|
}
|
||||||
|
propagateCancel(parent, c)
|
||||||
|
d := deadline.Sub(time.Now())
|
||||||
|
if d <= 0 {
|
||||||
|
c.cancel(true, DeadlineExceeded) // deadline has already passed
|
||||||
|
return c, func() { c.cancel(true, Canceled) }
|
||||||
|
}
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
if c.err == nil {
|
||||||
|
c.timer = time.AfterFunc(d, func() {
|
||||||
|
c.cancel(true, DeadlineExceeded)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return c, func() { c.cancel(true, Canceled) }
|
||||||
|
}
|
||||||
|
|
||||||
|
// A timerCtx carries a timer and a deadline. It embeds a cancelCtx to
|
||||||
|
// implement Done and Err. It implements cancel by stopping its timer then
|
||||||
|
// delegating to cancelCtx.cancel.
|
||||||
|
type timerCtx struct {
|
||||||
|
*cancelCtx
|
||||||
|
timer *time.Timer // Under cancelCtx.mu.
|
||||||
|
|
||||||
|
deadline time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *timerCtx) Deadline() (deadline time.Time, ok bool) {
|
||||||
|
return c.deadline, true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *timerCtx) String() string {
|
||||||
|
return fmt.Sprintf("%v.WithDeadline(%s [%s])", c.cancelCtx.Context, c.deadline, c.deadline.Sub(time.Now()))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *timerCtx) cancel(removeFromParent bool, err error) {
|
||||||
|
c.cancelCtx.cancel(false, err)
|
||||||
|
if removeFromParent {
|
||||||
|
// Remove this timerCtx from its parent cancelCtx's children.
|
||||||
|
removeChild(c.cancelCtx.Context, c)
|
||||||
|
}
|
||||||
|
c.mu.Lock()
|
||||||
|
if c.timer != nil {
|
||||||
|
c.timer.Stop()
|
||||||
|
c.timer = nil
|
||||||
|
}
|
||||||
|
c.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithTimeout returns WithDeadline(parent, time.Now().Add(timeout)).
|
||||||
|
//
|
||||||
|
// Canceling this context releases resources associated with it, so code should
|
||||||
|
// call cancel as soon as the operations running in this Context complete:
|
||||||
|
//
|
||||||
|
// func slowOperationWithTimeout(ctx context.Context) (Result, error) {
|
||||||
|
// ctx, cancel := context.WithTimeout(ctx, 100*time.Millisecond)
|
||||||
|
// defer cancel() // releases resources if slowOperation completes before timeout elapses
|
||||||
|
// return slowOperation(ctx)
|
||||||
|
// }
|
||||||
|
func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc) {
|
||||||
|
return WithDeadline(parent, time.Now().Add(timeout))
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithValue returns a copy of parent in which the value associated with key is
|
||||||
|
// val.
|
||||||
|
//
|
||||||
|
// Use context Values only for request-scoped data that transits processes and
|
||||||
|
// APIs, not for passing optional parameters to functions.
|
||||||
|
func WithValue(parent Context, key interface{}, val interface{}) Context {
|
||||||
|
return &valueCtx{parent, key, val}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A valueCtx carries a key-value pair. It implements Value for that key and
|
||||||
|
// delegates all other calls to the embedded Context.
|
||||||
|
type valueCtx struct {
|
||||||
|
Context
|
||||||
|
key, val interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *valueCtx) String() string {
|
||||||
|
return fmt.Sprintf("%v.WithValue(%#v, %#v)", c.Context, c.key, c.val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *valueCtx) Value(key interface{}) interface{} {
|
||||||
|
if c.key == key {
|
||||||
|
return c.val
|
||||||
|
}
|
||||||
|
return c.Context.Value(key)
|
||||||
|
}
|
||||||
+26
@@ -0,0 +1,26 @@
|
|||||||
|
// Copyright 2014 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package context_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"golang.org/x/net/context"
|
||||||
|
)
|
||||||
|
|
||||||
|
func ExampleWithTimeout() {
|
||||||
|
// Pass a context with a timeout to tell a blocking function that it
|
||||||
|
// should abandon its work after the timeout elapses.
|
||||||
|
ctx, _ := context.WithTimeout(context.Background(), 100*time.Millisecond)
|
||||||
|
select {
|
||||||
|
case <-time.After(200 * time.Millisecond):
|
||||||
|
fmt.Println("overslept")
|
||||||
|
case <-ctx.Done():
|
||||||
|
fmt.Println(ctx.Err()) // prints "context deadline exceeded"
|
||||||
|
}
|
||||||
|
// Output:
|
||||||
|
// context deadline exceeded
|
||||||
|
}
|
||||||
+210
@@ -0,0 +1,210 @@
|
|||||||
|
// Copyright 2010 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// Package dict implements the Dictionary Server Protocol
|
||||||
|
// as defined in RFC 2229.
|
||||||
|
package dict // import "golang.org/x/net/dict"
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/textproto"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A Client represents a client connection to a dictionary server.
|
||||||
|
type Client struct {
|
||||||
|
text *textproto.Conn
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dial returns a new client connected to a dictionary server at
|
||||||
|
// addr on the given network.
|
||||||
|
func Dial(network, addr string) (*Client, error) {
|
||||||
|
text, err := textproto.Dial(network, addr)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
_, _, err = text.ReadCodeLine(220)
|
||||||
|
if err != nil {
|
||||||
|
text.Close()
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &Client{text: text}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close closes the connection to the dictionary server.
|
||||||
|
func (c *Client) Close() error {
|
||||||
|
return c.text.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// A Dict represents a dictionary available on the server.
|
||||||
|
type Dict struct {
|
||||||
|
Name string // short name of dictionary
|
||||||
|
Desc string // long description
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dicts returns a list of the dictionaries available on the server.
|
||||||
|
func (c *Client) Dicts() ([]Dict, error) {
|
||||||
|
id, err := c.text.Cmd("SHOW DB")
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
c.text.StartResponse(id)
|
||||||
|
defer c.text.EndResponse(id)
|
||||||
|
|
||||||
|
_, _, err = c.text.ReadCodeLine(110)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
lines, err := c.text.ReadDotLines()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
_, _, err = c.text.ReadCodeLine(250)
|
||||||
|
|
||||||
|
dicts := make([]Dict, len(lines))
|
||||||
|
for i := range dicts {
|
||||||
|
d := &dicts[i]
|
||||||
|
a, _ := fields(lines[i])
|
||||||
|
if len(a) < 2 {
|
||||||
|
return nil, textproto.ProtocolError("invalid dictionary: " + lines[i])
|
||||||
|
}
|
||||||
|
d.Name = a[0]
|
||||||
|
d.Desc = a[1]
|
||||||
|
}
|
||||||
|
return dicts, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// A Defn represents a definition.
|
||||||
|
type Defn struct {
|
||||||
|
Dict Dict // Dict where definition was found
|
||||||
|
Word string // Word being defined
|
||||||
|
Text []byte // Definition text, typically multiple lines
|
||||||
|
}
|
||||||
|
|
||||||
|
// Define requests the definition of the given word.
|
||||||
|
// The argument dict names the dictionary to use,
|
||||||
|
// the Name field of a Dict returned by Dicts.
|
||||||
|
//
|
||||||
|
// The special dictionary name "*" means to look in all the
|
||||||
|
// server's dictionaries.
|
||||||
|
// The special dictionary name "!" means to look in all the
|
||||||
|
// server's dictionaries in turn, stopping after finding the word
|
||||||
|
// in one of them.
|
||||||
|
func (c *Client) Define(dict, word string) ([]*Defn, error) {
|
||||||
|
id, err := c.text.Cmd("DEFINE %s %q", dict, word)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
c.text.StartResponse(id)
|
||||||
|
defer c.text.EndResponse(id)
|
||||||
|
|
||||||
|
_, line, err := c.text.ReadCodeLine(150)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
a, _ := fields(line)
|
||||||
|
if len(a) < 1 {
|
||||||
|
return nil, textproto.ProtocolError("malformed response: " + line)
|
||||||
|
}
|
||||||
|
n, err := strconv.Atoi(a[0])
|
||||||
|
if err != nil {
|
||||||
|
return nil, textproto.ProtocolError("invalid definition count: " + a[0])
|
||||||
|
}
|
||||||
|
def := make([]*Defn, n)
|
||||||
|
for i := 0; i < n; i++ {
|
||||||
|
_, line, err = c.text.ReadCodeLine(151)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
a, _ := fields(line)
|
||||||
|
if len(a) < 3 {
|
||||||
|
// skip it, to keep protocol in sync
|
||||||
|
i--
|
||||||
|
n--
|
||||||
|
def = def[0:n]
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
d := &Defn{Word: a[0], Dict: Dict{a[1], a[2]}}
|
||||||
|
d.Text, err = c.text.ReadDotBytes()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
def[i] = d
|
||||||
|
}
|
||||||
|
_, _, err = c.text.ReadCodeLine(250)
|
||||||
|
return def, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fields returns the fields in s.
|
||||||
|
// Fields are space separated unquoted words
|
||||||
|
// or quoted with single or double quote.
|
||||||
|
func fields(s string) ([]string, error) {
|
||||||
|
var v []string
|
||||||
|
i := 0
|
||||||
|
for {
|
||||||
|
for i < len(s) && (s[i] == ' ' || s[i] == '\t') {
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
if i >= len(s) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if s[i] == '"' || s[i] == '\'' {
|
||||||
|
q := s[i]
|
||||||
|
// quoted string
|
||||||
|
var j int
|
||||||
|
for j = i + 1; ; j++ {
|
||||||
|
if j >= len(s) {
|
||||||
|
return nil, textproto.ProtocolError("malformed quoted string")
|
||||||
|
}
|
||||||
|
if s[j] == '\\' {
|
||||||
|
j++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if s[j] == q {
|
||||||
|
j++
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
v = append(v, unquote(s[i+1:j-1]))
|
||||||
|
i = j
|
||||||
|
} else {
|
||||||
|
// atom
|
||||||
|
var j int
|
||||||
|
for j = i; j < len(s); j++ {
|
||||||
|
if s[j] == ' ' || s[j] == '\t' || s[j] == '\\' || s[j] == '"' || s[j] == '\'' {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
v = append(v, s[i:j])
|
||||||
|
i = j
|
||||||
|
}
|
||||||
|
if i < len(s) {
|
||||||
|
c := s[i]
|
||||||
|
if c != ' ' && c != '\t' {
|
||||||
|
return nil, textproto.ProtocolError("quotes not on word boundaries")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return v, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func unquote(s string) string {
|
||||||
|
if strings.Index(s, "\\") < 0 {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
b := []byte(s)
|
||||||
|
w := 0
|
||||||
|
for r := 0; r < len(b); r++ {
|
||||||
|
c := b[r]
|
||||||
|
if c == '\\' {
|
||||||
|
r++
|
||||||
|
c = b[r]
|
||||||
|
}
|
||||||
|
b[w] = c
|
||||||
|
w++
|
||||||
|
}
|
||||||
|
return string(b[0:w])
|
||||||
|
}
|
||||||
+78
@@ -0,0 +1,78 @@
|
|||||||
|
// Copyright 2012 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// Package atom provides integer codes (also known as atoms) for a fixed set of
|
||||||
|
// frequently occurring HTML strings: tag names and attribute keys such as "p"
|
||||||
|
// and "id".
|
||||||
|
//
|
||||||
|
// Sharing an atom's name between all elements with the same tag can result in
|
||||||
|
// fewer string allocations when tokenizing and parsing HTML. Integer
|
||||||
|
// comparisons are also generally faster than string comparisons.
|
||||||
|
//
|
||||||
|
// The value of an atom's particular code is not guaranteed to stay the same
|
||||||
|
// between versions of this package. Neither is any ordering guaranteed:
|
||||||
|
// whether atom.H1 < atom.H2 may also change. The codes are not guaranteed to
|
||||||
|
// be dense. The only guarantees are that e.g. looking up "div" will yield
|
||||||
|
// atom.Div, calling atom.Div.String will return "div", and atom.Div != 0.
|
||||||
|
package atom // import "golang.org/x/net/html/atom"
|
||||||
|
|
||||||
|
// Atom is an integer code for a string. The zero value maps to "".
|
||||||
|
type Atom uint32
|
||||||
|
|
||||||
|
// String returns the atom's name.
|
||||||
|
func (a Atom) String() string {
|
||||||
|
start := uint32(a >> 8)
|
||||||
|
n := uint32(a & 0xff)
|
||||||
|
if start+n > uint32(len(atomText)) {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return atomText[start : start+n]
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a Atom) string() string {
|
||||||
|
return atomText[a>>8 : a>>8+a&0xff]
|
||||||
|
}
|
||||||
|
|
||||||
|
// fnv computes the FNV hash with an arbitrary starting value h.
|
||||||
|
func fnv(h uint32, s []byte) uint32 {
|
||||||
|
for i := range s {
|
||||||
|
h ^= uint32(s[i])
|
||||||
|
h *= 16777619
|
||||||
|
}
|
||||||
|
return h
|
||||||
|
}
|
||||||
|
|
||||||
|
func match(s string, t []byte) bool {
|
||||||
|
for i, c := range t {
|
||||||
|
if s[i] != c {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Lookup returns the atom whose name is s. It returns zero if there is no
|
||||||
|
// such atom. The lookup is case sensitive.
|
||||||
|
func Lookup(s []byte) Atom {
|
||||||
|
if len(s) == 0 || len(s) > maxAtomLen {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
h := fnv(hash0, s)
|
||||||
|
if a := table[h&uint32(len(table)-1)]; int(a&0xff) == len(s) && match(a.string(), s) {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
if a := table[(h>>16)&uint32(len(table)-1)]; int(a&0xff) == len(s) && match(a.string(), s) {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// String returns a string whose contents are equal to s. In that sense, it is
|
||||||
|
// equivalent to string(s) but may be more efficient.
|
||||||
|
func String(s []byte) string {
|
||||||
|
if a := Lookup(s); a != 0 {
|
||||||
|
return a.String()
|
||||||
|
}
|
||||||
|
return string(s)
|
||||||
|
}
|
||||||
+109
@@ -0,0 +1,109 @@
|
|||||||
|
// Copyright 2012 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package atom
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sort"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestKnown(t *testing.T) {
|
||||||
|
for _, s := range testAtomList {
|
||||||
|
if atom := Lookup([]byte(s)); atom.String() != s {
|
||||||
|
t.Errorf("Lookup(%q) = %#x (%q)", s, uint32(atom), atom.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHits(t *testing.T) {
|
||||||
|
for _, a := range table {
|
||||||
|
if a == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
got := Lookup([]byte(a.String()))
|
||||||
|
if got != a {
|
||||||
|
t.Errorf("Lookup(%q) = %#x, want %#x", a.String(), uint32(got), uint32(a))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMisses(t *testing.T) {
|
||||||
|
testCases := []string{
|
||||||
|
"",
|
||||||
|
"\x00",
|
||||||
|
"\xff",
|
||||||
|
"A",
|
||||||
|
"DIV",
|
||||||
|
"Div",
|
||||||
|
"dIV",
|
||||||
|
"aa",
|
||||||
|
"a\x00",
|
||||||
|
"ab",
|
||||||
|
"abb",
|
||||||
|
"abbr0",
|
||||||
|
"abbr ",
|
||||||
|
" abbr",
|
||||||
|
" a",
|
||||||
|
"acceptcharset",
|
||||||
|
"acceptCharset",
|
||||||
|
"accept_charset",
|
||||||
|
"h0",
|
||||||
|
"h1h2",
|
||||||
|
"h7",
|
||||||
|
"onClick",
|
||||||
|
"λ",
|
||||||
|
// The following string has the same hash (0xa1d7fab7) as "onmouseover".
|
||||||
|
"\x00\x00\x00\x00\x00\x50\x18\xae\x38\xd0\xb7",
|
||||||
|
}
|
||||||
|
for _, tc := range testCases {
|
||||||
|
got := Lookup([]byte(tc))
|
||||||
|
if got != 0 {
|
||||||
|
t.Errorf("Lookup(%q): got %d, want 0", tc, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForeignObject(t *testing.T) {
|
||||||
|
const (
|
||||||
|
afo = Foreignobject
|
||||||
|
afO = ForeignObject
|
||||||
|
sfo = "foreignobject"
|
||||||
|
sfO = "foreignObject"
|
||||||
|
)
|
||||||
|
if got := Lookup([]byte(sfo)); got != afo {
|
||||||
|
t.Errorf("Lookup(%q): got %#v, want %#v", sfo, got, afo)
|
||||||
|
}
|
||||||
|
if got := Lookup([]byte(sfO)); got != afO {
|
||||||
|
t.Errorf("Lookup(%q): got %#v, want %#v", sfO, got, afO)
|
||||||
|
}
|
||||||
|
if got := afo.String(); got != sfo {
|
||||||
|
t.Errorf("Atom(%#v).String(): got %q, want %q", afo, got, sfo)
|
||||||
|
}
|
||||||
|
if got := afO.String(); got != sfO {
|
||||||
|
t.Errorf("Atom(%#v).String(): got %q, want %q", afO, got, sfO)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func BenchmarkLookup(b *testing.B) {
|
||||||
|
sortedTable := make([]string, 0, len(table))
|
||||||
|
for _, a := range table {
|
||||||
|
if a != 0 {
|
||||||
|
sortedTable = append(sortedTable, a.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(sortedTable)
|
||||||
|
|
||||||
|
x := make([][]byte, 1000)
|
||||||
|
for i := range x {
|
||||||
|
x[i] = []byte(sortedTable[i%len(sortedTable)])
|
||||||
|
}
|
||||||
|
|
||||||
|
b.ResetTimer()
|
||||||
|
for i := 0; i < b.N; i++ {
|
||||||
|
for _, s := range x {
|
||||||
|
Lookup(s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+648
@@ -0,0 +1,648 @@
|
|||||||
|
// Copyright 2012 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// +build ignore
|
||||||
|
|
||||||
|
package main
|
||||||
|
|
||||||
|
// This program generates table.go and table_test.go.
|
||||||
|
// Invoke as
|
||||||
|
//
|
||||||
|
// go run gen.go |gofmt >table.go
|
||||||
|
// go run gen.go -test |gofmt >table_test.go
|
||||||
|
|
||||||
|
import (
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"math/rand"
|
||||||
|
"os"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// identifier converts s to a Go exported identifier.
|
||||||
|
// It converts "div" to "Div" and "accept-charset" to "AcceptCharset".
|
||||||
|
func identifier(s string) string {
|
||||||
|
b := make([]byte, 0, len(s))
|
||||||
|
cap := true
|
||||||
|
for _, c := range s {
|
||||||
|
if c == '-' {
|
||||||
|
cap = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if cap && 'a' <= c && c <= 'z' {
|
||||||
|
c -= 'a' - 'A'
|
||||||
|
}
|
||||||
|
cap = false
|
||||||
|
b = append(b, byte(c))
|
||||||
|
}
|
||||||
|
return string(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
var test = flag.Bool("test", false, "generate table_test.go")
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
flag.Parse()
|
||||||
|
|
||||||
|
var all []string
|
||||||
|
all = append(all, elements...)
|
||||||
|
all = append(all, attributes...)
|
||||||
|
all = append(all, eventHandlers...)
|
||||||
|
all = append(all, extra...)
|
||||||
|
sort.Strings(all)
|
||||||
|
|
||||||
|
if *test {
|
||||||
|
fmt.Printf("// generated by go run gen.go -test; DO NOT EDIT\n\n")
|
||||||
|
fmt.Printf("package atom\n\n")
|
||||||
|
fmt.Printf("var testAtomList = []string{\n")
|
||||||
|
for _, s := range all {
|
||||||
|
fmt.Printf("\t%q,\n", s)
|
||||||
|
}
|
||||||
|
fmt.Printf("}\n")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// uniq - lists have dups
|
||||||
|
// compute max len too
|
||||||
|
maxLen := 0
|
||||||
|
w := 0
|
||||||
|
for _, s := range all {
|
||||||
|
if w == 0 || all[w-1] != s {
|
||||||
|
if maxLen < len(s) {
|
||||||
|
maxLen = len(s)
|
||||||
|
}
|
||||||
|
all[w] = s
|
||||||
|
w++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
all = all[:w]
|
||||||
|
|
||||||
|
// Find hash that minimizes table size.
|
||||||
|
var best *table
|
||||||
|
for i := 0; i < 1000000; i++ {
|
||||||
|
if best != nil && 1<<(best.k-1) < len(all) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
h := rand.Uint32()
|
||||||
|
for k := uint(0); k <= 16; k++ {
|
||||||
|
if best != nil && k >= best.k {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
var t table
|
||||||
|
if t.init(h, k, all) {
|
||||||
|
best = &t
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if best == nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "failed to construct string table\n")
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Lay out strings, using overlaps when possible.
|
||||||
|
layout := append([]string{}, all...)
|
||||||
|
|
||||||
|
// Remove strings that are substrings of other strings
|
||||||
|
for changed := true; changed; {
|
||||||
|
changed = false
|
||||||
|
for i, s := range layout {
|
||||||
|
if s == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for j, t := range layout {
|
||||||
|
if i != j && t != "" && strings.Contains(s, t) {
|
||||||
|
changed = true
|
||||||
|
layout[j] = ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Join strings where one suffix matches another prefix.
|
||||||
|
for {
|
||||||
|
// Find best i, j, k such that layout[i][len-k:] == layout[j][:k],
|
||||||
|
// maximizing overlap length k.
|
||||||
|
besti := -1
|
||||||
|
bestj := -1
|
||||||
|
bestk := 0
|
||||||
|
for i, s := range layout {
|
||||||
|
if s == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for j, t := range layout {
|
||||||
|
if i == j {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for k := bestk + 1; k <= len(s) && k <= len(t); k++ {
|
||||||
|
if s[len(s)-k:] == t[:k] {
|
||||||
|
besti = i
|
||||||
|
bestj = j
|
||||||
|
bestk = k
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if bestk > 0 {
|
||||||
|
layout[besti] += layout[bestj][bestk:]
|
||||||
|
layout[bestj] = ""
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
text := strings.Join(layout, "")
|
||||||
|
|
||||||
|
atom := map[string]uint32{}
|
||||||
|
for _, s := range all {
|
||||||
|
off := strings.Index(text, s)
|
||||||
|
if off < 0 {
|
||||||
|
panic("lost string " + s)
|
||||||
|
}
|
||||||
|
atom[s] = uint32(off<<8 | len(s))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Generate the Go code.
|
||||||
|
fmt.Printf("// generated by go run gen.go; DO NOT EDIT\n\n")
|
||||||
|
fmt.Printf("package atom\n\nconst (\n")
|
||||||
|
for _, s := range all {
|
||||||
|
fmt.Printf("\t%s Atom = %#x\n", identifier(s), atom[s])
|
||||||
|
}
|
||||||
|
fmt.Printf(")\n\n")
|
||||||
|
|
||||||
|
fmt.Printf("const hash0 = %#x\n\n", best.h0)
|
||||||
|
fmt.Printf("const maxAtomLen = %d\n\n", maxLen)
|
||||||
|
|
||||||
|
fmt.Printf("var table = [1<<%d]Atom{\n", best.k)
|
||||||
|
for i, s := range best.tab {
|
||||||
|
if s == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
fmt.Printf("\t%#x: %#x, // %s\n", i, atom[s], s)
|
||||||
|
}
|
||||||
|
fmt.Printf("}\n")
|
||||||
|
datasize := (1 << best.k) * 4
|
||||||
|
|
||||||
|
fmt.Printf("const atomText =\n")
|
||||||
|
textsize := len(text)
|
||||||
|
for len(text) > 60 {
|
||||||
|
fmt.Printf("\t%q +\n", text[:60])
|
||||||
|
text = text[60:]
|
||||||
|
}
|
||||||
|
fmt.Printf("\t%q\n\n", text)
|
||||||
|
|
||||||
|
fmt.Fprintf(os.Stderr, "%d atoms; %d string bytes + %d tables = %d total data\n", len(all), textsize, datasize, textsize+datasize)
|
||||||
|
}
|
||||||
|
|
||||||
|
type byLen []string
|
||||||
|
|
||||||
|
func (x byLen) Less(i, j int) bool { return len(x[i]) > len(x[j]) }
|
||||||
|
func (x byLen) Swap(i, j int) { x[i], x[j] = x[j], x[i] }
|
||||||
|
func (x byLen) Len() int { return len(x) }
|
||||||
|
|
||||||
|
// fnv computes the FNV hash with an arbitrary starting value h.
|
||||||
|
func fnv(h uint32, s string) uint32 {
|
||||||
|
for i := 0; i < len(s); i++ {
|
||||||
|
h ^= uint32(s[i])
|
||||||
|
h *= 16777619
|
||||||
|
}
|
||||||
|
return h
|
||||||
|
}
|
||||||
|
|
||||||
|
// A table represents an attempt at constructing the lookup table.
|
||||||
|
// The lookup table uses cuckoo hashing, meaning that each string
|
||||||
|
// can be found in one of two positions.
|
||||||
|
type table struct {
|
||||||
|
h0 uint32
|
||||||
|
k uint
|
||||||
|
mask uint32
|
||||||
|
tab []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// hash returns the two hashes for s.
|
||||||
|
func (t *table) hash(s string) (h1, h2 uint32) {
|
||||||
|
h := fnv(t.h0, s)
|
||||||
|
h1 = h & t.mask
|
||||||
|
h2 = (h >> 16) & t.mask
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// init initializes the table with the given parameters.
|
||||||
|
// h0 is the initial hash value,
|
||||||
|
// k is the number of bits of hash value to use, and
|
||||||
|
// x is the list of strings to store in the table.
|
||||||
|
// init returns false if the table cannot be constructed.
|
||||||
|
func (t *table) init(h0 uint32, k uint, x []string) bool {
|
||||||
|
t.h0 = h0
|
||||||
|
t.k = k
|
||||||
|
t.tab = make([]string, 1<<k)
|
||||||
|
t.mask = 1<<k - 1
|
||||||
|
for _, s := range x {
|
||||||
|
if !t.insert(s) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// insert inserts s in the table.
|
||||||
|
func (t *table) insert(s string) bool {
|
||||||
|
h1, h2 := t.hash(s)
|
||||||
|
if t.tab[h1] == "" {
|
||||||
|
t.tab[h1] = s
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if t.tab[h2] == "" {
|
||||||
|
t.tab[h2] = s
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if t.push(h1, 0) {
|
||||||
|
t.tab[h1] = s
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if t.push(h2, 0) {
|
||||||
|
t.tab[h2] = s
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// push attempts to push aside the entry in slot i.
|
||||||
|
func (t *table) push(i uint32, depth int) bool {
|
||||||
|
if depth > len(t.tab) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
s := t.tab[i]
|
||||||
|
h1, h2 := t.hash(s)
|
||||||
|
j := h1 + h2 - i
|
||||||
|
if t.tab[j] != "" && !t.push(j, depth+1) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
t.tab[j] = s
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// The lists of element names and attribute keys were taken from
|
||||||
|
// https://html.spec.whatwg.org/multipage/indices.html#index
|
||||||
|
// as of the "HTML Living Standard - Last Updated 21 February 2015" version.
|
||||||
|
|
||||||
|
var elements = []string{
|
||||||
|
"a",
|
||||||
|
"abbr",
|
||||||
|
"address",
|
||||||
|
"area",
|
||||||
|
"article",
|
||||||
|
"aside",
|
||||||
|
"audio",
|
||||||
|
"b",
|
||||||
|
"base",
|
||||||
|
"bdi",
|
||||||
|
"bdo",
|
||||||
|
"blockquote",
|
||||||
|
"body",
|
||||||
|
"br",
|
||||||
|
"button",
|
||||||
|
"canvas",
|
||||||
|
"caption",
|
||||||
|
"cite",
|
||||||
|
"code",
|
||||||
|
"col",
|
||||||
|
"colgroup",
|
||||||
|
"command",
|
||||||
|
"data",
|
||||||
|
"datalist",
|
||||||
|
"dd",
|
||||||
|
"del",
|
||||||
|
"details",
|
||||||
|
"dfn",
|
||||||
|
"dialog",
|
||||||
|
"div",
|
||||||
|
"dl",
|
||||||
|
"dt",
|
||||||
|
"em",
|
||||||
|
"embed",
|
||||||
|
"fieldset",
|
||||||
|
"figcaption",
|
||||||
|
"figure",
|
||||||
|
"footer",
|
||||||
|
"form",
|
||||||
|
"h1",
|
||||||
|
"h2",
|
||||||
|
"h3",
|
||||||
|
"h4",
|
||||||
|
"h5",
|
||||||
|
"h6",
|
||||||
|
"head",
|
||||||
|
"header",
|
||||||
|
"hgroup",
|
||||||
|
"hr",
|
||||||
|
"html",
|
||||||
|
"i",
|
||||||
|
"iframe",
|
||||||
|
"img",
|
||||||
|
"input",
|
||||||
|
"ins",
|
||||||
|
"kbd",
|
||||||
|
"keygen",
|
||||||
|
"label",
|
||||||
|
"legend",
|
||||||
|
"li",
|
||||||
|
"link",
|
||||||
|
"map",
|
||||||
|
"mark",
|
||||||
|
"menu",
|
||||||
|
"menuitem",
|
||||||
|
"meta",
|
||||||
|
"meter",
|
||||||
|
"nav",
|
||||||
|
"noscript",
|
||||||
|
"object",
|
||||||
|
"ol",
|
||||||
|
"optgroup",
|
||||||
|
"option",
|
||||||
|
"output",
|
||||||
|
"p",
|
||||||
|
"param",
|
||||||
|
"pre",
|
||||||
|
"progress",
|
||||||
|
"q",
|
||||||
|
"rp",
|
||||||
|
"rt",
|
||||||
|
"ruby",
|
||||||
|
"s",
|
||||||
|
"samp",
|
||||||
|
"script",
|
||||||
|
"section",
|
||||||
|
"select",
|
||||||
|
"small",
|
||||||
|
"source",
|
||||||
|
"span",
|
||||||
|
"strong",
|
||||||
|
"style",
|
||||||
|
"sub",
|
||||||
|
"summary",
|
||||||
|
"sup",
|
||||||
|
"table",
|
||||||
|
"tbody",
|
||||||
|
"td",
|
||||||
|
"template",
|
||||||
|
"textarea",
|
||||||
|
"tfoot",
|
||||||
|
"th",
|
||||||
|
"thead",
|
||||||
|
"time",
|
||||||
|
"title",
|
||||||
|
"tr",
|
||||||
|
"track",
|
||||||
|
"u",
|
||||||
|
"ul",
|
||||||
|
"var",
|
||||||
|
"video",
|
||||||
|
"wbr",
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://html.spec.whatwg.org/multipage/indices.html#attributes-3
|
||||||
|
|
||||||
|
var attributes = []string{
|
||||||
|
"abbr",
|
||||||
|
"accept",
|
||||||
|
"accept-charset",
|
||||||
|
"accesskey",
|
||||||
|
"action",
|
||||||
|
"alt",
|
||||||
|
"async",
|
||||||
|
"autocomplete",
|
||||||
|
"autofocus",
|
||||||
|
"autoplay",
|
||||||
|
"challenge",
|
||||||
|
"charset",
|
||||||
|
"checked",
|
||||||
|
"cite",
|
||||||
|
"class",
|
||||||
|
"cols",
|
||||||
|
"colspan",
|
||||||
|
"command",
|
||||||
|
"content",
|
||||||
|
"contenteditable",
|
||||||
|
"contextmenu",
|
||||||
|
"controls",
|
||||||
|
"coords",
|
||||||
|
"crossorigin",
|
||||||
|
"data",
|
||||||
|
"datetime",
|
||||||
|
"default",
|
||||||
|
"defer",
|
||||||
|
"dir",
|
||||||
|
"dirname",
|
||||||
|
"disabled",
|
||||||
|
"download",
|
||||||
|
"draggable",
|
||||||
|
"dropzone",
|
||||||
|
"enctype",
|
||||||
|
"for",
|
||||||
|
"form",
|
||||||
|
"formaction",
|
||||||
|
"formenctype",
|
||||||
|
"formmethod",
|
||||||
|
"formnovalidate",
|
||||||
|
"formtarget",
|
||||||
|
"headers",
|
||||||
|
"height",
|
||||||
|
"hidden",
|
||||||
|
"high",
|
||||||
|
"href",
|
||||||
|
"hreflang",
|
||||||
|
"http-equiv",
|
||||||
|
"icon",
|
||||||
|
"id",
|
||||||
|
"inputmode",
|
||||||
|
"ismap",
|
||||||
|
"itemid",
|
||||||
|
"itemprop",
|
||||||
|
"itemref",
|
||||||
|
"itemscope",
|
||||||
|
"itemtype",
|
||||||
|
"keytype",
|
||||||
|
"kind",
|
||||||
|
"label",
|
||||||
|
"lang",
|
||||||
|
"list",
|
||||||
|
"loop",
|
||||||
|
"low",
|
||||||
|
"manifest",
|
||||||
|
"max",
|
||||||
|
"maxlength",
|
||||||
|
"media",
|
||||||
|
"mediagroup",
|
||||||
|
"method",
|
||||||
|
"min",
|
||||||
|
"minlength",
|
||||||
|
"multiple",
|
||||||
|
"muted",
|
||||||
|
"name",
|
||||||
|
"novalidate",
|
||||||
|
"open",
|
||||||
|
"optimum",
|
||||||
|
"pattern",
|
||||||
|
"ping",
|
||||||
|
"placeholder",
|
||||||
|
"poster",
|
||||||
|
"preload",
|
||||||
|
"radiogroup",
|
||||||
|
"readonly",
|
||||||
|
"rel",
|
||||||
|
"required",
|
||||||
|
"reversed",
|
||||||
|
"rows",
|
||||||
|
"rowspan",
|
||||||
|
"sandbox",
|
||||||
|
"spellcheck",
|
||||||
|
"scope",
|
||||||
|
"scoped",
|
||||||
|
"seamless",
|
||||||
|
"selected",
|
||||||
|
"shape",
|
||||||
|
"size",
|
||||||
|
"sizes",
|
||||||
|
"sortable",
|
||||||
|
"sorted",
|
||||||
|
"span",
|
||||||
|
"src",
|
||||||
|
"srcdoc",
|
||||||
|
"srclang",
|
||||||
|
"start",
|
||||||
|
"step",
|
||||||
|
"style",
|
||||||
|
"tabindex",
|
||||||
|
"target",
|
||||||
|
"title",
|
||||||
|
"translate",
|
||||||
|
"type",
|
||||||
|
"typemustmatch",
|
||||||
|
"usemap",
|
||||||
|
"value",
|
||||||
|
"width",
|
||||||
|
"wrap",
|
||||||
|
}
|
||||||
|
|
||||||
|
var eventHandlers = []string{
|
||||||
|
"onabort",
|
||||||
|
"onautocomplete",
|
||||||
|
"onautocompleteerror",
|
||||||
|
"onafterprint",
|
||||||
|
"onbeforeprint",
|
||||||
|
"onbeforeunload",
|
||||||
|
"onblur",
|
||||||
|
"oncancel",
|
||||||
|
"oncanplay",
|
||||||
|
"oncanplaythrough",
|
||||||
|
"onchange",
|
||||||
|
"onclick",
|
||||||
|
"onclose",
|
||||||
|
"oncontextmenu",
|
||||||
|
"oncuechange",
|
||||||
|
"ondblclick",
|
||||||
|
"ondrag",
|
||||||
|
"ondragend",
|
||||||
|
"ondragenter",
|
||||||
|
"ondragleave",
|
||||||
|
"ondragover",
|
||||||
|
"ondragstart",
|
||||||
|
"ondrop",
|
||||||
|
"ondurationchange",
|
||||||
|
"onemptied",
|
||||||
|
"onended",
|
||||||
|
"onerror",
|
||||||
|
"onfocus",
|
||||||
|
"onhashchange",
|
||||||
|
"oninput",
|
||||||
|
"oninvalid",
|
||||||
|
"onkeydown",
|
||||||
|
"onkeypress",
|
||||||
|
"onkeyup",
|
||||||
|
"onlanguagechange",
|
||||||
|
"onload",
|
||||||
|
"onloadeddata",
|
||||||
|
"onloadedmetadata",
|
||||||
|
"onloadstart",
|
||||||
|
"onmessage",
|
||||||
|
"onmousedown",
|
||||||
|
"onmousemove",
|
||||||
|
"onmouseout",
|
||||||
|
"onmouseover",
|
||||||
|
"onmouseup",
|
||||||
|
"onmousewheel",
|
||||||
|
"onoffline",
|
||||||
|
"ononline",
|
||||||
|
"onpagehide",
|
||||||
|
"onpageshow",
|
||||||
|
"onpause",
|
||||||
|
"onplay",
|
||||||
|
"onplaying",
|
||||||
|
"onpopstate",
|
||||||
|
"onprogress",
|
||||||
|
"onratechange",
|
||||||
|
"onreset",
|
||||||
|
"onresize",
|
||||||
|
"onscroll",
|
||||||
|
"onseeked",
|
||||||
|
"onseeking",
|
||||||
|
"onselect",
|
||||||
|
"onshow",
|
||||||
|
"onsort",
|
||||||
|
"onstalled",
|
||||||
|
"onstorage",
|
||||||
|
"onsubmit",
|
||||||
|
"onsuspend",
|
||||||
|
"ontimeupdate",
|
||||||
|
"ontoggle",
|
||||||
|
"onunload",
|
||||||
|
"onvolumechange",
|
||||||
|
"onwaiting",
|
||||||
|
}
|
||||||
|
|
||||||
|
// extra are ad-hoc values not covered by any of the lists above.
|
||||||
|
var extra = []string{
|
||||||
|
"align",
|
||||||
|
"annotation",
|
||||||
|
"annotation-xml",
|
||||||
|
"applet",
|
||||||
|
"basefont",
|
||||||
|
"bgsound",
|
||||||
|
"big",
|
||||||
|
"blink",
|
||||||
|
"center",
|
||||||
|
"color",
|
||||||
|
"desc",
|
||||||
|
"face",
|
||||||
|
"font",
|
||||||
|
"foreignObject", // HTML is case-insensitive, but SVG-embedded-in-HTML is case-sensitive.
|
||||||
|
"foreignobject",
|
||||||
|
"frame",
|
||||||
|
"frameset",
|
||||||
|
"image",
|
||||||
|
"isindex",
|
||||||
|
"listing",
|
||||||
|
"malignmark",
|
||||||
|
"marquee",
|
||||||
|
"math",
|
||||||
|
"mglyph",
|
||||||
|
"mi",
|
||||||
|
"mn",
|
||||||
|
"mo",
|
||||||
|
"ms",
|
||||||
|
"mtext",
|
||||||
|
"nobr",
|
||||||
|
"noembed",
|
||||||
|
"noframes",
|
||||||
|
"plaintext",
|
||||||
|
"prompt",
|
||||||
|
"public",
|
||||||
|
"spacer",
|
||||||
|
"strike",
|
||||||
|
"svg",
|
||||||
|
"system",
|
||||||
|
"tt",
|
||||||
|
"xmp",
|
||||||
|
}
|
||||||
+713
@@ -0,0 +1,713 @@
|
|||||||
|
// generated by go run gen.go; DO NOT EDIT
|
||||||
|
|
||||||
|
package atom
|
||||||
|
|
||||||
|
const (
|
||||||
|
A Atom = 0x1
|
||||||
|
Abbr Atom = 0x4
|
||||||
|
Accept Atom = 0x2106
|
||||||
|
AcceptCharset Atom = 0x210e
|
||||||
|
Accesskey Atom = 0x3309
|
||||||
|
Action Atom = 0x1f606
|
||||||
|
Address Atom = 0x4f307
|
||||||
|
Align Atom = 0x1105
|
||||||
|
Alt Atom = 0x4503
|
||||||
|
Annotation Atom = 0x1670a
|
||||||
|
AnnotationXml Atom = 0x1670e
|
||||||
|
Applet Atom = 0x2b306
|
||||||
|
Area Atom = 0x2fa04
|
||||||
|
Article Atom = 0x38807
|
||||||
|
Aside Atom = 0x8305
|
||||||
|
Async Atom = 0x7b05
|
||||||
|
Audio Atom = 0xa605
|
||||||
|
Autocomplete Atom = 0x1fc0c
|
||||||
|
Autofocus Atom = 0xb309
|
||||||
|
Autoplay Atom = 0xce08
|
||||||
|
B Atom = 0x101
|
||||||
|
Base Atom = 0xd604
|
||||||
|
Basefont Atom = 0xd608
|
||||||
|
Bdi Atom = 0x1a03
|
||||||
|
Bdo Atom = 0xe703
|
||||||
|
Bgsound Atom = 0x11807
|
||||||
|
Big Atom = 0x12403
|
||||||
|
Blink Atom = 0x12705
|
||||||
|
Blockquote Atom = 0x12c0a
|
||||||
|
Body Atom = 0x2f04
|
||||||
|
Br Atom = 0x202
|
||||||
|
Button Atom = 0x13606
|
||||||
|
Canvas Atom = 0x7f06
|
||||||
|
Caption Atom = 0x1bb07
|
||||||
|
Center Atom = 0x5b506
|
||||||
|
Challenge Atom = 0x21f09
|
||||||
|
Charset Atom = 0x2807
|
||||||
|
Checked Atom = 0x32807
|
||||||
|
Cite Atom = 0x3c804
|
||||||
|
Class Atom = 0x4de05
|
||||||
|
Code Atom = 0x14904
|
||||||
|
Col Atom = 0x15003
|
||||||
|
Colgroup Atom = 0x15008
|
||||||
|
Color Atom = 0x15d05
|
||||||
|
Cols Atom = 0x16204
|
||||||
|
Colspan Atom = 0x16207
|
||||||
|
Command Atom = 0x17507
|
||||||
|
Content Atom = 0x42307
|
||||||
|
Contenteditable Atom = 0x4230f
|
||||||
|
Contextmenu Atom = 0x3310b
|
||||||
|
Controls Atom = 0x18808
|
||||||
|
Coords Atom = 0x19406
|
||||||
|
Crossorigin Atom = 0x19f0b
|
||||||
|
Data Atom = 0x44a04
|
||||||
|
Datalist Atom = 0x44a08
|
||||||
|
Datetime Atom = 0x23c08
|
||||||
|
Dd Atom = 0x26702
|
||||||
|
Default Atom = 0x8607
|
||||||
|
Defer Atom = 0x14b05
|
||||||
|
Del Atom = 0x3ef03
|
||||||
|
Desc Atom = 0x4db04
|
||||||
|
Details Atom = 0x4807
|
||||||
|
Dfn Atom = 0x6103
|
||||||
|
Dialog Atom = 0x1b06
|
||||||
|
Dir Atom = 0x6903
|
||||||
|
Dirname Atom = 0x6907
|
||||||
|
Disabled Atom = 0x10c08
|
||||||
|
Div Atom = 0x11303
|
||||||
|
Dl Atom = 0x11e02
|
||||||
|
Download Atom = 0x40008
|
||||||
|
Draggable Atom = 0x17b09
|
||||||
|
Dropzone Atom = 0x39108
|
||||||
|
Dt Atom = 0x50902
|
||||||
|
Em Atom = 0x6502
|
||||||
|
Embed Atom = 0x6505
|
||||||
|
Enctype Atom = 0x21107
|
||||||
|
Face Atom = 0x5b304
|
||||||
|
Fieldset Atom = 0x1b008
|
||||||
|
Figcaption Atom = 0x1b80a
|
||||||
|
Figure Atom = 0x1cc06
|
||||||
|
Font Atom = 0xda04
|
||||||
|
Footer Atom = 0x8d06
|
||||||
|
For Atom = 0x1d803
|
||||||
|
ForeignObject Atom = 0x1d80d
|
||||||
|
Foreignobject Atom = 0x1e50d
|
||||||
|
Form Atom = 0x1f204
|
||||||
|
Formaction Atom = 0x1f20a
|
||||||
|
Formenctype Atom = 0x20d0b
|
||||||
|
Formmethod Atom = 0x2280a
|
||||||
|
Formnovalidate Atom = 0x2320e
|
||||||
|
Formtarget Atom = 0x2470a
|
||||||
|
Frame Atom = 0x9a05
|
||||||
|
Frameset Atom = 0x9a08
|
||||||
|
H1 Atom = 0x26e02
|
||||||
|
H2 Atom = 0x29402
|
||||||
|
H3 Atom = 0x2a702
|
||||||
|
H4 Atom = 0x2e902
|
||||||
|
H5 Atom = 0x2f302
|
||||||
|
H6 Atom = 0x50b02
|
||||||
|
Head Atom = 0x2d504
|
||||||
|
Header Atom = 0x2d506
|
||||||
|
Headers Atom = 0x2d507
|
||||||
|
Height Atom = 0x25106
|
||||||
|
Hgroup Atom = 0x25906
|
||||||
|
Hidden Atom = 0x26506
|
||||||
|
High Atom = 0x26b04
|
||||||
|
Hr Atom = 0x27002
|
||||||
|
Href Atom = 0x27004
|
||||||
|
Hreflang Atom = 0x27008
|
||||||
|
Html Atom = 0x25504
|
||||||
|
HttpEquiv Atom = 0x2780a
|
||||||
|
I Atom = 0x601
|
||||||
|
Icon Atom = 0x42204
|
||||||
|
Id Atom = 0x8502
|
||||||
|
Iframe Atom = 0x29606
|
||||||
|
Image Atom = 0x29c05
|
||||||
|
Img Atom = 0x2a103
|
||||||
|
Input Atom = 0x3e805
|
||||||
|
Inputmode Atom = 0x3e809
|
||||||
|
Ins Atom = 0x1a803
|
||||||
|
Isindex Atom = 0x2a907
|
||||||
|
Ismap Atom = 0x2b005
|
||||||
|
Itemid Atom = 0x33c06
|
||||||
|
Itemprop Atom = 0x3c908
|
||||||
|
Itemref Atom = 0x5ad07
|
||||||
|
Itemscope Atom = 0x2b909
|
||||||
|
Itemtype Atom = 0x2c308
|
||||||
|
Kbd Atom = 0x1903
|
||||||
|
Keygen Atom = 0x3906
|
||||||
|
Keytype Atom = 0x53707
|
||||||
|
Kind Atom = 0x10904
|
||||||
|
Label Atom = 0xf005
|
||||||
|
Lang Atom = 0x27404
|
||||||
|
Legend Atom = 0x18206
|
||||||
|
Li Atom = 0x1202
|
||||||
|
Link Atom = 0x12804
|
||||||
|
List Atom = 0x44e04
|
||||||
|
Listing Atom = 0x44e07
|
||||||
|
Loop Atom = 0xf404
|
||||||
|
Low Atom = 0x11f03
|
||||||
|
Malignmark Atom = 0x100a
|
||||||
|
Manifest Atom = 0x5f108
|
||||||
|
Map Atom = 0x2b203
|
||||||
|
Mark Atom = 0x1604
|
||||||
|
Marquee Atom = 0x2cb07
|
||||||
|
Math Atom = 0x2d204
|
||||||
|
Max Atom = 0x2e103
|
||||||
|
Maxlength Atom = 0x2e109
|
||||||
|
Media Atom = 0x6e05
|
||||||
|
Mediagroup Atom = 0x6e0a
|
||||||
|
Menu Atom = 0x33804
|
||||||
|
Menuitem Atom = 0x33808
|
||||||
|
Meta Atom = 0x45d04
|
||||||
|
Meter Atom = 0x24205
|
||||||
|
Method Atom = 0x22c06
|
||||||
|
Mglyph Atom = 0x2a206
|
||||||
|
Mi Atom = 0x2eb02
|
||||||
|
Min Atom = 0x2eb03
|
||||||
|
Minlength Atom = 0x2eb09
|
||||||
|
Mn Atom = 0x23502
|
||||||
|
Mo Atom = 0x3ed02
|
||||||
|
Ms Atom = 0x2bc02
|
||||||
|
Mtext Atom = 0x2f505
|
||||||
|
Multiple Atom = 0x30308
|
||||||
|
Muted Atom = 0x30b05
|
||||||
|
Name Atom = 0x6c04
|
||||||
|
Nav Atom = 0x3e03
|
||||||
|
Nobr Atom = 0x5704
|
||||||
|
Noembed Atom = 0x6307
|
||||||
|
Noframes Atom = 0x9808
|
||||||
|
Noscript Atom = 0x3d208
|
||||||
|
Novalidate Atom = 0x2360a
|
||||||
|
Object Atom = 0x1ec06
|
||||||
|
Ol Atom = 0xc902
|
||||||
|
Onabort Atom = 0x13a07
|
||||||
|
Onafterprint Atom = 0x1c00c
|
||||||
|
Onautocomplete Atom = 0x1fa0e
|
||||||
|
Onautocompleteerror Atom = 0x1fa13
|
||||||
|
Onbeforeprint Atom = 0x6040d
|
||||||
|
Onbeforeunload Atom = 0x4e70e
|
||||||
|
Onblur Atom = 0xaa06
|
||||||
|
Oncancel Atom = 0xe908
|
||||||
|
Oncanplay Atom = 0x28509
|
||||||
|
Oncanplaythrough Atom = 0x28510
|
||||||
|
Onchange Atom = 0x3a708
|
||||||
|
Onclick Atom = 0x31007
|
||||||
|
Onclose Atom = 0x31707
|
||||||
|
Oncontextmenu Atom = 0x32f0d
|
||||||
|
Oncuechange Atom = 0x3420b
|
||||||
|
Ondblclick Atom = 0x34d0a
|
||||||
|
Ondrag Atom = 0x35706
|
||||||
|
Ondragend Atom = 0x35709
|
||||||
|
Ondragenter Atom = 0x3600b
|
||||||
|
Ondragleave Atom = 0x36b0b
|
||||||
|
Ondragover Atom = 0x3760a
|
||||||
|
Ondragstart Atom = 0x3800b
|
||||||
|
Ondrop Atom = 0x38f06
|
||||||
|
Ondurationchange Atom = 0x39f10
|
||||||
|
Onemptied Atom = 0x39609
|
||||||
|
Onended Atom = 0x3af07
|
||||||
|
Onerror Atom = 0x3b607
|
||||||
|
Onfocus Atom = 0x3bd07
|
||||||
|
Onhashchange Atom = 0x3da0c
|
||||||
|
Oninput Atom = 0x3e607
|
||||||
|
Oninvalid Atom = 0x3f209
|
||||||
|
Onkeydown Atom = 0x3fb09
|
||||||
|
Onkeypress Atom = 0x4080a
|
||||||
|
Onkeyup Atom = 0x41807
|
||||||
|
Onlanguagechange Atom = 0x43210
|
||||||
|
Onload Atom = 0x44206
|
||||||
|
Onloadeddata Atom = 0x4420c
|
||||||
|
Onloadedmetadata Atom = 0x45510
|
||||||
|
Onloadstart Atom = 0x46b0b
|
||||||
|
Onmessage Atom = 0x47609
|
||||||
|
Onmousedown Atom = 0x47f0b
|
||||||
|
Onmousemove Atom = 0x48a0b
|
||||||
|
Onmouseout Atom = 0x4950a
|
||||||
|
Onmouseover Atom = 0x4a20b
|
||||||
|
Onmouseup Atom = 0x4ad09
|
||||||
|
Onmousewheel Atom = 0x4b60c
|
||||||
|
Onoffline Atom = 0x4c209
|
||||||
|
Ononline Atom = 0x4cb08
|
||||||
|
Onpagehide Atom = 0x4d30a
|
||||||
|
Onpageshow Atom = 0x4fe0a
|
||||||
|
Onpause Atom = 0x50d07
|
||||||
|
Onplay Atom = 0x51706
|
||||||
|
Onplaying Atom = 0x51709
|
||||||
|
Onpopstate Atom = 0x5200a
|
||||||
|
Onprogress Atom = 0x52a0a
|
||||||
|
Onratechange Atom = 0x53e0c
|
||||||
|
Onreset Atom = 0x54a07
|
||||||
|
Onresize Atom = 0x55108
|
||||||
|
Onscroll Atom = 0x55f08
|
||||||
|
Onseeked Atom = 0x56708
|
||||||
|
Onseeking Atom = 0x56f09
|
||||||
|
Onselect Atom = 0x57808
|
||||||
|
Onshow Atom = 0x58206
|
||||||
|
Onsort Atom = 0x58b06
|
||||||
|
Onstalled Atom = 0x59509
|
||||||
|
Onstorage Atom = 0x59e09
|
||||||
|
Onsubmit Atom = 0x5a708
|
||||||
|
Onsuspend Atom = 0x5bb09
|
||||||
|
Ontimeupdate Atom = 0xdb0c
|
||||||
|
Ontoggle Atom = 0x5c408
|
||||||
|
Onunload Atom = 0x5cc08
|
||||||
|
Onvolumechange Atom = 0x5d40e
|
||||||
|
Onwaiting Atom = 0x5e209
|
||||||
|
Open Atom = 0x3cf04
|
||||||
|
Optgroup Atom = 0xf608
|
||||||
|
Optimum Atom = 0x5eb07
|
||||||
|
Option Atom = 0x60006
|
||||||
|
Output Atom = 0x49c06
|
||||||
|
P Atom = 0xc01
|
||||||
|
Param Atom = 0xc05
|
||||||
|
Pattern Atom = 0x5107
|
||||||
|
Ping Atom = 0x7704
|
||||||
|
Placeholder Atom = 0xc30b
|
||||||
|
Plaintext Atom = 0xfd09
|
||||||
|
Poster Atom = 0x15706
|
||||||
|
Pre Atom = 0x25e03
|
||||||
|
Preload Atom = 0x25e07
|
||||||
|
Progress Atom = 0x52c08
|
||||||
|
Prompt Atom = 0x5fa06
|
||||||
|
Public Atom = 0x41e06
|
||||||
|
Q Atom = 0x13101
|
||||||
|
Radiogroup Atom = 0x30a
|
||||||
|
Readonly Atom = 0x2fb08
|
||||||
|
Rel Atom = 0x25f03
|
||||||
|
Required Atom = 0x1d008
|
||||||
|
Reversed Atom = 0x5a08
|
||||||
|
Rows Atom = 0x9204
|
||||||
|
Rowspan Atom = 0x9207
|
||||||
|
Rp Atom = 0x1c602
|
||||||
|
Rt Atom = 0x13f02
|
||||||
|
Ruby Atom = 0xaf04
|
||||||
|
S Atom = 0x2c01
|
||||||
|
Samp Atom = 0x4e04
|
||||||
|
Sandbox Atom = 0xbb07
|
||||||
|
Scope Atom = 0x2bd05
|
||||||
|
Scoped Atom = 0x2bd06
|
||||||
|
Script Atom = 0x3d406
|
||||||
|
Seamless Atom = 0x31c08
|
||||||
|
Section Atom = 0x4e207
|
||||||
|
Select Atom = 0x57a06
|
||||||
|
Selected Atom = 0x57a08
|
||||||
|
Shape Atom = 0x4f905
|
||||||
|
Size Atom = 0x55504
|
||||||
|
Sizes Atom = 0x55505
|
||||||
|
Small Atom = 0x18f05
|
||||||
|
Sortable Atom = 0x58d08
|
||||||
|
Sorted Atom = 0x19906
|
||||||
|
Source Atom = 0x1aa06
|
||||||
|
Spacer Atom = 0x2db06
|
||||||
|
Span Atom = 0x9504
|
||||||
|
Spellcheck Atom = 0x3230a
|
||||||
|
Src Atom = 0x3c303
|
||||||
|
Srcdoc Atom = 0x3c306
|
||||||
|
Srclang Atom = 0x41107
|
||||||
|
Start Atom = 0x38605
|
||||||
|
Step Atom = 0x5f704
|
||||||
|
Strike Atom = 0x53306
|
||||||
|
Strong Atom = 0x55906
|
||||||
|
Style Atom = 0x61105
|
||||||
|
Sub Atom = 0x5a903
|
||||||
|
Summary Atom = 0x61607
|
||||||
|
Sup Atom = 0x61d03
|
||||||
|
Svg Atom = 0x62003
|
||||||
|
System Atom = 0x62306
|
||||||
|
Tabindex Atom = 0x46308
|
||||||
|
Table Atom = 0x42d05
|
||||||
|
Target Atom = 0x24b06
|
||||||
|
Tbody Atom = 0x2e05
|
||||||
|
Td Atom = 0x4702
|
||||||
|
Template Atom = 0x62608
|
||||||
|
Textarea Atom = 0x2f608
|
||||||
|
Tfoot Atom = 0x8c05
|
||||||
|
Th Atom = 0x22e02
|
||||||
|
Thead Atom = 0x2d405
|
||||||
|
Time Atom = 0xdd04
|
||||||
|
Title Atom = 0xa105
|
||||||
|
Tr Atom = 0x10502
|
||||||
|
Track Atom = 0x10505
|
||||||
|
Translate Atom = 0x14009
|
||||||
|
Tt Atom = 0x5302
|
||||||
|
Type Atom = 0x21404
|
||||||
|
Typemustmatch Atom = 0x2140d
|
||||||
|
U Atom = 0xb01
|
||||||
|
Ul Atom = 0x8a02
|
||||||
|
Usemap Atom = 0x51106
|
||||||
|
Value Atom = 0x4005
|
||||||
|
Var Atom = 0x11503
|
||||||
|
Video Atom = 0x28105
|
||||||
|
Wbr Atom = 0x12103
|
||||||
|
Width Atom = 0x50705
|
||||||
|
Wrap Atom = 0x58704
|
||||||
|
Xmp Atom = 0xc103
|
||||||
|
)
|
||||||
|
|
||||||
|
const hash0 = 0xc17da63e
|
||||||
|
|
||||||
|
const maxAtomLen = 19
|
||||||
|
|
||||||
|
var table = [1 << 9]Atom{
|
||||||
|
0x1: 0x48a0b, // onmousemove
|
||||||
|
0x2: 0x5e209, // onwaiting
|
||||||
|
0x3: 0x1fa13, // onautocompleteerror
|
||||||
|
0x4: 0x5fa06, // prompt
|
||||||
|
0x7: 0x5eb07, // optimum
|
||||||
|
0x8: 0x1604, // mark
|
||||||
|
0xa: 0x5ad07, // itemref
|
||||||
|
0xb: 0x4fe0a, // onpageshow
|
||||||
|
0xc: 0x57a06, // select
|
||||||
|
0xd: 0x17b09, // draggable
|
||||||
|
0xe: 0x3e03, // nav
|
||||||
|
0xf: 0x17507, // command
|
||||||
|
0x11: 0xb01, // u
|
||||||
|
0x14: 0x2d507, // headers
|
||||||
|
0x15: 0x44a08, // datalist
|
||||||
|
0x17: 0x4e04, // samp
|
||||||
|
0x1a: 0x3fb09, // onkeydown
|
||||||
|
0x1b: 0x55f08, // onscroll
|
||||||
|
0x1c: 0x15003, // col
|
||||||
|
0x20: 0x3c908, // itemprop
|
||||||
|
0x21: 0x2780a, // http-equiv
|
||||||
|
0x22: 0x61d03, // sup
|
||||||
|
0x24: 0x1d008, // required
|
||||||
|
0x2b: 0x25e07, // preload
|
||||||
|
0x2c: 0x6040d, // onbeforeprint
|
||||||
|
0x2d: 0x3600b, // ondragenter
|
||||||
|
0x2e: 0x50902, // dt
|
||||||
|
0x2f: 0x5a708, // onsubmit
|
||||||
|
0x30: 0x27002, // hr
|
||||||
|
0x31: 0x32f0d, // oncontextmenu
|
||||||
|
0x33: 0x29c05, // image
|
||||||
|
0x34: 0x50d07, // onpause
|
||||||
|
0x35: 0x25906, // hgroup
|
||||||
|
0x36: 0x7704, // ping
|
||||||
|
0x37: 0x57808, // onselect
|
||||||
|
0x3a: 0x11303, // div
|
||||||
|
0x3b: 0x1fa0e, // onautocomplete
|
||||||
|
0x40: 0x2eb02, // mi
|
||||||
|
0x41: 0x31c08, // seamless
|
||||||
|
0x42: 0x2807, // charset
|
||||||
|
0x43: 0x8502, // id
|
||||||
|
0x44: 0x5200a, // onpopstate
|
||||||
|
0x45: 0x3ef03, // del
|
||||||
|
0x46: 0x2cb07, // marquee
|
||||||
|
0x47: 0x3309, // accesskey
|
||||||
|
0x49: 0x8d06, // footer
|
||||||
|
0x4a: 0x44e04, // list
|
||||||
|
0x4b: 0x2b005, // ismap
|
||||||
|
0x51: 0x33804, // menu
|
||||||
|
0x52: 0x2f04, // body
|
||||||
|
0x55: 0x9a08, // frameset
|
||||||
|
0x56: 0x54a07, // onreset
|
||||||
|
0x57: 0x12705, // blink
|
||||||
|
0x58: 0xa105, // title
|
||||||
|
0x59: 0x38807, // article
|
||||||
|
0x5b: 0x22e02, // th
|
||||||
|
0x5d: 0x13101, // q
|
||||||
|
0x5e: 0x3cf04, // open
|
||||||
|
0x5f: 0x2fa04, // area
|
||||||
|
0x61: 0x44206, // onload
|
||||||
|
0x62: 0xda04, // font
|
||||||
|
0x63: 0xd604, // base
|
||||||
|
0x64: 0x16207, // colspan
|
||||||
|
0x65: 0x53707, // keytype
|
||||||
|
0x66: 0x11e02, // dl
|
||||||
|
0x68: 0x1b008, // fieldset
|
||||||
|
0x6a: 0x2eb03, // min
|
||||||
|
0x6b: 0x11503, // var
|
||||||
|
0x6f: 0x2d506, // header
|
||||||
|
0x70: 0x13f02, // rt
|
||||||
|
0x71: 0x15008, // colgroup
|
||||||
|
0x72: 0x23502, // mn
|
||||||
|
0x74: 0x13a07, // onabort
|
||||||
|
0x75: 0x3906, // keygen
|
||||||
|
0x76: 0x4c209, // onoffline
|
||||||
|
0x77: 0x21f09, // challenge
|
||||||
|
0x78: 0x2b203, // map
|
||||||
|
0x7a: 0x2e902, // h4
|
||||||
|
0x7b: 0x3b607, // onerror
|
||||||
|
0x7c: 0x2e109, // maxlength
|
||||||
|
0x7d: 0x2f505, // mtext
|
||||||
|
0x7e: 0xbb07, // sandbox
|
||||||
|
0x7f: 0x58b06, // onsort
|
||||||
|
0x80: 0x100a, // malignmark
|
||||||
|
0x81: 0x45d04, // meta
|
||||||
|
0x82: 0x7b05, // async
|
||||||
|
0x83: 0x2a702, // h3
|
||||||
|
0x84: 0x26702, // dd
|
||||||
|
0x85: 0x27004, // href
|
||||||
|
0x86: 0x6e0a, // mediagroup
|
||||||
|
0x87: 0x19406, // coords
|
||||||
|
0x88: 0x41107, // srclang
|
||||||
|
0x89: 0x34d0a, // ondblclick
|
||||||
|
0x8a: 0x4005, // value
|
||||||
|
0x8c: 0xe908, // oncancel
|
||||||
|
0x8e: 0x3230a, // spellcheck
|
||||||
|
0x8f: 0x9a05, // frame
|
||||||
|
0x91: 0x12403, // big
|
||||||
|
0x94: 0x1f606, // action
|
||||||
|
0x95: 0x6903, // dir
|
||||||
|
0x97: 0x2fb08, // readonly
|
||||||
|
0x99: 0x42d05, // table
|
||||||
|
0x9a: 0x61607, // summary
|
||||||
|
0x9b: 0x12103, // wbr
|
||||||
|
0x9c: 0x30a, // radiogroup
|
||||||
|
0x9d: 0x6c04, // name
|
||||||
|
0x9f: 0x62306, // system
|
||||||
|
0xa1: 0x15d05, // color
|
||||||
|
0xa2: 0x7f06, // canvas
|
||||||
|
0xa3: 0x25504, // html
|
||||||
|
0xa5: 0x56f09, // onseeking
|
||||||
|
0xac: 0x4f905, // shape
|
||||||
|
0xad: 0x25f03, // rel
|
||||||
|
0xae: 0x28510, // oncanplaythrough
|
||||||
|
0xaf: 0x3760a, // ondragover
|
||||||
|
0xb0: 0x62608, // template
|
||||||
|
0xb1: 0x1d80d, // foreignObject
|
||||||
|
0xb3: 0x9204, // rows
|
||||||
|
0xb6: 0x44e07, // listing
|
||||||
|
0xb7: 0x49c06, // output
|
||||||
|
0xb9: 0x3310b, // contextmenu
|
||||||
|
0xbb: 0x11f03, // low
|
||||||
|
0xbc: 0x1c602, // rp
|
||||||
|
0xbd: 0x5bb09, // onsuspend
|
||||||
|
0xbe: 0x13606, // button
|
||||||
|
0xbf: 0x4db04, // desc
|
||||||
|
0xc1: 0x4e207, // section
|
||||||
|
0xc2: 0x52a0a, // onprogress
|
||||||
|
0xc3: 0x59e09, // onstorage
|
||||||
|
0xc4: 0x2d204, // math
|
||||||
|
0xc5: 0x4503, // alt
|
||||||
|
0xc7: 0x8a02, // ul
|
||||||
|
0xc8: 0x5107, // pattern
|
||||||
|
0xc9: 0x4b60c, // onmousewheel
|
||||||
|
0xca: 0x35709, // ondragend
|
||||||
|
0xcb: 0xaf04, // ruby
|
||||||
|
0xcc: 0xc01, // p
|
||||||
|
0xcd: 0x31707, // onclose
|
||||||
|
0xce: 0x24205, // meter
|
||||||
|
0xcf: 0x11807, // bgsound
|
||||||
|
0xd2: 0x25106, // height
|
||||||
|
0xd4: 0x101, // b
|
||||||
|
0xd5: 0x2c308, // itemtype
|
||||||
|
0xd8: 0x1bb07, // caption
|
||||||
|
0xd9: 0x10c08, // disabled
|
||||||
|
0xdb: 0x33808, // menuitem
|
||||||
|
0xdc: 0x62003, // svg
|
||||||
|
0xdd: 0x18f05, // small
|
||||||
|
0xde: 0x44a04, // data
|
||||||
|
0xe0: 0x4cb08, // ononline
|
||||||
|
0xe1: 0x2a206, // mglyph
|
||||||
|
0xe3: 0x6505, // embed
|
||||||
|
0xe4: 0x10502, // tr
|
||||||
|
0xe5: 0x46b0b, // onloadstart
|
||||||
|
0xe7: 0x3c306, // srcdoc
|
||||||
|
0xeb: 0x5c408, // ontoggle
|
||||||
|
0xed: 0xe703, // bdo
|
||||||
|
0xee: 0x4702, // td
|
||||||
|
0xef: 0x8305, // aside
|
||||||
|
0xf0: 0x29402, // h2
|
||||||
|
0xf1: 0x52c08, // progress
|
||||||
|
0xf2: 0x12c0a, // blockquote
|
||||||
|
0xf4: 0xf005, // label
|
||||||
|
0xf5: 0x601, // i
|
||||||
|
0xf7: 0x9207, // rowspan
|
||||||
|
0xfb: 0x51709, // onplaying
|
||||||
|
0xfd: 0x2a103, // img
|
||||||
|
0xfe: 0xf608, // optgroup
|
||||||
|
0xff: 0x42307, // content
|
||||||
|
0x101: 0x53e0c, // onratechange
|
||||||
|
0x103: 0x3da0c, // onhashchange
|
||||||
|
0x104: 0x4807, // details
|
||||||
|
0x106: 0x40008, // download
|
||||||
|
0x109: 0x14009, // translate
|
||||||
|
0x10b: 0x4230f, // contenteditable
|
||||||
|
0x10d: 0x36b0b, // ondragleave
|
||||||
|
0x10e: 0x2106, // accept
|
||||||
|
0x10f: 0x57a08, // selected
|
||||||
|
0x112: 0x1f20a, // formaction
|
||||||
|
0x113: 0x5b506, // center
|
||||||
|
0x115: 0x45510, // onloadedmetadata
|
||||||
|
0x116: 0x12804, // link
|
||||||
|
0x117: 0xdd04, // time
|
||||||
|
0x118: 0x19f0b, // crossorigin
|
||||||
|
0x119: 0x3bd07, // onfocus
|
||||||
|
0x11a: 0x58704, // wrap
|
||||||
|
0x11b: 0x42204, // icon
|
||||||
|
0x11d: 0x28105, // video
|
||||||
|
0x11e: 0x4de05, // class
|
||||||
|
0x121: 0x5d40e, // onvolumechange
|
||||||
|
0x122: 0xaa06, // onblur
|
||||||
|
0x123: 0x2b909, // itemscope
|
||||||
|
0x124: 0x61105, // style
|
||||||
|
0x127: 0x41e06, // public
|
||||||
|
0x129: 0x2320e, // formnovalidate
|
||||||
|
0x12a: 0x58206, // onshow
|
||||||
|
0x12c: 0x51706, // onplay
|
||||||
|
0x12d: 0x3c804, // cite
|
||||||
|
0x12e: 0x2bc02, // ms
|
||||||
|
0x12f: 0xdb0c, // ontimeupdate
|
||||||
|
0x130: 0x10904, // kind
|
||||||
|
0x131: 0x2470a, // formtarget
|
||||||
|
0x135: 0x3af07, // onended
|
||||||
|
0x136: 0x26506, // hidden
|
||||||
|
0x137: 0x2c01, // s
|
||||||
|
0x139: 0x2280a, // formmethod
|
||||||
|
0x13a: 0x3e805, // input
|
||||||
|
0x13c: 0x50b02, // h6
|
||||||
|
0x13d: 0xc902, // ol
|
||||||
|
0x13e: 0x3420b, // oncuechange
|
||||||
|
0x13f: 0x1e50d, // foreignobject
|
||||||
|
0x143: 0x4e70e, // onbeforeunload
|
||||||
|
0x144: 0x2bd05, // scope
|
||||||
|
0x145: 0x39609, // onemptied
|
||||||
|
0x146: 0x14b05, // defer
|
||||||
|
0x147: 0xc103, // xmp
|
||||||
|
0x148: 0x39f10, // ondurationchange
|
||||||
|
0x149: 0x1903, // kbd
|
||||||
|
0x14c: 0x47609, // onmessage
|
||||||
|
0x14d: 0x60006, // option
|
||||||
|
0x14e: 0x2eb09, // minlength
|
||||||
|
0x14f: 0x32807, // checked
|
||||||
|
0x150: 0xce08, // autoplay
|
||||||
|
0x152: 0x202, // br
|
||||||
|
0x153: 0x2360a, // novalidate
|
||||||
|
0x156: 0x6307, // noembed
|
||||||
|
0x159: 0x31007, // onclick
|
||||||
|
0x15a: 0x47f0b, // onmousedown
|
||||||
|
0x15b: 0x3a708, // onchange
|
||||||
|
0x15e: 0x3f209, // oninvalid
|
||||||
|
0x15f: 0x2bd06, // scoped
|
||||||
|
0x160: 0x18808, // controls
|
||||||
|
0x161: 0x30b05, // muted
|
||||||
|
0x162: 0x58d08, // sortable
|
||||||
|
0x163: 0x51106, // usemap
|
||||||
|
0x164: 0x1b80a, // figcaption
|
||||||
|
0x165: 0x35706, // ondrag
|
||||||
|
0x166: 0x26b04, // high
|
||||||
|
0x168: 0x3c303, // src
|
||||||
|
0x169: 0x15706, // poster
|
||||||
|
0x16b: 0x1670e, // annotation-xml
|
||||||
|
0x16c: 0x5f704, // step
|
||||||
|
0x16d: 0x4, // abbr
|
||||||
|
0x16e: 0x1b06, // dialog
|
||||||
|
0x170: 0x1202, // li
|
||||||
|
0x172: 0x3ed02, // mo
|
||||||
|
0x175: 0x1d803, // for
|
||||||
|
0x176: 0x1a803, // ins
|
||||||
|
0x178: 0x55504, // size
|
||||||
|
0x179: 0x43210, // onlanguagechange
|
||||||
|
0x17a: 0x8607, // default
|
||||||
|
0x17b: 0x1a03, // bdi
|
||||||
|
0x17c: 0x4d30a, // onpagehide
|
||||||
|
0x17d: 0x6907, // dirname
|
||||||
|
0x17e: 0x21404, // type
|
||||||
|
0x17f: 0x1f204, // form
|
||||||
|
0x181: 0x28509, // oncanplay
|
||||||
|
0x182: 0x6103, // dfn
|
||||||
|
0x183: 0x46308, // tabindex
|
||||||
|
0x186: 0x6502, // em
|
||||||
|
0x187: 0x27404, // lang
|
||||||
|
0x189: 0x39108, // dropzone
|
||||||
|
0x18a: 0x4080a, // onkeypress
|
||||||
|
0x18b: 0x23c08, // datetime
|
||||||
|
0x18c: 0x16204, // cols
|
||||||
|
0x18d: 0x1, // a
|
||||||
|
0x18e: 0x4420c, // onloadeddata
|
||||||
|
0x190: 0xa605, // audio
|
||||||
|
0x192: 0x2e05, // tbody
|
||||||
|
0x193: 0x22c06, // method
|
||||||
|
0x195: 0xf404, // loop
|
||||||
|
0x196: 0x29606, // iframe
|
||||||
|
0x198: 0x2d504, // head
|
||||||
|
0x19e: 0x5f108, // manifest
|
||||||
|
0x19f: 0xb309, // autofocus
|
||||||
|
0x1a0: 0x14904, // code
|
||||||
|
0x1a1: 0x55906, // strong
|
||||||
|
0x1a2: 0x30308, // multiple
|
||||||
|
0x1a3: 0xc05, // param
|
||||||
|
0x1a6: 0x21107, // enctype
|
||||||
|
0x1a7: 0x5b304, // face
|
||||||
|
0x1a8: 0xfd09, // plaintext
|
||||||
|
0x1a9: 0x26e02, // h1
|
||||||
|
0x1aa: 0x59509, // onstalled
|
||||||
|
0x1ad: 0x3d406, // script
|
||||||
|
0x1ae: 0x2db06, // spacer
|
||||||
|
0x1af: 0x55108, // onresize
|
||||||
|
0x1b0: 0x4a20b, // onmouseover
|
||||||
|
0x1b1: 0x5cc08, // onunload
|
||||||
|
0x1b2: 0x56708, // onseeked
|
||||||
|
0x1b4: 0x2140d, // typemustmatch
|
||||||
|
0x1b5: 0x1cc06, // figure
|
||||||
|
0x1b6: 0x4950a, // onmouseout
|
||||||
|
0x1b7: 0x25e03, // pre
|
||||||
|
0x1b8: 0x50705, // width
|
||||||
|
0x1b9: 0x19906, // sorted
|
||||||
|
0x1bb: 0x5704, // nobr
|
||||||
|
0x1be: 0x5302, // tt
|
||||||
|
0x1bf: 0x1105, // align
|
||||||
|
0x1c0: 0x3e607, // oninput
|
||||||
|
0x1c3: 0x41807, // onkeyup
|
||||||
|
0x1c6: 0x1c00c, // onafterprint
|
||||||
|
0x1c7: 0x210e, // accept-charset
|
||||||
|
0x1c8: 0x33c06, // itemid
|
||||||
|
0x1c9: 0x3e809, // inputmode
|
||||||
|
0x1cb: 0x53306, // strike
|
||||||
|
0x1cc: 0x5a903, // sub
|
||||||
|
0x1cd: 0x10505, // track
|
||||||
|
0x1ce: 0x38605, // start
|
||||||
|
0x1d0: 0xd608, // basefont
|
||||||
|
0x1d6: 0x1aa06, // source
|
||||||
|
0x1d7: 0x18206, // legend
|
||||||
|
0x1d8: 0x2d405, // thead
|
||||||
|
0x1da: 0x8c05, // tfoot
|
||||||
|
0x1dd: 0x1ec06, // object
|
||||||
|
0x1de: 0x6e05, // media
|
||||||
|
0x1df: 0x1670a, // annotation
|
||||||
|
0x1e0: 0x20d0b, // formenctype
|
||||||
|
0x1e2: 0x3d208, // noscript
|
||||||
|
0x1e4: 0x55505, // sizes
|
||||||
|
0x1e5: 0x1fc0c, // autocomplete
|
||||||
|
0x1e6: 0x9504, // span
|
||||||
|
0x1e7: 0x9808, // noframes
|
||||||
|
0x1e8: 0x24b06, // target
|
||||||
|
0x1e9: 0x38f06, // ondrop
|
||||||
|
0x1ea: 0x2b306, // applet
|
||||||
|
0x1ec: 0x5a08, // reversed
|
||||||
|
0x1f0: 0x2a907, // isindex
|
||||||
|
0x1f3: 0x27008, // hreflang
|
||||||
|
0x1f5: 0x2f302, // h5
|
||||||
|
0x1f6: 0x4f307, // address
|
||||||
|
0x1fa: 0x2e103, // max
|
||||||
|
0x1fb: 0xc30b, // placeholder
|
||||||
|
0x1fc: 0x2f608, // textarea
|
||||||
|
0x1fe: 0x4ad09, // onmouseup
|
||||||
|
0x1ff: 0x3800b, // ondragstart
|
||||||
|
}
|
||||||
|
|
||||||
|
const atomText = "abbradiogrouparamalignmarkbdialogaccept-charsetbodyaccesskey" +
|
||||||
|
"genavaluealtdetailsampatternobreversedfnoembedirnamediagroup" +
|
||||||
|
"ingasyncanvasidefaultfooterowspanoframesetitleaudionblurubya" +
|
||||||
|
"utofocusandboxmplaceholderautoplaybasefontimeupdatebdoncance" +
|
||||||
|
"labelooptgrouplaintextrackindisabledivarbgsoundlowbrbigblink" +
|
||||||
|
"blockquotebuttonabortranslatecodefercolgroupostercolorcolspa" +
|
||||||
|
"nnotation-xmlcommandraggablegendcontrolsmallcoordsortedcross" +
|
||||||
|
"originsourcefieldsetfigcaptionafterprintfigurequiredforeignO" +
|
||||||
|
"bjectforeignobjectformactionautocompleteerrorformenctypemust" +
|
||||||
|
"matchallengeformmethodformnovalidatetimeterformtargetheightm" +
|
||||||
|
"lhgroupreloadhiddenhigh1hreflanghttp-equivideoncanplaythroug" +
|
||||||
|
"h2iframeimageimglyph3isindexismappletitemscopeditemtypemarqu" +
|
||||||
|
"eematheaderspacermaxlength4minlength5mtextareadonlymultiplem" +
|
||||||
|
"utedonclickoncloseamlesspellcheckedoncontextmenuitemidoncuec" +
|
||||||
|
"hangeondblclickondragendondragenterondragleaveondragoverondr" +
|
||||||
|
"agstarticleondropzonemptiedondurationchangeonendedonerroronf" +
|
||||||
|
"ocusrcdocitempropenoscriptonhashchangeoninputmodeloninvalido" +
|
||||||
|
"nkeydownloadonkeypressrclangonkeyupublicontenteditableonlang" +
|
||||||
|
"uagechangeonloadeddatalistingonloadedmetadatabindexonloadsta" +
|
||||||
|
"rtonmessageonmousedownonmousemoveonmouseoutputonmouseoveronm" +
|
||||||
|
"ouseuponmousewheelonofflineononlineonpagehidesclassectionbef" +
|
||||||
|
"oreunloaddresshapeonpageshowidth6onpausemaponplayingonpopsta" +
|
||||||
|
"teonprogresstrikeytypeonratechangeonresetonresizestrongonscr" +
|
||||||
|
"ollonseekedonseekingonselectedonshowraponsortableonstalledon" +
|
||||||
|
"storageonsubmitemrefacenteronsuspendontoggleonunloadonvolume" +
|
||||||
|
"changeonwaitingoptimumanifestepromptoptionbeforeprintstylesu" +
|
||||||
|
"mmarysupsvgsystemplate"
|
||||||
+351
@@ -0,0 +1,351 @@
|
|||||||
|
// generated by go run gen.go -test; DO NOT EDIT
|
||||||
|
|
||||||
|
package atom
|
||||||
|
|
||||||
|
var testAtomList = []string{
|
||||||
|
"a",
|
||||||
|
"abbr",
|
||||||
|
"abbr",
|
||||||
|
"accept",
|
||||||
|
"accept-charset",
|
||||||
|
"accesskey",
|
||||||
|
"action",
|
||||||
|
"address",
|
||||||
|
"align",
|
||||||
|
"alt",
|
||||||
|
"annotation",
|
||||||
|
"annotation-xml",
|
||||||
|
"applet",
|
||||||
|
"area",
|
||||||
|
"article",
|
||||||
|
"aside",
|
||||||
|
"async",
|
||||||
|
"audio",
|
||||||
|
"autocomplete",
|
||||||
|
"autofocus",
|
||||||
|
"autoplay",
|
||||||
|
"b",
|
||||||
|
"base",
|
||||||
|
"basefont",
|
||||||
|
"bdi",
|
||||||
|
"bdo",
|
||||||
|
"bgsound",
|
||||||
|
"big",
|
||||||
|
"blink",
|
||||||
|
"blockquote",
|
||||||
|
"body",
|
||||||
|
"br",
|
||||||
|
"button",
|
||||||
|
"canvas",
|
||||||
|
"caption",
|
||||||
|
"center",
|
||||||
|
"challenge",
|
||||||
|
"charset",
|
||||||
|
"checked",
|
||||||
|
"cite",
|
||||||
|
"cite",
|
||||||
|
"class",
|
||||||
|
"code",
|
||||||
|
"col",
|
||||||
|
"colgroup",
|
||||||
|
"color",
|
||||||
|
"cols",
|
||||||
|
"colspan",
|
||||||
|
"command",
|
||||||
|
"command",
|
||||||
|
"content",
|
||||||
|
"contenteditable",
|
||||||
|
"contextmenu",
|
||||||
|
"controls",
|
||||||
|
"coords",
|
||||||
|
"crossorigin",
|
||||||
|
"data",
|
||||||
|
"data",
|
||||||
|
"datalist",
|
||||||
|
"datetime",
|
||||||
|
"dd",
|
||||||
|
"default",
|
||||||
|
"defer",
|
||||||
|
"del",
|
||||||
|
"desc",
|
||||||
|
"details",
|
||||||
|
"dfn",
|
||||||
|
"dialog",
|
||||||
|
"dir",
|
||||||
|
"dirname",
|
||||||
|
"disabled",
|
||||||
|
"div",
|
||||||
|
"dl",
|
||||||
|
"download",
|
||||||
|
"draggable",
|
||||||
|
"dropzone",
|
||||||
|
"dt",
|
||||||
|
"em",
|
||||||
|
"embed",
|
||||||
|
"enctype",
|
||||||
|
"face",
|
||||||
|
"fieldset",
|
||||||
|
"figcaption",
|
||||||
|
"figure",
|
||||||
|
"font",
|
||||||
|
"footer",
|
||||||
|
"for",
|
||||||
|
"foreignObject",
|
||||||
|
"foreignobject",
|
||||||
|
"form",
|
||||||
|
"form",
|
||||||
|
"formaction",
|
||||||
|
"formenctype",
|
||||||
|
"formmethod",
|
||||||
|
"formnovalidate",
|
||||||
|
"formtarget",
|
||||||
|
"frame",
|
||||||
|
"frameset",
|
||||||
|
"h1",
|
||||||
|
"h2",
|
||||||
|
"h3",
|
||||||
|
"h4",
|
||||||
|
"h5",
|
||||||
|
"h6",
|
||||||
|
"head",
|
||||||
|
"header",
|
||||||
|
"headers",
|
||||||
|
"height",
|
||||||
|
"hgroup",
|
||||||
|
"hidden",
|
||||||
|
"high",
|
||||||
|
"hr",
|
||||||
|
"href",
|
||||||
|
"hreflang",
|
||||||
|
"html",
|
||||||
|
"http-equiv",
|
||||||
|
"i",
|
||||||
|
"icon",
|
||||||
|
"id",
|
||||||
|
"iframe",
|
||||||
|
"image",
|
||||||
|
"img",
|
||||||
|
"input",
|
||||||
|
"inputmode",
|
||||||
|
"ins",
|
||||||
|
"isindex",
|
||||||
|
"ismap",
|
||||||
|
"itemid",
|
||||||
|
"itemprop",
|
||||||
|
"itemref",
|
||||||
|
"itemscope",
|
||||||
|
"itemtype",
|
||||||
|
"kbd",
|
||||||
|
"keygen",
|
||||||
|
"keytype",
|
||||||
|
"kind",
|
||||||
|
"label",
|
||||||
|
"label",
|
||||||
|
"lang",
|
||||||
|
"legend",
|
||||||
|
"li",
|
||||||
|
"link",
|
||||||
|
"list",
|
||||||
|
"listing",
|
||||||
|
"loop",
|
||||||
|
"low",
|
||||||
|
"malignmark",
|
||||||
|
"manifest",
|
||||||
|
"map",
|
||||||
|
"mark",
|
||||||
|
"marquee",
|
||||||
|
"math",
|
||||||
|
"max",
|
||||||
|
"maxlength",
|
||||||
|
"media",
|
||||||
|
"mediagroup",
|
||||||
|
"menu",
|
||||||
|
"menuitem",
|
||||||
|
"meta",
|
||||||
|
"meter",
|
||||||
|
"method",
|
||||||
|
"mglyph",
|
||||||
|
"mi",
|
||||||
|
"min",
|
||||||
|
"minlength",
|
||||||
|
"mn",
|
||||||
|
"mo",
|
||||||
|
"ms",
|
||||||
|
"mtext",
|
||||||
|
"multiple",
|
||||||
|
"muted",
|
||||||
|
"name",
|
||||||
|
"nav",
|
||||||
|
"nobr",
|
||||||
|
"noembed",
|
||||||
|
"noframes",
|
||||||
|
"noscript",
|
||||||
|
"novalidate",
|
||||||
|
"object",
|
||||||
|
"ol",
|
||||||
|
"onabort",
|
||||||
|
"onafterprint",
|
||||||
|
"onautocomplete",
|
||||||
|
"onautocompleteerror",
|
||||||
|
"onbeforeprint",
|
||||||
|
"onbeforeunload",
|
||||||
|
"onblur",
|
||||||
|
"oncancel",
|
||||||
|
"oncanplay",
|
||||||
|
"oncanplaythrough",
|
||||||
|
"onchange",
|
||||||
|
"onclick",
|
||||||
|
"onclose",
|
||||||
|
"oncontextmenu",
|
||||||
|
"oncuechange",
|
||||||
|
"ondblclick",
|
||||||
|
"ondrag",
|
||||||
|
"ondragend",
|
||||||
|
"ondragenter",
|
||||||
|
"ondragleave",
|
||||||
|
"ondragover",
|
||||||
|
"ondragstart",
|
||||||
|
"ondrop",
|
||||||
|
"ondurationchange",
|
||||||
|
"onemptied",
|
||||||
|
"onended",
|
||||||
|
"onerror",
|
||||||
|
"onfocus",
|
||||||
|
"onhashchange",
|
||||||
|
"oninput",
|
||||||
|
"oninvalid",
|
||||||
|
"onkeydown",
|
||||||
|
"onkeypress",
|
||||||
|
"onkeyup",
|
||||||
|
"onlanguagechange",
|
||||||
|
"onload",
|
||||||
|
"onloadeddata",
|
||||||
|
"onloadedmetadata",
|
||||||
|
"onloadstart",
|
||||||
|
"onmessage",
|
||||||
|
"onmousedown",
|
||||||
|
"onmousemove",
|
||||||
|
"onmouseout",
|
||||||
|
"onmouseover",
|
||||||
|
"onmouseup",
|
||||||
|
"onmousewheel",
|
||||||
|
"onoffline",
|
||||||
|
"ononline",
|
||||||
|
"onpagehide",
|
||||||
|
"onpageshow",
|
||||||
|
"onpause",
|
||||||
|
"onplay",
|
||||||
|
"onplaying",
|
||||||
|
"onpopstate",
|
||||||
|
"onprogress",
|
||||||
|
"onratechange",
|
||||||
|
"onreset",
|
||||||
|
"onresize",
|
||||||
|
"onscroll",
|
||||||
|
"onseeked",
|
||||||
|
"onseeking",
|
||||||
|
"onselect",
|
||||||
|
"onshow",
|
||||||
|
"onsort",
|
||||||
|
"onstalled",
|
||||||
|
"onstorage",
|
||||||
|
"onsubmit",
|
||||||
|
"onsuspend",
|
||||||
|
"ontimeupdate",
|
||||||
|
"ontoggle",
|
||||||
|
"onunload",
|
||||||
|
"onvolumechange",
|
||||||
|
"onwaiting",
|
||||||
|
"open",
|
||||||
|
"optgroup",
|
||||||
|
"optimum",
|
||||||
|
"option",
|
||||||
|
"output",
|
||||||
|
"p",
|
||||||
|
"param",
|
||||||
|
"pattern",
|
||||||
|
"ping",
|
||||||
|
"placeholder",
|
||||||
|
"plaintext",
|
||||||
|
"poster",
|
||||||
|
"pre",
|
||||||
|
"preload",
|
||||||
|
"progress",
|
||||||
|
"prompt",
|
||||||
|
"public",
|
||||||
|
"q",
|
||||||
|
"radiogroup",
|
||||||
|
"readonly",
|
||||||
|
"rel",
|
||||||
|
"required",
|
||||||
|
"reversed",
|
||||||
|
"rows",
|
||||||
|
"rowspan",
|
||||||
|
"rp",
|
||||||
|
"rt",
|
||||||
|
"ruby",
|
||||||
|
"s",
|
||||||
|
"samp",
|
||||||
|
"sandbox",
|
||||||
|
"scope",
|
||||||
|
"scoped",
|
||||||
|
"script",
|
||||||
|
"seamless",
|
||||||
|
"section",
|
||||||
|
"select",
|
||||||
|
"selected",
|
||||||
|
"shape",
|
||||||
|
"size",
|
||||||
|
"sizes",
|
||||||
|
"small",
|
||||||
|
"sortable",
|
||||||
|
"sorted",
|
||||||
|
"source",
|
||||||
|
"spacer",
|
||||||
|
"span",
|
||||||
|
"span",
|
||||||
|
"spellcheck",
|
||||||
|
"src",
|
||||||
|
"srcdoc",
|
||||||
|
"srclang",
|
||||||
|
"start",
|
||||||
|
"step",
|
||||||
|
"strike",
|
||||||
|
"strong",
|
||||||
|
"style",
|
||||||
|
"style",
|
||||||
|
"sub",
|
||||||
|
"summary",
|
||||||
|
"sup",
|
||||||
|
"svg",
|
||||||
|
"system",
|
||||||
|
"tabindex",
|
||||||
|
"table",
|
||||||
|
"target",
|
||||||
|
"tbody",
|
||||||
|
"td",
|
||||||
|
"template",
|
||||||
|
"textarea",
|
||||||
|
"tfoot",
|
||||||
|
"th",
|
||||||
|
"thead",
|
||||||
|
"time",
|
||||||
|
"title",
|
||||||
|
"title",
|
||||||
|
"tr",
|
||||||
|
"track",
|
||||||
|
"translate",
|
||||||
|
"tt",
|
||||||
|
"type",
|
||||||
|
"typemustmatch",
|
||||||
|
"u",
|
||||||
|
"ul",
|
||||||
|
"usemap",
|
||||||
|
"value",
|
||||||
|
"var",
|
||||||
|
"video",
|
||||||
|
"wbr",
|
||||||
|
"width",
|
||||||
|
"wrap",
|
||||||
|
"xmp",
|
||||||
|
}
|
||||||
+257
@@ -0,0 +1,257 @@
|
|||||||
|
// Copyright 2013 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// Package charset provides common text encodings for HTML documents.
|
||||||
|
//
|
||||||
|
// The mapping from encoding labels to encodings is defined at
|
||||||
|
// https://encoding.spec.whatwg.org/.
|
||||||
|
package charset // import "golang.org/x/net/html/charset"
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"mime"
|
||||||
|
"strings"
|
||||||
|
"unicode/utf8"
|
||||||
|
|
||||||
|
"golang.org/x/net/html"
|
||||||
|
"golang.org/x/text/encoding"
|
||||||
|
"golang.org/x/text/encoding/charmap"
|
||||||
|
"golang.org/x/text/encoding/htmlindex"
|
||||||
|
"golang.org/x/text/transform"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Lookup returns the encoding with the specified label, and its canonical
|
||||||
|
// name. It returns nil and the empty string if label is not one of the
|
||||||
|
// standard encodings for HTML. Matching is case-insensitive and ignores
|
||||||
|
// leading and trailing whitespace. Encoders will use HTML escape sequences for
|
||||||
|
// runes that are not supported by the character set.
|
||||||
|
func Lookup(label string) (e encoding.Encoding, name string) {
|
||||||
|
e, err := htmlindex.Get(label)
|
||||||
|
if err != nil {
|
||||||
|
return nil, ""
|
||||||
|
}
|
||||||
|
name, _ = htmlindex.Name(e)
|
||||||
|
return &htmlEncoding{e}, name
|
||||||
|
}
|
||||||
|
|
||||||
|
type htmlEncoding struct{ encoding.Encoding }
|
||||||
|
|
||||||
|
func (h *htmlEncoding) NewEncoder() *encoding.Encoder {
|
||||||
|
// HTML requires a non-terminating legacy encoder. We use HTML escapes to
|
||||||
|
// substitute unsupported code points.
|
||||||
|
return encoding.HTMLEscapeUnsupported(h.Encoding.NewEncoder())
|
||||||
|
}
|
||||||
|
|
||||||
|
// DetermineEncoding determines the encoding of an HTML document by examining
|
||||||
|
// up to the first 1024 bytes of content and the declared Content-Type.
|
||||||
|
//
|
||||||
|
// See http://www.whatwg.org/specs/web-apps/current-work/multipage/parsing.html#determining-the-character-encoding
|
||||||
|
func DetermineEncoding(content []byte, contentType string) (e encoding.Encoding, name string, certain bool) {
|
||||||
|
if len(content) > 1024 {
|
||||||
|
content = content[:1024]
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, b := range boms {
|
||||||
|
if bytes.HasPrefix(content, b.bom) {
|
||||||
|
e, name = Lookup(b.enc)
|
||||||
|
return e, name, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, params, err := mime.ParseMediaType(contentType); err == nil {
|
||||||
|
if cs, ok := params["charset"]; ok {
|
||||||
|
if e, name = Lookup(cs); e != nil {
|
||||||
|
return e, name, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(content) > 0 {
|
||||||
|
e, name = prescan(content)
|
||||||
|
if e != nil {
|
||||||
|
return e, name, false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try to detect UTF-8.
|
||||||
|
// First eliminate any partial rune at the end.
|
||||||
|
for i := len(content) - 1; i >= 0 && i > len(content)-4; i-- {
|
||||||
|
b := content[i]
|
||||||
|
if b < 0x80 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if utf8.RuneStart(b) {
|
||||||
|
content = content[:i]
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
hasHighBit := false
|
||||||
|
for _, c := range content {
|
||||||
|
if c >= 0x80 {
|
||||||
|
hasHighBit = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if hasHighBit && utf8.Valid(content) {
|
||||||
|
return encoding.Nop, "utf-8", false
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: change default depending on user's locale?
|
||||||
|
return charmap.Windows1252, "windows-1252", false
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewReader returns an io.Reader that converts the content of r to UTF-8.
|
||||||
|
// It calls DetermineEncoding to find out what r's encoding is.
|
||||||
|
func NewReader(r io.Reader, contentType string) (io.Reader, error) {
|
||||||
|
preview := make([]byte, 1024)
|
||||||
|
n, err := io.ReadFull(r, preview)
|
||||||
|
switch {
|
||||||
|
case err == io.ErrUnexpectedEOF:
|
||||||
|
preview = preview[:n]
|
||||||
|
r = bytes.NewReader(preview)
|
||||||
|
case err != nil:
|
||||||
|
return nil, err
|
||||||
|
default:
|
||||||
|
r = io.MultiReader(bytes.NewReader(preview), r)
|
||||||
|
}
|
||||||
|
|
||||||
|
if e, _, _ := DetermineEncoding(preview, contentType); e != encoding.Nop {
|
||||||
|
r = transform.NewReader(r, e.NewDecoder())
|
||||||
|
}
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewReaderLabel returns a reader that converts from the specified charset to
|
||||||
|
// UTF-8. It uses Lookup to find the encoding that corresponds to label, and
|
||||||
|
// returns an error if Lookup returns nil. It is suitable for use as
|
||||||
|
// encoding/xml.Decoder's CharsetReader function.
|
||||||
|
func NewReaderLabel(label string, input io.Reader) (io.Reader, error) {
|
||||||
|
e, _ := Lookup(label)
|
||||||
|
if e == nil {
|
||||||
|
return nil, fmt.Errorf("unsupported charset: %q", label)
|
||||||
|
}
|
||||||
|
return transform.NewReader(input, e.NewDecoder()), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func prescan(content []byte) (e encoding.Encoding, name string) {
|
||||||
|
z := html.NewTokenizer(bytes.NewReader(content))
|
||||||
|
for {
|
||||||
|
switch z.Next() {
|
||||||
|
case html.ErrorToken:
|
||||||
|
return nil, ""
|
||||||
|
|
||||||
|
case html.StartTagToken, html.SelfClosingTagToken:
|
||||||
|
tagName, hasAttr := z.TagName()
|
||||||
|
if !bytes.Equal(tagName, []byte("meta")) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
attrList := make(map[string]bool)
|
||||||
|
gotPragma := false
|
||||||
|
|
||||||
|
const (
|
||||||
|
dontKnow = iota
|
||||||
|
doNeedPragma
|
||||||
|
doNotNeedPragma
|
||||||
|
)
|
||||||
|
needPragma := dontKnow
|
||||||
|
|
||||||
|
name = ""
|
||||||
|
e = nil
|
||||||
|
for hasAttr {
|
||||||
|
var key, val []byte
|
||||||
|
key, val, hasAttr = z.TagAttr()
|
||||||
|
ks := string(key)
|
||||||
|
if attrList[ks] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
attrList[ks] = true
|
||||||
|
for i, c := range val {
|
||||||
|
if 'A' <= c && c <= 'Z' {
|
||||||
|
val[i] = c + 0x20
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
switch ks {
|
||||||
|
case "http-equiv":
|
||||||
|
if bytes.Equal(val, []byte("content-type")) {
|
||||||
|
gotPragma = true
|
||||||
|
}
|
||||||
|
|
||||||
|
case "content":
|
||||||
|
if e == nil {
|
||||||
|
name = fromMetaElement(string(val))
|
||||||
|
if name != "" {
|
||||||
|
e, name = Lookup(name)
|
||||||
|
if e != nil {
|
||||||
|
needPragma = doNeedPragma
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
case "charset":
|
||||||
|
e, name = Lookup(string(val))
|
||||||
|
needPragma = doNotNeedPragma
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if needPragma == dontKnow || needPragma == doNeedPragma && !gotPragma {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.HasPrefix(name, "utf-16") {
|
||||||
|
name = "utf-8"
|
||||||
|
e = encoding.Nop
|
||||||
|
}
|
||||||
|
|
||||||
|
if e != nil {
|
||||||
|
return e, name
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func fromMetaElement(s string) string {
|
||||||
|
for s != "" {
|
||||||
|
csLoc := strings.Index(s, "charset")
|
||||||
|
if csLoc == -1 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
s = s[csLoc+len("charset"):]
|
||||||
|
s = strings.TrimLeft(s, " \t\n\f\r")
|
||||||
|
if !strings.HasPrefix(s, "=") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s = s[1:]
|
||||||
|
s = strings.TrimLeft(s, " \t\n\f\r")
|
||||||
|
if s == "" {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
if q := s[0]; q == '"' || q == '\'' {
|
||||||
|
s = s[1:]
|
||||||
|
closeQuote := strings.IndexRune(s, rune(q))
|
||||||
|
if closeQuote == -1 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return s[:closeQuote]
|
||||||
|
}
|
||||||
|
|
||||||
|
end := strings.IndexAny(s, "; \t\n\f\r")
|
||||||
|
if end == -1 {
|
||||||
|
end = len(s)
|
||||||
|
}
|
||||||
|
return s[:end]
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
var boms = []struct {
|
||||||
|
bom []byte
|
||||||
|
enc string
|
||||||
|
}{
|
||||||
|
{[]byte{0xfe, 0xff}, "utf-16be"},
|
||||||
|
{[]byte{0xff, 0xfe}, "utf-16le"},
|
||||||
|
{[]byte{0xef, 0xbb, 0xbf}, "utf-8"},
|
||||||
|
}
|
||||||
+237
@@ -0,0 +1,237 @@
|
|||||||
|
// Copyright 2013 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package charset
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/xml"
|
||||||
|
"io/ioutil"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"golang.org/x/text/transform"
|
||||||
|
)
|
||||||
|
|
||||||
|
func transformString(t transform.Transformer, s string) (string, error) {
|
||||||
|
r := transform.NewReader(strings.NewReader(s), t)
|
||||||
|
b, err := ioutil.ReadAll(r)
|
||||||
|
return string(b), err
|
||||||
|
}
|
||||||
|
|
||||||
|
type testCase struct {
|
||||||
|
utf8, other, otherEncoding string
|
||||||
|
}
|
||||||
|
|
||||||
|
// testCases for encoding and decoding.
|
||||||
|
var testCases = []testCase{
|
||||||
|
{"Résumé", "Résumé", "utf8"},
|
||||||
|
{"Résumé", "R\xe9sum\xe9", "latin1"},
|
||||||
|
{"これは漢字です。", "S0\x8c0o0\"oW[g0Y0\x020", "UTF-16LE"},
|
||||||
|
{"これは漢字です。", "0S0\x8c0oo\"[W0g0Y0\x02", "UTF-16BE"},
|
||||||
|
{"Hello, world", "Hello, world", "ASCII"},
|
||||||
|
{"Gdańsk", "Gda\xf1sk", "ISO-8859-2"},
|
||||||
|
{"Ââ Čč Đđ Ŋŋ Õõ Šš Žž Åå Ää", "\xc2\xe2 \xc8\xe8 \xa9\xb9 \xaf\xbf \xd5\xf5 \xaa\xba \xac\xbc \xc5\xe5 \xc4\xe4", "ISO-8859-10"},
|
||||||
|
{"สำหรับ", "\xca\xd3\xcb\xc3\u047a", "ISO-8859-11"},
|
||||||
|
{"latviešu", "latvie\xf0u", "ISO-8859-13"},
|
||||||
|
{"Seònaid", "Se\xf2naid", "ISO-8859-14"},
|
||||||
|
{"€1 is cheap", "\xa41 is cheap", "ISO-8859-15"},
|
||||||
|
{"românește", "rom\xe2ne\xbate", "ISO-8859-16"},
|
||||||
|
{"nutraĵo", "nutra\xbco", "ISO-8859-3"},
|
||||||
|
{"Kalâdlit", "Kal\xe2dlit", "ISO-8859-4"},
|
||||||
|
{"русский", "\xe0\xe3\xe1\xe1\xda\xd8\xd9", "ISO-8859-5"},
|
||||||
|
{"ελληνικά", "\xe5\xeb\xeb\xe7\xed\xe9\xea\xdc", "ISO-8859-7"},
|
||||||
|
{"Kağan", "Ka\xf0an", "ISO-8859-9"},
|
||||||
|
{"Résumé", "R\x8esum\x8e", "macintosh"},
|
||||||
|
{"Gdańsk", "Gda\xf1sk", "windows-1250"},
|
||||||
|
{"русский", "\xf0\xf3\xf1\xf1\xea\xe8\xe9", "windows-1251"},
|
||||||
|
{"Résumé", "R\xe9sum\xe9", "windows-1252"},
|
||||||
|
{"ελληνικά", "\xe5\xeb\xeb\xe7\xed\xe9\xea\xdc", "windows-1253"},
|
||||||
|
{"Kağan", "Ka\xf0an", "windows-1254"},
|
||||||
|
{"עִבְרִית", "\xf2\xc4\xe1\xc0\xf8\xc4\xe9\xfa", "windows-1255"},
|
||||||
|
{"العربية", "\xc7\xe1\xda\xd1\xc8\xed\xc9", "windows-1256"},
|
||||||
|
{"latviešu", "latvie\xf0u", "windows-1257"},
|
||||||
|
{"Việt", "Vi\xea\xf2t", "windows-1258"},
|
||||||
|
{"สำหรับ", "\xca\xd3\xcb\xc3\u047a", "windows-874"},
|
||||||
|
{"русский", "\xd2\xd5\xd3\xd3\xcb\xc9\xca", "KOI8-R"},
|
||||||
|
{"українська", "\xd5\xcb\xd2\xc1\xa7\xce\xd3\xd8\xcb\xc1", "KOI8-U"},
|
||||||
|
{"Hello 常用國字標準字體表", "Hello \xb1`\xa5\u03b0\xea\xa6r\xbc\u0437\u01e6r\xc5\xe9\xaa\xed", "big5"},
|
||||||
|
{"Hello 常用國字標準字體表", "Hello \xb3\xa3\xd3\xc3\x87\xf8\xd7\xd6\x98\xcb\x9c\xca\xd7\xd6\xf3\x77\xb1\xed", "gbk"},
|
||||||
|
{"Hello 常用國字標準字體表", "Hello \xb3\xa3\xd3\xc3\x87\xf8\xd7\xd6\x98\xcb\x9c\xca\xd7\xd6\xf3\x77\xb1\xed", "gb18030"},
|
||||||
|
{"עִבְרִית", "\x81\x30\xfb\x30\x81\x30\xf6\x34\x81\x30\xf9\x33\x81\x30\xf6\x30\x81\x30\xfb\x36\x81\x30\xf6\x34\x81\x30\xfa\x31\x81\x30\xfb\x38", "gb18030"},
|
||||||
|
{"㧯", "\x82\x31\x89\x38", "gb18030"},
|
||||||
|
{"これは漢字です。", "\x82\xb1\x82\xea\x82\xcd\x8a\xbf\x8e\x9a\x82\xc5\x82\xb7\x81B", "SJIS"},
|
||||||
|
{"Hello, 世界!", "Hello, \x90\xa2\x8aE!", "SJIS"},
|
||||||
|
{"イウエオカ", "\xb2\xb3\xb4\xb5\xb6", "SJIS"},
|
||||||
|
{"これは漢字です。", "\xa4\xb3\xa4\xec\xa4\u03f4\xc1\xbb\xfa\xa4\u01e4\xb9\xa1\xa3", "EUC-JP"},
|
||||||
|
{"Hello, 世界!", "Hello, \x1b$B@$3&\x1b(B!", "ISO-2022-JP"},
|
||||||
|
{"다음과 같은 조건을 따라야 합니다: 저작자표시", "\xb4\xd9\xc0\xbd\xb0\xfa \xb0\xb0\xc0\xba \xc1\xb6\xb0\xc7\xc0\xbb \xb5\xfb\xb6\xf3\xbe\xdf \xc7մϴ\xd9: \xc0\xfa\xc0\xdb\xc0\xdaǥ\xbd\xc3", "EUC-KR"},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDecode(t *testing.T) {
|
||||||
|
testCases := append(testCases, []testCase{
|
||||||
|
// Replace multi-byte maximum subpart of ill-formed subsequence with
|
||||||
|
// single replacement character (WhatWG requirement).
|
||||||
|
{"Rés\ufffdumé", "Rés\xe1\x80umé", "utf8"},
|
||||||
|
}...)
|
||||||
|
for _, tc := range testCases {
|
||||||
|
e, _ := Lookup(tc.otherEncoding)
|
||||||
|
if e == nil {
|
||||||
|
t.Errorf("%s: not found", tc.otherEncoding)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s, err := transformString(e.NewDecoder(), tc.other)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("%s: decode %q: %v", tc.otherEncoding, tc.other, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if s != tc.utf8 {
|
||||||
|
t.Errorf("%s: got %q, want %q", tc.otherEncoding, s, tc.utf8)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEncode(t *testing.T) {
|
||||||
|
testCases := append(testCases, []testCase{
|
||||||
|
// Use Go-style replacement.
|
||||||
|
{"Rés\xe1\x80umé", "Rés\ufffd\ufffdumé", "utf8"},
|
||||||
|
// U+0144 LATIN SMALL LETTER N WITH ACUTE not supported by encoding.
|
||||||
|
{"Gdańsk", "Gdańsk", "ISO-8859-11"},
|
||||||
|
{"\ufffd", "�", "ISO-8859-11"},
|
||||||
|
{"a\xe1\x80b", "a��b", "ISO-8859-11"},
|
||||||
|
}...)
|
||||||
|
for _, tc := range testCases {
|
||||||
|
e, _ := Lookup(tc.otherEncoding)
|
||||||
|
if e == nil {
|
||||||
|
t.Errorf("%s: not found", tc.otherEncoding)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s, err := transformString(e.NewEncoder(), tc.utf8)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("%s: encode %q: %s", tc.otherEncoding, tc.utf8, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if s != tc.other {
|
||||||
|
t.Errorf("%s: got %q, want %q", tc.otherEncoding, s, tc.other)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var sniffTestCases = []struct {
|
||||||
|
filename, declared, want string
|
||||||
|
}{
|
||||||
|
{"HTTP-charset.html", "text/html; charset=iso-8859-15", "iso-8859-15"},
|
||||||
|
{"UTF-16LE-BOM.html", "", "utf-16le"},
|
||||||
|
{"UTF-16BE-BOM.html", "", "utf-16be"},
|
||||||
|
{"meta-content-attribute.html", "text/html", "iso-8859-15"},
|
||||||
|
{"meta-charset-attribute.html", "text/html", "iso-8859-15"},
|
||||||
|
{"No-encoding-declaration.html", "text/html", "utf-8"},
|
||||||
|
{"HTTP-vs-UTF-8-BOM.html", "text/html; charset=iso-8859-15", "utf-8"},
|
||||||
|
{"HTTP-vs-meta-content.html", "text/html; charset=iso-8859-15", "iso-8859-15"},
|
||||||
|
{"HTTP-vs-meta-charset.html", "text/html; charset=iso-8859-15", "iso-8859-15"},
|
||||||
|
{"UTF-8-BOM-vs-meta-content.html", "text/html", "utf-8"},
|
||||||
|
{"UTF-8-BOM-vs-meta-charset.html", "text/html", "utf-8"},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSniff(t *testing.T) {
|
||||||
|
switch runtime.GOOS {
|
||||||
|
case "nacl": // platforms that don't permit direct file system access
|
||||||
|
t.Skipf("not supported on %q", runtime.GOOS)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range sniffTestCases {
|
||||||
|
content, err := ioutil.ReadFile("testdata/" + tc.filename)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("%s: error reading file: %v", tc.filename, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
_, name, _ := DetermineEncoding(content, tc.declared)
|
||||||
|
if name != tc.want {
|
||||||
|
t.Errorf("%s: got %q, want %q", tc.filename, name, tc.want)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReader(t *testing.T) {
|
||||||
|
switch runtime.GOOS {
|
||||||
|
case "nacl": // platforms that don't permit direct file system access
|
||||||
|
t.Skipf("not supported on %q", runtime.GOOS)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range sniffTestCases {
|
||||||
|
content, err := ioutil.ReadFile("testdata/" + tc.filename)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("%s: error reading file: %v", tc.filename, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
r, err := NewReader(bytes.NewReader(content), tc.declared)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("%s: error creating reader: %v", tc.filename, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := ioutil.ReadAll(r)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("%s: error reading from charset.NewReader: %v", tc.filename, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
e, _ := Lookup(tc.want)
|
||||||
|
want, err := ioutil.ReadAll(transform.NewReader(bytes.NewReader(content), e.NewDecoder()))
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("%s: error decoding with hard-coded charset name: %v", tc.filename, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !bytes.Equal(got, want) {
|
||||||
|
t.Errorf("%s: got %q, want %q", tc.filename, got, want)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var metaTestCases = []struct {
|
||||||
|
meta, want string
|
||||||
|
}{
|
||||||
|
{"", ""},
|
||||||
|
{"text/html", ""},
|
||||||
|
{"text/html; charset utf-8", ""},
|
||||||
|
{"text/html; charset=latin-2", "latin-2"},
|
||||||
|
{"text/html; charset; charset = utf-8", "utf-8"},
|
||||||
|
{`charset="big5"`, "big5"},
|
||||||
|
{"charset='shift_jis'", "shift_jis"},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromMeta(t *testing.T) {
|
||||||
|
for _, tc := range metaTestCases {
|
||||||
|
got := fromMetaElement(tc.meta)
|
||||||
|
if got != tc.want {
|
||||||
|
t.Errorf("%q: got %q, want %q", tc.meta, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestXML(t *testing.T) {
|
||||||
|
const s = "<?xml version=\"1.0\" encoding=\"windows-1252\"?><a><Word>r\xe9sum\xe9</Word></a>"
|
||||||
|
|
||||||
|
d := xml.NewDecoder(strings.NewReader(s))
|
||||||
|
d.CharsetReader = NewReaderLabel
|
||||||
|
|
||||||
|
var a struct {
|
||||||
|
Word string
|
||||||
|
}
|
||||||
|
err := d.Decode(&a)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Decode: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := "résumé"
|
||||||
|
if a.Word != want {
|
||||||
|
t.Errorf("got %q, want %q", a.Word, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
+48
@@ -0,0 +1,48 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" >
|
||||||
|
<head>
|
||||||
|
<title>HTTP charset</title>
|
||||||
|
<link rel='author' title='Richard Ishida' href='mailto:ishida@w3.org'>
|
||||||
|
<link rel='help' href='http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream'>
|
||||||
|
<link rel="stylesheet" type="text/css" href="./generatedtests.css">
|
||||||
|
<script src="http://w3c-test.org/resources/testharness.js"></script>
|
||||||
|
<script src="http://w3c-test.org/resources/testharnessreport.js"></script>
|
||||||
|
<meta name='flags' content='http'>
|
||||||
|
<meta name="assert" content="The character encoding of a page can be set using the HTTP header charset declaration.">
|
||||||
|
<style type='text/css'>
|
||||||
|
.test div { width: 50px; }</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="the-input-byte-stream/support/encodingtests-15.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p class='title'>HTTP charset</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div id='log'></div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='test'><div id='box' class='ýäè'> </div></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='description'>
|
||||||
|
<p class="assertion" title="Assertion">The character encoding of a page can be set using the HTTP header charset declaration.</p>
|
||||||
|
<div class="notes"><p><p>The test contains a div with a class name that contains the following sequence of bytes: 0xC3 0xBD 0xC3 0xA4 0xC3 0xA8. These represent different sequences of characters in ISO 8859-15, ISO 8859-1 and UTF-8. The external, UTF-8-encoded stylesheet contains a selector <code>.test div.ÜÀÚ</code>. This matches the sequence of bytes above when they are interpreted as ISO 8859-15. If the class name matches the selector then the test will pass.</p><p>The only character encoding declaration for this HTML file is in the HTTP header, which sets the encoding to ISO 8859-15.</p></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="nexttest"><div><a href="generate?test=the-input-byte-stream-003">Next test</a></div><div class="doctype">HTML5</div>
|
||||||
|
<p class="jump">the-input-byte-stream-001<br /><a href="/International/tests/html5/the-input-byte-stream/results-basics#basics" target="_blank">Result summary & related tests</a><br /><a href="http://w3c-test.org/framework/details/i18n-html5/the-input-byte-stream-001" target="_blank">Detailed results for this test</a><br/> <a href="http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream" target="_blank">Link to spec</a></p>
|
||||||
|
<div class='prereq'>Assumptions: <ul><li>The default encoding for the browser you are testing is not set to ISO 8859-15.</li>
|
||||||
|
<li>The test is read from a server that supports HTTP.</li></ul></div>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
test(function() {
|
||||||
|
assert_equals(document.getElementById('box').offsetWidth, 100);
|
||||||
|
}, " ");
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
||||||
+48
@@ -0,0 +1,48 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" >
|
||||||
|
<head>
|
||||||
|
<title>HTTP vs UTF-8 BOM</title>
|
||||||
|
<link rel='author' title='Richard Ishida' href='mailto:ishida@w3.org'>
|
||||||
|
<link rel='help' href='http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream'>
|
||||||
|
<link rel="stylesheet" type="text/css" href="./generatedtests.css">
|
||||||
|
<script src="http://w3c-test.org/resources/testharness.js"></script>
|
||||||
|
<script src="http://w3c-test.org/resources/testharnessreport.js"></script>
|
||||||
|
<meta name='flags' content='http'>
|
||||||
|
<meta name="assert" content="A character encoding set in the HTTP header has lower precedence than the UTF-8 signature.">
|
||||||
|
<style type='text/css'>
|
||||||
|
.test div { width: 50px; }</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="the-input-byte-stream/support/encodingtests-utf8.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p class='title'>HTTP vs UTF-8 BOM</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div id='log'></div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='test'><div id='box' class='ýäè'> </div></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='description'>
|
||||||
|
<p class="assertion" title="Assertion">A character encoding set in the HTTP header has lower precedence than the UTF-8 signature.</p>
|
||||||
|
<div class="notes"><p><p>The HTTP header attempts to set the character encoding to ISO 8859-15. The page starts with a UTF-8 signature.</p><p>The test contains a div with a class name that contains the following sequence of bytes: 0xC3 0xBD 0xC3 0xA4 0xC3 0xA8. These represent different sequences of characters in ISO 8859-15, ISO 8859-1 and UTF-8. The external, UTF-8-encoded stylesheet contains a selector <code>.test div.ýäè</code>. This matches the sequence of bytes above when they are interpreted as UTF-8. If the class name matches the selector then the test will pass.</p><p>If the test is unsuccessful, the characters  should appear at the top of the page. These represent the bytes that make up the UTF-8 signature when encountered in the ISO 8859-15 encoding.</p></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="nexttest"><div><a href="generate?test=the-input-byte-stream-022">Next test</a></div><div class="doctype">HTML5</div>
|
||||||
|
<p class="jump">the-input-byte-stream-034<br /><a href="/International/tests/html5/the-input-byte-stream/results-basics#precedence" target="_blank">Result summary & related tests</a><br /><a href="http://w3c-test.org/framework/details/i18n-html5/the-input-byte-stream-034" target="_blank">Detailed results for this test</a><br/> <a href="http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream" target="_blank">Link to spec</a></p>
|
||||||
|
<div class='prereq'>Assumptions: <ul><li>The default encoding for the browser you are testing is not set to ISO 8859-15.</li>
|
||||||
|
<li>The test is read from a server that supports HTTP.</li></ul></div>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
test(function() {
|
||||||
|
assert_equals(document.getElementById('box').offsetWidth, 100);
|
||||||
|
}, " ");
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
||||||
+49
@@ -0,0 +1,49 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="iso-8859-1" > <title>HTTP vs meta charset</title>
|
||||||
|
<link rel='author' title='Richard Ishida' href='mailto:ishida@w3.org'>
|
||||||
|
<link rel='help' href='http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream'>
|
||||||
|
<link rel="stylesheet" type="text/css" href="./generatedtests.css">
|
||||||
|
<script src="http://w3c-test.org/resources/testharness.js"></script>
|
||||||
|
<script src="http://w3c-test.org/resources/testharnessreport.js"></script>
|
||||||
|
<meta name='flags' content='http'>
|
||||||
|
<meta name="assert" content="The HTTP header has a higher precedence than an encoding declaration in a meta charset attribute.">
|
||||||
|
<style type='text/css'>
|
||||||
|
.test div { width: 50px; }.test div { width: 90px; }
|
||||||
|
</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="the-input-byte-stream/support/encodingtests-15.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p class='title'>HTTP vs meta charset</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div id='log'></div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='test'><div id='box' class='ýäè'> </div></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='description'>
|
||||||
|
<p class="assertion" title="Assertion">The HTTP header has a higher precedence than an encoding declaration in a meta charset attribute.</p>
|
||||||
|
<div class="notes"><p><p>The HTTP header attempts to set the character encoding to ISO 8859-15. The page contains an encoding declaration in a meta charset attribute that attempts to set the character encoding to ISO 8859-1.</p><p>The test contains a div with a class name that contains the following sequence of bytes: 0xC3 0xBD 0xC3 0xA4 0xC3 0xA8. These represent different sequences of characters in ISO 8859-15, ISO 8859-1 and UTF-8. The external, UTF-8-encoded stylesheet contains a selector <code>.test div.ÜÀÚ</code>. This matches the sequence of bytes above when they are interpreted as ISO 8859-15. If the class name matches the selector then the test will pass.</p></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="nexttest"><div><a href="generate?test=the-input-byte-stream-037">Next test</a></div><div class="doctype">HTML5</div>
|
||||||
|
<p class="jump">the-input-byte-stream-018<br /><a href="/International/tests/html5/the-input-byte-stream/results-basics#precedence" target="_blank">Result summary & related tests</a><br /><a href="http://w3c-test.org/framework/details/i18n-html5/the-input-byte-stream-018" target="_blank">Detailed results for this test</a><br/> <a href="http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream" target="_blank">Link to spec</a></p>
|
||||||
|
<div class='prereq'>Assumptions: <ul><li>The default encoding for the browser you are testing is not set to ISO 8859-15.</li>
|
||||||
|
<li>The test is read from a server that supports HTTP.</li></ul></div>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
test(function() {
|
||||||
|
assert_equals(document.getElementById('box').offsetWidth, 100);
|
||||||
|
}, " ");
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
||||||
+49
@@ -0,0 +1,49 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="content-type" content="text/html;charset=iso-8859-1" > <title>HTTP vs meta content</title>
|
||||||
|
<link rel='author' title='Richard Ishida' href='mailto:ishida@w3.org'>
|
||||||
|
<link rel='help' href='http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream'>
|
||||||
|
<link rel="stylesheet" type="text/css" href="./generatedtests.css">
|
||||||
|
<script src="http://w3c-test.org/resources/testharness.js"></script>
|
||||||
|
<script src="http://w3c-test.org/resources/testharnessreport.js"></script>
|
||||||
|
<meta name='flags' content='http'>
|
||||||
|
<meta name="assert" content="The HTTP header has a higher precedence than an encoding declaration in a meta content attribute.">
|
||||||
|
<style type='text/css'>
|
||||||
|
.test div { width: 50px; }.test div { width: 90px; }
|
||||||
|
</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="the-input-byte-stream/support/encodingtests-15.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p class='title'>HTTP vs meta content</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div id='log'></div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='test'><div id='box' class='ýäè'> </div></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='description'>
|
||||||
|
<p class="assertion" title="Assertion">The HTTP header has a higher precedence than an encoding declaration in a meta content attribute.</p>
|
||||||
|
<div class="notes"><p><p>The HTTP header attempts to set the character encoding to ISO 8859-15. The page contains an encoding declaration in a meta content attribute that attempts to set the character encoding to ISO 8859-1.</p><p>The test contains a div with a class name that contains the following sequence of bytes: 0xC3 0xBD 0xC3 0xA4 0xC3 0xA8. These represent different sequences of characters in ISO 8859-15, ISO 8859-1 and UTF-8. The external, UTF-8-encoded stylesheet contains a selector <code>.test div.ÜÀÚ</code>. This matches the sequence of bytes above when they are interpreted as ISO 8859-15. If the class name matches the selector then the test will pass.</p></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="nexttest"><div><a href="generate?test=the-input-byte-stream-018">Next test</a></div><div class="doctype">HTML5</div>
|
||||||
|
<p class="jump">the-input-byte-stream-016<br /><a href="/International/tests/html5/the-input-byte-stream/results-basics#precedence" target="_blank">Result summary & related tests</a><br /><a href="http://w3c-test.org/framework/details/i18n-html5/the-input-byte-stream-016" target="_blank">Detailed results for this test</a><br/> <a href="http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream" target="_blank">Link to spec</a></p>
|
||||||
|
<div class='prereq'>Assumptions: <ul><li>The default encoding for the browser you are testing is not set to ISO 8859-15.</li>
|
||||||
|
<li>The test is read from a server that supports HTTP.</li></ul></div>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
test(function() {
|
||||||
|
assert_equals(document.getElementById('box').offsetWidth, 100);
|
||||||
|
}, " ");
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
||||||
+47
@@ -0,0 +1,47 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" >
|
||||||
|
<head>
|
||||||
|
<title>No encoding declaration</title>
|
||||||
|
<link rel='author' title='Richard Ishida' href='mailto:ishida@w3.org'>
|
||||||
|
<link rel='help' href='http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream'>
|
||||||
|
<link rel="stylesheet" type="text/css" href="./generatedtests.css">
|
||||||
|
<script src="http://w3c-test.org/resources/testharness.js"></script>
|
||||||
|
<script src="http://w3c-test.org/resources/testharnessreport.js"></script>
|
||||||
|
<meta name='flags' content='http'>
|
||||||
|
<meta name="assert" content="A page with no encoding information in HTTP, BOM, XML declaration or meta element will be treated as UTF-8.">
|
||||||
|
<style type='text/css'>
|
||||||
|
.test div { width: 50px; }</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="the-input-byte-stream/support/encodingtests-utf8.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p class='title'>No encoding declaration</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div id='log'></div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='test'><div id='box' class='ýäè'> </div></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='description'>
|
||||||
|
<p class="assertion" title="Assertion">A page with no encoding information in HTTP, BOM, XML declaration or meta element will be treated as UTF-8.</p>
|
||||||
|
<div class="notes"><p><p>The test on this page contains a div with a class name that contains the following sequence of bytes: 0xC3 0xBD 0xC3 0xA4 0xC3 0xA8. These represent different sequences of characters in ISO 8859-15, ISO 8859-1 and UTF-8. The external, UTF-8-encoded stylesheet contains a selector <code>.test div.ýäè</code>. This matches the sequence of bytes above when they are interpreted as UTF-8. If the class name matches the selector then the test will pass.</p></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="nexttest"><div><a href="generate?test=the-input-byte-stream-034">Next test</a></div><div class="doctype">HTML5</div>
|
||||||
|
<p class="jump">the-input-byte-stream-015<br /><a href="/International/tests/html5/the-input-byte-stream/results-basics#basics" target="_blank">Result summary & related tests</a><br /><a href="http://w3c-test.org/framework/details/i18n-html5/the-input-byte-stream-015" target="_blank">Detailed results for this test</a><br/> <a href="http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream" target="_blank">Link to spec</a></p>
|
||||||
|
<div class='prereq'>Assumptions: <ul><li>The test is read from a server that supports HTTP.</li></ul></div>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
test(function() {
|
||||||
|
assert_equals(document.getElementById('box').offsetWidth, 100);
|
||||||
|
}, " ");
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
These test cases come from
|
||||||
|
http://www.w3.org/International/tests/repository/html5/the-input-byte-stream/results-basics
|
||||||
|
|
||||||
|
Distributed under both the W3C Test Suite License
|
||||||
|
(http://www.w3.org/Consortium/Legal/2008/04-testsuite-license)
|
||||||
|
and the W3C 3-clause BSD License
|
||||||
|
(http://www.w3.org/Consortium/Legal/2008/03-bsd-license).
|
||||||
|
To contribute to a W3C Test Suite, see the policies and contribution
|
||||||
|
forms (http://www.w3.org/2004/10/27-testcases).
|
||||||
BIN
Binary file not shown.
BIN
Binary file not shown.
+49
@@ -0,0 +1,49 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="iso-8859-15"> <title>UTF-8 BOM vs meta charset</title>
|
||||||
|
<link rel='author' title='Richard Ishida' href='mailto:ishida@w3.org'>
|
||||||
|
<link rel='help' href='http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream'>
|
||||||
|
<link rel="stylesheet" type="text/css" href="./generatedtests.css">
|
||||||
|
<script src="http://w3c-test.org/resources/testharness.js"></script>
|
||||||
|
<script src="http://w3c-test.org/resources/testharnessreport.js"></script>
|
||||||
|
<meta name='flags' content='http'>
|
||||||
|
<meta name="assert" content="A page with a UTF-8 BOM will be recognized as UTF-8 even if the meta charset attribute declares a different encoding.">
|
||||||
|
<style type='text/css'>
|
||||||
|
.test div { width: 50px; }.test div { width: 90px; }
|
||||||
|
</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="the-input-byte-stream/support/encodingtests-utf8.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p class='title'>UTF-8 BOM vs meta charset</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div id='log'></div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='test'><div id='box' class='ýäè'> </div></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='description'>
|
||||||
|
<p class="assertion" title="Assertion">A page with a UTF-8 BOM will be recognized as UTF-8 even if the meta charset attribute declares a different encoding.</p>
|
||||||
|
<div class="notes"><p><p>The page contains an encoding declaration in a meta charset attribute that attempts to set the character encoding to ISO 8859-15, but the file starts with a UTF-8 signature.</p><p>The test contains a div with a class name that contains the following sequence of bytes: 0xC3 0xBD 0xC3 0xA4 0xC3 0xA8. These represent different sequences of characters in ISO 8859-15, ISO 8859-1 and UTF-8. The external, UTF-8-encoded stylesheet contains a selector <code>.test div.ýäè</code>. This matches the sequence of bytes above when they are interpreted as UTF-8. If the class name matches the selector then the test will pass.</p></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="nexttest"><div><a href="generate?test=the-input-byte-stream-024">Next test</a></div><div class="doctype">HTML5</div>
|
||||||
|
<p class="jump">the-input-byte-stream-038<br /><a href="/International/tests/html5/the-input-byte-stream/results-basics#precedence" target="_blank">Result summary & related tests</a><br /><a href="http://w3c-test.org/framework/details/i18n-html5/the-input-byte-stream-038" target="_blank">Detailed results for this test</a><br/> <a href="http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream" target="_blank">Link to spec</a></p>
|
||||||
|
<div class='prereq'>Assumptions: <ul><li>The default encoding for the browser you are testing is not set to ISO 8859-15.</li>
|
||||||
|
<li>The test is read from a server that supports HTTP.</li></ul></div>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
test(function() {
|
||||||
|
assert_equals(document.getElementById('box').offsetWidth, 100);
|
||||||
|
}, " ");
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
||||||
+48
@@ -0,0 +1,48 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="content-type" content="text/html; charset=iso-8859-15"> <title>UTF-8 BOM vs meta content</title>
|
||||||
|
<link rel='author' title='Richard Ishida' href='mailto:ishida@w3.org'>
|
||||||
|
<link rel='help' href='http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream'>
|
||||||
|
<link rel="stylesheet" type="text/css" href="./generatedtests.css">
|
||||||
|
<script src="http://w3c-test.org/resources/testharness.js"></script>
|
||||||
|
<script src="http://w3c-test.org/resources/testharnessreport.js"></script>
|
||||||
|
<meta name='flags' content='http'>
|
||||||
|
<meta name="assert" content="A page with a UTF-8 BOM will be recognized as UTF-8 even if the meta content attribute declares a different encoding.">
|
||||||
|
<style type='text/css'>
|
||||||
|
.test div { width: 50px; }</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="the-input-byte-stream/support/encodingtests-utf8.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p class='title'>UTF-8 BOM vs meta content</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div id='log'></div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='test'><div id='box' class='ýäè'> </div></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='description'>
|
||||||
|
<p class="assertion" title="Assertion">A page with a UTF-8 BOM will be recognized as UTF-8 even if the meta content attribute declares a different encoding.</p>
|
||||||
|
<div class="notes"><p><p>The page contains an encoding declaration in a meta content attribute that attempts to set the character encoding to ISO 8859-15, but the file starts with a UTF-8 signature.</p><p>The test contains a div with a class name that contains the following sequence of bytes: 0xC3 0xBD 0xC3 0xA4 0xC3 0xA8. These represent different sequences of characters in ISO 8859-15, ISO 8859-1 and UTF-8. The external, UTF-8-encoded stylesheet contains a selector <code>.test div.ýäè</code>. This matches the sequence of bytes above when they are interpreted as UTF-8. If the class name matches the selector then the test will pass.</p></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="nexttest"><div><a href="generate?test=the-input-byte-stream-038">Next test</a></div><div class="doctype">HTML5</div>
|
||||||
|
<p class="jump">the-input-byte-stream-037<br /><a href="/International/tests/html5/the-input-byte-stream/results-basics#precedence" target="_blank">Result summary & related tests</a><br /><a href="http://w3c-test.org/framework/details/i18n-html5/the-input-byte-stream-037" target="_blank">Detailed results for this test</a><br/> <a href="http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream" target="_blank">Link to spec</a></p>
|
||||||
|
<div class='prereq'>Assumptions: <ul><li>The default encoding for the browser you are testing is not set to ISO 8859-15.</li>
|
||||||
|
<li>The test is read from a server that supports HTTP.</li></ul></div>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
test(function() {
|
||||||
|
assert_equals(document.getElementById('box').offsetWidth, 100);
|
||||||
|
}, " ");
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
||||||
+48
@@ -0,0 +1,48 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="iso-8859-15"> <title>meta charset attribute</title>
|
||||||
|
<link rel='author' title='Richard Ishida' href='mailto:ishida@w3.org'>
|
||||||
|
<link rel='help' href='http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream'>
|
||||||
|
<link rel="stylesheet" type="text/css" href="./generatedtests.css">
|
||||||
|
<script src="http://w3c-test.org/resources/testharness.js"></script>
|
||||||
|
<script src="http://w3c-test.org/resources/testharnessreport.js"></script>
|
||||||
|
<meta name='flags' content='http'>
|
||||||
|
<meta name="assert" content="The character encoding of the page can be set by a meta element with charset attribute.">
|
||||||
|
<style type='text/css'>
|
||||||
|
.test div { width: 50px; }</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="the-input-byte-stream/support/encodingtests-15.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p class='title'>meta charset attribute</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div id='log'></div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='test'><div id='box' class='ýäè'> </div></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='description'>
|
||||||
|
<p class="assertion" title="Assertion">The character encoding of the page can be set by a meta element with charset attribute.</p>
|
||||||
|
<div class="notes"><p><p>The only character encoding declaration for this HTML file is in the charset attribute of the meta element, which declares the encoding to be ISO 8859-15.</p><p>The test contains a div with a class name that contains the following sequence of bytes: 0xC3 0xBD 0xC3 0xA4 0xC3 0xA8. These represent different sequences of characters in ISO 8859-15, ISO 8859-1 and UTF-8. The external, UTF-8-encoded stylesheet contains a selector <code>.test div.ÜÀÚ</code>. This matches the sequence of bytes above when they are interpreted as ISO 8859-15. If the class name matches the selector then the test will pass.</p></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="nexttest"><div><a href="generate?test=the-input-byte-stream-015">Next test</a></div><div class="doctype">HTML5</div>
|
||||||
|
<p class="jump">the-input-byte-stream-009<br /><a href="/International/tests/html5/the-input-byte-stream/results-basics#basics" target="_blank">Result summary & related tests</a><br /><a href="http://w3c-test.org/framework/details/i18n-html5/the-input-byte-stream-009" target="_blank">Detailed results for this test</a><br/> <a href="http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream" target="_blank">Link to spec</a></p>
|
||||||
|
<div class='prereq'>Assumptions: <ul><li>The default encoding for the browser you are testing is not set to ISO 8859-15.</li>
|
||||||
|
<li>The test is read from a server that supports HTTP.</li></ul></div>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
test(function() {
|
||||||
|
assert_equals(document.getElementById('box').offsetWidth, 100);
|
||||||
|
}, " ");
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
||||||
+48
@@ -0,0 +1,48 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="content-type" content="text/html; charset=iso-8859-15"> <title>meta content attribute</title>
|
||||||
|
<link rel='author' title='Richard Ishida' href='mailto:ishida@w3.org'>
|
||||||
|
<link rel='help' href='http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream'>
|
||||||
|
<link rel="stylesheet" type="text/css" href="./generatedtests.css">
|
||||||
|
<script src="http://w3c-test.org/resources/testharness.js"></script>
|
||||||
|
<script src="http://w3c-test.org/resources/testharnessreport.js"></script>
|
||||||
|
<meta name='flags' content='http'>
|
||||||
|
<meta name="assert" content="The character encoding of the page can be set by a meta element with http-equiv and content attributes.">
|
||||||
|
<style type='text/css'>
|
||||||
|
.test div { width: 50px; }</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="the-input-byte-stream/support/encodingtests-15.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p class='title'>meta content attribute</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div id='log'></div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='test'><div id='box' class='ýäè'> </div></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='description'>
|
||||||
|
<p class="assertion" title="Assertion">The character encoding of the page can be set by a meta element with http-equiv and content attributes.</p>
|
||||||
|
<div class="notes"><p><p>The only character encoding declaration for this HTML file is in the content attribute of the meta element, which declares the encoding to be ISO 8859-15.</p><p>The test contains a div with a class name that contains the following sequence of bytes: 0xC3 0xBD 0xC3 0xA4 0xC3 0xA8. These represent different sequences of characters in ISO 8859-15, ISO 8859-1 and UTF-8. The external, UTF-8-encoded stylesheet contains a selector <code>.test div.ÜÀÚ</code>. This matches the sequence of bytes above when they are interpreted as ISO 8859-15. If the class name matches the selector then the test will pass.</p></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="nexttest"><div><a href="generate?test=the-input-byte-stream-009">Next test</a></div><div class="doctype">HTML5</div>
|
||||||
|
<p class="jump">the-input-byte-stream-007<br /><a href="/International/tests/html5/the-input-byte-stream/results-basics#basics" target="_blank">Result summary & related tests</a><br /><a href="http://w3c-test.org/framework/details/i18n-html5/the-input-byte-stream-007" target="_blank">Detailed results for this test</a><br/> <a href="http://www.w3.org/TR/html5/syntax.html#the-input-byte-stream" target="_blank">Link to spec</a></p>
|
||||||
|
<div class='prereq'>Assumptions: <ul><li>The default encoding for the browser you are testing is not set to ISO 8859-15.</li>
|
||||||
|
<li>The test is read from a server that supports HTTP.</li></ul></div>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
test(function() {
|
||||||
|
assert_equals(document.getElementById('box').offsetWidth, 100);
|
||||||
|
}, " ");
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
||||||
+102
@@ -0,0 +1,102 @@
|
|||||||
|
// Copyright 2011 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package html
|
||||||
|
|
||||||
|
// Section 12.2.3.2 of the HTML5 specification says "The following elements
|
||||||
|
// have varying levels of special parsing rules".
|
||||||
|
// https://html.spec.whatwg.org/multipage/syntax.html#the-stack-of-open-elements
|
||||||
|
var isSpecialElementMap = map[string]bool{
|
||||||
|
"address": true,
|
||||||
|
"applet": true,
|
||||||
|
"area": true,
|
||||||
|
"article": true,
|
||||||
|
"aside": true,
|
||||||
|
"base": true,
|
||||||
|
"basefont": true,
|
||||||
|
"bgsound": true,
|
||||||
|
"blockquote": true,
|
||||||
|
"body": true,
|
||||||
|
"br": true,
|
||||||
|
"button": true,
|
||||||
|
"caption": true,
|
||||||
|
"center": true,
|
||||||
|
"col": true,
|
||||||
|
"colgroup": true,
|
||||||
|
"dd": true,
|
||||||
|
"details": true,
|
||||||
|
"dir": true,
|
||||||
|
"div": true,
|
||||||
|
"dl": true,
|
||||||
|
"dt": true,
|
||||||
|
"embed": true,
|
||||||
|
"fieldset": true,
|
||||||
|
"figcaption": true,
|
||||||
|
"figure": true,
|
||||||
|
"footer": true,
|
||||||
|
"form": true,
|
||||||
|
"frame": true,
|
||||||
|
"frameset": true,
|
||||||
|
"h1": true,
|
||||||
|
"h2": true,
|
||||||
|
"h3": true,
|
||||||
|
"h4": true,
|
||||||
|
"h5": true,
|
||||||
|
"h6": true,
|
||||||
|
"head": true,
|
||||||
|
"header": true,
|
||||||
|
"hgroup": true,
|
||||||
|
"hr": true,
|
||||||
|
"html": true,
|
||||||
|
"iframe": true,
|
||||||
|
"img": true,
|
||||||
|
"input": true,
|
||||||
|
"isindex": true,
|
||||||
|
"li": true,
|
||||||
|
"link": true,
|
||||||
|
"listing": true,
|
||||||
|
"marquee": true,
|
||||||
|
"menu": true,
|
||||||
|
"meta": true,
|
||||||
|
"nav": true,
|
||||||
|
"noembed": true,
|
||||||
|
"noframes": true,
|
||||||
|
"noscript": true,
|
||||||
|
"object": true,
|
||||||
|
"ol": true,
|
||||||
|
"p": true,
|
||||||
|
"param": true,
|
||||||
|
"plaintext": true,
|
||||||
|
"pre": true,
|
||||||
|
"script": true,
|
||||||
|
"section": true,
|
||||||
|
"select": true,
|
||||||
|
"source": true,
|
||||||
|
"style": true,
|
||||||
|
"summary": true,
|
||||||
|
"table": true,
|
||||||
|
"tbody": true,
|
||||||
|
"td": true,
|
||||||
|
"template": true,
|
||||||
|
"textarea": true,
|
||||||
|
"tfoot": true,
|
||||||
|
"th": true,
|
||||||
|
"thead": true,
|
||||||
|
"title": true,
|
||||||
|
"tr": true,
|
||||||
|
"track": true,
|
||||||
|
"ul": true,
|
||||||
|
"wbr": true,
|
||||||
|
"xmp": true,
|
||||||
|
}
|
||||||
|
|
||||||
|
func isSpecialElement(element *Node) bool {
|
||||||
|
switch element.Namespace {
|
||||||
|
case "", "html":
|
||||||
|
return isSpecialElementMap[element.Data]
|
||||||
|
case "svg":
|
||||||
|
return element.Data == "foreignObject"
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
+106
@@ -0,0 +1,106 @@
|
|||||||
|
// Copyright 2010 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
/*
|
||||||
|
Package html implements an HTML5-compliant tokenizer and parser.
|
||||||
|
|
||||||
|
Tokenization is done by creating a Tokenizer for an io.Reader r. It is the
|
||||||
|
caller's responsibility to ensure that r provides UTF-8 encoded HTML.
|
||||||
|
|
||||||
|
z := html.NewTokenizer(r)
|
||||||
|
|
||||||
|
Given a Tokenizer z, the HTML is tokenized by repeatedly calling z.Next(),
|
||||||
|
which parses the next token and returns its type, or an error:
|
||||||
|
|
||||||
|
for {
|
||||||
|
tt := z.Next()
|
||||||
|
if tt == html.ErrorToken {
|
||||||
|
// ...
|
||||||
|
return ...
|
||||||
|
}
|
||||||
|
// Process the current token.
|
||||||
|
}
|
||||||
|
|
||||||
|
There are two APIs for retrieving the current token. The high-level API is to
|
||||||
|
call Token; the low-level API is to call Text or TagName / TagAttr. Both APIs
|
||||||
|
allow optionally calling Raw after Next but before Token, Text, TagName, or
|
||||||
|
TagAttr. In EBNF notation, the valid call sequence per token is:
|
||||||
|
|
||||||
|
Next {Raw} [ Token | Text | TagName {TagAttr} ]
|
||||||
|
|
||||||
|
Token returns an independent data structure that completely describes a token.
|
||||||
|
Entities (such as "<") are unescaped, tag names and attribute keys are
|
||||||
|
lower-cased, and attributes are collected into a []Attribute. For example:
|
||||||
|
|
||||||
|
for {
|
||||||
|
if z.Next() == html.ErrorToken {
|
||||||
|
// Returning io.EOF indicates success.
|
||||||
|
return z.Err()
|
||||||
|
}
|
||||||
|
emitToken(z.Token())
|
||||||
|
}
|
||||||
|
|
||||||
|
The low-level API performs fewer allocations and copies, but the contents of
|
||||||
|
the []byte values returned by Text, TagName and TagAttr may change on the next
|
||||||
|
call to Next. For example, to extract an HTML page's anchor text:
|
||||||
|
|
||||||
|
depth := 0
|
||||||
|
for {
|
||||||
|
tt := z.Next()
|
||||||
|
switch tt {
|
||||||
|
case ErrorToken:
|
||||||
|
return z.Err()
|
||||||
|
case TextToken:
|
||||||
|
if depth > 0 {
|
||||||
|
// emitBytes should copy the []byte it receives,
|
||||||
|
// if it doesn't process it immediately.
|
||||||
|
emitBytes(z.Text())
|
||||||
|
}
|
||||||
|
case StartTagToken, EndTagToken:
|
||||||
|
tn, _ := z.TagName()
|
||||||
|
if len(tn) == 1 && tn[0] == 'a' {
|
||||||
|
if tt == StartTagToken {
|
||||||
|
depth++
|
||||||
|
} else {
|
||||||
|
depth--
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Parsing is done by calling Parse with an io.Reader, which returns the root of
|
||||||
|
the parse tree (the document element) as a *Node. It is the caller's
|
||||||
|
responsibility to ensure that the Reader provides UTF-8 encoded HTML. For
|
||||||
|
example, to process each anchor node in depth-first order:
|
||||||
|
|
||||||
|
doc, err := html.Parse(r)
|
||||||
|
if err != nil {
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
var f func(*html.Node)
|
||||||
|
f = func(n *html.Node) {
|
||||||
|
if n.Type == html.ElementNode && n.Data == "a" {
|
||||||
|
// Do something with n...
|
||||||
|
}
|
||||||
|
for c := n.FirstChild; c != nil; c = c.NextSibling {
|
||||||
|
f(c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
f(doc)
|
||||||
|
|
||||||
|
The relevant specifications include:
|
||||||
|
https://html.spec.whatwg.org/multipage/syntax.html and
|
||||||
|
https://html.spec.whatwg.org/multipage/syntax.html#tokenization
|
||||||
|
*/
|
||||||
|
package html // import "golang.org/x/net/html"
|
||||||
|
|
||||||
|
// The tokenization algorithm implemented by this package is not a line-by-line
|
||||||
|
// transliteration of the relatively verbose state-machine in the WHATWG
|
||||||
|
// specification. A more direct approach is used instead, where the program
|
||||||
|
// counter implies the state, such as whether it is tokenizing a tag or a text
|
||||||
|
// node. Specification compliance is verified by checking expected and actual
|
||||||
|
// outputs over a test suite rather than aiming for algorithmic fidelity.
|
||||||
|
|
||||||
|
// TODO(nigeltao): Does a DOM API belong in this package or a separate one?
|
||||||
|
// TODO(nigeltao): How does parsing interact with a JavaScript engine?
|
||||||
+156
@@ -0,0 +1,156 @@
|
|||||||
|
// Copyright 2011 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package html
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// parseDoctype parses the data from a DoctypeToken into a name,
|
||||||
|
// public identifier, and system identifier. It returns a Node whose Type
|
||||||
|
// is DoctypeNode, whose Data is the name, and which has attributes
|
||||||
|
// named "system" and "public" for the two identifiers if they were present.
|
||||||
|
// quirks is whether the document should be parsed in "quirks mode".
|
||||||
|
func parseDoctype(s string) (n *Node, quirks bool) {
|
||||||
|
n = &Node{Type: DoctypeNode}
|
||||||
|
|
||||||
|
// Find the name.
|
||||||
|
space := strings.IndexAny(s, whitespace)
|
||||||
|
if space == -1 {
|
||||||
|
space = len(s)
|
||||||
|
}
|
||||||
|
n.Data = s[:space]
|
||||||
|
// The comparison to "html" is case-sensitive.
|
||||||
|
if n.Data != "html" {
|
||||||
|
quirks = true
|
||||||
|
}
|
||||||
|
n.Data = strings.ToLower(n.Data)
|
||||||
|
s = strings.TrimLeft(s[space:], whitespace)
|
||||||
|
|
||||||
|
if len(s) < 6 {
|
||||||
|
// It can't start with "PUBLIC" or "SYSTEM".
|
||||||
|
// Ignore the rest of the string.
|
||||||
|
return n, quirks || s != ""
|
||||||
|
}
|
||||||
|
|
||||||
|
key := strings.ToLower(s[:6])
|
||||||
|
s = s[6:]
|
||||||
|
for key == "public" || key == "system" {
|
||||||
|
s = strings.TrimLeft(s, whitespace)
|
||||||
|
if s == "" {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
quote := s[0]
|
||||||
|
if quote != '"' && quote != '\'' {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
s = s[1:]
|
||||||
|
q := strings.IndexRune(s, rune(quote))
|
||||||
|
var id string
|
||||||
|
if q == -1 {
|
||||||
|
id = s
|
||||||
|
s = ""
|
||||||
|
} else {
|
||||||
|
id = s[:q]
|
||||||
|
s = s[q+1:]
|
||||||
|
}
|
||||||
|
n.Attr = append(n.Attr, Attribute{Key: key, Val: id})
|
||||||
|
if key == "public" {
|
||||||
|
key = "system"
|
||||||
|
} else {
|
||||||
|
key = ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if key != "" || s != "" {
|
||||||
|
quirks = true
|
||||||
|
} else if len(n.Attr) > 0 {
|
||||||
|
if n.Attr[0].Key == "public" {
|
||||||
|
public := strings.ToLower(n.Attr[0].Val)
|
||||||
|
switch public {
|
||||||
|
case "-//w3o//dtd w3 html strict 3.0//en//", "-/w3d/dtd html 4.0 transitional/en", "html":
|
||||||
|
quirks = true
|
||||||
|
default:
|
||||||
|
for _, q := range quirkyIDs {
|
||||||
|
if strings.HasPrefix(public, q) {
|
||||||
|
quirks = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// The following two public IDs only cause quirks mode if there is no system ID.
|
||||||
|
if len(n.Attr) == 1 && (strings.HasPrefix(public, "-//w3c//dtd html 4.01 frameset//") ||
|
||||||
|
strings.HasPrefix(public, "-//w3c//dtd html 4.01 transitional//")) {
|
||||||
|
quirks = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if lastAttr := n.Attr[len(n.Attr)-1]; lastAttr.Key == "system" &&
|
||||||
|
strings.ToLower(lastAttr.Val) == "http://www.ibm.com/data/dtd/v11/ibmxhtml1-transitional.dtd" {
|
||||||
|
quirks = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return n, quirks
|
||||||
|
}
|
||||||
|
|
||||||
|
// quirkyIDs is a list of public doctype identifiers that cause a document
|
||||||
|
// to be interpreted in quirks mode. The identifiers should be in lower case.
|
||||||
|
var quirkyIDs = []string{
|
||||||
|
"+//silmaril//dtd html pro v0r11 19970101//",
|
||||||
|
"-//advasoft ltd//dtd html 3.0 aswedit + extensions//",
|
||||||
|
"-//as//dtd html 3.0 aswedit + extensions//",
|
||||||
|
"-//ietf//dtd html 2.0 level 1//",
|
||||||
|
"-//ietf//dtd html 2.0 level 2//",
|
||||||
|
"-//ietf//dtd html 2.0 strict level 1//",
|
||||||
|
"-//ietf//dtd html 2.0 strict level 2//",
|
||||||
|
"-//ietf//dtd html 2.0 strict//",
|
||||||
|
"-//ietf//dtd html 2.0//",
|
||||||
|
"-//ietf//dtd html 2.1e//",
|
||||||
|
"-//ietf//dtd html 3.0//",
|
||||||
|
"-//ietf//dtd html 3.2 final//",
|
||||||
|
"-//ietf//dtd html 3.2//",
|
||||||
|
"-//ietf//dtd html 3//",
|
||||||
|
"-//ietf//dtd html level 0//",
|
||||||
|
"-//ietf//dtd html level 1//",
|
||||||
|
"-//ietf//dtd html level 2//",
|
||||||
|
"-//ietf//dtd html level 3//",
|
||||||
|
"-//ietf//dtd html strict level 0//",
|
||||||
|
"-//ietf//dtd html strict level 1//",
|
||||||
|
"-//ietf//dtd html strict level 2//",
|
||||||
|
"-//ietf//dtd html strict level 3//",
|
||||||
|
"-//ietf//dtd html strict//",
|
||||||
|
"-//ietf//dtd html//",
|
||||||
|
"-//metrius//dtd metrius presentational//",
|
||||||
|
"-//microsoft//dtd internet explorer 2.0 html strict//",
|
||||||
|
"-//microsoft//dtd internet explorer 2.0 html//",
|
||||||
|
"-//microsoft//dtd internet explorer 2.0 tables//",
|
||||||
|
"-//microsoft//dtd internet explorer 3.0 html strict//",
|
||||||
|
"-//microsoft//dtd internet explorer 3.0 html//",
|
||||||
|
"-//microsoft//dtd internet explorer 3.0 tables//",
|
||||||
|
"-//netscape comm. corp.//dtd html//",
|
||||||
|
"-//netscape comm. corp.//dtd strict html//",
|
||||||
|
"-//o'reilly and associates//dtd html 2.0//",
|
||||||
|
"-//o'reilly and associates//dtd html extended 1.0//",
|
||||||
|
"-//o'reilly and associates//dtd html extended relaxed 1.0//",
|
||||||
|
"-//softquad software//dtd hotmetal pro 6.0::19990601::extensions to html 4.0//",
|
||||||
|
"-//softquad//dtd hotmetal pro 4.0::19971010::extensions to html 4.0//",
|
||||||
|
"-//spyglass//dtd html 2.0 extended//",
|
||||||
|
"-//sq//dtd html 2.0 hotmetal + extensions//",
|
||||||
|
"-//sun microsystems corp.//dtd hotjava html//",
|
||||||
|
"-//sun microsystems corp.//dtd hotjava strict html//",
|
||||||
|
"-//w3c//dtd html 3 1995-03-24//",
|
||||||
|
"-//w3c//dtd html 3.2 draft//",
|
||||||
|
"-//w3c//dtd html 3.2 final//",
|
||||||
|
"-//w3c//dtd html 3.2//",
|
||||||
|
"-//w3c//dtd html 3.2s draft//",
|
||||||
|
"-//w3c//dtd html 4.0 frameset//",
|
||||||
|
"-//w3c//dtd html 4.0 transitional//",
|
||||||
|
"-//w3c//dtd html experimental 19960712//",
|
||||||
|
"-//w3c//dtd html experimental 970421//",
|
||||||
|
"-//w3c//dtd w3 html//",
|
||||||
|
"-//w3o//dtd w3 html 3.0//",
|
||||||
|
"-//webtechs//dtd mozilla html 2.0//",
|
||||||
|
"-//webtechs//dtd mozilla html//",
|
||||||
|
}
|
||||||
+2253
File diff suppressed because it is too large
Load Diff
+29
@@ -0,0 +1,29 @@
|
|||||||
|
// Copyright 2010 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package html
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
"unicode/utf8"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestEntityLength(t *testing.T) {
|
||||||
|
// We verify that the length of UTF-8 encoding of each value is <= 1 + len(key).
|
||||||
|
// The +1 comes from the leading "&". This property implies that the length of
|
||||||
|
// unescaped text is <= the length of escaped text.
|
||||||
|
for k, v := range entity {
|
||||||
|
if 1+len(k) < utf8.RuneLen(v) {
|
||||||
|
t.Error("escaped entity &" + k + " is shorter than its UTF-8 encoding " + string(v))
|
||||||
|
}
|
||||||
|
if len(k) > longestEntityWithoutSemicolon && k[len(k)-1] != ';' {
|
||||||
|
t.Errorf("entity name %s is %d characters, but longestEntityWithoutSemicolon=%d", k, len(k), longestEntityWithoutSemicolon)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for k, v := range entity2 {
|
||||||
|
if 1+len(k) < utf8.RuneLen(v[0])+utf8.RuneLen(v[1]) {
|
||||||
|
t.Error("escaped entity &" + k + " is shorter than its UTF-8 encoding " + string(v[0]) + string(v[1]))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+258
@@ -0,0 +1,258 @@
|
|||||||
|
// Copyright 2010 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package html
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"strings"
|
||||||
|
"unicode/utf8"
|
||||||
|
)
|
||||||
|
|
||||||
|
// These replacements permit compatibility with old numeric entities that
|
||||||
|
// assumed Windows-1252 encoding.
|
||||||
|
// https://html.spec.whatwg.org/multipage/syntax.html#consume-a-character-reference
|
||||||
|
var replacementTable = [...]rune{
|
||||||
|
'\u20AC', // First entry is what 0x80 should be replaced with.
|
||||||
|
'\u0081',
|
||||||
|
'\u201A',
|
||||||
|
'\u0192',
|
||||||
|
'\u201E',
|
||||||
|
'\u2026',
|
||||||
|
'\u2020',
|
||||||
|
'\u2021',
|
||||||
|
'\u02C6',
|
||||||
|
'\u2030',
|
||||||
|
'\u0160',
|
||||||
|
'\u2039',
|
||||||
|
'\u0152',
|
||||||
|
'\u008D',
|
||||||
|
'\u017D',
|
||||||
|
'\u008F',
|
||||||
|
'\u0090',
|
||||||
|
'\u2018',
|
||||||
|
'\u2019',
|
||||||
|
'\u201C',
|
||||||
|
'\u201D',
|
||||||
|
'\u2022',
|
||||||
|
'\u2013',
|
||||||
|
'\u2014',
|
||||||
|
'\u02DC',
|
||||||
|
'\u2122',
|
||||||
|
'\u0161',
|
||||||
|
'\u203A',
|
||||||
|
'\u0153',
|
||||||
|
'\u009D',
|
||||||
|
'\u017E',
|
||||||
|
'\u0178', // Last entry is 0x9F.
|
||||||
|
// 0x00->'\uFFFD' is handled programmatically.
|
||||||
|
// 0x0D->'\u000D' is a no-op.
|
||||||
|
}
|
||||||
|
|
||||||
|
// unescapeEntity reads an entity like "<" from b[src:] and writes the
|
||||||
|
// corresponding "<" to b[dst:], returning the incremented dst and src cursors.
|
||||||
|
// Precondition: b[src] == '&' && dst <= src.
|
||||||
|
// attribute should be true if parsing an attribute value.
|
||||||
|
func unescapeEntity(b []byte, dst, src int, attribute bool) (dst1, src1 int) {
|
||||||
|
// https://html.spec.whatwg.org/multipage/syntax.html#consume-a-character-reference
|
||||||
|
|
||||||
|
// i starts at 1 because we already know that s[0] == '&'.
|
||||||
|
i, s := 1, b[src:]
|
||||||
|
|
||||||
|
if len(s) <= 1 {
|
||||||
|
b[dst] = b[src]
|
||||||
|
return dst + 1, src + 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if s[i] == '#' {
|
||||||
|
if len(s) <= 3 { // We need to have at least "&#.".
|
||||||
|
b[dst] = b[src]
|
||||||
|
return dst + 1, src + 1
|
||||||
|
}
|
||||||
|
i++
|
||||||
|
c := s[i]
|
||||||
|
hex := false
|
||||||
|
if c == 'x' || c == 'X' {
|
||||||
|
hex = true
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
|
||||||
|
x := '\x00'
|
||||||
|
for i < len(s) {
|
||||||
|
c = s[i]
|
||||||
|
i++
|
||||||
|
if hex {
|
||||||
|
if '0' <= c && c <= '9' {
|
||||||
|
x = 16*x + rune(c) - '0'
|
||||||
|
continue
|
||||||
|
} else if 'a' <= c && c <= 'f' {
|
||||||
|
x = 16*x + rune(c) - 'a' + 10
|
||||||
|
continue
|
||||||
|
} else if 'A' <= c && c <= 'F' {
|
||||||
|
x = 16*x + rune(c) - 'A' + 10
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
} else if '0' <= c && c <= '9' {
|
||||||
|
x = 10*x + rune(c) - '0'
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if c != ';' {
|
||||||
|
i--
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
if i <= 3 { // No characters matched.
|
||||||
|
b[dst] = b[src]
|
||||||
|
return dst + 1, src + 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if 0x80 <= x && x <= 0x9F {
|
||||||
|
// Replace characters from Windows-1252 with UTF-8 equivalents.
|
||||||
|
x = replacementTable[x-0x80]
|
||||||
|
} else if x == 0 || (0xD800 <= x && x <= 0xDFFF) || x > 0x10FFFF {
|
||||||
|
// Replace invalid characters with the replacement character.
|
||||||
|
x = '\uFFFD'
|
||||||
|
}
|
||||||
|
|
||||||
|
return dst + utf8.EncodeRune(b[dst:], x), src + i
|
||||||
|
}
|
||||||
|
|
||||||
|
// Consume the maximum number of characters possible, with the
|
||||||
|
// consumed characters matching one of the named references.
|
||||||
|
|
||||||
|
for i < len(s) {
|
||||||
|
c := s[i]
|
||||||
|
i++
|
||||||
|
// Lower-cased characters are more common in entities, so we check for them first.
|
||||||
|
if 'a' <= c && c <= 'z' || 'A' <= c && c <= 'Z' || '0' <= c && c <= '9' {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if c != ';' {
|
||||||
|
i--
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
entityName := string(s[1:i])
|
||||||
|
if entityName == "" {
|
||||||
|
// No-op.
|
||||||
|
} else if attribute && entityName[len(entityName)-1] != ';' && len(s) > i && s[i] == '=' {
|
||||||
|
// No-op.
|
||||||
|
} else if x := entity[entityName]; x != 0 {
|
||||||
|
return dst + utf8.EncodeRune(b[dst:], x), src + i
|
||||||
|
} else if x := entity2[entityName]; x[0] != 0 {
|
||||||
|
dst1 := dst + utf8.EncodeRune(b[dst:], x[0])
|
||||||
|
return dst1 + utf8.EncodeRune(b[dst1:], x[1]), src + i
|
||||||
|
} else if !attribute {
|
||||||
|
maxLen := len(entityName) - 1
|
||||||
|
if maxLen > longestEntityWithoutSemicolon {
|
||||||
|
maxLen = longestEntityWithoutSemicolon
|
||||||
|
}
|
||||||
|
for j := maxLen; j > 1; j-- {
|
||||||
|
if x := entity[entityName[:j]]; x != 0 {
|
||||||
|
return dst + utf8.EncodeRune(b[dst:], x), src + j + 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dst1, src1 = dst+i, src+i
|
||||||
|
copy(b[dst:dst1], b[src:src1])
|
||||||
|
return dst1, src1
|
||||||
|
}
|
||||||
|
|
||||||
|
// unescape unescapes b's entities in-place, so that "a<b" becomes "a<b".
|
||||||
|
// attribute should be true if parsing an attribute value.
|
||||||
|
func unescape(b []byte, attribute bool) []byte {
|
||||||
|
for i, c := range b {
|
||||||
|
if c == '&' {
|
||||||
|
dst, src := unescapeEntity(b, i, i, attribute)
|
||||||
|
for src < len(b) {
|
||||||
|
c := b[src]
|
||||||
|
if c == '&' {
|
||||||
|
dst, src = unescapeEntity(b, dst, src, attribute)
|
||||||
|
} else {
|
||||||
|
b[dst] = c
|
||||||
|
dst, src = dst+1, src+1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return b[0:dst]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// lower lower-cases the A-Z bytes in b in-place, so that "aBc" becomes "abc".
|
||||||
|
func lower(b []byte) []byte {
|
||||||
|
for i, c := range b {
|
||||||
|
if 'A' <= c && c <= 'Z' {
|
||||||
|
b[i] = c + 'a' - 'A'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
const escapedChars = "&'<>\"\r"
|
||||||
|
|
||||||
|
func escape(w writer, s string) error {
|
||||||
|
i := strings.IndexAny(s, escapedChars)
|
||||||
|
for i != -1 {
|
||||||
|
if _, err := w.WriteString(s[:i]); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var esc string
|
||||||
|
switch s[i] {
|
||||||
|
case '&':
|
||||||
|
esc = "&"
|
||||||
|
case '\'':
|
||||||
|
// "'" is shorter than "'" and apos was not in HTML until HTML5.
|
||||||
|
esc = "'"
|
||||||
|
case '<':
|
||||||
|
esc = "<"
|
||||||
|
case '>':
|
||||||
|
esc = ">"
|
||||||
|
case '"':
|
||||||
|
// """ is shorter than """.
|
||||||
|
esc = """
|
||||||
|
case '\r':
|
||||||
|
esc = " "
|
||||||
|
default:
|
||||||
|
panic("unrecognized escape character")
|
||||||
|
}
|
||||||
|
s = s[i+1:]
|
||||||
|
if _, err := w.WriteString(esc); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
i = strings.IndexAny(s, escapedChars)
|
||||||
|
}
|
||||||
|
_, err := w.WriteString(s)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EscapeString escapes special characters like "<" to become "<". It
|
||||||
|
// escapes only five such characters: <, >, &, ' and ".
|
||||||
|
// UnescapeString(EscapeString(s)) == s always holds, but the converse isn't
|
||||||
|
// always true.
|
||||||
|
func EscapeString(s string) string {
|
||||||
|
if strings.IndexAny(s, escapedChars) == -1 {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
var buf bytes.Buffer
|
||||||
|
escape(&buf, s)
|
||||||
|
return buf.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnescapeString unescapes entities like "<" to become "<". It unescapes a
|
||||||
|
// larger range of entities than EscapeString escapes. For example, "á"
|
||||||
|
// unescapes to "á", as does "á" and "&xE1;".
|
||||||
|
// UnescapeString(EscapeString(s)) == s always holds, but the converse isn't
|
||||||
|
// always true.
|
||||||
|
func UnescapeString(s string) string {
|
||||||
|
for _, c := range s {
|
||||||
|
if c == '&' {
|
||||||
|
return string(unescape([]byte(s), false))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
+97
@@ -0,0 +1,97 @@
|
|||||||
|
// Copyright 2013 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package html
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
type unescapeTest struct {
|
||||||
|
// A short description of the test case.
|
||||||
|
desc string
|
||||||
|
// The HTML text.
|
||||||
|
html string
|
||||||
|
// The unescaped text.
|
||||||
|
unescaped string
|
||||||
|
}
|
||||||
|
|
||||||
|
var unescapeTests = []unescapeTest{
|
||||||
|
// Handle no entities.
|
||||||
|
{
|
||||||
|
"copy",
|
||||||
|
"A\ttext\nstring",
|
||||||
|
"A\ttext\nstring",
|
||||||
|
},
|
||||||
|
// Handle simple named entities.
|
||||||
|
{
|
||||||
|
"simple",
|
||||||
|
"& > <",
|
||||||
|
"& > <",
|
||||||
|
},
|
||||||
|
// Handle hitting the end of the string.
|
||||||
|
{
|
||||||
|
"stringEnd",
|
||||||
|
"& &",
|
||||||
|
"& &",
|
||||||
|
},
|
||||||
|
// Handle entities with two codepoints.
|
||||||
|
{
|
||||||
|
"multiCodepoint",
|
||||||
|
"text ⋛︀ blah",
|
||||||
|
"text \u22db\ufe00 blah",
|
||||||
|
},
|
||||||
|
// Handle decimal numeric entities.
|
||||||
|
{
|
||||||
|
"decimalEntity",
|
||||||
|
"Delta = Δ ",
|
||||||
|
"Delta = Δ ",
|
||||||
|
},
|
||||||
|
// Handle hexadecimal numeric entities.
|
||||||
|
{
|
||||||
|
"hexadecimalEntity",
|
||||||
|
"Lambda = λ = λ ",
|
||||||
|
"Lambda = λ = λ ",
|
||||||
|
},
|
||||||
|
// Handle numeric early termination.
|
||||||
|
{
|
||||||
|
"numericEnds",
|
||||||
|
"&# &#x €43 © = ©f = ©",
|
||||||
|
"&# &#x €43 © = ©f = ©",
|
||||||
|
},
|
||||||
|
// Handle numeric ISO-8859-1 entity replacements.
|
||||||
|
{
|
||||||
|
"numericReplacements",
|
||||||
|
"Footnote‡",
|
||||||
|
"Footnote‡",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnescape(t *testing.T) {
|
||||||
|
for _, tt := range unescapeTests {
|
||||||
|
unescaped := UnescapeString(tt.html)
|
||||||
|
if unescaped != tt.unescaped {
|
||||||
|
t.Errorf("TestUnescape %s: want %q, got %q", tt.desc, tt.unescaped, unescaped)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnescapeEscape(t *testing.T) {
|
||||||
|
ss := []string{
|
||||||
|
``,
|
||||||
|
`abc def`,
|
||||||
|
`a & b`,
|
||||||
|
`a&b`,
|
||||||
|
`a & b`,
|
||||||
|
`"`,
|
||||||
|
`"`,
|
||||||
|
`"<&>"`,
|
||||||
|
`"<&>"`,
|
||||||
|
`3&5==1 && 0<1, "0<1", a+acute=á`,
|
||||||
|
`The special characters are: <, >, &, ' and "`,
|
||||||
|
}
|
||||||
|
for _, s := range ss {
|
||||||
|
if got := UnescapeString(EscapeString(s)); got != s {
|
||||||
|
t.Errorf("got %q want %q", got, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+40
@@ -0,0 +1,40 @@
|
|||||||
|
// Copyright 2012 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// This example demonstrates parsing HTML data and walking the resulting tree.
|
||||||
|
package html_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"golang.org/x/net/html"
|
||||||
|
)
|
||||||
|
|
||||||
|
func ExampleParse() {
|
||||||
|
s := `<p>Links:</p><ul><li><a href="foo">Foo</a><li><a href="/bar/baz">BarBaz</a></ul>`
|
||||||
|
doc, err := html.Parse(strings.NewReader(s))
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
var f func(*html.Node)
|
||||||
|
f = func(n *html.Node) {
|
||||||
|
if n.Type == html.ElementNode && n.Data == "a" {
|
||||||
|
for _, a := range n.Attr {
|
||||||
|
if a.Key == "href" {
|
||||||
|
fmt.Println(a.Val)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for c := n.FirstChild; c != nil; c = c.NextSibling {
|
||||||
|
f(c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
f(doc)
|
||||||
|
// Output:
|
||||||
|
// foo
|
||||||
|
// /bar/baz
|
||||||
|
}
|
||||||
+226
@@ -0,0 +1,226 @@
|
|||||||
|
// Copyright 2011 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package html
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
func adjustAttributeNames(aa []Attribute, nameMap map[string]string) {
|
||||||
|
for i := range aa {
|
||||||
|
if newName, ok := nameMap[aa[i].Key]; ok {
|
||||||
|
aa[i].Key = newName
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func adjustForeignAttributes(aa []Attribute) {
|
||||||
|
for i, a := range aa {
|
||||||
|
if a.Key == "" || a.Key[0] != 'x' {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
switch a.Key {
|
||||||
|
case "xlink:actuate", "xlink:arcrole", "xlink:href", "xlink:role", "xlink:show",
|
||||||
|
"xlink:title", "xlink:type", "xml:base", "xml:lang", "xml:space", "xmlns:xlink":
|
||||||
|
j := strings.Index(a.Key, ":")
|
||||||
|
aa[i].Namespace = a.Key[:j]
|
||||||
|
aa[i].Key = a.Key[j+1:]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func htmlIntegrationPoint(n *Node) bool {
|
||||||
|
if n.Type != ElementNode {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
switch n.Namespace {
|
||||||
|
case "math":
|
||||||
|
if n.Data == "annotation-xml" {
|
||||||
|
for _, a := range n.Attr {
|
||||||
|
if a.Key == "encoding" {
|
||||||
|
val := strings.ToLower(a.Val)
|
||||||
|
if val == "text/html" || val == "application/xhtml+xml" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case "svg":
|
||||||
|
switch n.Data {
|
||||||
|
case "desc", "foreignObject", "title":
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func mathMLTextIntegrationPoint(n *Node) bool {
|
||||||
|
if n.Namespace != "math" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
switch n.Data {
|
||||||
|
case "mi", "mo", "mn", "ms", "mtext":
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Section 12.2.5.5.
|
||||||
|
var breakout = map[string]bool{
|
||||||
|
"b": true,
|
||||||
|
"big": true,
|
||||||
|
"blockquote": true,
|
||||||
|
"body": true,
|
||||||
|
"br": true,
|
||||||
|
"center": true,
|
||||||
|
"code": true,
|
||||||
|
"dd": true,
|
||||||
|
"div": true,
|
||||||
|
"dl": true,
|
||||||
|
"dt": true,
|
||||||
|
"em": true,
|
||||||
|
"embed": true,
|
||||||
|
"h1": true,
|
||||||
|
"h2": true,
|
||||||
|
"h3": true,
|
||||||
|
"h4": true,
|
||||||
|
"h5": true,
|
||||||
|
"h6": true,
|
||||||
|
"head": true,
|
||||||
|
"hr": true,
|
||||||
|
"i": true,
|
||||||
|
"img": true,
|
||||||
|
"li": true,
|
||||||
|
"listing": true,
|
||||||
|
"menu": true,
|
||||||
|
"meta": true,
|
||||||
|
"nobr": true,
|
||||||
|
"ol": true,
|
||||||
|
"p": true,
|
||||||
|
"pre": true,
|
||||||
|
"ruby": true,
|
||||||
|
"s": true,
|
||||||
|
"small": true,
|
||||||
|
"span": true,
|
||||||
|
"strong": true,
|
||||||
|
"strike": true,
|
||||||
|
"sub": true,
|
||||||
|
"sup": true,
|
||||||
|
"table": true,
|
||||||
|
"tt": true,
|
||||||
|
"u": true,
|
||||||
|
"ul": true,
|
||||||
|
"var": true,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Section 12.2.5.5.
|
||||||
|
var svgTagNameAdjustments = map[string]string{
|
||||||
|
"altglyph": "altGlyph",
|
||||||
|
"altglyphdef": "altGlyphDef",
|
||||||
|
"altglyphitem": "altGlyphItem",
|
||||||
|
"animatecolor": "animateColor",
|
||||||
|
"animatemotion": "animateMotion",
|
||||||
|
"animatetransform": "animateTransform",
|
||||||
|
"clippath": "clipPath",
|
||||||
|
"feblend": "feBlend",
|
||||||
|
"fecolormatrix": "feColorMatrix",
|
||||||
|
"fecomponenttransfer": "feComponentTransfer",
|
||||||
|
"fecomposite": "feComposite",
|
||||||
|
"feconvolvematrix": "feConvolveMatrix",
|
||||||
|
"fediffuselighting": "feDiffuseLighting",
|
||||||
|
"fedisplacementmap": "feDisplacementMap",
|
||||||
|
"fedistantlight": "feDistantLight",
|
||||||
|
"feflood": "feFlood",
|
||||||
|
"fefunca": "feFuncA",
|
||||||
|
"fefuncb": "feFuncB",
|
||||||
|
"fefuncg": "feFuncG",
|
||||||
|
"fefuncr": "feFuncR",
|
||||||
|
"fegaussianblur": "feGaussianBlur",
|
||||||
|
"feimage": "feImage",
|
||||||
|
"femerge": "feMerge",
|
||||||
|
"femergenode": "feMergeNode",
|
||||||
|
"femorphology": "feMorphology",
|
||||||
|
"feoffset": "feOffset",
|
||||||
|
"fepointlight": "fePointLight",
|
||||||
|
"fespecularlighting": "feSpecularLighting",
|
||||||
|
"fespotlight": "feSpotLight",
|
||||||
|
"fetile": "feTile",
|
||||||
|
"feturbulence": "feTurbulence",
|
||||||
|
"foreignobject": "foreignObject",
|
||||||
|
"glyphref": "glyphRef",
|
||||||
|
"lineargradient": "linearGradient",
|
||||||
|
"radialgradient": "radialGradient",
|
||||||
|
"textpath": "textPath",
|
||||||
|
}
|
||||||
|
|
||||||
|
// Section 12.2.5.1
|
||||||
|
var mathMLAttributeAdjustments = map[string]string{
|
||||||
|
"definitionurl": "definitionURL",
|
||||||
|
}
|
||||||
|
|
||||||
|
var svgAttributeAdjustments = map[string]string{
|
||||||
|
"attributename": "attributeName",
|
||||||
|
"attributetype": "attributeType",
|
||||||
|
"basefrequency": "baseFrequency",
|
||||||
|
"baseprofile": "baseProfile",
|
||||||
|
"calcmode": "calcMode",
|
||||||
|
"clippathunits": "clipPathUnits",
|
||||||
|
"contentscripttype": "contentScriptType",
|
||||||
|
"contentstyletype": "contentStyleType",
|
||||||
|
"diffuseconstant": "diffuseConstant",
|
||||||
|
"edgemode": "edgeMode",
|
||||||
|
"externalresourcesrequired": "externalResourcesRequired",
|
||||||
|
"filterres": "filterRes",
|
||||||
|
"filterunits": "filterUnits",
|
||||||
|
"glyphref": "glyphRef",
|
||||||
|
"gradienttransform": "gradientTransform",
|
||||||
|
"gradientunits": "gradientUnits",
|
||||||
|
"kernelmatrix": "kernelMatrix",
|
||||||
|
"kernelunitlength": "kernelUnitLength",
|
||||||
|
"keypoints": "keyPoints",
|
||||||
|
"keysplines": "keySplines",
|
||||||
|
"keytimes": "keyTimes",
|
||||||
|
"lengthadjust": "lengthAdjust",
|
||||||
|
"limitingconeangle": "limitingConeAngle",
|
||||||
|
"markerheight": "markerHeight",
|
||||||
|
"markerunits": "markerUnits",
|
||||||
|
"markerwidth": "markerWidth",
|
||||||
|
"maskcontentunits": "maskContentUnits",
|
||||||
|
"maskunits": "maskUnits",
|
||||||
|
"numoctaves": "numOctaves",
|
||||||
|
"pathlength": "pathLength",
|
||||||
|
"patterncontentunits": "patternContentUnits",
|
||||||
|
"patterntransform": "patternTransform",
|
||||||
|
"patternunits": "patternUnits",
|
||||||
|
"pointsatx": "pointsAtX",
|
||||||
|
"pointsaty": "pointsAtY",
|
||||||
|
"pointsatz": "pointsAtZ",
|
||||||
|
"preservealpha": "preserveAlpha",
|
||||||
|
"preserveaspectratio": "preserveAspectRatio",
|
||||||
|
"primitiveunits": "primitiveUnits",
|
||||||
|
"refx": "refX",
|
||||||
|
"refy": "refY",
|
||||||
|
"repeatcount": "repeatCount",
|
||||||
|
"repeatdur": "repeatDur",
|
||||||
|
"requiredextensions": "requiredExtensions",
|
||||||
|
"requiredfeatures": "requiredFeatures",
|
||||||
|
"specularconstant": "specularConstant",
|
||||||
|
"specularexponent": "specularExponent",
|
||||||
|
"spreadmethod": "spreadMethod",
|
||||||
|
"startoffset": "startOffset",
|
||||||
|
"stddeviation": "stdDeviation",
|
||||||
|
"stitchtiles": "stitchTiles",
|
||||||
|
"surfacescale": "surfaceScale",
|
||||||
|
"systemlanguage": "systemLanguage",
|
||||||
|
"tablevalues": "tableValues",
|
||||||
|
"targetx": "targetX",
|
||||||
|
"targety": "targetY",
|
||||||
|
"textlength": "textLength",
|
||||||
|
"viewbox": "viewBox",
|
||||||
|
"viewtarget": "viewTarget",
|
||||||
|
"xchannelselector": "xChannelSelector",
|
||||||
|
"ychannelselector": "yChannelSelector",
|
||||||
|
"zoomandpan": "zoomAndPan",
|
||||||
|
}
|
||||||
+193
@@ -0,0 +1,193 @@
|
|||||||
|
// Copyright 2011 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package html
|
||||||
|
|
||||||
|
import (
|
||||||
|
"golang.org/x/net/html/atom"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A NodeType is the type of a Node.
|
||||||
|
type NodeType uint32
|
||||||
|
|
||||||
|
const (
|
||||||
|
ErrorNode NodeType = iota
|
||||||
|
TextNode
|
||||||
|
DocumentNode
|
||||||
|
ElementNode
|
||||||
|
CommentNode
|
||||||
|
DoctypeNode
|
||||||
|
scopeMarkerNode
|
||||||
|
)
|
||||||
|
|
||||||
|
// Section 12.2.3.3 says "scope markers are inserted when entering applet
|
||||||
|
// elements, buttons, object elements, marquees, table cells, and table
|
||||||
|
// captions, and are used to prevent formatting from 'leaking'".
|
||||||
|
var scopeMarker = Node{Type: scopeMarkerNode}
|
||||||
|
|
||||||
|
// A Node consists of a NodeType and some Data (tag name for element nodes,
|
||||||
|
// content for text) and are part of a tree of Nodes. Element nodes may also
|
||||||
|
// have a Namespace and contain a slice of Attributes. Data is unescaped, so
|
||||||
|
// that it looks like "a<b" rather than "a<b". For element nodes, DataAtom
|
||||||
|
// is the atom for Data, or zero if Data is not a known tag name.
|
||||||
|
//
|
||||||
|
// An empty Namespace implies a "http://www.w3.org/1999/xhtml" namespace.
|
||||||
|
// Similarly, "math" is short for "http://www.w3.org/1998/Math/MathML", and
|
||||||
|
// "svg" is short for "http://www.w3.org/2000/svg".
|
||||||
|
type Node struct {
|
||||||
|
Parent, FirstChild, LastChild, PrevSibling, NextSibling *Node
|
||||||
|
|
||||||
|
Type NodeType
|
||||||
|
DataAtom atom.Atom
|
||||||
|
Data string
|
||||||
|
Namespace string
|
||||||
|
Attr []Attribute
|
||||||
|
}
|
||||||
|
|
||||||
|
// InsertBefore inserts newChild as a child of n, immediately before oldChild
|
||||||
|
// in the sequence of n's children. oldChild may be nil, in which case newChild
|
||||||
|
// is appended to the end of n's children.
|
||||||
|
//
|
||||||
|
// It will panic if newChild already has a parent or siblings.
|
||||||
|
func (n *Node) InsertBefore(newChild, oldChild *Node) {
|
||||||
|
if newChild.Parent != nil || newChild.PrevSibling != nil || newChild.NextSibling != nil {
|
||||||
|
panic("html: InsertBefore called for an attached child Node")
|
||||||
|
}
|
||||||
|
var prev, next *Node
|
||||||
|
if oldChild != nil {
|
||||||
|
prev, next = oldChild.PrevSibling, oldChild
|
||||||
|
} else {
|
||||||
|
prev = n.LastChild
|
||||||
|
}
|
||||||
|
if prev != nil {
|
||||||
|
prev.NextSibling = newChild
|
||||||
|
} else {
|
||||||
|
n.FirstChild = newChild
|
||||||
|
}
|
||||||
|
if next != nil {
|
||||||
|
next.PrevSibling = newChild
|
||||||
|
} else {
|
||||||
|
n.LastChild = newChild
|
||||||
|
}
|
||||||
|
newChild.Parent = n
|
||||||
|
newChild.PrevSibling = prev
|
||||||
|
newChild.NextSibling = next
|
||||||
|
}
|
||||||
|
|
||||||
|
// AppendChild adds a node c as a child of n.
|
||||||
|
//
|
||||||
|
// It will panic if c already has a parent or siblings.
|
||||||
|
func (n *Node) AppendChild(c *Node) {
|
||||||
|
if c.Parent != nil || c.PrevSibling != nil || c.NextSibling != nil {
|
||||||
|
panic("html: AppendChild called for an attached child Node")
|
||||||
|
}
|
||||||
|
last := n.LastChild
|
||||||
|
if last != nil {
|
||||||
|
last.NextSibling = c
|
||||||
|
} else {
|
||||||
|
n.FirstChild = c
|
||||||
|
}
|
||||||
|
n.LastChild = c
|
||||||
|
c.Parent = n
|
||||||
|
c.PrevSibling = last
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveChild removes a node c that is a child of n. Afterwards, c will have
|
||||||
|
// no parent and no siblings.
|
||||||
|
//
|
||||||
|
// It will panic if c's parent is not n.
|
||||||
|
func (n *Node) RemoveChild(c *Node) {
|
||||||
|
if c.Parent != n {
|
||||||
|
panic("html: RemoveChild called for a non-child Node")
|
||||||
|
}
|
||||||
|
if n.FirstChild == c {
|
||||||
|
n.FirstChild = c.NextSibling
|
||||||
|
}
|
||||||
|
if c.NextSibling != nil {
|
||||||
|
c.NextSibling.PrevSibling = c.PrevSibling
|
||||||
|
}
|
||||||
|
if n.LastChild == c {
|
||||||
|
n.LastChild = c.PrevSibling
|
||||||
|
}
|
||||||
|
if c.PrevSibling != nil {
|
||||||
|
c.PrevSibling.NextSibling = c.NextSibling
|
||||||
|
}
|
||||||
|
c.Parent = nil
|
||||||
|
c.PrevSibling = nil
|
||||||
|
c.NextSibling = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// reparentChildren reparents all of src's child nodes to dst.
|
||||||
|
func reparentChildren(dst, src *Node) {
|
||||||
|
for {
|
||||||
|
child := src.FirstChild
|
||||||
|
if child == nil {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
src.RemoveChild(child)
|
||||||
|
dst.AppendChild(child)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// clone returns a new node with the same type, data and attributes.
|
||||||
|
// The clone has no parent, no siblings and no children.
|
||||||
|
func (n *Node) clone() *Node {
|
||||||
|
m := &Node{
|
||||||
|
Type: n.Type,
|
||||||
|
DataAtom: n.DataAtom,
|
||||||
|
Data: n.Data,
|
||||||
|
Attr: make([]Attribute, len(n.Attr)),
|
||||||
|
}
|
||||||
|
copy(m.Attr, n.Attr)
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
// nodeStack is a stack of nodes.
|
||||||
|
type nodeStack []*Node
|
||||||
|
|
||||||
|
// pop pops the stack. It will panic if s is empty.
|
||||||
|
func (s *nodeStack) pop() *Node {
|
||||||
|
i := len(*s)
|
||||||
|
n := (*s)[i-1]
|
||||||
|
*s = (*s)[:i-1]
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
// top returns the most recently pushed node, or nil if s is empty.
|
||||||
|
func (s *nodeStack) top() *Node {
|
||||||
|
if i := len(*s); i > 0 {
|
||||||
|
return (*s)[i-1]
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// index returns the index of the top-most occurrence of n in the stack, or -1
|
||||||
|
// if n is not present.
|
||||||
|
func (s *nodeStack) index(n *Node) int {
|
||||||
|
for i := len(*s) - 1; i >= 0; i-- {
|
||||||
|
if (*s)[i] == n {
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
|
||||||
|
// insert inserts a node at the given index.
|
||||||
|
func (s *nodeStack) insert(i int, n *Node) {
|
||||||
|
(*s) = append(*s, nil)
|
||||||
|
copy((*s)[i+1:], (*s)[i:])
|
||||||
|
(*s)[i] = n
|
||||||
|
}
|
||||||
|
|
||||||
|
// remove removes a node from the stack. It is a no-op if n is not present.
|
||||||
|
func (s *nodeStack) remove(n *Node) {
|
||||||
|
i := s.index(n)
|
||||||
|
if i == -1 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
copy((*s)[i:], (*s)[i+1:])
|
||||||
|
j := len(*s) - 1
|
||||||
|
(*s)[j] = nil
|
||||||
|
*s = (*s)[:j]
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user