30
29
transport as _mod_transport,
32
from bzrlib.i18n import gettext
33
31
from bzrlib.lazy_import import lazy_import
34
32
lazy_import(globals(), """
35
from bzrlib.smart import (
33
from bzrlib.smart import medium
39
34
from bzrlib.transport import (
43
38
from bzrlib import (
56
50
hooks: An instance of SmartServerHooks.
59
# This is the timeout on the socket we use .accept() on. It is exposed here
60
# so the test suite can set it faster. (It thread.interrupt_main() will not
61
# fire a KeyboardInterrupt during socket.accept)
63
_SHUTDOWN_POLL_TIMEOUT = 1.0
64
_LOG_WAITING_TIMEOUT = 10.0
68
def __init__(self, backing_transport, root_client_path='/',
53
def __init__(self, backing_transport, root_client_path='/'):
70
54
"""Construct a new server.
72
56
To actually start it running, call either start_background_thread or
75
59
:param backing_transport: The transport to serve.
76
60
:param root_client_path: The client path that will correspond to root
77
61
of backing_transport.
78
:param client_timeout: See SmartServerSocketStreamMedium's timeout
81
63
self.backing_transport = backing_transport
82
64
self.root_client_path = root_client_path
83
self._client_timeout = client_timeout
84
self._active_connections = []
85
# This is set to indicate we want to wait for clients to finish before
87
self._gracefully_stopping = False
89
66
def start_server(self, host, port):
90
67
"""Create the server listening socket.
116
93
self._sockname = self._server_socket.getsockname()
117
94
self.port = self._sockname[1]
118
95
self._server_socket.listen(1)
119
self._server_socket.settimeout(self._ACCEPT_TIMEOUT)
120
# Once we start accept()ing connections, we set started.
96
self._server_socket.settimeout(1)
121
97
self._started = threading.Event()
122
# Once we stop accept()ing connections (and are closing the socket) we
124
98
self._stopped = threading.Event()
125
# Once we have finished waiting for all clients, etc. We set
127
self._fully_stopped = threading.Event()
129
100
def _backing_urls(self):
130
101
# There are three interesting urls:
163
134
for hook in SmartTCPServer.hooks['server_stopped']:
164
135
hook(backing_urls, self.get_url())
166
def _stop_gracefully(self):
167
trace.note(gettext('Requested to stop gracefully'))
168
self._should_terminate = True
169
self._gracefully_stopping = True
170
for handler, _ in self._active_connections:
171
handler._stop_gracefully()
173
def _wait_for_clients_to_disconnect(self):
174
self._poll_active_connections()
175
if not self._active_connections:
177
trace.note(gettext('Waiting for %d client(s) to finish')
178
% (len(self._active_connections),))
179
t_next_log = self._timer() + self._LOG_WAITING_TIMEOUT
180
while self._active_connections:
182
if now >= t_next_log:
183
trace.note(gettext('Still waiting for %d client(s) to finish')
184
% (len(self._active_connections),))
185
t_next_log = now + self._LOG_WAITING_TIMEOUT
186
self._poll_active_connections(self._SHUTDOWN_POLL_TIMEOUT)
188
137
def serve(self, thread_name_suffix=''):
189
# Note: There is a temptation to do
190
# signals.register_on_hangup(id(self), self._stop_gracefully)
191
# However, that creates a temporary object which is a bound
192
# method. signals._on_sighup is a WeakKeyDictionary so it
193
# immediately gets garbage collected, because nothing else
194
# references it. Instead, we need to keep a real reference to the
195
# bound method for the lifetime of the serve() function.
196
stop_gracefully = self._stop_gracefully
197
signals.register_on_hangup(id(self), stop_gracefully)
198
138
self._should_terminate = False
199
139
# for hooks we are letting code know that a server has started (and
200
140
# later stopped).
211
151
except self._socket_error, e:
212
152
# if the socket is closed by stop_background_thread
213
# we might get a EBADF here, or if we get a signal we
214
# can get EINTR, any other socket errors should get
216
if e.args[0] not in (errno.EBADF, errno.EINTR):
217
trace.warning(gettext("listening socket error: %s")
153
# we might get a EBADF here, any other socket errors
155
if e.args[0] != errno.EBADF:
156
trace.warning("listening socket error: %s", e)
220
158
if self._should_terminate:
223
160
self.serve_conn(conn, thread_name_suffix)
224
# Cleanout any threads that have finished processing.
225
self._poll_active_connections()
226
161
except KeyboardInterrupt:
227
162
# dont log when CTRL-C'd.
230
165
trace.report_exception(sys.exc_info(), sys.stderr)
234
170
# ensure the server socket is closed.
235
171
self._server_socket.close()
236
172
except self._socket_error:
237
173
# ignore errors on close
240
signals.unregister_on_hangup(id(self))
241
175
self.run_server_stopped_hooks()
242
if self._gracefully_stopping:
243
self._wait_for_clients_to_disconnect()
244
self._fully_stopped.set()
246
177
def get_url(self):
247
178
"""Return the url of the server"""
248
179
return "bzr://%s:%s/" % (self._sockname[0], self._sockname[1])
250
def _make_handler(self, conn):
251
return medium.SmartServerSocketStreamMedium(
252
conn, self.backing_transport, self.root_client_path,
253
timeout=self._client_timeout)
255
def _poll_active_connections(self, timeout=0.0):
256
"""Check to see if any active connections have finished.
258
This will iterate through self._active_connections, and update any
259
connections that are finished.
261
:param timeout: The timeout to pass to thread.join(). By default, we
262
set it to 0, so that we don't hang if threads are not done yet.
266
for handler, thread in self._active_connections:
269
still_active.append((handler, thread))
270
self._active_connections = still_active
272
181
def serve_conn(self, conn, thread_name_suffix):
273
182
# For WIN32, where the timeout value from the listening socket
274
183
# propagates to the newly accepted socket.
275
184
conn.setblocking(True)
276
185
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
186
handler = medium.SmartServerSocketStreamMedium(
187
conn, self.backing_transport, self.root_client_path)
277
188
thread_name = 'smart-server-child' + thread_name_suffix
278
handler = self._make_handler(conn)
279
189
connection_thread = threading.Thread(
280
190
None, handler.serve, name=thread_name)
281
self._active_connections.append((handler, connection_thread))
191
# FIXME: This thread is never joined, it should at least be collected
192
# somewhere so that tests that want to check for leaked threads can get
193
# rid of them -- vila 20100531
282
194
connection_thread.setDaemon(True)
283
195
connection_thread.start()
284
196
return connection_thread
418
330
chroot_server = chroot.ChrootServer(transport)
419
331
chroot_server.start_server()
420
332
self.cleanups.append(chroot_server.stop_server)
421
transport = _mod_transport.get_transport_from_url(chroot_server.get_url())
333
transport = _mod_transport.get_transport(chroot_server.get_url())
422
334
if self.base_path is not None:
423
335
# Decorate the server's backing transport with a filter that can
424
336
# expand homedirs.
425
337
expand_userdirs = self._make_expand_userdirs_filter(transport)
426
338
expand_userdirs.start_server()
427
339
self.cleanups.append(expand_userdirs.stop_server)
428
transport = _mod_transport.get_transport_from_url(expand_userdirs.get_url())
340
transport = _mod_transport.get_transport(expand_userdirs.get_url())
429
341
self.transport = transport
431
def _get_stdin_stdout(self):
432
return sys.stdin, sys.stdout
434
def _make_smart_server(self, host, port, inet, timeout):
436
c = config.GlobalStack()
437
timeout = c.get('serve.client_timeout')
343
def _make_smart_server(self, host, port, inet):
439
stdin, stdout = self._get_stdin_stdout()
440
345
smart_server = medium.SmartServerPipeStreamMedium(
441
stdin, stdout, self.transport, timeout=timeout)
346
sys.stdin, sys.stdout, self.transport)
444
349
host = medium.BZR_DEFAULT_INTERFACE
446
351
port = medium.BZR_DEFAULT_PORT
447
smart_server = SmartTCPServer(self.transport,
448
client_timeout=timeout)
352
smart_server = SmartTCPServer(self.transport)
449
353
smart_server.start_server(host, port)
450
trace.note(gettext('listening on port: %s') % smart_server.port)
354
trace.note('listening on port: %s' % smart_server.port)
451
355
self.smart_server = smart_server
453
357
def _change_globals(self):
464
368
self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
465
369
ui.ui_factory = ui.SilentUIFactory()
466
370
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
467
orig = signals.install_sighup_handler()
468
def restore_signals():
469
signals.restore_sighup_handler(orig)
470
self.cleanups.append(restore_signals)
472
def set_up(self, transport, host, port, inet, timeout):
372
def set_up(self, transport, host, port, inet):
473
373
self._make_backing_transport(transport)
474
self._make_smart_server(host, port, inet, timeout)
374
self._make_smart_server(host, port, inet)
475
375
self._change_globals()
477
377
def tear_down(self):
478
378
for cleanup in reversed(self.cleanups):
482
def serve_bzr(transport, host=None, port=None, inet=False, timeout=None):
381
def serve_bzr(transport, host=None, port=None, inet=False):
483
382
"""This is the default implementation of 'bzr serve'.
485
384
It creates a TCP or pipe smart server on 'transport, and runs it. The
486
385
transport will be decorated with a chroot and pathfilter (using
487
386
os.path.expanduser).
489
388
bzr_server = BzrServerFactory()
491
bzr_server.set_up(transport, host, port, inet, timeout)
390
bzr_server.set_up(transport, host, port, inet)
492
391
bzr_server.smart_server.serve()
494
393
hook_caught_exception = False
added
removed
bzrlib/smart/server.py
