forked from GoogleCloudPlatform/gcsfuse
/
flags.go
254 lines (214 loc) · 6.08 KB
/
flags.go
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
// Copyright 2015 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.
package main
import (
"os"
"time"
mountpkg "github.com/googlecloudplatform/gcsfuse/mount"
"github.com/jgeewax/cli"
)
func newApp() (app *cli.App) {
app = &cli.App{
Name: "gcsfuse",
Usage: "Mount a GCS bucket locally",
ArgumentUsage: "bucket mountpoint",
HideHelp: true,
HideVersion: true,
Writer: os.Stderr,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "help, h",
Usage: "Print this help text and exit successfuly.",
},
/////////////////////////
// File system
/////////////////////////
cli.StringSliceFlag{
Name: "o",
Usage: "Additional system-specific mount options. Be careful!",
},
cli.IntFlag{
Name: "dir-mode",
Value: 0755,
Usage: "Permissions bits for directories. (default: 0755)",
HideDefault: true,
},
cli.IntFlag{
Name: "file-mode",
Value: 0644,
Usage: "Permission bits for files (default: 0644)",
HideDefault: true,
},
cli.IntFlag{
Name: "uid",
Value: -1,
HideDefault: true,
Usage: "UID owner of all inodes.",
},
cli.IntFlag{
Name: "gid",
Value: -1,
HideDefault: true,
Usage: "GID owner of all inodes.",
},
cli.BoolFlag{
Name: "implicit-dirs",
Usage: "Implicitly define directories based on content. See" +
"docs/semantics.md",
},
/////////////////////////
// GCS
/////////////////////////
cli.StringFlag{
Name: "key-file",
Value: "",
HideDefault: true,
Usage: "Path to JSON key file for use with GCS. " +
"(default: none, Google application default credentials used)",
},
cli.Float64Flag{
Name: "limit-bytes-per-sec",
Value: -1,
Usage: "Bandwidth limit for reading data, measured over a 30-second " +
"window. (use -1 for no limit)",
},
cli.Float64Flag{
Name: "limit-ops-per-sec",
Value: 5.0,
Usage: "Operations per second limit, measured over a 30-second window " +
"(use -1 for no limit)",
},
/////////////////////////
// Tuning
/////////////////////////
cli.DurationFlag{
Name: "stat-cache-ttl",
Value: time.Minute,
Usage: "How long to cache StatObject results from GCS.",
},
cli.DurationFlag{
Name: "type-cache-ttl",
Value: time.Minute,
Usage: "How long to cache name -> file/dir mappings in directory " +
"inodes.",
},
cli.IntFlag{
Name: "gcs-chunk-size",
Value: 1 << 24,
Usage: "Max chunk size for loading GCS objects.",
},
cli.StringFlag{
Name: "temp-dir",
Value: "",
HideDefault: true,
Usage: "Temporary directory for local GCS object copies. " +
"(default: system default, likely /tmp)",
},
cli.IntFlag{
Name: "temp-dir-bytes",
Value: 1 << 31,
Usage: "Size limit of the temporary directory.",
},
/////////////////////////
// Debugging
/////////////////////////
cli.BoolFlag{
Name: "debug_cpu_profile",
Usage: "Write a 10-second CPU profile to /tmp on SIGHUP.",
},
cli.BoolFlag{
Name: "debug_fuse",
Usage: "Enable fuse-related debugging output.",
},
cli.BoolFlag{
Name: "debug_gcs",
Usage: "Print GCS request and timing information.",
},
cli.BoolFlag{
Name: "debug_http",
Usage: "Dump HTTP requests and responses to/from GCS.",
},
cli.BoolFlag{
Name: "debug_invariants",
Usage: "Panic when internal invariants are violated.",
},
cli.BoolFlag{
Name: "debug_mem_profile",
Usage: "Write a 10-second memory profile to /tmp on SIGHUP.",
},
},
}
return
}
type flagStorage struct {
// File system
MountOptions map[string]string
DirMode os.FileMode
FileMode os.FileMode
Uid int64
Gid int64
ImplicitDirs bool
// GCS
KeyFile string
EgressBandwidthLimitBytesPerSecond float64
OpRateLimitHz float64
// Tuning
StatCacheTTL time.Duration
TypeCacheTTL time.Duration
GCSChunkSize uint64
TempDir string
TempDirLimit int64
// Debugging
DebugCPUProfile bool
DebugFuse bool
DebugGCS bool
DebugHTTP bool
DebugInvariants bool
DebugMemProfile bool
}
// Add the flags accepted by run to the supplied flag set, returning the
// variables into which the flags will parse.
func populateFlags(c *cli.Context) (flags *flagStorage) {
flags = &flagStorage{
// File system
MountOptions: make(map[string]string),
DirMode: os.FileMode(c.Int("dir-mode")),
FileMode: os.FileMode(c.Int("file-mode")),
Uid: int64(c.Int("uid")),
Gid: int64(c.Int("gid")),
// GCS,
KeyFile: c.String("key-file"),
EgressBandwidthLimitBytesPerSecond: c.Float64("limit-bytes-per-sec"),
OpRateLimitHz: c.Float64("limit-ops-per-sec"),
// Tuning,
StatCacheTTL: c.Duration("stat-cache-ttl"),
TypeCacheTTL: c.Duration("type-cache-ttl"),
GCSChunkSize: uint64(c.Int("gcs-chunk-size")),
TempDir: c.String("temp-dir"),
TempDirLimit: int64(c.Int("temp-dir-bytes")),
ImplicitDirs: c.Bool("implicit-dirs"),
// Debugging,
DebugCPUProfile: c.Bool("debug_cpu_profile"),
DebugFuse: c.Bool("debug_fuse"),
DebugGCS: c.Bool("debug_gcs"),
DebugHTTP: c.Bool("debug_http"),
DebugInvariants: c.Bool("debug_invariants"),
DebugMemProfile: c.Bool("debug_mem_profile"),
}
// Handle the repeated "-o" flag.
for _, o := range c.StringSlice("o") {
mountpkg.ParseOptions(flags.MountOptions, o)
}
return
}