def service_loop(self):
"""start a RePCe server serving self's server
stop servicing if a timeout is configured and got no
keep-alime in that inteval
"""
if boolify(gconf.use_rsync_xattrs) and not privileged():
raise GsyncdError(
"using rsync for extended attributes is not supported")
repce = RepceServer(
self.server, sys.stdin, sys.stdout, int(gconf.sync_jobs))
t = syncdutils.Thread(target=lambda: (repce.service_loop(),
syncdutils.finalize()))
t.start()
logging.info("slave listening")
if gconf.timeout and int(gconf.timeout) > 0:
while True:
lp = self.server.last_keep_alive
time.sleep(int(gconf.timeout))
if lp == self.server.last_keep_alive:
logging.info(
"connection inactive for %d seconds, stopping" %
int(gconf.timeout))
break
else:
select((), (), ())
def service_loop(self):
"""start a RePCe server serving self's server
stop servicing if a timeout is configured and got no
keep-alime in that inteval
"""
if boolify(gconf.use_rsync_xattrs) and not privileged():
raise GsyncdError(
"using rsync for extended attributes is not supported")
repce = RepceServer(self.server, sys.stdin, sys.stdout,
int(gconf.sync_jobs))
t = syncdutils.Thread(
target=lambda: (repce.service_loop(), syncdutils.finalize()))
t.start()
logging.info("slave listening")
if gconf.timeout and int(gconf.timeout) > 0:
while True:
lp = self.server.last_keep_alive
time.sleep(int(gconf.timeout))
if lp == self.server.last_keep_alive:
logging.info(
"connection inactive for %d seconds, stopping" %
int(gconf.timeout))
break
else:
select((), (), ())
def connect(self):
"""inhibit the resource beyond
Choose mounting backend (direct or mountbroker),
set up glusterfs parameters and perform the mount
with given backend
"""
label = getattr(gconf, 'mountbroker', None)
if not label and not privileged():
label = syncdutils.getusername()
mounter = label and self.MountbrokerMounter or self.DirectMounter
params = gconf.gluster_params.split() + \
(gconf.gluster_log_level and ['log-level=' + gconf.gluster_log_level] or []) + \
['log-file=' + gconf.gluster_log_file, 'volfile-server=' + self.host,
'volfile-id=' + self.volume, 'client-pid=-1']
mounter(params).inhibit(*[l for l in [label] if l])
def connect(self):
"""inhibit the resource beyond
Choose mounting backend (direct or mountbroker),
set up glusterfs parameters and perform the mount
with given backend
"""
label = getattr(gconf, 'mountbroker', None)
if not label and not privileged():
label = syncdutils.getusername()
mounter = label and self.MountbrokerMounter or self.DirectMounter
params = gconf.gluster_params.split() + \
(gconf.gluster_log_level and ['log-level=' + gconf.gluster_log_level] or []) + \
['log-file=' + gconf.gluster_log_file, 'volfile-server=' + self.host,
'volfile-id=' + self.volume, 'client-pid=-1']
mounter(params).inhibit(*[l for l in [label] if l])
def main_i():
"""internal main routine
parse command line, decide what action will be taken;
we can either:
- query/manipulate configuration
- format gsyncd urls using gsyncd's url parsing engine
- start service in following modes, in given stages:
- agent: startup(), ChangelogAgent()
- monitor: startup(), monitor()
- master: startup(), connect_remote(), connect(), service_loop()
- slave: startup(), connect(), service_loop()
"""
rconf = {'go_daemon': 'should'}
def store_abs(opt, optstr, val, parser):
if val and val != '-':
val = os.path.abspath(val)
setattr(parser.values, opt.dest, val)
def store_local(opt, optstr, val, parser):
rconf[opt.dest] = val
def store_local_curry(val):
return lambda o, oo, vx, p: store_local(o, oo, val, p)
def store_local_obj(op, dmake):
return lambda o, oo, vx, p: store_local(
o, oo, FreeObject(op=op, **dmake(vx)), p)
op = OptionParser(
usage="%prog [options...] <master> <slave>", version="%prog 0.0.1")
op.add_option('--gluster-command-dir', metavar='DIR', default='')
op.add_option('--gluster-log-file', metavar='LOGF',
default=os.devnull, type=str, action='callback',
callback=store_abs)
op.add_option('--gluster-log-level', metavar='LVL')
op.add_option('--gluster-params', metavar='PRMS', default='')
op.add_option(
'--glusterd-uuid', metavar='UUID', type=str, default='',
help=SUPPRESS_HELP)
op.add_option(
'--gluster-cli-options', metavar='OPTS', default='--log-file=-')
op.add_option('--mountbroker', metavar='LABEL')
op.add_option('-p', '--pid-file', metavar='PIDF', type=str,
action='callback', callback=store_abs)
op.add_option('-l', '--log-file', metavar='LOGF', type=str,
action='callback', callback=store_abs)
op.add_option('--iprefix', metavar='LOGD', type=str,
action='callback', callback=store_abs)
op.add_option('--changelog-log-file', metavar='LOGF', type=str,
action='callback', callback=store_abs)
op.add_option('--log-file-mbr', metavar='LOGF', type=str,
action='callback', callback=store_abs)
op.add_option('--state-file', metavar='STATF', type=str,
action='callback', callback=store_abs)
op.add_option('--state-detail-file', metavar='STATF',
type=str, action='callback', callback=store_abs)
op.add_option('--georep-session-working-dir', metavar='STATF',
type=str, action='callback', callback=store_abs)
op.add_option('--ignore-deletes', default=False, action='store_true')
op.add_option('--isolated-slave', default=False, action='store_true')
op.add_option('--use-rsync-xattrs', default=False, action='store_true')
op.add_option('--pause-on-start', default=False, action='store_true')
op.add_option('-L', '--log-level', metavar='LVL')
op.add_option('-r', '--remote-gsyncd', metavar='CMD',
default=os.path.abspath(sys.argv[0]))
op.add_option('--volume-id', metavar='UUID')
op.add_option('--slave-id', metavar='ID')
op.add_option('--session-owner', metavar='ID')
op.add_option('--local-id', metavar='ID', help=SUPPRESS_HELP, default='')
op.add_option(
'--local-path', metavar='PATH', help=SUPPRESS_HELP, default='')
op.add_option('-s', '--ssh-command', metavar='CMD', default='ssh')
op.add_option('--ssh-command-tar', metavar='CMD', default='ssh')
op.add_option('--rsync-command', metavar='CMD', default='rsync')
op.add_option('--rsync-options', metavar='OPTS', default='')
op.add_option('--rsync-ssh-options', metavar='OPTS', default='--compress')
op.add_option('--timeout', metavar='SEC', type=int, default=120)
op.add_option('--connection-timeout', metavar='SEC',
type=int, default=60, help=SUPPRESS_HELP)
op.add_option('--sync-jobs', metavar='N', type=int, default=3)
op.add_option('--replica-failover-interval', metavar='N',
type=int, default=1)
op.add_option('--changelog-archive-format', metavar='N',
type=str, default="%Y%m")
op.add_option(
'--turns', metavar='N', type=int, default=0, help=SUPPRESS_HELP)
op.add_option('--allow-network', metavar='IPS', default='')
op.add_option('--socketdir', metavar='DIR')
op.add_option('--state-socket-unencoded', metavar='SOCKF',
type=str, action='callback', callback=store_abs)
op.add_option('--checkpoint', metavar='LABEL', default='')
# tunables for failover/failback mechanism:
# None - gsyncd behaves as normal
# blind - gsyncd works with xtime pairs to identify
# candidates for synchronization
# wrapup - same as normal mode but does not assign
# xtimes to orphaned files
# see crawl() for usage of the above tunables
op.add_option('--special-sync-mode', type=str, help=SUPPRESS_HELP)
# changelog or xtime? (TODO: Change the default)
op.add_option(
'--change-detector', metavar='MODE', type=str, default='xtime')
# sleep interval for change detection (xtime crawl uses a hardcoded 1
# second sleep time)
op.add_option('--change-interval', metavar='SEC', type=int, default=3)
# working directory for changelog based mechanism
op.add_option('--working-dir', metavar='DIR', type=str,
action='callback', callback=store_abs)
op.add_option('--use-tarssh', default=False, action='store_true')
op.add_option('-c', '--config-file', metavar='CONF',
type=str, action='callback', callback=store_local)
# duh. need to specify dest or value will be mapped to None :S
op.add_option('--monitor', dest='monitor', action='callback',
callback=store_local_curry(True))
op.add_option('--agent', dest='agent', action='callback',
callback=store_local_curry(True))
op.add_option('--resource-local', dest='resource_local',
type=str, action='callback', callback=store_local)
op.add_option('--resource-remote', dest='resource_remote',
type=str, action='callback', callback=store_local)
op.add_option('--feedback-fd', dest='feedback_fd', type=int,
help=SUPPRESS_HELP, action='callback', callback=store_local)
op.add_option('--rpc-fd', dest='rpc_fd', type=str, help=SUPPRESS_HELP)
op.add_option('--listen', dest='listen', help=SUPPRESS_HELP,
action='callback', callback=store_local_curry(True))
op.add_option('-N', '--no-daemon', dest="go_daemon",
action='callback', callback=store_local_curry('dont'))
op.add_option('--verify', type=str, dest="verify",
action='callback', callback=store_local)
op.add_option('--create', type=str, dest="create",
action='callback', callback=store_local)
op.add_option('--delete', dest='delete', action='callback',
callback=store_local_curry(True))
op.add_option('--debug', dest="go_daemon", action='callback',
callback=lambda *a: (store_local_curry('dont')(*a),
setattr(
a[-1].values, 'log_file', '-'),
setattr(a[-1].values, 'log_level',
'DEBUG'),
setattr(a[-1].values,
'changelog_log_file', '-')))
op.add_option('--path', type=str, action='append')
for a in ('check', 'get'):
op.add_option('--config-' + a, metavar='OPT', type=str, dest='config',
action='callback',
callback=store_local_obj(a, lambda vx: {'opt': vx}))
op.add_option('--config-get-all', dest='config', action='callback',
callback=store_local_obj('get', lambda vx: {'opt': None}))
for m in ('', '-rx', '-glob'):
# call this code 'Pythonic' eh?
# have to define a one-shot local function to be able
# to inject (a value depending on the)
# iteration variable into the inner lambda
def conf_mod_opt_regex_variant(rx):
op.add_option('--config-set' + m, metavar='OPT VAL', type=str,
nargs=2, dest='config', action='callback',
callback=store_local_obj('set', lambda vx: {
'opt': vx[0], 'val': vx[1], 'rx': rx}))
op.add_option('--config-del' + m, metavar='OPT', type=str,
dest='config', action='callback',
callback=store_local_obj('del', lambda vx: {
'opt': vx, 'rx': rx}))
conf_mod_opt_regex_variant(m and m[1:] or False)
op.add_option('--normalize-url', dest='url_print',
action='callback', callback=store_local_curry('normal'))
op.add_option('--canonicalize-url', dest='url_print',
action='callback', callback=store_local_curry('canon'))
op.add_option('--canonicalize-escape-url', dest='url_print',
action='callback', callback=store_local_curry('canon_esc'))
tunables = [norm(o.get_opt_string()[2:])
for o in op.option_list
if (o.callback in (store_abs, 'store_true', None) and
o.get_opt_string() not in ('--version', '--help'))]
remote_tunables = ['listen', 'go_daemon', 'timeout',
'session_owner', 'config_file', 'use_rsync_xattrs']
rq_remote_tunables = {'listen': True}
# precedence for sources of values: 1) commandline, 2) cfg file, 3)
# defaults for this to work out we need to tell apart defaults from
# explicitly set options... so churn out the defaults here and call
# the parser with virgin values container.
defaults = op.get_default_values()
opts, args = op.parse_args(values=optparse.Values())
args_orig = args[:]
r = rconf.get('resource_local')
if r:
if len(args) == 0:
args.append(None)
args[0] = r
r = rconf.get('resource_remote')
if r:
if len(args) == 0:
raise GsyncdError('local resource unspecfied')
elif len(args) == 1:
args.append(None)
args[1] = r
confdata = rconf.get('config')
if not (len(args) == 2 or
(len(args) == 1 and rconf.get('listen')) or
(len(args) <= 2 and confdata) or
rconf.get('url_print')):
sys.stderr.write("error: incorrect number of arguments\n\n")
sys.stderr.write(op.get_usage() + "\n")
sys.exit(1)
verify = rconf.get('verify')
if verify:
logging.info(verify)
logging.info("Able to spawn gsyncd.py")
return
restricted = os.getenv('_GSYNCD_RESTRICTED_')
if restricted:
allopts = {}
allopts.update(opts.__dict__)
allopts.update(rconf)
bannedtuns = set(allopts.keys()) - set(remote_tunables)
if bannedtuns:
raise GsyncdError('following tunables cannot be set with '
'restricted SSH invocaton: ' +
', '.join(bannedtuns))
for k, v in rq_remote_tunables.items():
if not k in allopts or allopts[k] != v:
raise GsyncdError('tunable %s is not set to value %s required '
'for restricted SSH invocaton' %
(k, v))
confrx = getattr(confdata, 'rx', None)
def makersc(aa, check=True):
if not aa:
return ([], None, None)
ra = [resource.parse_url(u) for u in aa]
local = ra[0]
remote = None
if len(ra) > 1:
remote = ra[1]
if check and not local.can_connect_to(remote):
raise GsyncdError("%s cannot work with %s" %
(local.path, remote and remote.path))
return (ra, local, remote)
if confrx:
# peers are regexen, don't try to parse them
if confrx == 'glob':
args = ['\A' + fnmatch.translate(a) for a in args]
canon_peers = args
namedict = {}
else:
dc = rconf.get('url_print')
rscs, local, remote = makersc(args_orig, not dc)
if dc:
for r in rscs:
print(r.get_url(**{'normal': {},
'canon': {'canonical': True},
'canon_esc': {'canonical': True,
'escaped': True}}[dc]))
return
pa = ([], [], [])
urlprms = (
{}, {'canonical': True}, {'canonical': True, 'escaped': True})
for x in rscs:
for i in range(len(pa)):
pa[i].append(x.get_url(**urlprms[i]))
_, canon_peers, canon_esc_peers = pa
# creating the namedict, a dict representing various ways of referring
# to / repreenting peers to be fillable in config templates
mods = (lambda x: x, lambda x: x[
0].upper() + x[1:], lambda x: 'e' + x[0].upper() + x[1:])
if remote:
rmap = {local: ('local', 'master'), remote: ('remote', 'slave')}
else:
rmap = {local: ('local', 'slave')}
namedict = {}
for i in range(len(rscs)):
x = rscs[i]
for name in rmap[x]:
for j in range(3):
namedict[mods[j](name)] = pa[j][i]
namedict[name + 'vol'] = x.volume
if name == 'remote':
namedict['remotehost'] = x.remotehost
if not 'config_file' in rconf:
rconf['config_file'] = os.path.join(
os.path.dirname(sys.argv[0]), "conf/gsyncd_template.conf")
upgrade_config_file(rconf['config_file'])
gcnf = GConffile(
rconf['config_file'], canon_peers,
defaults.__dict__, opts.__dict__, namedict)
checkpoint_change = False
if confdata:
opt_ok = norm(confdata.opt) in tunables + [None]
if confdata.op == 'check':
if opt_ok:
sys.exit(0)
else:
sys.exit(1)
elif not opt_ok:
raise GsyncdError("not a valid option: " + confdata.opt)
if confdata.op == 'get':
gcnf.get(confdata.opt)
elif confdata.op == 'set':
gcnf.set(confdata.opt, confdata.val, confdata.rx)
elif confdata.op == 'del':
gcnf.delete(confdata.opt, confdata.rx)
# when modifying checkpoint, it's important to make a log
# of that, so in that case we go on to set up logging even
# if its just config invocation
if confdata.opt == 'checkpoint' and confdata.op in ('set', 'del') and \
not confdata.rx:
checkpoint_change = True
if not checkpoint_change:
return
gconf.__dict__.update(defaults.__dict__)
gcnf.update_to(gconf.__dict__)
gconf.__dict__.update(opts.__dict__)
gconf.configinterface = gcnf
delete = rconf.get('delete')
if delete:
logging.info('geo-replication delete')
# Delete pid file, status file, socket file
cleanup_paths = []
if getattr(gconf, 'pid_file', None):
cleanup_paths.append(gconf.pid_file)
if getattr(gconf, 'state_file', None):
cleanup_paths.append(gconf.state_file)
if getattr(gconf, 'state_detail_file', None):
cleanup_paths.append(gconf.state_detail_file)
if getattr(gconf, 'state_socket_unencoded', None):
cleanup_paths.append(gconf.state_socket_unencoded)
cleanup_paths.append(rconf['config_file'][:-11] + "*")
# Cleanup changelog working dirs
if getattr(gconf, 'working_dir', None):
try:
shutil.rmtree(gconf.working_dir)
except (IOError, OSError):
if sys.exc_info()[1].errno == ENOENT:
pass
else:
raise GsyncdError(
'Error while removing working dir: %s' %
gconf.working_dir)
for path in cleanup_paths:
# To delete temp files
for f in glob.glob(path + "*"):
_unlink(f)
return
if restricted and gconf.allow_network:
ssh_conn = os.getenv('SSH_CONNECTION')
if not ssh_conn:
# legacy env var
ssh_conn = os.getenv('SSH_CLIENT')
if ssh_conn:
allowed_networks = [IPNetwork(a)
for a in gconf.allow_network.split(',')]
client_ip = IPAddress(ssh_conn.split()[0])
allowed = False
for nw in allowed_networks:
if client_ip in nw:
allowed = True
break
if not allowed:
raise GsyncdError("client IP address is not allowed")
ffd = rconf.get('feedback_fd')
if ffd:
fcntl.fcntl(ffd, fcntl.F_SETFD, fcntl.FD_CLOEXEC)
# normalize loglevel
lvl0 = gconf.log_level
if isinstance(lvl0, str):
lvl1 = lvl0.upper()
lvl2 = logging.getLevelName(lvl1)
# I have _never_ _ever_ seen such an utterly braindead
# error condition
if lvl2 == "Level " + lvl1:
raise GsyncdError('cannot recognize log level "%s"' % lvl0)
gconf.log_level = lvl2
if not privileged() and gconf.log_file_mbr:
gconf.log_file = gconf.log_file_mbr
if checkpoint_change:
try:
GLogger._gsyncd_loginit(log_file=gconf.log_file, label='conf')
if confdata.op == 'set':
logging.info('checkpoint %s set' % confdata.val)
gcnf.delete('checkpoint_completed')
gcnf.delete('checkpoint_target')
elif confdata.op == 'del':
logging.info('checkpoint info was reset')
# if it is removing 'checkpoint' then we need
# to remove 'checkpoint_completed' and 'checkpoint_target' too
gcnf.delete('checkpoint_completed')
gcnf.delete('checkpoint_target')
except IOError:
if sys.exc_info()[1].errno == ENOENT:
# directory of log path is not present,
# which happens if we get here from
# a peer-multiplexed "config-set checkpoint"
# (as that directory is created only on the
# original node)
pass
else:
raise
return
create = rconf.get('create')
if create:
if getattr(gconf, 'state_file', None):
update_file(gconf.state_file, lambda f: f.write(create + '\n'))
return
go_daemon = rconf['go_daemon']
be_monitor = rconf.get('monitor')
be_agent = rconf.get('agent')
rscs, local, remote = makersc(args)
if not be_monitor and isinstance(remote, resource.SSH) and \
go_daemon == 'should':
go_daemon = 'postconn'
log_file = None
else:
log_file = gconf.log_file
if be_monitor:
label = 'monitor'
elif be_agent:
label = 'agent'
elif remote:
# master
label = gconf.local_path
else:
label = 'slave'
startup(go_daemon=go_daemon, log_file=log_file, label=label)
resource.Popen.init_errhandler()
if be_agent:
os.setsid()
logging.debug('rpc_fd: %s' % repr(gconf.rpc_fd))
return agent(Changelog(), gconf.rpc_fd)
if be_monitor:
return monitor(*rscs)
logging.info("syncing: %s" % " -> ".join(r.url for r in rscs))
if remote:
go_daemon = remote.connect_remote(go_daemon=go_daemon)
if go_daemon:
startup(go_daemon=go_daemon, log_file=gconf.log_file)
# complete remote connection in child
remote.connect_remote(go_daemon='done')
local.connect()
if ffd:
os.close(ffd)
local.service_loop(*[r for r in [remote] if r])
def main_i():
"""internal main routine
parse command line, decide what action will be taken;
we can either:
- query/manipulate configuration
- format gsyncd urls using gsyncd's url parsing engine
- start service in following modes, in given stages:
- agent: startup(), ChangelogAgent()
- monitor: startup(), monitor()
- master: startup(), connect_remote(), connect(), service_loop()
- slave: startup(), connect(), service_loop()
"""
rconf = {'go_daemon': 'should'}
def store_abs(opt, optstr, val, parser):
if val and val != '-':
val = os.path.abspath(val)
setattr(parser.values, opt.dest, val)
def store_local(opt, optstr, val, parser):
rconf[opt.dest] = val
def store_local_curry(val):
return lambda o, oo, vx, p: store_local(o, oo, val, p)
def store_local_obj(op, dmake):
return lambda o, oo, vx, p: store_local(
o, oo, FreeObject(op=op, **dmake(vx)), p)
op = OptionParser(
usage="%prog [options...] <master> <slave>", version="%prog 0.0.1")
op.add_option('--gluster-command-dir', metavar='DIR', default='')
op.add_option('--gluster-log-file', metavar='LOGF',
default=os.devnull, type=str, action='callback',
callback=store_abs)
op.add_option('--gluster-log-level', metavar='LVL')
op.add_option('--gluster-params', metavar='PRMS', default='')
op.add_option(
'--glusterd-uuid', metavar='UUID', type=str, default='',
help=SUPPRESS_HELP)
op.add_option(
'--gluster-cli-options', metavar='OPTS', default='--log-file=-')
op.add_option('--mountbroker', metavar='LABEL')
op.add_option('-p', '--pid-file', metavar='PIDF', type=str,
action='callback', callback=store_abs)
op.add_option('-l', '--log-file', metavar='LOGF', type=str,
action='callback', callback=store_abs)
op.add_option('--iprefix', metavar='LOGD', type=str,
action='callback', callback=store_abs)
op.add_option('--changelog-log-file', metavar='LOGF', type=str,
action='callback', callback=store_abs)
op.add_option('--log-file-mbr', metavar='LOGF', type=str,
action='callback', callback=store_abs)
op.add_option('--state-file', metavar='STATF', type=str,
action='callback', callback=store_abs)
op.add_option('--state-detail-file', metavar='STATF',
type=str, action='callback', callback=store_abs)
op.add_option('--georep-session-working-dir', metavar='STATF',
type=str, action='callback', callback=store_abs)
op.add_option('--ignore-deletes', default=False, action='store_true')
op.add_option('--isolated-slave', default=False, action='store_true')
op.add_option('--use-rsync-xattrs', default=False, action='store_true')
op.add_option('--pause-on-start', default=False, action='store_true')
op.add_option('-L', '--log-level', metavar='LVL')
op.add_option('-r', '--remote-gsyncd', metavar='CMD',
default=os.path.abspath(sys.argv[0]))
op.add_option('--volume-id', metavar='UUID')
op.add_option('--slave-id', metavar='ID')
op.add_option('--session-owner', metavar='ID')
op.add_option('--local-id', metavar='ID', help=SUPPRESS_HELP, default='')
op.add_option(
'--local-path', metavar='PATH', help=SUPPRESS_HELP, default='')
op.add_option('-s', '--ssh-command', metavar='CMD', default='ssh')
op.add_option('--ssh-command-tar', metavar='CMD', default='ssh')
op.add_option('--rsync-command', metavar='CMD', default='rsync')
op.add_option('--rsync-options', metavar='OPTS', default='')
op.add_option('--rsync-ssh-options', metavar='OPTS', default='--compress')
op.add_option('--timeout', metavar='SEC', type=int, default=120)
op.add_option('--connection-timeout', metavar='SEC',
type=int, default=60, help=SUPPRESS_HELP)
op.add_option('--sync-jobs', metavar='N', type=int, default=3)
op.add_option('--replica-failover-interval', metavar='N',
type=int, default=1)
op.add_option(
'--turns', metavar='N', type=int, default=0, help=SUPPRESS_HELP)
op.add_option('--allow-network', metavar='IPS', default='')
op.add_option('--socketdir', metavar='DIR')
op.add_option('--state-socket-unencoded', metavar='SOCKF',
type=str, action='callback', callback=store_abs)
op.add_option('--checkpoint', metavar='LABEL', default='')
# tunables for failover/failback mechanism:
# None - gsyncd behaves as normal
# blind - gsyncd works with xtime pairs to identify
# candidates for synchronization
# wrapup - same as normal mode but does not assign
# xtimes to orphaned files
# see crawl() for usage of the above tunables
op.add_option('--special-sync-mode', type=str, help=SUPPRESS_HELP)
# changelog or xtime? (TODO: Change the default)
op.add_option(
'--change-detector', metavar='MODE', type=str, default='xtime')
# sleep interval for change detection (xtime crawl uses a hardcoded 1
# second sleep time)
op.add_option('--change-interval', metavar='SEC', type=int, default=3)
# working directory for changelog based mechanism
op.add_option('--working-dir', metavar='DIR', type=str,
action='callback', callback=store_abs)
op.add_option('--use-tarssh', default=False, action='store_true')
op.add_option('-c', '--config-file', metavar='CONF',
type=str, action='callback', callback=store_local)
# duh. need to specify dest or value will be mapped to None :S
op.add_option('--monitor', dest='monitor', action='callback',
callback=store_local_curry(True))
op.add_option('--agent', dest='agent', action='callback',
callback=store_local_curry(True))
op.add_option('--resource-local', dest='resource_local',
type=str, action='callback', callback=store_local)
op.add_option('--resource-remote', dest='resource_remote',
type=str, action='callback', callback=store_local)
op.add_option('--feedback-fd', dest='feedback_fd', type=int,
help=SUPPRESS_HELP, action='callback', callback=store_local)
op.add_option('--rpc-fd', dest='rpc_fd', type=str, help=SUPPRESS_HELP)
op.add_option('--listen', dest='listen', help=SUPPRESS_HELP,
action='callback', callback=store_local_curry(True))
op.add_option('-N', '--no-daemon', dest="go_daemon",
action='callback', callback=store_local_curry('dont'))
op.add_option('--verify', type=str, dest="verify",
action='callback', callback=store_local)
op.add_option('--create', type=str, dest="create",
action='callback', callback=store_local)
op.add_option('--delete', dest='delete', action='callback',
callback=store_local_curry(True))
op.add_option('--debug', dest="go_daemon", action='callback',
callback=lambda *a: (store_local_curry('dont')(*a),
setattr(
a[-1].values, 'log_file', '-'),
setattr(a[-1].values, 'log_level',
'DEBUG'),
setattr(a[-1].values,
'changelog_log_file', '-')))
op.add_option('--path', type=str, action='append')
for a in ('check', 'get'):
op.add_option('--config-' + a, metavar='OPT', type=str, dest='config',
action='callback',
callback=store_local_obj(a, lambda vx: {'opt': vx}))
op.add_option('--config-get-all', dest='config', action='callback',
callback=store_local_obj('get', lambda vx: {'opt': None}))
for m in ('', '-rx', '-glob'):
# call this code 'Pythonic' eh?
# have to define a one-shot local function to be able
# to inject (a value depending on the)
# iteration variable into the inner lambda
def conf_mod_opt_regex_variant(rx):
op.add_option('--config-set' + m, metavar='OPT VAL', type=str,
nargs=2, dest='config', action='callback',
callback=store_local_obj('set', lambda vx: {
'opt': vx[0], 'val': vx[1], 'rx': rx}))
op.add_option('--config-del' + m, metavar='OPT', type=str,
dest='config', action='callback',
callback=store_local_obj('del', lambda vx: {
'opt': vx, 'rx': rx}))
conf_mod_opt_regex_variant(m and m[1:] or False)
op.add_option('--normalize-url', dest='url_print',
action='callback', callback=store_local_curry('normal'))
op.add_option('--canonicalize-url', dest='url_print',
action='callback', callback=store_local_curry('canon'))
op.add_option('--canonicalize-escape-url', dest='url_print',
action='callback', callback=store_local_curry('canon_esc'))
tunables = [norm(o.get_opt_string()[2:])
for o in op.option_list
if (o.callback in (store_abs, 'store_true', None) and
o.get_opt_string() not in ('--version', '--help'))]
remote_tunables = ['listen', 'go_daemon', 'timeout',
'session_owner', 'config_file', 'use_rsync_xattrs']
rq_remote_tunables = {'listen': True}
# precedence for sources of values: 1) commandline, 2) cfg file, 3)
# defaults for this to work out we need to tell apart defaults from
# explicitly set options... so churn out the defaults here and call
# the parser with virgin values container.
defaults = op.get_default_values()
opts, args = op.parse_args(values=optparse.Values())
args_orig = args[:]
r = rconf.get('resource_local')
if r:
if len(args) == 0:
args.append(None)
args[0] = r
r = rconf.get('resource_remote')
if r:
if len(args) == 0:
raise GsyncdError('local resource unspecfied')
elif len(args) == 1:
args.append(None)
args[1] = r
confdata = rconf.get('config')
if not (len(args) == 2 or
(len(args) == 1 and rconf.get('listen')) or
(len(args) <= 2 and confdata) or
rconf.get('url_print')):
sys.stderr.write("error: incorrect number of arguments\n\n")
sys.stderr.write(op.get_usage() + "\n")
sys.exit(1)
verify = rconf.get('verify')
if verify:
logging.info(verify)
logging.info("Able to spawn gsyncd.py")
return
restricted = os.getenv('_GSYNCD_RESTRICTED_')
if restricted:
allopts = {}
allopts.update(opts.__dict__)
allopts.update(rconf)
bannedtuns = set(allopts.keys()) - set(remote_tunables)
if bannedtuns:
raise GsyncdError('following tunables cannot be set with '
'restricted SSH invocaton: ' +
', '.join(bannedtuns))
for k, v in rq_remote_tunables.items():
if not k in allopts or allopts[k] != v:
raise GsyncdError('tunable %s is not set to value %s required '
'for restricted SSH invocaton' %
(k, v))
confrx = getattr(confdata, 'rx', None)
def makersc(aa, check=True):
if not aa:
return ([], None, None)
ra = [resource.parse_url(u) for u in aa]
local = ra[0]
remote = None
if len(ra) > 1:
remote = ra[1]
if check and not local.can_connect_to(remote):
raise GsyncdError("%s cannot work with %s" %
(local.path, remote and remote.path))
return (ra, local, remote)
if confrx:
# peers are regexen, don't try to parse them
if confrx == 'glob':
args = ['\A' + fnmatch.translate(a) for a in args]
canon_peers = args
namedict = {}
else:
dc = rconf.get('url_print')
rscs, local, remote = makersc(args_orig, not dc)
if dc:
for r in rscs:
print(r.get_url(**{'normal': {},
'canon': {'canonical': True},
'canon_esc': {'canonical': True,
'escaped': True}}[dc]))
return
pa = ([], [], [])
urlprms = (
{}, {'canonical': True}, {'canonical': True, 'escaped': True})
for x in rscs:
for i in range(len(pa)):
pa[i].append(x.get_url(**urlprms[i]))
_, canon_peers, canon_esc_peers = pa
# creating the namedict, a dict representing various ways of referring
# to / repreenting peers to be fillable in config templates
mods = (lambda x: x, lambda x: x[
0].upper() + x[1:], lambda x: 'e' + x[0].upper() + x[1:])
if remote:
rmap = {local: ('local', 'master'), remote: ('remote', 'slave')}
else:
rmap = {local: ('local', 'slave')}
namedict = {}
for i in range(len(rscs)):
x = rscs[i]
for name in rmap[x]:
for j in range(3):
namedict[mods[j](name)] = pa[j][i]
namedict[name + 'vol'] = x.volume
if name == 'remote':
namedict['remotehost'] = x.remotehost
if not 'config_file' in rconf:
rconf['config_file'] = os.path.join(
os.path.dirname(sys.argv[0]), "conf/gsyncd_template.conf")
upgrade_config_file(rconf['config_file'])
gcnf = GConffile(
rconf['config_file'], canon_peers,
defaults.__dict__, opts.__dict__, namedict)
checkpoint_change = False
if confdata:
opt_ok = norm(confdata.opt) in tunables + [None]
if confdata.op == 'check':
if opt_ok:
sys.exit(0)
else:
sys.exit(1)
elif not opt_ok:
raise GsyncdError("not a valid option: " + confdata.opt)
if confdata.op == 'get':
gcnf.get(confdata.opt)
elif confdata.op == 'set':
gcnf.set(confdata.opt, confdata.val, confdata.rx)
elif confdata.op == 'del':
gcnf.delete(confdata.opt, confdata.rx)
# when modifying checkpoint, it's important to make a log
# of that, so in that case we go on to set up logging even
# if its just config invocation
if confdata.opt == 'checkpoint' and confdata.op in ('set', 'del') and \
not confdata.rx:
checkpoint_change = True
if not checkpoint_change:
return
gconf.__dict__.update(defaults.__dict__)
gcnf.update_to(gconf.__dict__)
gconf.__dict__.update(opts.__dict__)
gconf.configinterface = gcnf
delete = rconf.get('delete')
if delete:
logging.info('geo-replication delete')
# Delete pid file, status file, socket file
cleanup_paths = []
if getattr(gconf, 'pid_file', None):
cleanup_paths.append(gconf.pid_file)
if getattr(gconf, 'state_file', None):
cleanup_paths.append(gconf.state_file)
if getattr(gconf, 'state_detail_file', None):
cleanup_paths.append(gconf.state_detail_file)
if getattr(gconf, 'state_socket_unencoded', None):
cleanup_paths.append(gconf.state_socket_unencoded)
cleanup_paths.append(rconf['config_file'][:-11] + "*")
# Cleanup changelog working dirs
if getattr(gconf, 'working_dir', None):
try:
shutil.rmtree(gconf.working_dir)
except (IOError, OSError):
if sys.exc_info()[1].errno == ENOENT:
pass
else:
raise GsyncdError(
'Error while removing working dir: %s' %
gconf.working_dir)
for path in cleanup_paths:
# To delete temp files
for f in glob.glob(path + "*"):
_unlink(f)
return
if restricted and gconf.allow_network:
ssh_conn = os.getenv('SSH_CONNECTION')
if not ssh_conn:
# legacy env var
ssh_conn = os.getenv('SSH_CLIENT')
if ssh_conn:
allowed_networks = [IPNetwork(a)
for a in gconf.allow_network.split(',')]
client_ip = IPAddress(ssh_conn.split()[0])
allowed = False
for nw in allowed_networks:
if client_ip in nw:
allowed = True
break
if not allowed:
raise GsyncdError("client IP address is not allowed")
ffd = rconf.get('feedback_fd')
if ffd:
fcntl.fcntl(ffd, fcntl.F_SETFD, fcntl.FD_CLOEXEC)
# normalize loglevel
lvl0 = gconf.log_level
if isinstance(lvl0, str):
lvl1 = lvl0.upper()
lvl2 = logging.getLevelName(lvl1)
# I have _never_ _ever_ seen such an utterly braindead
# error condition
if lvl2 == "Level " + lvl1:
raise GsyncdError('cannot recognize log level "%s"' % lvl0)
gconf.log_level = lvl2
if not privileged() and gconf.log_file_mbr:
gconf.log_file = gconf.log_file_mbr
if checkpoint_change:
try:
GLogger._gsyncd_loginit(log_file=gconf.log_file, label='conf')
if confdata.op == 'set':
logging.info('checkpoint %s set' % confdata.val)
gcnf.delete('checkpoint_completed')
gcnf.delete('checkpoint_target')
elif confdata.op == 'del':
logging.info('checkpoint info was reset')
# if it is removing 'checkpoint' then we need
# to remove 'checkpoint_completed' and 'checkpoint_target' too
gcnf.delete('checkpoint_completed')
gcnf.delete('checkpoint_target')
except IOError:
if sys.exc_info()[1].errno == ENOENT:
# directory of log path is not present,
# which happens if we get here from
# a peer-multiplexed "config-set checkpoint"
# (as that directory is created only on the
# original node)
pass
else:
raise
return
create = rconf.get('create')
if create:
if getattr(gconf, 'state_file', None):
update_file(gconf.state_file, lambda f: f.write(create + '\n'))
return
go_daemon = rconf['go_daemon']
be_monitor = rconf.get('monitor')
be_agent = rconf.get('agent')
rscs, local, remote = makersc(args)
if not be_monitor and isinstance(remote, resource.SSH) and \
go_daemon == 'should':
go_daemon = 'postconn'
log_file = None
else:
log_file = gconf.log_file
if be_monitor:
label = 'monitor'
elif be_agent:
label = 'agent'
elif remote:
# master
label = gconf.local_path
else:
label = 'slave'
startup(go_daemon=go_daemon, log_file=log_file, label=label)
resource.Popen.init_errhandler()
if be_agent:
os.setsid()
logging.debug('rpc_fd: %s' % repr(gconf.rpc_fd))
return agent(Changelog(), gconf.rpc_fd)
if be_monitor:
return monitor(*rscs)
logging.info("syncing: %s" % " -> ".join(r.url for r in rscs))
if remote:
go_daemon = remote.connect_remote(go_daemon=go_daemon)
if go_daemon:
startup(go_daemon=go_daemon, log_file=gconf.log_file)
# complete remote connection in child
remote.connect_remote(go_daemon='done')
local.connect()
if ffd:
os.close(ffd)
local.service_loop(*[r for r in [remote] if r])
class Server(object):
"""singleton implemening those filesystem access primitives
which are needed for geo-replication functionality
(Singleton in the sense it's a class which has only static
and classmethods and is used directly, without instantiation.)
"""
GX_NSPACE_PFX = (privileged() and "trusted" or "system")
GX_NSPACE = GX_NSPACE_PFX + ".glusterfs"
NTV_FMTSTR = "!" + "B" * 19 + "II"
FRGN_XTRA_FMT = "I"
FRGN_FMTSTR = NTV_FMTSTR + FRGN_XTRA_FMT
GX_GFID_CANONICAL_LEN = 37 # canonical gfid len + '\0'
local_path = ''
@classmethod
def _fmt_mknod(cls, l):
return "!II%dsI%dsIII" % (cls.GX_GFID_CANONICAL_LEN, l + 1)
@classmethod
def _fmt_mkdir(cls, l):
return "!II%dsI%dsII" % (cls.GX_GFID_CANONICAL_LEN, l + 1)
@classmethod
def _fmt_symlink(cls, l1, l2):
return "!II%dsI%ds%ds" % (cls.GX_GFID_CANONICAL_LEN, l1 + 1, l2 + 1)
def _pathguard(f):
"""decorator method that checks
the path argument of the decorated
functions to make sure it does not
point out of the managed tree
"""
fc = funcode(f)
pi = list(fc.co_varnames).index('path')
def ff(*a):
path = a[pi]
ps = path.split('/')
if path[0] == '/' or '..' in ps:
raise ValueError('unsafe path')
a = list(a)
a[pi] = os.path.join(a[0].local_path, path)
return f(*a)
return ff
@classmethod
@_pathguard
def entries(cls, path):
"""directory entries in an array"""
# prevent symlinks being followed
if not stat.S_ISDIR(os.lstat(path).st_mode):
raise OSError(ENOTDIR, os.strerror(ENOTDIR))
return os.listdir(path)
@classmethod
@_pathguard
def purge(cls, path, entries=None):
"""force-delete subtrees
If @entries is not specified, delete
the whole subtree under @path (including
@path).
Otherwise, @entries should be a
a sequence of children of @path, and
the effect is identical with a joint
@entries-less purge on them, ie.
for e in entries:
cls.purge(os.path.join(path, e))
"""
me_also = entries == None
if not entries:
try:
# if it's a symlink, prevent
# following it
try:
os.unlink(path)
return
except OSError:
ex = sys.exc_info()[1]
if ex.errno == EISDIR:
entries = os.listdir(path)
else:
raise
except OSError:
ex = sys.exc_info()[1]
if ex.errno in (ENOTDIR, ENOENT, ELOOP):
try:
os.unlink(path)
return
except OSError:
ex = sys.exc_info()[1]
if ex.errno == ENOENT:
return
raise
else:
raise
for e in entries:
cls.purge(os.path.join(path, e))
if me_also:
os.rmdir(path)
@classmethod
@_pathguard
def _create(cls, path, ctor):
"""path creation backend routine"""
try:
ctor(path)
except OSError:
ex = sys.exc_info()[1]
if ex.errno == EEXIST:
cls.purge(path)
return ctor(path)
raise
@classmethod
@_pathguard
def mkdir(cls, path):
cls._create(path, os.mkdir)
@classmethod
@_pathguard
def symlink(cls, lnk, path):
cls._create(path, lambda p: os.symlink(lnk, p))
@classmethod
@_pathguard
def xtime(cls, path, uuid):
"""query xtime extended attribute
Return xtime of @path for @uuid as a pair of integers.
"Normal" errors due to non-existent @path or extended attribute
are tolerated and errno is returned in such a case.
"""
try:
return struct.unpack(
'!II',
Xattr.lgetxattr(path, '.'.join([cls.GX_NSPACE, uuid, 'xtime']),
8))
except OSError:
ex = sys.exc_info()[1]
if ex.errno in (ENOENT, ENODATA, ENOTDIR):
return ex.errno
else:
raise
@classmethod
def gfid(cls, gfidpath):
return errno_wrap(
Xattr.lgetxattr,
[gfidpath, 'glusterfs.gfid', cls.GX_GFID_CANONICAL_LEN], [ENOENT])
@classmethod
def node_uuid(cls, path='.'):
try:
uuid_l = Xattr.lgetxattr_buf(
path, '.'.join([cls.GX_NSPACE, 'node-uuid']))
return uuid_l[:-1].split(' ')
except OSError:
raise
@classmethod
def xtime_vec(cls, path, *uuids):
"""vectored version of @xtime
accepts a list of uuids and returns a dictionary
with uuid as key(s) and xtime as value(s)
"""
xt = {}
for uuid in uuids:
xtu = cls.xtime(path, uuid)
if xtu == ENODATA:
xtu = None
if isinstance(xtu, int):
return xtu
xt[uuid] = xtu
return xt
@classmethod
@_pathguard
def set_xtime(cls, path, uuid, mark):
"""set @mark as xtime for @uuid on @path"""
Xattr.lsetxattr(path, '.'.join([cls.GX_NSPACE, uuid, 'xtime']),
struct.pack('!II', *mark))
@classmethod
def set_xtime_vec(cls, path, mark_dct):
"""vectored (or dictered) version of set_xtime
ignore values that match @ignore
"""
for u, t in mark_dct.items():
cls.set_xtime(path, u, t)
@classmethod
def entry_ops(cls, entries):
pfx = gauxpfx()
logging.debug('entries: %s' % repr(entries))
# regular file
def entry_pack_reg(gf, bn, st):
blen = len(bn)
mo = st['mode']
return struct.pack(cls._fmt_mknod(blen), st['uid'], st['gid'], gf,
mo, bn, stat.S_IMODE(mo), 0, umask())
# mkdir
def entry_pack_mkdir(gf, bn, st):
blen = len(bn)
mo = st['mode']
return struct.pack(cls._fmt_mkdir(blen), st['uid'], st['gid'], gf,
mo, bn, stat.S_IMODE(mo), umask())
#symlink
def entry_pack_symlink(gf, bn, lnk, st):
blen = len(bn)
llen = len(lnk)
return struct.pack(cls._fmt_symlink(blen, llen), st['uid'],
st['gid'], gf, st['mode'], bn, lnk)
def entry_purge(entry, gfid):
# This is an extremely racy code and needs to be fixed ASAP.
# The GFID check here is to be sure that the pargfid/bname
# to be purged is the GFID gotten from the changelog.
# (a stat(changelog_gfid) would also be valid here)
# The race here is between the GFID check and the purge.
disk_gfid = cls.gfid(entry)
if isinstance(disk_gfid, int):
return
if not gfid == disk_gfid:
return
er = errno_wrap(os.unlink, [entry], [ENOENT, EISDIR])
if isinstance(er, int):
if er == EISDIR:
er = errno_wrap(os.rmdir, [entry], [ENOENT, ENOTEMPTY])
if er == ENOTEMPTY:
return er
for e in entries:
blob = None
op = e['op']
gfid = e['gfid']
entry = e['entry']
(pg, bname) = entry2pb(entry)
if op in ['RMDIR', 'UNLINK']:
while True:
er = entry_purge(entry, gfid)
if isinstance(er, int):
time.sleep(1)
else:
break
elif op == 'CREATE':
blob = entry_pack_reg(gfid, bname, e['stat'])
elif op == 'MKDIR':
blob = entry_pack_mkdir(gfid, bname, e['stat'])
elif op == 'LINK':
errno_wrap(os.link, [os.path.join(pfx, gfid), entry],
[ENOENT, EEXIST])
elif op == 'SYMLINK':
blob = entry_pack_symlink(gfid, bname, e['link'], e['stat'])
elif op == 'RENAME':
en = e['entry1']
errno_wrap(os.rename, [entry, en], [ENOENT, EEXIST])
if blob:
errno_wrap(Xattr.lsetxattr_l,
[pg, 'glusterfs.gfid.newfile', blob],
[ENOENT, EEXIST])
@classmethod
def changelog_register(cls, cl_brick, cl_dir, cl_log, cl_level, retries=0):
Changes.cl_register(cl_brick, cl_dir, cl_log, cl_level, retries)
@classmethod
def changelog_scan(cls):
Changes.cl_scan()
@classmethod
def changelog_getchanges(cls):
return Changes.cl_getchanges()
@classmethod
def changelog_done(cls, clfile):
Changes.cl_done(clfile)
@classmethod
@_pathguard
def setattr(cls, path, adct):
"""set file attributes
@adct is a dict, where 'own', 'mode' and 'times'
keys are looked for and values used to perform
chown, chmod or utimes on @path.
"""
own = adct.get('own')
if own:
os.lchown(path, *own)
mode = adct.get('mode')
if mode:
os.chmod(path, stat.S_IMODE(mode))
times = adct.get('times')
if times:
os.utime(path, times)
@staticmethod
def pid():
return os.getpid()
last_keep_alive = 0
@classmethod
def keep_alive(cls, dct):
"""process keepalive messages.
Return keep-alive counter (number of received keep-alive
messages).
Now the "keep-alive" message can also have a payload which is
used to set a foreign volume-mark on the underlying file system.
"""
if dct:
key = '.'.join([cls.GX_NSPACE, 'volume-mark', dct['uuid']])
val = struct.pack(
cls.FRGN_FMTSTR,
*(dct['version'] + tuple(
int(x, 16)
for x in re.findall('(?:[\da-f]){2}', dct['uuid'])) +
(dct['retval'], ) + dct['volume_mark'][0:2] +
(dct['timeout'], )))
Xattr.lsetxattr('.', key, val)
cls.last_keep_alive += 1
return cls.last_keep_alive
@staticmethod
def version():
"""version used in handshake"""
return 1.0
class Server(object):
"""singleton implemening those filesystem access primitives
which are needed for geo-replication functionality
(Singleton in the sense it's a class which has only static
and classmethods and is used directly, without instantiation.)
"""
GX_NSPACE = (privileged() and "trusted" or "system") + ".glusterfs"
NTV_FMTSTR = "!" + "B" * 19 + "II"
FRGN_XTRA_FMT = "I"
FRGN_FMTSTR = NTV_FMTSTR + FRGN_XTRA_FMT
def _pathguard(f):
"""decorator method that checks
the path argument of the decorated
functions to make sure it does not
point out of the managed tree
"""
fc = getattr(f, 'func_code', None)
if not fc:
# python 3
fc = f.__code__
pi = list(fc.co_varnames).index('path')
def ff(*a):
path = a[pi]
ps = path.split('/')
if path[0] == '/' or '..' in ps:
raise ValueError('unsafe path')
return f(*a)
return ff
@staticmethod
@_pathguard
def entries(path):
"""directory entries in an array"""
# prevent symlinks being followed
if not stat.S_ISDIR(os.lstat(path).st_mode):
raise OSError(ENOTDIR, os.strerror(ENOTDIR))
return os.listdir(path)
@classmethod
@_pathguard
def purge(cls, path, entries=None):
"""force-delete subtrees
If @entries is not specified, delete
the whole subtree under @path (including
@path).
Otherwise, @entries should be a
a sequence of children of @path, and
the effect is identical with a joint
@entries-less purge on them, ie.
for e in entries:
cls.purge(os.path.join(path, e))
"""
me_also = entries == None
if not entries:
try:
# if it's a symlink, prevent
# following it
try:
os.unlink(path)
return
except OSError:
ex = sys.exc_info()[1]
if ex.errno == EISDIR:
entries = os.listdir(path)
else:
raise
except OSError:
ex = sys.exc_info()[1]
if ex.errno in (ENOTDIR, ENOENT, ELOOP):
try:
os.unlink(path)
return
except OSError:
ex = sys.exc_info()[1]
if ex.errno == ENOENT:
return
raise
else:
raise
for e in entries:
cls.purge(os.path.join(path, e))
if me_also:
os.rmdir(path)
@classmethod
@_pathguard
def _create(cls, path, ctor):
"""path creation backend routine"""
try:
ctor(path)
except OSError:
ex = sys.exc_info()[1]
if ex.errno == EEXIST:
cls.purge(path)
return ctor(path)
raise
@classmethod
@_pathguard
def mkdir(cls, path):
cls._create(path, os.mkdir)
@classmethod
@_pathguard
def symlink(cls, lnk, path):
cls._create(path, lambda p: os.symlink(lnk, p))
@classmethod
@_pathguard
def xtime(cls, path, uuid):
"""query xtime extended attribute
Return xtime of @path for @uuid as a pair of integers.
"Normal" errors due to non-existent @path or extended attribute
are tolerated and errno is returned in such a case.
"""
try:
return struct.unpack(
'!II',
Xattr.lgetxattr(path, '.'.join([cls.GX_NSPACE, uuid, 'xtime']),
8))
except OSError:
ex = sys.exc_info()[1]
if ex.errno in (ENOENT, ENODATA, ENOTDIR):
return ex.errno
else:
raise
@classmethod
def xtime_vec(cls, path, *uuids):
"""vectored version of @xtime
accepts a list of uuids and returns a dictionary
with uuid as key(s) and xtime as value(s)
"""
xt = {}
for uuid in uuids:
xtu = cls.xtime(path, uuid)
if xtu == ENODATA:
xtu = None
if isinstance(xtu, int):
return xtu
xt[uuid] = xtu
return xt
@classmethod
@_pathguard
def set_xtime(cls, path, uuid, mark):
"""set @mark as xtime for @uuid on @path"""
Xattr.lsetxattr(path, '.'.join([cls.GX_NSPACE, uuid, 'xtime']),
struct.pack('!II', *mark))
@classmethod
def set_xtime_vec(cls, path, mark_dct):
"""vectored (or dictered) version of set_xtime
ignore values that match @ignore
"""
for u, t in mark_dct.items():
cls.set_xtime(path, u, t)
@staticmethod
@_pathguard
def setattr(path, adct):
"""set file attributes
@adct is a dict, where 'own', 'mode' and 'times'
keys are looked for and values used to perform
chown, chmod or utimes on @path.
"""
own = adct.get('own')
if own:
os.lchown(path, *own)
mode = adct.get('mode')
if mode:
os.chmod(path, stat.S_IMODE(mode))
times = adct.get('times')
if times:
os.utime(path, times)
@staticmethod
def pid():
return os.getpid()
last_keep_alive = 0
@classmethod
def keep_alive(cls, dct):
"""process keepalive messages.
Return keep-alive counter (number of received keep-alive
messages).
Now the "keep-alive" message can also have a payload which is
used to set a foreign volume-mark on the underlying file system.
"""
if dct:
key = '.'.join([cls.GX_NSPACE, 'volume-mark', dct['uuid']])
val = struct.pack(
cls.FRGN_FMTSTR,
*(dct['version'] + tuple(
int(x, 16)
for x in re.findall('(?:[\da-f]){2}', dct['uuid'])) +
(dct['retval'], ) + dct['volume_mark'][0:2] +
(dct['timeout'], )))
Xattr.lsetxattr('.', key, val)
cls.last_keep_alive += 1
return cls.last_keep_alive
@staticmethod
def version():
"""version used in handshake"""
return 1.0
def main_i():
"""internal main routine
parse command line, decide what action will be taken;
we can either:
- query/manipulate configuration
- format gsyncd urls using gsyncd's url parsing engine
- start service in following modes, in given stages:
- agent: startup(), ChangelogAgent()
- monitor: startup(), monitor()
- master: startup(), connect_remote(), connect(), service_loop()
- slave: startup(), connect(), service_loop()
"""
rconf = {"go_daemon": "should"}
def store_abs(opt, optstr, val, parser):
if val and val != "-":
val = os.path.abspath(val)
setattr(parser.values, opt.dest, val)
def store_local(opt, optstr, val, parser):
rconf[opt.dest] = val
def store_local_curry(val):
return lambda o, oo, vx, p: store_local(o, oo, val, p)
def store_local_obj(op, dmake):
return lambda o, oo, vx, p: store_local(o, oo, FreeObject(op=op, **dmake(vx)), p)
op = OptionParser(usage="%prog [options...] <master> <slave>", version="%prog 0.0.1")
op.add_option("--gluster-command-dir", metavar="DIR", default="")
op.add_option(
"--gluster-log-file", metavar="LOGF", default=os.devnull, type=str, action="callback", callback=store_abs
)
op.add_option("--gluster-log-level", metavar="LVL")
op.add_option("--gluster-params", metavar="PRMS", default="")
op.add_option("--glusterd-uuid", metavar="UUID", type=str, default="", help=SUPPRESS_HELP)
op.add_option("--gluster-cli-options", metavar="OPTS", default="--log-file=-")
op.add_option("--mountbroker", metavar="LABEL")
op.add_option("-p", "--pid-file", metavar="PIDF", type=str, action="callback", callback=store_abs)
op.add_option("-l", "--log-file", metavar="LOGF", type=str, action="callback", callback=store_abs)
op.add_option("--iprefix", metavar="LOGD", type=str, action="callback", callback=store_abs)
op.add_option("--changelog-log-file", metavar="LOGF", type=str, action="callback", callback=store_abs)
op.add_option("--log-file-mbr", metavar="LOGF", type=str, action="callback", callback=store_abs)
op.add_option("--state-file", metavar="STATF", type=str, action="callback", callback=store_abs)
op.add_option("--state-detail-file", metavar="STATF", type=str, action="callback", callback=store_abs)
op.add_option("--georep-session-working-dir", metavar="STATF", type=str, action="callback", callback=store_abs)
op.add_option("--ignore-deletes", default=False, action="store_true")
op.add_option("--isolated-slave", default=False, action="store_true")
op.add_option("--use-rsync-xattrs", default=False, action="store_true")
op.add_option("--sync-xattrs", default=True, action="store_true")
op.add_option("--sync-acls", default=True, action="store_true")
op.add_option("--log-rsync-performance", default=False, action="store_true")
op.add_option("--pause-on-start", default=False, action="store_true")
op.add_option("-L", "--log-level", metavar="LVL")
op.add_option("-r", "--remote-gsyncd", metavar="CMD", default=os.path.abspath(sys.argv[0]))
op.add_option("--volume-id", metavar="UUID")
op.add_option("--slave-id", metavar="ID")
op.add_option("--session-owner", metavar="ID")
op.add_option("--local-id", metavar="ID", help=SUPPRESS_HELP, default="")
op.add_option("--local-path", metavar="PATH", help=SUPPRESS_HELP, default="")
op.add_option("-s", "--ssh-command", metavar="CMD", default="ssh")
op.add_option("--ssh-command-tar", metavar="CMD", default="ssh")
op.add_option("--rsync-command", metavar="CMD", default="rsync")
op.add_option("--rsync-options", metavar="OPTS", default="")
op.add_option("--rsync-ssh-options", metavar="OPTS", default="--compress")
op.add_option("--timeout", metavar="SEC", type=int, default=120)
op.add_option("--connection-timeout", metavar="SEC", type=int, default=60, help=SUPPRESS_HELP)
op.add_option("--sync-jobs", metavar="N", type=int, default=3)
op.add_option("--replica-failover-interval", metavar="N", type=int, default=1)
op.add_option("--changelog-archive-format", metavar="N", type=str, default="%Y%m")
op.add_option("--use-meta-volume", default=False, action="store_true")
op.add_option("--meta-volume-mnt", metavar="N", type=str, default="/var/run/gluster/shared_storage")
op.add_option("--turns", metavar="N", type=int, default=0, help=SUPPRESS_HELP)
op.add_option("--allow-network", metavar="IPS", default="")
op.add_option("--socketdir", metavar="DIR")
op.add_option("--state-socket-unencoded", metavar="SOCKF", type=str, action="callback", callback=store_abs)
op.add_option("--checkpoint", metavar="LABEL", default="0")
# tunables for failover/failback mechanism:
# None - gsyncd behaves as normal
# blind - gsyncd works with xtime pairs to identify
# candidates for synchronization
# wrapup - same as normal mode but does not assign
# xtimes to orphaned files
# see crawl() for usage of the above tunables
op.add_option("--special-sync-mode", type=str, help=SUPPRESS_HELP)
# changelog or xtime? (TODO: Change the default)
op.add_option("--change-detector", metavar="MODE", type=str, default="xtime")
# sleep interval for change detection (xtime crawl uses a hardcoded 1
# second sleep time)
op.add_option("--change-interval", metavar="SEC", type=int, default=3)
# working directory for changelog based mechanism
op.add_option("--working-dir", metavar="DIR", type=str, action="callback", callback=store_abs)
op.add_option("--use-tarssh", default=False, action="store_true")
op.add_option("-c", "--config-file", metavar="CONF", type=str, action="callback", callback=store_local)
# duh. need to specify dest or value will be mapped to None :S
op.add_option("--monitor", dest="monitor", action="callback", callback=store_local_curry(True))
op.add_option("--agent", dest="agent", action="callback", callback=store_local_curry(True))
op.add_option("--resource-local", dest="resource_local", type=str, action="callback", callback=store_local)
op.add_option("--resource-remote", dest="resource_remote", type=str, action="callback", callback=store_local)
op.add_option(
"--feedback-fd", dest="feedback_fd", type=int, help=SUPPRESS_HELP, action="callback", callback=store_local
)
op.add_option("--rpc-fd", dest="rpc_fd", type=str, help=SUPPRESS_HELP)
op.add_option("--subvol-num", dest="subvol_num", type=int, help=SUPPRESS_HELP)
op.add_option("--listen", dest="listen", help=SUPPRESS_HELP, action="callback", callback=store_local_curry(True))
op.add_option("-N", "--no-daemon", dest="go_daemon", action="callback", callback=store_local_curry("dont"))
op.add_option("--verify", type=str, dest="verify", action="callback", callback=store_local)
op.add_option("--create", type=str, dest="create", action="callback", callback=store_local)
op.add_option("--delete", dest="delete", action="callback", callback=store_local_curry(True))
op.add_option("--status-get", dest="status_get", action="callback", callback=store_local_curry(True))
op.add_option(
"--debug",
dest="go_daemon",
action="callback",
callback=lambda *a: (
store_local_curry("dont")(*a),
setattr(a[-1].values, "log_file", "-"),
setattr(a[-1].values, "log_level", "DEBUG"),
setattr(a[-1].values, "changelog_log_file", "-"),
),
)
op.add_option("--path", type=str, action="append")
for a in ("check", "get"):
op.add_option(
"--config-" + a,
metavar="OPT",
type=str,
dest="config",
action="callback",
callback=store_local_obj(a, lambda vx: {"opt": vx}),
)
op.add_option(
"--config-get-all", dest="config", action="callback", callback=store_local_obj("get", lambda vx: {"opt": None})
)
for m in ("", "-rx", "-glob"):
# call this code 'Pythonic' eh?
# have to define a one-shot local function to be able
# to inject (a value depending on the)
# iteration variable into the inner lambda
def conf_mod_opt_regex_variant(rx):
op.add_option(
"--config-set" + m,
metavar="OPT VAL",
type=str,
nargs=2,
dest="config",
action="callback",
callback=store_local_obj("set", lambda vx: {"opt": vx[0], "val": vx[1], "rx": rx}),
)
op.add_option(
"--config-del" + m,
metavar="OPT",
type=str,
dest="config",
action="callback",
callback=store_local_obj("del", lambda vx: {"opt": vx, "rx": rx}),
)
conf_mod_opt_regex_variant(m and m[1:] or False)
op.add_option("--normalize-url", dest="url_print", action="callback", callback=store_local_curry("normal"))
op.add_option("--canonicalize-url", dest="url_print", action="callback", callback=store_local_curry("canon"))
op.add_option(
"--canonicalize-escape-url", dest="url_print", action="callback", callback=store_local_curry("canon_esc")
)
tunables = [
norm(o.get_opt_string()[2:])
for o in op.option_list
if (o.callback in (store_abs, "store_true", None) and o.get_opt_string() not in ("--version", "--help"))
]
remote_tunables = ["listen", "go_daemon", "timeout", "session_owner", "config_file", "use_rsync_xattrs"]
rq_remote_tunables = {"listen": True}
# precedence for sources of values: 1) commandline, 2) cfg file, 3)
# defaults for this to work out we need to tell apart defaults from
# explicitly set options... so churn out the defaults here and call
# the parser with virgin values container.
defaults = op.get_default_values()
opts, args = op.parse_args(values=optparse.Values())
args_orig = args[:]
r = rconf.get("resource_local")
if r:
if len(args) == 0:
args.append(None)
args[0] = r
r = rconf.get("resource_remote")
if r:
if len(args) == 0:
raise GsyncdError("local resource unspecfied")
elif len(args) == 1:
args.append(None)
args[1] = r
confdata = rconf.get("config")
if not (
len(args) == 2
or (len(args) == 1 and rconf.get("listen"))
or (len(args) <= 2 and confdata)
or rconf.get("url_print")
):
sys.stderr.write("error: incorrect number of arguments\n\n")
sys.stderr.write(op.get_usage() + "\n")
sys.exit(1)
verify = rconf.get("verify")
if verify:
logging.info(verify)
logging.info("Able to spawn gsyncd.py")
return
restricted = os.getenv("_GSYNCD_RESTRICTED_")
if restricted:
allopts = {}
allopts.update(opts.__dict__)
allopts.update(rconf)
bannedtuns = set(allopts.keys()) - set(remote_tunables)
if bannedtuns:
raise GsyncdError(
"following tunables cannot be set with " "restricted SSH invocaton: " + ", ".join(bannedtuns)
)
for k, v in rq_remote_tunables.items():
if not k in allopts or allopts[k] != v:
raise GsyncdError("tunable %s is not set to value %s required " "for restricted SSH invocaton" % (k, v))
confrx = getattr(confdata, "rx", None)
def makersc(aa, check=True):
if not aa:
return ([], None, None)
ra = [resource.parse_url(u) for u in aa]
local = ra[0]
remote = None
if len(ra) > 1:
remote = ra[1]
if check and not local.can_connect_to(remote):
raise GsyncdError("%s cannot work with %s" % (local.path, remote and remote.path))
return (ra, local, remote)
if confrx:
# peers are regexen, don't try to parse them
if confrx == "glob":
args = ["\A" + fnmatch.translate(a) for a in args]
canon_peers = args
namedict = {}
else:
dc = rconf.get("url_print")
rscs, local, remote = makersc(args_orig, not dc)
if dc:
for r in rscs:
print(
r.get_url(
**{
"normal": {},
"canon": {"canonical": True},
"canon_esc": {"canonical": True, "escaped": True},
}[dc]
)
)
return
pa = ([], [], [])
urlprms = ({}, {"canonical": True}, {"canonical": True, "escaped": True})
for x in rscs:
for i in range(len(pa)):
pa[i].append(x.get_url(**urlprms[i]))
_, canon_peers, canon_esc_peers = pa
# creating the namedict, a dict representing various ways of referring
# to / repreenting peers to be fillable in config templates
mods = (lambda x: x, lambda x: x[0].upper() + x[1:], lambda x: "e" + x[0].upper() + x[1:])
if remote:
rmap = {local: ("local", "master"), remote: ("remote", "slave")}
else:
rmap = {local: ("local", "slave")}
namedict = {}
for i in range(len(rscs)):
x = rscs[i]
for name in rmap[x]:
for j in range(3):
namedict[mods[j](name)] = pa[j][i]
namedict[name + "vol"] = x.volume
if name == "remote":
namedict["remotehost"] = x.remotehost
if not "config_file" in rconf:
rconf["config_file"] = os.path.join(os.path.dirname(sys.argv[0]), "conf/gsyncd_template.conf")
upgrade_config_file(rconf["config_file"])
gcnf = GConffile(rconf["config_file"], canon_peers, defaults.__dict__, opts.__dict__, namedict)
checkpoint_change = False
if confdata:
opt_ok = norm(confdata.opt) in tunables + [None]
if confdata.op == "check":
if opt_ok:
sys.exit(0)
else:
sys.exit(1)
elif not opt_ok:
raise GsyncdError("not a valid option: " + confdata.opt)
if confdata.op == "get":
gcnf.get(confdata.opt)
elif confdata.op == "set":
gcnf.set(confdata.opt, confdata.val, confdata.rx)
elif confdata.op == "del":
gcnf.delete(confdata.opt, confdata.rx)
# when modifying checkpoint, it's important to make a log
# of that, so in that case we go on to set up logging even
# if its just config invocation
if confdata.opt == "checkpoint" and confdata.op in ("set", "del") and not confdata.rx:
checkpoint_change = True
if not checkpoint_change:
return
gconf.__dict__.update(defaults.__dict__)
gcnf.update_to(gconf.__dict__)
gconf.__dict__.update(opts.__dict__)
gconf.configinterface = gcnf
delete = rconf.get("delete")
if delete:
logging.info("geo-replication delete")
# Delete pid file, status file, socket file
cleanup_paths = []
if getattr(gconf, "pid_file", None):
cleanup_paths.append(gconf.pid_file)
if getattr(gconf, "state_file", None):
cleanup_paths.append(gconf.state_file)
if getattr(gconf, "state_detail_file", None):
cleanup_paths.append(gconf.state_detail_file)
if getattr(gconf, "state_socket_unencoded", None):
cleanup_paths.append(gconf.state_socket_unencoded)
cleanup_paths.append(rconf["config_file"][:-11] + "*")
# Cleanup changelog working dirs
if getattr(gconf, "working_dir", None):
try:
shutil.rmtree(gconf.working_dir)
except (IOError, OSError):
if sys.exc_info()[1].errno == ENOENT:
pass
else:
raise GsyncdError("Error while removing working dir: %s" % gconf.working_dir)
for path in cleanup_paths:
# To delete temp files
for f in glob.glob(path + "*"):
_unlink(f)
return
if restricted and gconf.allow_network:
ssh_conn = os.getenv("SSH_CONNECTION")
if not ssh_conn:
# legacy env var
ssh_conn = os.getenv("SSH_CLIENT")
if ssh_conn:
allowed_networks = [IPNetwork(a) for a in gconf.allow_network.split(",")]
client_ip = IPAddress(ssh_conn.split()[0])
allowed = False
for nw in allowed_networks:
if client_ip in nw:
allowed = True
break
if not allowed:
raise GsyncdError("client IP address is not allowed")
ffd = rconf.get("feedback_fd")
if ffd:
fcntl.fcntl(ffd, fcntl.F_SETFD, fcntl.FD_CLOEXEC)
# normalize loglevel
lvl0 = gconf.log_level
if isinstance(lvl0, str):
lvl1 = lvl0.upper()
lvl2 = logging.getLevelName(lvl1)
# I have _never_ _ever_ seen such an utterly braindead
# error condition
if lvl2 == "Level " + lvl1:
raise GsyncdError('cannot recognize log level "%s"' % lvl0)
gconf.log_level = lvl2
if not privileged() and gconf.log_file_mbr:
gconf.log_file = gconf.log_file_mbr
if checkpoint_change:
try:
GLogger._gsyncd_loginit(log_file=gconf.log_file, label="conf")
if confdata.op == "set":
logging.info("checkpoint %s set" % confdata.val)
elif confdata.op == "del":
logging.info("checkpoint info was reset")
except IOError:
if sys.exc_info()[1].errno == ENOENT:
# directory of log path is not present,
# which happens if we get here from
# a peer-multiplexed "config-set checkpoint"
# (as that directory is created only on the
# original node)
pass
else:
raise
return
create = rconf.get("create")
if create:
if getattr(gconf, "state_file", None):
set_monitor_status(gconf.state_file, create)
return
go_daemon = rconf["go_daemon"]
be_monitor = rconf.get("monitor")
be_agent = rconf.get("agent")
rscs, local, remote = makersc(args)
status_get = rconf.get("status_get")
if status_get:
for brick in gconf.path:
brick_status = GeorepStatus(gconf.state_file, brick)
checkpoint_time = int(getattr(gconf, "checkpoint", "0"))
brick_status.print_status(checkpoint_time=checkpoint_time)
return
if not be_monitor and isinstance(remote, resource.SSH) and go_daemon == "should":
go_daemon = "postconn"
log_file = None
else:
log_file = gconf.log_file
if be_monitor:
label = "monitor"
elif be_agent:
label = "agent"
elif remote:
# master
label = gconf.local_path
else:
label = "slave"
startup(go_daemon=go_daemon, log_file=log_file, label=label)
resource.Popen.init_errhandler()
if be_agent:
os.setsid()
logging.debug("rpc_fd: %s" % repr(gconf.rpc_fd))
return agent(Changelog(), gconf.rpc_fd)
if be_monitor:
return monitor(*rscs)
logging.info("syncing: %s" % " -> ".join(r.url for r in rscs))
if remote:
go_daemon = remote.connect_remote(go_daemon=go_daemon)
if go_daemon:
startup(go_daemon=go_daemon, log_file=gconf.log_file)
# complete remote connection in child
remote.connect_remote(go_daemon="done")
local.connect()
if ffd:
os.close(ffd)
local.service_loop(*[r for r in [remote] if r])