File: query.go

package info (click to toggle)
stenographer 0.0~git20180422.0.73ce5dd-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 19,112 kB
  • sloc: cpp: 2,062; sh: 782; yacc: 257; makefile: 102
file content (210 lines) | stat: -rw-r--r-- 7,138 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
// Copyright 2014 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//go:generate go tool yacc -p parser parser.y
//go:generate go fmt y.go

// Package query provides objects for specifying a query against stenographer.
package query

import (
	"fmt"
	"net"
	"path/filepath"
	"strconv"
	"strings"
	"time"

	"github.com/google/stenographer/base"
	"github.com/google/stenographer/indexfile"
	"github.com/google/stenographer/stats"
	"golang.org/x/net/context"
)

var (
	v                        = base.V // verbose logging
	indexBaseLookupsStarted  = stats.S.Get("index_base_lookups_started")
	indexBaseLookupsFinished = stats.S.Get("index_base_lookups_finished")
	indexBaseLookupNanos     = stats.S.Get("index_base_lookup_nanos")
	indexSetLookupsStarted   = stats.S.Get("index_set_lookups_started")
	indexSetLookupsFinished  = stats.S.Get("index_set_lookups_finished")
	indexSetLookupNanos      = stats.S.Get("index_set_lookup_nanos")
)

// Query encodes the set of packets a requester wants to get from stenographer.
type Query interface {
	// LookupIn finds the set of packet positions for all packets that match the
	// query from an index file.  Users shouldn't call this directly, and should
	// instead pass the query into BlockFile's Lookup() to get back actual
	// packets.
	LookupIn(context.Context, *indexfile.IndexFile) (base.Positions, error)
	// String returns a human readable string for this query.
	String() string
	// base returns whether this is a base query, hitting an indexfile directly,
	// or an intersect/union set operation.
	base() bool
}

func log(q Query, i *indexfile.IndexFile, bp *base.Positions, err *error) func() {
	start := time.Now()
	if q.base() {
		indexBaseLookupsStarted.Increment()
	} else {
		indexSetLookupsStarted.Increment()
	}
	return func() {
		duration := time.Since(start)
		if q.base() {
			indexBaseLookupsFinished.Increment()
			indexBaseLookupNanos.IncrementBy(duration.Nanoseconds())
		} else {
			indexSetLookupsFinished.Increment()
			indexSetLookupNanos.IncrementBy(duration.Nanoseconds())
		}
		v(3, "Query %q in %q took %v, found %d  %v", q, i.Name(), duration, len(*bp), *err)
	}
}

type portQuery uint16

func (q portQuery) LookupIn(ctx context.Context, index *indexfile.IndexFile) (bp base.Positions, err error) {
	defer log(q, index, &bp, &err)()
	return index.PortPositions(ctx, uint16(q))
}
func (q portQuery) String() string { return fmt.Sprintf("port %d", q) }
func (q portQuery) base() bool     { return true }

type vlanQuery uint16

func (q vlanQuery) LookupIn(ctx context.Context, index *indexfile.IndexFile) (bp base.Positions, err error) {
	defer log(q, index, &bp, &err)()
	return index.VLANPositions(ctx, uint16(q))
}
func (q vlanQuery) String() string { return fmt.Sprintf("vlan %d", q) }
func (q vlanQuery) base() bool     { return true }

type mplsQuery uint32

func (q mplsQuery) LookupIn(ctx context.Context, index *indexfile.IndexFile) (bp base.Positions, err error) {
	defer log(q, index, &bp, &err)()
	return index.MPLSPositions(ctx, uint32(q))
}
func (q mplsQuery) String() string { return fmt.Sprintf("mpls %d", q) }
func (q mplsQuery) base() bool     { return true }

type protocolQuery byte

func (q protocolQuery) LookupIn(ctx context.Context, index *indexfile.IndexFile) (bp base.Positions, err error) {
	defer log(q, index, &bp, &err)()
	return index.ProtoPositions(ctx, byte(q))
}
func (q protocolQuery) String() string { return fmt.Sprintf("ip proto %d", q) }
func (q protocolQuery) base() bool     { return true }

type ipQuery [2]net.IP

func (q ipQuery) LookupIn(ctx context.Context, index *indexfile.IndexFile) (bp base.Positions, err error) {
	defer log(q, index, &bp, &err)()
	return index.IPPositions(ctx, q[0], q[1])
}
func (q ipQuery) String() string { return fmt.Sprintf("host %v-%v", q[0], q[1]) }
func (q ipQuery) base() bool     { return true }

type unionQuery []Query

func (a unionQuery) LookupIn(ctx context.Context, index *indexfile.IndexFile) (bp base.Positions, err error) {
	defer log(a, index, &bp, &err)()
	var positions base.Positions
	for _, query := range a {
		pos, err := query.LookupIn(ctx, index)
		if err != nil {
			return nil, err
		}
		positions = positions.Union(pos)
	}
	return positions, nil
}
func (a unionQuery) String() string {
	all := make([]string, len(a))
	for i, query := range a {
		all[i] = query.String()
	}
	return "(" + strings.Join(all, " or ") + ")"
}
func (a unionQuery) base() bool { return false }

type intersectQuery []Query

func (a intersectQuery) LookupIn(ctx context.Context, index *indexfile.IndexFile) (bp base.Positions, err error) {
	defer log(a, index, &bp, &err)()
	positions := base.AllPositions
	for _, query := range a {
		pos, err := query.LookupIn(ctx, index)
		if err != nil {
			return nil, err
		}
		positions = positions.Intersect(pos)
	}
	return positions, nil
}
func (a intersectQuery) String() string {
	all := make([]string, len(a))
	for i, query := range a {
		all[i] = query.String()
	}
	return "(" + strings.Join(all, " and ") + ")"
}
func (a intersectQuery) base() bool { return false }

type timeQuery [2]time.Time

func (a timeQuery) LookupIn(ctx context.Context, index *indexfile.IndexFile) (bp base.Positions, err error) {
	defer log(a, index, &bp, &err)()
	last := filepath.Base(index.Name())
	intval, err := strconv.ParseInt(last, 10, 64)
	if err != nil {
		return nil, fmt.Errorf("could not parse basename %q: %v", last, err)
	}
	t := time.Unix(0, intval*1000) // converts micros -> nanos
	// Note, we add a minute when doing 'before' queries and subtract a minute
	// when doing 'after' queries, to make sure we actually get the time
	// specified.
	if !a[0].IsZero() && t.Before(a[0].Add(-time.Minute)) {
		v(2, "time query skipping %q", index.Name())
		return base.NoPositions, nil
	}
	if !a[1].IsZero() && t.After(a[1].Add(time.Minute)) {
		v(2, "time query skipping %q", index.Name())
		return base.NoPositions, nil
	}
	v(2, "time query using %q", index.Name())
	return base.AllPositions, nil
}
func (a timeQuery) String() string {
	if a[0].IsZero() {
		return fmt.Sprintf("before %v", a[1].Format(time.RFC3339))
	}
	return fmt.Sprintf("after %v", a[0].Format(time.RFC3339))
}
func (a timeQuery) base() bool { return true }

// NewQuery parses the given query arg and returns a query object.
// This query can then be passed into a blockfile to get out the set of packets
// which match it.
//
// Currently, we support one simple method of parsing a query, detailed in the
// README.md file.  Returns an error if the query string is invalid.
func NewQuery(query string) (Query, error) {
	return parse(query)
}