]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | #!@PYTHON_EXECUTABLE@ |
2 | # -*- mode:python -*- | |
3 | # vim: ts=4 sw=4 smarttab expandtab | |
4 | # | |
5 | # Processed in Makefile to add python #! line and version variable | |
6 | # | |
7 | # | |
8 | ||
9 | ||
10 | """ | |
11 | ceph.in becomes ceph, the command-line management tool for Ceph clusters. | |
12 | This is a replacement for tools/ceph.cc and tools/common.cc. | |
13 | ||
14 | Copyright (C) 2013 Inktank Storage, Inc. | |
15 | ||
16 | This is free software; you can redistribute it and/or | |
17 | modify it under the terms of the GNU General Public | |
18 | License version 2, as published by the Free Software | |
19 | Foundation. See file COPYING. | |
20 | """ | |
21 | ||
22 | from __future__ import print_function | |
23 | import codecs | |
24 | import os | |
25 | import sys | |
26 | import platform | |
27 | ||
28 | try: | |
29 | input = raw_input | |
30 | except NameError: | |
31 | pass | |
32 | ||
31f18b77 FG |
33 | CEPH_GIT_VER = "@CEPH_GIT_VER@" |
34 | CEPH_GIT_NICE_VER = "@CEPH_GIT_NICE_VER@" | |
35 | CEPH_RELEASE = "@CEPH_RELEASE@" | |
36 | CEPH_RELEASE_NAME = "@CEPH_RELEASE_NAME@" | |
37 | CEPH_RELEASE_TYPE = "@CEPH_RELEASE_TYPE@" | |
7c673cae FG |
38 | |
39 | # Flags from src/mon/Monitor.h | |
31f18b77 FG |
40 | FLAG_NOFORWARD = (1 << 0) |
41 | FLAG_OBSOLETE = (1 << 1) | |
7c673cae FG |
42 | FLAG_DEPRECATED = (1 << 2) |
43 | ||
44 | # priorities from src/common/perf_counters.h | |
45 | PRIO_CRITICAL = 10 | |
46 | PRIO_INTERESTING = 8 | |
47 | PRIO_USEFUL = 5 | |
48 | PRIO_UNINTERESTING = 2 | |
49 | PRIO_DEBUGONLY = 0 | |
50 | ||
51 | PRIO_DEFAULT = PRIO_USEFUL | |
52 | ||
53 | # Make life easier on developers: | |
54 | # If in src/, and .libs and pybind exist here, assume we're running | |
55 | # from a Ceph source dir and tweak PYTHONPATH and LD_LIBRARY_PATH | |
56 | # to use local files | |
57 | ||
58 | MYPATH = os.path.abspath(__file__) | |
59 | MYDIR = os.path.dirname(MYPATH) | |
60 | DEVMODEMSG = '*** DEVELOPER MODE: setting PATH, PYTHONPATH and LD_LIBRARY_PATH ***' | |
61 | ||
31f18b77 | 62 | |
7c673cae FG |
63 | def respawn_in_path(lib_path, pybind_path, pythonlib_path): |
64 | execv_cmd = ['python'] | |
65 | if 'CEPH_DBG' in os.environ: | |
66 | execv_cmd += ['-mpdb'] | |
67 | ||
68 | if platform.system() == "Darwin": | |
69 | lib_path_var = "DYLD_LIBRARY_PATH" | |
70 | else: | |
71 | lib_path_var = "LD_LIBRARY_PATH" | |
72 | ||
73 | py_binary = os.environ.get("PYTHON", "python") | |
74 | ||
75 | if lib_path_var in os.environ: | |
76 | if lib_path not in os.environ[lib_path_var]: | |
77 | os.environ[lib_path_var] += ':' + lib_path | |
31f18b77 FG |
78 | if "CEPH_DEV" not in os.environ: |
79 | print(DEVMODEMSG, file=sys.stderr) | |
7c673cae FG |
80 | os.execvp(py_binary, execv_cmd + sys.argv) |
81 | else: | |
82 | os.environ[lib_path_var] = lib_path | |
31f18b77 FG |
83 | if "CEPH_DEV" not in os.environ: |
84 | print(DEVMODEMSG, file=sys.stderr) | |
7c673cae FG |
85 | os.execvp(py_binary, execv_cmd + sys.argv) |
86 | sys.path.insert(0, os.path.join(MYDIR, pybind_path)) | |
87 | sys.path.insert(0, os.path.join(MYDIR, pythonlib_path)) | |
88 | ||
31f18b77 | 89 | |
7c673cae FG |
90 | def get_pythonlib_dir(): |
91 | """Returns the name of a distutils build directory""" | |
92 | return "lib.{version[0]}".format(version=sys.version_info) | |
93 | ||
94 | if os.path.exists(os.path.join(os.getcwd(), "CMakeCache.txt")) \ | |
95 | and os.path.exists(os.path.join(os.getcwd(), "bin/init-ceph")): | |
96 | src_path = None | |
97 | for l in open("./CMakeCache.txt"): | |
98 | if l.startswith("ceph_SOURCE_DIR:STATIC="): | |
99 | src_path = l.split("=")[1].strip() | |
100 | ||
7c673cae FG |
101 | if src_path is None: |
102 | # Huh, maybe we're not really in a cmake environment? | |
103 | pass | |
104 | else: | |
105 | # Developer mode, but in a cmake build dir instead of the src dir | |
106 | lib_path = os.path.join(os.getcwd(), "lib") | |
107 | bin_path = os.path.join(os.getcwd(), "bin") | |
108 | pybind_path = os.path.join(src_path, "src", "pybind") | |
109 | pythonlib_path = os.path.join(lib_path, | |
110 | "cython_modules", | |
111 | get_pythonlib_dir()) | |
112 | ||
113 | respawn_in_path(lib_path, pybind_path, pythonlib_path) | |
114 | ||
115 | if 'PATH' in os.environ and bin_path not in os.environ['PATH']: | |
116 | os.environ['PATH'] += ':' + bin_path | |
117 | ||
118 | import argparse | |
119 | import errno | |
120 | import json | |
121 | import rados | |
122 | import shlex | |
123 | import signal | |
124 | import string | |
125 | import subprocess | |
126 | ||
127 | from ceph_argparse import \ | |
128 | concise_sig, descsort_key, parse_json_funcsigs, \ | |
129 | matchnum, validate_command, find_cmd_target, \ | |
130 | send_command, json_command, run_in_thread | |
131 | ||
31f18b77 | 132 | from ceph_daemon import admin_socket, DaemonWatcher, Termsize |
7c673cae FG |
133 | |
134 | # just a couple of globals | |
135 | ||
136 | verbose = False | |
137 | cluster_handle = None | |
138 | ||
139 | # Always use Unicode (UTF-8) for stdout | |
140 | if sys.version_info[0] >= 3: | |
141 | raw_stdout = sys.stdout.buffer | |
142 | raw_stderr = sys.stderr.buffer | |
143 | else: | |
144 | raw_stdout = sys.__stdout__ | |
145 | raw_stderr = sys.__stderr__ | |
146 | sys.stdout = codecs.getwriter('utf-8')(raw_stdout) | |
147 | sys.stderr = codecs.getwriter('utf-8')(raw_stderr) | |
148 | ||
31f18b77 | 149 | |
7c673cae FG |
150 | def raw_write(buf): |
151 | sys.stdout.flush() | |
152 | raw_stdout.write(buf) | |
153 | ||
7c673cae FG |
154 | |
155 | def osdids(): | |
156 | ret, outbuf, outs = json_command(cluster_handle, prefix='osd ls') | |
7c673cae FG |
157 | if ret: |
158 | raise RuntimeError('Can\'t contact mon for osd list') | |
159 | return [line.decode('utf-8') for line in outbuf.split(b'\n') if line] | |
160 | ||
31f18b77 | 161 | |
7c673cae FG |
162 | def monids(): |
163 | ret, outbuf, outs = json_command(cluster_handle, prefix='mon dump', | |
31f18b77 | 164 | argdict={'format': 'json'}) |
7c673cae FG |
165 | if ret: |
166 | raise RuntimeError('Can\'t contact mon for mon list') | |
167 | d = json.loads(outbuf.decode('utf-8')) | |
168 | return [m['name'] for m in d['mons']] | |
169 | ||
31f18b77 | 170 | |
7c673cae FG |
171 | def mdsids(): |
172 | ret, outbuf, outs = json_command(cluster_handle, prefix='mds dump', | |
31f18b77 | 173 | argdict={'format': 'json'}) |
7c673cae FG |
174 | if ret: |
175 | raise RuntimeError('Can\'t contact mon for mds list') | |
176 | d = json.loads(outbuf.decode('utf-8')) | |
177 | l = [] | |
178 | infodict = d['info'] | |
179 | for mdsdict in infodict.values(): | |
180 | l.append(mdsdict['name']) | |
181 | return l | |
182 | ||
31f18b77 FG |
183 | |
184 | def mgrids(): | |
185 | ret, outbuf, outs = json_command(cluster_handle, prefix='mgr dump', | |
186 | argdict={'format': 'json'}) | |
187 | if ret: | |
188 | raise RuntimeError('Can\'t contact mon for mgr list') | |
189 | ||
190 | d = json.loads(outbuf.decode('utf-8')) | |
191 | l = [] | |
192 | l.append(d['active_name']) | |
193 | for i in d['standbys']: | |
194 | l.append(i['name']) | |
195 | return l | |
196 | ||
197 | ||
198 | def validate_target(target): | |
199 | """ | |
200 | this function will return true iff target is a correct | |
201 | target, such as mon.a/osd.2/mds.a/mgr. | |
202 | ||
203 | target: array, likes ['osd', '2'] | |
204 | return: bool, or raise RuntimeError | |
205 | """ | |
206 | ||
207 | if len(target) == 2: | |
208 | # for case "service.id" | |
209 | service_name, service_id = target[0], target[1] | |
210 | exist_ids = [] | |
211 | if service_name == "mon": | |
212 | exist_ids = monids() | |
213 | elif service_name == "osd": | |
214 | exist_ids = osdids() | |
215 | elif service_name == "mds": | |
216 | exist_ids = mdsids() | |
217 | elif service_name == "mgr": | |
218 | exist_ids = mgrids() | |
219 | else: | |
220 | print('WARN: {0} is not a legal service name, should be one of mon/osd/mds/mgr'.format(service_name), | |
221 | file=sys.stderr) | |
222 | return False | |
223 | ||
224 | if service_id in exist_ids: | |
225 | return True | |
226 | else: | |
227 | print('WARN: the service id you provided does not exist. service id should ' | |
228 | 'be one of {0}.'.format('/'.join(exist_ids)), file=sys.stderr) | |
229 | return False | |
230 | ||
231 | elif len(target) == 1 and target[0] in ['mgr', 'mon']: | |
232 | return True | |
233 | else: | |
234 | print('WARN: \"{0}\" is not a legal target. it should be one of mon.<id>/osd.<int>/mds.<id>/mgr'.format('.'.join(target)), file=sys.stderr) | |
235 | return False | |
236 | ||
237 | ||
7c673cae FG |
238 | # these args must be passed to all child programs |
239 | GLOBAL_ARGS = { | |
240 | 'client_id': '--id', | |
241 | 'client_name': '--name', | |
242 | 'cluster': '--cluster', | |
243 | 'cephconf': '--conf', | |
244 | } | |
245 | ||
31f18b77 | 246 | |
7c673cae FG |
247 | def parse_cmdargs(args=None, target=''): |
248 | # alias: let the line-wrapping be sane | |
249 | AP = argparse.ArgumentParser | |
250 | ||
251 | # format our own help | |
252 | parser = AP(description='Ceph administration tool', add_help=False) | |
253 | ||
254 | parser.add_argument('--completion', action='store_true', | |
255 | help=argparse.SUPPRESS) | |
256 | ||
257 | parser.add_argument('-h', '--help', help='request mon help', | |
258 | action='store_true') | |
259 | ||
260 | parser.add_argument('-c', '--conf', dest='cephconf', | |
261 | help='ceph configuration file') | |
262 | parser.add_argument('-i', '--in-file', dest='input_file', | |
263 | help='input file') | |
264 | parser.add_argument('-o', '--out-file', dest='output_file', | |
265 | help='output file') | |
266 | ||
267 | parser.add_argument('--id', '--user', dest='client_id', | |
268 | help='client id for authentication') | |
269 | parser.add_argument('--name', '-n', dest='client_name', | |
270 | help='client name for authentication') | |
271 | parser.add_argument('--cluster', help='cluster name') | |
272 | ||
273 | parser.add_argument('--admin-daemon', dest='admin_socket', | |
274 | help='submit admin-socket commands (\"help\" for help') | |
275 | parser.add_argument('--admin-socket', dest='admin_socket_nope', | |
276 | help='you probably mean --admin-daemon') | |
277 | ||
278 | parser.add_argument('-s', '--status', action='store_true', | |
279 | help='show cluster status') | |
280 | ||
281 | parser.add_argument('-w', '--watch', action='store_true', | |
282 | help='watch live cluster changes') | |
283 | parser.add_argument('--watch-debug', action='store_true', | |
284 | help='watch debug events') | |
285 | parser.add_argument('--watch-info', action='store_true', | |
286 | help='watch info events') | |
287 | parser.add_argument('--watch-sec', action='store_true', | |
288 | help='watch security events') | |
289 | parser.add_argument('--watch-warn', action='store_true', | |
290 | help='watch warn events') | |
291 | parser.add_argument('--watch-error', action='store_true', | |
292 | help='watch error events') | |
293 | ||
294 | parser.add_argument('--version', '-v', action="store_true", help="display version") | |
295 | parser.add_argument('--verbose', action="store_true", help="make verbose") | |
296 | parser.add_argument('--concise', dest='verbose', action="store_false", | |
297 | help="make less verbose") | |
298 | ||
299 | parser.add_argument('-f', '--format', choices=['json', 'json-pretty', | |
300 | 'xml', 'xml-pretty', 'plain'], dest='output_format') | |
301 | ||
302 | parser.add_argument('--connect-timeout', dest='cluster_timeout', | |
303 | type=int, | |
304 | help='set a timeout for connecting to the cluster') | |
305 | ||
306 | # returns a Namespace with the parsed args, and a list of all extras | |
307 | parsed_args, extras = parser.parse_known_args(args) | |
308 | ||
309 | return parser, parsed_args, extras | |
310 | ||
311 | ||
312 | def hdr(s): | |
313 | print('\n', s, '\n', '=' * len(s)) | |
314 | ||
31f18b77 | 315 | |
7c673cae FG |
316 | def do_basic_help(parser, args): |
317 | """ | |
318 | Print basic parser help | |
319 | If the cluster is available, get and print monitor help | |
320 | """ | |
321 | hdr('General usage:') | |
322 | parser.print_help() | |
323 | print_locally_handled_command_help() | |
324 | ||
31f18b77 | 325 | |
7c673cae FG |
326 | def print_locally_handled_command_help(): |
327 | hdr("Local commands:") | |
328 | print(""" | |
329 | ping <mon.id> Send simple presence/life test to a mon | |
330 | <mon.id> may be 'mon.*' for all mons | |
331 | daemon {type.id|path} <cmd> | |
332 | Same as --admin-daemon, but auto-find admin socket | |
333 | daemonperf {type.id | path} [stat-pats] [priority] [<interval>] [<count>] | |
334 | daemonperf {type.id | path} list|ls [stat-pats] [priority] | |
335 | Get selected perf stats from daemon/admin socket | |
336 | Optional shell-glob comma-delim match string stat-pats | |
337 | Optional selection priority (can abbreviate name): | |
338 | critical, interesting, useful, noninteresting, debug | |
339 | List shows a table of all available stats | |
340 | Run <count> times (default forever), | |
341 | once per <interval> seconds (default 1) | |
342 | """, file=sys.stdout) | |
343 | ||
344 | ||
31f18b77 | 345 | def do_extended_help(parser, args, target, partial): |
7c673cae FG |
346 | def help_for_sigs(sigs, partial=None): |
347 | sys.stdout.write(format_help(parse_json_funcsigs(sigs, 'cli'), | |
348 | partial=partial)) | |
349 | ||
350 | def help_for_target(target, partial=None): | |
351 | ret, outbuf, outs = json_command(cluster_handle, target=target, | |
352 | prefix='get_command_descriptions', | |
353 | timeout=10) | |
354 | if ret: | |
31f18b77 FG |
355 | print("couldn't get command descriptions for {0}: {1} ({2})". |
356 | format(target, outs, ret), file=sys.stderr) | |
357 | return ret | |
7c673cae | 358 | else: |
31f18b77 | 359 | return help_for_sigs(outbuf.decode('utf-8'), partial) |
7c673cae | 360 | |
31f18b77 FG |
361 | assert(cluster_handle.state == "connected") |
362 | return help_for_target(target, partial) | |
7c673cae FG |
363 | |
364 | DONTSPLIT = string.ascii_letters + '{[<>]}' | |
365 | ||
31f18b77 | 366 | |
7c673cae FG |
367 | def wrap(s, width, indent): |
368 | """ | |
369 | generator to transform s into a sequence of strings width or shorter, | |
370 | for wrapping text to a specific column width. | |
371 | Attempt to break on anything but DONTSPLIT characters. | |
372 | indent is amount to indent 2nd-through-nth lines. | |
373 | ||
374 | so "long string long string long string" width=11 indent=1 becomes | |
375 | 'long string', ' long string', ' long string' so that it can be printed | |
376 | as | |
377 | long string | |
378 | long string | |
379 | long string | |
380 | ||
381 | Consumes s. | |
382 | """ | |
383 | result = '' | |
384 | leader = '' | |
385 | while len(s): | |
386 | ||
31f18b77 | 387 | if len(s) <= width: |
7c673cae FG |
388 | # no splitting; just possibly indent |
389 | result = leader + s | |
390 | s = '' | |
391 | yield result | |
392 | ||
393 | else: | |
394 | splitpos = width | |
395 | while (splitpos > 0) and (s[splitpos-1] in DONTSPLIT): | |
396 | splitpos -= 1 | |
397 | ||
398 | if splitpos == 0: | |
399 | splitpos = width | |
400 | ||
401 | if result: | |
402 | # prior result means we're mid-iteration, indent | |
403 | result = leader | |
404 | else: | |
405 | # first time, set leader and width for next | |
406 | leader = ' ' * indent | |
407 | width -= 1 # for subsequent space additions | |
408 | ||
409 | # remove any leading spaces in this chunk of s | |
410 | result += s[:splitpos].lstrip() | |
411 | s = s[splitpos:] | |
412 | ||
413 | yield result | |
414 | ||
415 | raise StopIteration | |
416 | ||
31f18b77 | 417 | |
7c673cae FG |
418 | def format_help(cmddict, partial=None): |
419 | """ | |
420 | Formats all the cmdsigs and helptexts from cmddict into a sorted-by- | |
421 | cmdsig 2-column display, with each column wrapped and indented to | |
31f18b77 | 422 | fit into (terminal_width / 2) characters. |
7c673cae FG |
423 | """ |
424 | ||
425 | fullusage = '' | |
426 | for cmd in sorted(cmddict.values(), key=descsort_key): | |
427 | ||
428 | if not cmd['help']: | |
429 | continue | |
31f18b77 FG |
430 | flags = cmd.get('flags', 0) |
431 | if flags & (FLAG_OBSOLETE | FLAG_DEPRECATED): | |
7c673cae FG |
432 | continue |
433 | concise = concise_sig(cmd['sig']) | |
434 | if partial and not concise.startswith(partial): | |
435 | continue | |
31f18b77 FG |
436 | width = Termsize().cols - 1 # 1 for the line between sig and help |
437 | sig_width = int(width / 2) | |
438 | # make sure width == sig_width + help_width, even (width % 2 > 0) | |
439 | help_width = int(width / 2) + (width % 2) | |
440 | siglines = [l for l in wrap(concise, sig_width, 1)] | |
441 | helplines = [l for l in wrap(cmd['help'], help_width, 1)] | |
7c673cae FG |
442 | |
443 | # make lists the same length | |
444 | maxlen = max(len(siglines), len(helplines)) | |
445 | siglines.extend([''] * (maxlen - len(siglines))) | |
446 | helplines.extend([''] * (maxlen - len(helplines))) | |
447 | ||
448 | # so we can zip them for output | |
31f18b77 FG |
449 | for s, h in zip(siglines, helplines): |
450 | fullusage += '{s:{w}s} {h}\n'.format(s=s, h=h, w=sig_width) | |
7c673cae FG |
451 | |
452 | return fullusage | |
453 | ||
454 | ||
455 | def ceph_conf(parsed_args, field, name): | |
31f18b77 | 456 | args = ['ceph-conf'] |
7c673cae FG |
457 | |
458 | if name: | |
459 | args.extend(['--name', name]) | |
460 | ||
461 | # add any args in GLOBAL_ARGS | |
462 | for key, val in GLOBAL_ARGS.items(): | |
463 | # ignore name in favor of argument name, if any | |
464 | if name and key == 'client_name': | |
465 | continue | |
466 | if getattr(parsed_args, key): | |
467 | args.extend([val, getattr(parsed_args, key)]) | |
468 | ||
469 | args.extend(['--show-config-value', field]) | |
470 | p = subprocess.Popen( | |
471 | args, | |
472 | stdout=subprocess.PIPE, | |
473 | stderr=subprocess.PIPE) | |
474 | outdata, errdata = p.communicate() | |
31f18b77 | 475 | if len(errdata): |
7c673cae FG |
476 | raise RuntimeError('unable to get conf option %s for %s: %s' % (field, name, errdata)) |
477 | return outdata.rstrip() | |
478 | ||
479 | PROMPT = 'ceph> ' | |
480 | ||
481 | if sys.stdin.isatty(): | |
482 | def read_input(): | |
483 | while True: | |
484 | line = input(PROMPT).rstrip() | |
485 | if line in ['q', 'quit', 'Q', 'exit']: | |
486 | return None | |
487 | if line: | |
488 | return line | |
489 | else: | |
490 | def read_input(): | |
491 | while True: | |
492 | line = sys.stdin.readline() | |
493 | if not line: | |
494 | return None | |
495 | line = line.rstrip() | |
496 | if line: | |
497 | return line | |
498 | ||
499 | ||
500 | def new_style_command(parsed_args, cmdargs, target, sigdict, inbuf, verbose): | |
501 | """ | |
502 | Do new-style command dance. | |
503 | target: daemon to receive command: mon (any) or osd.N | |
504 | sigdict - the parsed output from the new monitor describing commands | |
505 | inbuf - any -i input file data | |
506 | verbose - bool | |
507 | """ | |
508 | if verbose: | |
509 | for cmdtag in sorted(sigdict.keys()): | |
510 | cmd = sigdict[cmdtag] | |
511 | sig = cmd['sig'] | |
512 | print('{0}: {1}'.format(cmdtag, concise_sig(sig))) | |
513 | ||
514 | if True: | |
515 | if cmdargs: | |
516 | # Validate input args against list of sigs | |
517 | valid_dict = validate_command(sigdict, cmdargs, verbose) | |
518 | if valid_dict: | |
519 | if parsed_args.output_format: | |
520 | valid_dict['format'] = parsed_args.output_format | |
521 | else: | |
522 | return -errno.EINVAL, '', 'invalid command' | |
523 | else: | |
524 | if sys.stdin.isatty(): | |
525 | # do the command-interpreter looping | |
526 | # for input to do readline cmd editing | |
527 | import readline # noqa | |
528 | ||
529 | while True: | |
530 | interactive_input = read_input() | |
531 | if interactive_input is None: | |
532 | return 0, '', '' | |
533 | cmdargs = parse_cmdargs(shlex.split(interactive_input))[2] | |
534 | try: | |
535 | target = find_cmd_target(cmdargs) | |
536 | except Exception as e: | |
31f18b77 FG |
537 | print('error handling command target: {0}'.format(e), |
538 | file=sys.stderr) | |
7c673cae FG |
539 | continue |
540 | if len(cmdargs) and cmdargs[0] == 'tell': | |
31f18b77 FG |
541 | print('Can not use \'tell\' in interactive mode.', |
542 | file=sys.stderr) | |
7c673cae FG |
543 | continue |
544 | valid_dict = validate_command(sigdict, cmdargs, verbose) | |
545 | if valid_dict: | |
546 | if parsed_args.output_format: | |
547 | valid_dict['format'] = parsed_args.output_format | |
548 | if verbose: | |
549 | print("Submitting command: ", valid_dict, file=sys.stderr) | |
550 | ret, outbuf, outs = json_command(cluster_handle, | |
551 | target=target, | |
552 | argdict=valid_dict) | |
553 | if ret: | |
554 | ret = abs(ret) | |
31f18b77 FG |
555 | print('Error: {0} {1}'.format(ret, errno.errorcode.get(ret, 'Unknown')), |
556 | file=sys.stderr) | |
7c673cae FG |
557 | if outbuf: |
558 | print(outbuf) | |
559 | if outs: | |
560 | print('Status:\n', outs, file=sys.stderr) | |
561 | else: | |
562 | print("Invalid command", file=sys.stderr) | |
563 | ||
564 | if verbose: | |
565 | print("Submitting command: ", valid_dict, file=sys.stderr) | |
566 | return json_command(cluster_handle, target=target, argdict=valid_dict, | |
567 | inbuf=inbuf) | |
568 | ||
569 | ||
570 | def complete(sigdict, args, target): | |
571 | """ | |
572 | Command completion. Match as much of [args] as possible, | |
573 | and print every possible match separated by newlines. | |
574 | Return exitcode. | |
575 | """ | |
576 | # XXX this looks a lot like the front of validate_command(). Refactor? | |
577 | ||
578 | complete_verbose = 'COMPVERBOSE' in os.environ | |
579 | ||
580 | # Repulsive hack to handle tell: lop off 'tell' and target | |
581 | # and validate the rest of the command. 'target' is already | |
582 | # determined in our callers, so it's ok to remove it here. | |
583 | if len(args) and args[0] == 'tell': | |
584 | args = args[2:] | |
585 | # look for best match, accumulate possibles in bestcmds | |
586 | # (so we can maybe give a more-useful error message) | |
587 | ||
588 | match_count = 0 | |
589 | comps = [] | |
590 | for cmdtag, cmd in sigdict.items(): | |
591 | sig = cmd['sig'] | |
592 | j = 0 | |
593 | # iterate over all arguments, except last one | |
594 | for arg in args[0:-1]: | |
595 | if j > len(sig)-1: | |
596 | # an out of argument definitions | |
597 | break | |
598 | found_match = arg in sig[j].complete(arg) | |
599 | if not found_match and sig[j].req: | |
600 | # no elements that match | |
601 | break | |
602 | if not sig[j].N: | |
603 | j += 1 | |
604 | else: | |
605 | # successfully matched all - except last one - arguments | |
606 | if j < len(sig) and len(args) > 0: | |
607 | comps += sig[j].complete(args[-1]) | |
608 | ||
609 | match_count += 1 | |
610 | match_cmd = cmd | |
611 | ||
612 | if match_count == 1 and len(comps) == 0: | |
613 | # only one command matched and no hints yet => add help | |
614 | comps = comps + [' ', '#'+match_cmd['help']] | |
615 | print('\n'.join(sorted(set(comps)))) | |
616 | return 0 | |
617 | ||
618 | ||
7c673cae FG |
619 | def ping_monitor(cluster_handle, name, timeout): |
620 | if 'mon.' not in name: | |
621 | print('"ping" expects a monitor to ping; try "ping mon.<id>"', file=sys.stderr) | |
622 | return 1 | |
623 | ||
624 | mon_id = name[len('mon.'):] | |
31f18b77 | 625 | if mon_id == '*': |
7c673cae | 626 | run_in_thread(cluster_handle.connect, timeout=timeout) |
31f18b77 | 627 | for m in monids(): |
7c673cae FG |
628 | s = run_in_thread(cluster_handle.ping_monitor, m) |
629 | if s is None: | |
630 | print("mon.{0}".format(m) + '\n' + "Error connecting to monitor.") | |
631 | else: | |
632 | print("mon.{0}".format(m) + '\n' + s) | |
31f18b77 | 633 | else: |
7c673cae FG |
634 | s = run_in_thread(cluster_handle.ping_monitor, mon_id) |
635 | print(s) | |
636 | return 0 | |
637 | ||
638 | ||
639 | def maybe_daemon_command(parsed_args, childargs): | |
640 | """ | |
641 | Check if --admin-socket, daemon, or daemonperf command | |
642 | if it is, returns (boolean handled, return code if handled == True) | |
643 | """ | |
644 | ||
645 | daemon_perf = False | |
646 | sockpath = None | |
647 | if parsed_args.admin_socket: | |
648 | sockpath = parsed_args.admin_socket | |
649 | elif len(childargs) > 0 and childargs[0] in ["daemon", "daemonperf"]: | |
650 | daemon_perf = (childargs[0] == "daemonperf") | |
651 | # Treat "daemon <path>" or "daemon <name>" like --admin_daemon <path> | |
652 | # Handle "daemonperf <path>" the same but requires no trailing args | |
653 | require_args = 2 if daemon_perf else 3 | |
654 | if len(childargs) >= require_args: | |
655 | if childargs[1].find('/') >= 0: | |
656 | sockpath = childargs[1] | |
657 | else: | |
658 | # try resolve daemon name | |
659 | try: | |
660 | sockpath = ceph_conf(parsed_args, 'admin_socket', | |
661 | childargs[1]) | |
662 | except Exception as e: | |
663 | print('Can\'t get admin socket path: ' + str(e), file=sys.stderr) | |
664 | return True, errno.EINVAL | |
665 | # for both: | |
666 | childargs = childargs[2:] | |
667 | else: | |
31f18b77 FG |
668 | print('{0} requires at least {1} arguments'.format(childargs[0], require_args), |
669 | file=sys.stderr) | |
7c673cae FG |
670 | return True, errno.EINVAL |
671 | ||
672 | if sockpath and daemon_perf: | |
673 | return True, daemonperf(childargs, sockpath) | |
674 | elif sockpath: | |
675 | try: | |
676 | raw_write(admin_socket(sockpath, childargs, parsed_args.output_format)) | |
677 | except Exception as e: | |
678 | print('admin_socket: {0}'.format(e), file=sys.stderr) | |
679 | return True, errno.EINVAL | |
680 | return True, 0 | |
681 | ||
682 | return False, 0 | |
683 | ||
684 | ||
685 | def isnum(s): | |
686 | try: | |
687 | float(s) | |
688 | return True | |
689 | except ValueError: | |
690 | return False | |
691 | ||
31f18b77 | 692 | |
7c673cae FG |
693 | def daemonperf(childargs, sockpath): |
694 | """ | |
695 | Handle daemonperf command; returns errno or 0 | |
696 | ||
697 | daemonperf <daemon> [priority string] [statpats] [interval] [count] | |
698 | daemonperf <daemon> list|ls [statpats] | |
699 | """ | |
700 | ||
701 | interval = 1 | |
702 | count = None | |
703 | statpats = None | |
704 | priority = None | |
705 | do_list = False | |
706 | ||
707 | def prio_from_name(arg): | |
708 | ||
709 | PRIOMAP = { | |
710 | 'critical': PRIO_CRITICAL, | |
711 | 'interesting': PRIO_INTERESTING, | |
712 | 'useful': PRIO_USEFUL, | |
713 | 'uninteresting': PRIO_UNINTERESTING, | |
714 | 'debugonly': PRIO_DEBUGONLY, | |
715 | } | |
716 | ||
717 | if arg in PRIOMAP: | |
718 | return PRIOMAP[arg] | |
719 | # allow abbreviation | |
720 | for name, val in PRIOMAP.items(): | |
721 | if name.startswith(arg): | |
722 | return val | |
723 | return None | |
724 | ||
725 | # consume and analyze non-numeric args | |
726 | while len(childargs) and not isnum(childargs[0]): | |
727 | arg = childargs.pop(0) | |
728 | # 'list'? | |
729 | if arg in ['list', 'ls']: | |
31f18b77 | 730 | do_list = True |
7c673cae FG |
731 | continue |
732 | # prio? | |
733 | prio = prio_from_name(arg) | |
734 | if prio is not None: | |
735 | priority = prio | |
736 | continue | |
737 | # statpats | |
738 | statpats = arg.split(',') | |
739 | ||
740 | if priority is None: | |
741 | priority = PRIO_DEFAULT | |
742 | ||
743 | if len(childargs) > 0: | |
744 | try: | |
745 | interval = float(childargs.pop(0)) | |
746 | if interval < 0: | |
747 | raise ValueError | |
748 | except ValueError: | |
749 | print('daemonperf: interval should be a positive number', file=sys.stderr) | |
750 | return errno.EINVAL | |
751 | ||
752 | if len(childargs) > 0: | |
753 | arg = childargs.pop(0) | |
754 | if (not isnum(arg)) or (int(arg) < 0): | |
755 | print('daemonperf: count should be a positive integer', file=sys.stderr) | |
756 | return errno.EINVAL | |
757 | count = int(arg) | |
758 | ||
759 | watcher = DaemonWatcher(sockpath, statpats, priority) | |
760 | if do_list: | |
761 | watcher.list() | |
762 | else: | |
763 | watcher.run(interval, count) | |
764 | ||
765 | return 0 | |
766 | ||
7c673cae FG |
767 | |
768 | def main(): | |
769 | ceph_args = os.environ.get('CEPH_ARGS') | |
770 | if ceph_args: | |
771 | if "injectargs" in sys.argv: | |
772 | i = sys.argv.index("injectargs") | |
773 | sys.argv = sys.argv[:i] + ceph_args.split() + sys.argv[i:] | |
774 | else: | |
775 | sys.argv.extend(ceph_args.split()) | |
776 | parser, parsed_args, childargs = parse_cmdargs() | |
777 | ||
778 | if parsed_args.version: | |
31f18b77 FG |
779 | print('ceph version {0} ({1}) {2} ({3})'.format( |
780 | CEPH_GIT_NICE_VER, | |
781 | CEPH_GIT_VER, | |
782 | CEPH_RELEASE_NAME, | |
783 | CEPH_RELEASE_TYPE)) # noqa | |
7c673cae FG |
784 | return 0 |
785 | ||
786 | global verbose | |
787 | verbose = parsed_args.verbose | |
788 | ||
789 | if verbose: | |
790 | print("parsed_args: {0}, childargs: {1}".format(parsed_args, childargs), file=sys.stderr) | |
791 | ||
792 | if parsed_args.admin_socket_nope: | |
31f18b77 FG |
793 | print('--admin-socket is used by daemons; ' |
794 | 'you probably mean --admin-daemon/daemon', file=sys.stderr) | |
7c673cae FG |
795 | return 1 |
796 | ||
797 | # pass on --id, --name, --conf | |
798 | name = 'client.admin' | |
799 | if parsed_args.client_id: | |
800 | name = 'client.' + parsed_args.client_id | |
801 | if parsed_args.client_name: | |
802 | name = parsed_args.client_name | |
803 | ||
804 | # default '' means default conf search | |
805 | conffile = '' | |
806 | if parsed_args.cephconf: | |
807 | conffile = parsed_args.cephconf | |
808 | # For now, --admin-daemon is handled as usual. Try it | |
809 | # first in case we can't connect() to the cluster | |
810 | ||
811 | format = parsed_args.output_format | |
812 | ||
813 | done, ret = maybe_daemon_command(parsed_args, childargs) | |
814 | if done: | |
815 | return ret | |
816 | ||
817 | timeout = None | |
818 | if parsed_args.cluster_timeout: | |
819 | timeout = parsed_args.cluster_timeout | |
820 | ||
821 | # basic help | |
822 | if parsed_args.help: | |
823 | do_basic_help(parser, childargs) | |
824 | ||
825 | # handle any 'generic' ceph arguments that we didn't parse here | |
826 | global cluster_handle | |
827 | ||
828 | # rados.Rados() will call rados_create2, and then read the conf file, | |
829 | # and then set the keys from the dict. So we must do these | |
830 | # "pre-file defaults" first (see common_preinit in librados) | |
831 | conf_defaults = { | |
31f18b77 FG |
832 | 'log_to_stderr': 'true', |
833 | 'err_to_stderr': 'true', | |
834 | 'log_flush_on_exit': 'true', | |
7c673cae FG |
835 | } |
836 | ||
837 | if 'injectargs' in childargs: | |
838 | position = childargs.index('injectargs') | |
839 | injectargs = childargs[position:] | |
840 | childargs = childargs[:position] | |
841 | if verbose: | |
31f18b77 FG |
842 | print('Separate childargs {0} from injectargs {1}'.format(childargs, injectargs), |
843 | file=sys.stderr) | |
7c673cae FG |
844 | else: |
845 | injectargs = None | |
846 | ||
847 | clustername = None | |
848 | if parsed_args.cluster: | |
849 | clustername = parsed_args.cluster | |
850 | ||
851 | try: | |
852 | cluster_handle = run_in_thread(rados.Rados, | |
853 | name=name, clustername=clustername, | |
854 | conf_defaults=conf_defaults, | |
855 | conffile=conffile) | |
856 | retargs = run_in_thread(cluster_handle.conf_parse_argv, childargs) | |
857 | except rados.Error as e: | |
858 | print('Error initializing cluster client: {0!r}'.format(e), file=sys.stderr) | |
859 | return 1 | |
860 | ||
861 | childargs = retargs | |
862 | if not childargs: | |
863 | childargs = [] | |
864 | ||
865 | # -- means "stop parsing args", but we don't want to see it either | |
866 | if '--' in childargs: | |
867 | childargs.remove('--') | |
868 | if injectargs and '--' in injectargs: | |
869 | injectargs.remove('--') | |
870 | ||
871 | # special deprecation warning for 'ceph <type> tell' | |
872 | # someday 'mds' will be here too | |
31f18b77 FG |
873 | if (len(childargs) >= 2 and |
874 | childargs[0] in ['mon', 'osd'] and | |
875 | childargs[1] == 'tell'): | |
876 | print('"{0} tell" is deprecated; try "tell {0}.<id> <command> [options...]" instead (id can be "*") '.format(childargs[0]), | |
877 | file=sys.stderr) | |
7c673cae FG |
878 | return 1 |
879 | ||
880 | if parsed_args.help: | |
881 | # short default timeout for -h | |
882 | if not timeout: | |
883 | timeout = 5 | |
884 | ||
885 | hdr('Monitor commands:') | |
886 | print('[Contacting monitor, timeout after %d seconds]' % timeout) | |
887 | ||
888 | if childargs and childargs[0] == 'ping': | |
889 | if len(childargs) < 2: | |
890 | print('"ping" requires a monitor name as argument: "ping mon.<id>"', file=sys.stderr) | |
891 | return 1 | |
892 | if parsed_args.completion: | |
31f18b77 | 893 | # for completion let timeout be really small |
7c673cae FG |
894 | timeout = 3 |
895 | try: | |
896 | if childargs and childargs[0] == 'ping': | |
897 | return ping_monitor(cluster_handle, childargs[1], timeout) | |
898 | run_in_thread(cluster_handle.connect, timeout=timeout) | |
899 | except KeyboardInterrupt: | |
900 | print('Cluster connection aborted', file=sys.stderr) | |
901 | return 1 | |
902 | except rados.PermissionDeniedError as e: | |
903 | print(str(e), file=sys.stderr) | |
904 | return errno.EACCES | |
905 | except Exception as e: | |
906 | print(str(e), file=sys.stderr) | |
907 | return 1 | |
7c673cae | 908 | if parsed_args.help: |
31f18b77 | 909 | return do_extended_help(parser, childargs, ('mon', ''), ' '.join(childargs)) |
7c673cae | 910 | |
31f18b77 FG |
911 | # implement "tell service.id help" |
912 | if len(childargs) >= 3 and childargs[0] == 'tell' and childargs[2] == 'help': | |
913 | target = childargs[1].split('.') | |
914 | if validate_target(target): | |
915 | return do_extended_help(parser, childargs, target, None) | |
916 | else: | |
917 | print('target {0} doesn\'t exists, please pass correct target to tell command, such as mon.a/' | |
918 | 'osd.1/mds.a/mgr'.format(childargs[1]), file=sys.stderr) | |
919 | return 1 | |
7c673cae FG |
920 | # implement -w/--watch_* |
921 | # This is ugly, but Namespace() isn't quite rich enough. | |
922 | level = '' | |
923 | for k, v in parsed_args._get_kwargs(): | |
924 | if k.startswith('watch') and v: | |
925 | if k == 'watch': | |
926 | level = 'info' | |
927 | else: | |
928 | level = k.replace('watch_', '') | |
929 | if level: | |
930 | ||
931 | # an awfully simple callback | |
932 | def watch_cb(arg, line, who, stamp_sec, stamp_nsec, seq, level, msg): | |
933 | print(line) | |
934 | sys.stdout.flush() | |
935 | ||
936 | # first do a ceph status | |
937 | ret, outbuf, outs = json_command(cluster_handle, prefix='status') | |
7c673cae FG |
938 | if ret: |
939 | print("status query failed: ", outs, file=sys.stderr) | |
940 | return ret | |
941 | print(outbuf) | |
942 | ||
943 | # this instance keeps the watch connection alive, but is | |
944 | # otherwise unused | |
945 | run_in_thread(cluster_handle.monitor_log, level, watch_cb, 0) | |
946 | ||
947 | # loop forever letting watch_cb print lines | |
948 | try: | |
949 | signal.pause() | |
950 | except KeyboardInterrupt: | |
951 | # or until ^C, at least | |
952 | return 0 | |
953 | ||
954 | # read input file, if any | |
955 | inbuf = b'' | |
956 | if parsed_args.input_file: | |
957 | try: | |
958 | with open(parsed_args.input_file, 'rb') as f: | |
959 | inbuf = f.read() | |
960 | except Exception as e: | |
961 | print('Can\'t open input file {0}: {1}'.format(parsed_args.input_file, e), file=sys.stderr) | |
962 | return 1 | |
963 | ||
964 | # prepare output file, if any | |
965 | if parsed_args.output_file: | |
966 | try: | |
967 | outf = open(parsed_args.output_file, 'wb') | |
968 | except Exception as e: | |
969 | print('Can\'t open output file {0}: {1}'.format(parsed_args.output_file, e), file=sys.stderr) | |
970 | return 1 | |
971 | ||
972 | # -s behaves like a command (ceph status). | |
973 | if parsed_args.status: | |
974 | childargs.insert(0, 'status') | |
975 | ||
976 | try: | |
977 | target = find_cmd_target(childargs) | |
978 | except Exception as e: | |
979 | print('error handling command target: {0}'.format(e), file=sys.stderr) | |
980 | return 1 | |
981 | ||
982 | # Repulsive hack to handle tell: lop off 'tell' and target | |
983 | # and validate the rest of the command. 'target' is already | |
984 | # determined in our callers, so it's ok to remove it here. | |
985 | is_tell = False | |
986 | if len(childargs) and childargs[0] == 'tell': | |
987 | childargs = childargs[2:] | |
988 | is_tell = True | |
989 | ||
990 | if is_tell: | |
991 | if injectargs: | |
992 | childargs = injectargs | |
993 | if not len(childargs): | |
994 | print('"{0} tell" requires additional arguments.'.format(sys.argv[0]), | |
31f18b77 FG |
995 | 'Try "{0} tell <name> <command> [options...]" instead.'.format(sys.argv[0]), |
996 | file=sys.stderr) | |
7c673cae FG |
997 | return errno.EINVAL |
998 | ||
999 | # fetch JSON sigs from command | |
1000 | # each line contains one command signature (a placeholder name | |
1001 | # of the form 'cmdNNN' followed by an array of argument descriptors) | |
1002 | # as part of the validated argument JSON object | |
1003 | ||
1004 | targets = [target] | |
1005 | ||
1006 | if target[1] == '*': | |
1007 | if target[0] == 'osd': | |
1008 | targets = [(target[0], o) for o in osdids()] | |
1009 | elif target[0] == 'mon': | |
1010 | targets = [(target[0], m) for m in monids()] | |
1011 | ||
1012 | final_ret = 0 | |
1013 | for target in targets: | |
1014 | # prettify? prefix output with target, if there was a wildcard used | |
1015 | prefix = '' | |
1016 | suffix = '' | |
1017 | if not parsed_args.output_file and len(targets) > 1: | |
1018 | prefix = '{0}.{1}: '.format(*target) | |
1019 | suffix = '\n' | |
1020 | ||
1021 | ret, outbuf, outs = json_command(cluster_handle, target=target, | |
1022 | prefix='get_command_descriptions') | |
31f18b77 FG |
1023 | if ret: |
1024 | where = '{0}.{1}'.format(*target) | |
1025 | if ret > 0: | |
1026 | raise RuntimeError('Unexpeceted return code from {0}: {1}'. | |
1027 | format(where, ret)) | |
1028 | outs = 'problem getting command descriptions from {0}'.format(where) | |
1029 | else: | |
1030 | sigdict = parse_json_funcsigs(outbuf.decode('utf-8'), 'cli') | |
7c673cae | 1031 | |
31f18b77 FG |
1032 | if parsed_args.completion: |
1033 | return complete(sigdict, childargs, target) | |
7c673cae | 1034 | |
31f18b77 FG |
1035 | ret, outbuf, outs = new_style_command(parsed_args, childargs, |
1036 | target, sigdict, inbuf, | |
1037 | verbose) | |
7c673cae | 1038 | |
31f18b77 FG |
1039 | # debug tool: send any successful command *again* to |
1040 | # verify that it is idempotent. | |
1041 | if not ret and 'CEPH_CLI_TEST_DUP_COMMAND' in os.environ: | |
1042 | ret, outbuf, outs = new_style_command(parsed_args, childargs, | |
1043 | target, sigdict, inbuf, | |
1044 | verbose) | |
1045 | if ret < 0: | |
1046 | ret = -ret | |
1047 | print(prefix + | |
1048 | 'Second attempt of previously successful command ' | |
1049 | 'failed with {0}: {1}'.format( | |
1050 | errno.errorcode.get(ret, 'Unknown'), outs), | |
1051 | file=sys.stderr) | |
7c673cae FG |
1052 | |
1053 | if ret < 0: | |
1054 | ret = -ret | |
31f18b77 FG |
1055 | errstr = errno.errorcode.get(ret, 'Unknown') |
1056 | print(u'Error {0}: {1}'.format(errstr, outs), file=sys.stderr) | |
7c673cae FG |
1057 | if len(targets) > 1: |
1058 | final_ret = ret | |
1059 | else: | |
1060 | return ret | |
1061 | ||
31f18b77 FG |
1062 | if outs: |
1063 | print(prefix + outs, file=sys.stderr) | |
7c673cae FG |
1064 | |
1065 | sys.stdout.flush() | |
1066 | ||
31f18b77 | 1067 | if parsed_args.output_file: |
7c673cae FG |
1068 | outf.write(outbuf) |
1069 | else: | |
1070 | # hack: old code printed status line before many json outputs | |
1071 | # (osd dump, etc.) that consumers know to ignore. Add blank line | |
1072 | # to satisfy consumers that skip the first line, but not annoy | |
1073 | # consumers that don't. | |
1074 | if parsed_args.output_format and \ | |
31f18b77 | 1075 | parsed_args.output_format.startswith('json'): |
7c673cae FG |
1076 | print() |
1077 | ||
1078 | # if we are prettifying things, normalize newlines. sigh. | |
1079 | if suffix: | |
1080 | outbuf = outbuf.rstrip() | |
1081 | if outbuf: | |
1082 | try: | |
1083 | print(prefix, end='') | |
1084 | # Write directly to binary stdout | |
1085 | raw_write(outbuf) | |
1086 | print(suffix, end='') | |
1087 | except IOError as e: | |
1088 | if e.errno != errno.EPIPE: | |
1089 | raise e | |
1090 | ||
1091 | sys.stdout.flush() | |
1092 | ||
31f18b77 | 1093 | if parsed_args.output_file: |
7c673cae FG |
1094 | outf.close() |
1095 | ||
1096 | if final_ret: | |
1097 | return final_ret | |
1098 | ||
1099 | return 0 | |
1100 | ||
1101 | if __name__ == '__main__': | |
1102 | retval = main() | |
1103 | # shutdown explicitly; Rados() does not | |
1104 | if cluster_handle: | |
1105 | run_in_thread(cluster_handle.shutdown) | |
1106 | sys.exit(retval) |