← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/server.py

(gz) Fix test failure on alpha by correcting format string for
 gc_chk_sha1_record (Martin [gz])

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smart/server.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
20
20
import os.path
21
21
import socket
22
22
import sys
23
 
import time
24
23
import threading
25
24
 
26
 
from bzrlib.hooks import Hooks
 
25
from bzrlib.hooks import HookPoint, Hooks
27
26
from bzrlib import (
28
27
    errors,
29
28
    trace,
30
29
    transport as _mod_transport,
31
30
)
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 (
36
 
    medium,
37
 
    signals,
38
 
    )
 
33
from bzrlib.smart import medium
39
34
from bzrlib.transport import (
40
35
    chroot,
41
36
    pathfilter,
42
37
    )
43
38
from bzrlib import (
44
 
    config,
45
39
    urlutils,
46
40
    )
47
41
""")
56
50
    hooks: An instance of SmartServerHooks.
57
51
    """
58
52
 
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)
62
 
    _ACCEPT_TIMEOUT = 1.0
63
 
    _SHUTDOWN_POLL_TIMEOUT = 1.0
64
 
    _LOG_WAITING_TIMEOUT = 10.0
65
 
 
66
 
    _timer = time.time
67
 
 
68
 
    def __init__(self, backing_transport, root_client_path='/',
69
 
                 client_timeout=None):
 
53
    def __init__(self, backing_transport, root_client_path='/'):
70
54
        """Construct a new server.
71
55
 
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
79
 
            parameter.
80
62
        """
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
86
 
        # we disconnect.
87
 
        self._gracefully_stopping = False
88
65
 
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
123
 
        # set _stopped
124
98
        self._stopped = threading.Event()
125
 
        # Once we have finished waiting for all clients, etc. We set
126
 
        # _fully_stopped
127
 
        self._fully_stopped = threading.Event()
128
99
 
129
100
    def _backing_urls(self):
130
101
        # There are three interesting urls:
132
103
        # The URL that a commit done on the same machine as the server will
133
104
        # have within the servers space. (e.g. file:///home/user/source)
134
105
        # The URL that will be given to other hooks in the same process -
135
 
        # the URL of the backing transport itself. (e.g. filtered-36195:///)
 
106
        # the URL of the backing transport itself. (e.g. chroot+:///)
136
107
        # We need all three because:
137
108
        #  * other machines see the first
138
109
        #  * local commits on this machine should be able to be mapped to
163
134
        for hook in SmartTCPServer.hooks['server_stopped']:
164
135
            hook(backing_urls, self.get_url())
165
136
 
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()
172
 
 
173
 
    def _wait_for_clients_to_disconnect(self):
174
 
        self._poll_active_connections()
175
 
        if not self._active_connections:
176
 
            return
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:
181
 
            now = self._timer()
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)
187
 
 
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).
210
150
                        pass
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
215
 
                        # logged.
216
 
                        if e.args[0] not in (errno.EBADF, errno.EINTR):
217
 
                            trace.warning(gettext("listening socket error: %s")
218
 
                                          % (e,))
 
153
                        # we might get a EBADF here, any other socket errors
 
154
                        # should get logged.
 
155
                        if e.args[0] != errno.EBADF:
 
156
                            trace.warning("listening socket error: %s", e)
219
157
                    else:
220
158
                        if self._should_terminate:
221
 
                            conn.close()
222
159
                            break
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.
228
163
                raise
230
165
                trace.report_exception(sys.exc_info(), sys.stderr)
231
166
                raise
232
167
        finally:
 
168
            self._stopped.set()
233
169
            try:
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
238
174
                pass
239
 
            self._stopped.set()
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()
245
176
 
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])
249
180
 
250
 
    def _make_handler(self, conn):
251
 
        return medium.SmartServerSocketStreamMedium(
252
 
            conn, self.backing_transport, self.root_client_path,
253
 
            timeout=self._client_timeout)
254
 
 
255
 
    def _poll_active_connections(self, timeout=0.0):
256
 
        """Check to see if any active connections have finished.
257
 
 
258
 
        This will iterate through self._active_connections, and update any
259
 
        connections that are finished.
260
 
 
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.
263
 
        :return: None
264
 
        """
265
 
        still_active = []
266
 
        for handler, thread in self._active_connections:
267
 
            thread.join(timeout)
268
 
            if thread.isAlive():
269
 
                still_active.append((handler, thread))
270
 
        self._active_connections = still_active
271
 
 
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
327
239
        These are all empty initially, because by default nothing should get
328
240
        notified.
329
241
        """
330
 
        Hooks.__init__(self, "bzrlib.smart.server", "SmartTCPServer.hooks")
331
 
        self.add_hook('server_started',
 
242
        Hooks.__init__(self)
 
243
        self.create_hook(HookPoint('server_started',
332
244
            "Called by the bzr server when it starts serving a directory. "
333
245
            "server_started is called with (backing urls, public url), "
334
246
            "where backing_url is a list of URLs giving the "
335
247
            "server-specific directory locations, and public_url is the "
336
 
            "public URL for the directory being served.", (0, 16))
337
 
        self.add_hook('server_started_ex',
 
248
            "public URL for the directory being served.", (0, 16), None))
 
249
        self.create_hook(HookPoint('server_started_ex',
338
250
            "Called by the bzr server when it starts serving a directory. "
339
251
            "server_started is called with (backing_urls, server_obj).",
340
 
            (1, 17))
341
 
        self.add_hook('server_stopped',
 
252
            (1, 17), None))
 
253
        self.create_hook(HookPoint('server_stopped',
342
254
            "Called by the bzr server when it stops serving a directory. "
343
255
            "server_stopped is called with the same parameters as the "
344
 
            "server_started hook: (backing_urls, public_url).", (0, 16))
345
 
        self.add_hook('server_exception',
346
 
            "Called by the bzr server when an exception occurs. "
347
 
            "server_exception is called with the sys.exc_info() tuple "
348
 
            "return true for the hook if the exception has been handled, "
349
 
            "in which case the server will exit normally.", (2, 4))
 
256
            "server_started hook: (backing_urls, public_url).", (0, 16), None))
350
257
 
351
258
SmartTCPServer.hooks = SmartServerHooks()
352
259
 
418
325
        chroot_server = chroot.ChrootServer(transport)
419
326
        chroot_server.start_server()
420
327
        self.cleanups.append(chroot_server.stop_server)
421
 
        transport = _mod_transport.get_transport_from_url(chroot_server.get_url())
 
328
        transport = _mod_transport.get_transport(chroot_server.get_url())
422
329
        if self.base_path is not None:
423
330
            # Decorate the server's backing transport with a filter that can
424
331
            # expand homedirs.
425
332
            expand_userdirs = self._make_expand_userdirs_filter(transport)
426
333
            expand_userdirs.start_server()
427
334
            self.cleanups.append(expand_userdirs.stop_server)
428
 
            transport = _mod_transport.get_transport_from_url(expand_userdirs.get_url())
 
335
            transport = _mod_transport.get_transport(expand_userdirs.get_url())
429
336
        self.transport = transport
430
337
 
431
 
    def _get_stdin_stdout(self):
432
 
        return sys.stdin, sys.stdout
433
 
 
434
 
    def _make_smart_server(self, host, port, inet, timeout):
435
 
        if timeout is None:
436
 
            c = config.GlobalStack()
437
 
            timeout = c.get('serve.client_timeout')
 
338
    def _make_smart_server(self, host, port, inet):
438
339
        if inet:
439
 
            stdin, stdout = self._get_stdin_stdout()
440
340
            smart_server = medium.SmartServerPipeStreamMedium(
441
 
                stdin, stdout, self.transport, timeout=timeout)
 
341
                sys.stdin, sys.stdout, self.transport)
442
342
        else:
443
343
            if host is None:
444
344
                host = medium.BZR_DEFAULT_INTERFACE
445
345
            if port is None:
446
346
                port = medium.BZR_DEFAULT_PORT
447
 
            smart_server = SmartTCPServer(self.transport,
448
 
                                          client_timeout=timeout)
 
347
            smart_server = SmartTCPServer(self.transport)
449
348
            smart_server.start_server(host, port)
450
 
            trace.note(gettext('listening on port: %s') % smart_server.port)
 
349
            trace.note('listening on port: %s' % smart_server.port)
451
350
        self.smart_server = smart_server
452
351
 
453
352
    def _change_globals(self):
464
363
        self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
465
364
        ui.ui_factory = ui.SilentUIFactory()
466
365
        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)
471
366
 
472
 
    def set_up(self, transport, host, port, inet, timeout):
 
367
    def set_up(self, transport, host, port, inet):
473
368
        self._make_backing_transport(transport)
474
 
        self._make_smart_server(host, port, inet, timeout)
 
369
        self._make_smart_server(host, port, inet)
475
370
        self._change_globals()
476
371
 
477
372
    def tear_down(self):
479
374
            cleanup()
480
375
 
481
376
 
482
 
def serve_bzr(transport, host=None, port=None, inet=False, timeout=None):
 
377
def serve_bzr(transport, host=None, port=None, inet=False):
483
378
    """This is the default implementation of 'bzr serve'.
484
 
 
 
379
    
485
380
    It creates a TCP or pipe smart server on 'transport, and runs it.  The
486
381
    transport will be decorated with a chroot and pathfilter (using
487
382
    os.path.expanduser).
488
383
    """
489
384
    bzr_server = BzrServerFactory()
490
385
    try:
491
 
        bzr_server.set_up(transport, host, port, inet, timeout)
 
386
        bzr_server.set_up(transport, host, port, inet)
492
387
        bzr_server.smart_server.serve()
493
 
    except:
494
 
        hook_caught_exception = False
495
 
        for hook in SmartTCPServer.hooks['server_exception']:
496
 
            hook_caught_exception = hook(sys.exc_info())
497
 
        if not hook_caught_exception:
498
 
            raise
499
388
    finally:
500
389
        bzr_server.tear_down()
 
390