1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
|
Description: remove .py suffix from portserver script
Author: Sascha Steinbiss <satta@debian.org>
--- a/setup.py
+++ b/setup.py
@@ -29,7 +29,7 @@
requires.append('asyncio(>=3.4)')
if py_version >= (3, 3):
# The example portserver implementation requires Python 3 and asyncio.
- scripts.append('src/portserver.py')
+ scripts.append('src/portserver')
distutils.core.setup(
name='portpicker',
--- /dev/null
+++ b/src/portserver
@@ -0,0 +1,374 @@
+#!/usr/bin/python3
+#
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""A server to hand out network ports to applications running on one host.
+
+Typical usage:
+ 1) Run one instance of this process on each of your unittest farm hosts.
+ 2) Set the PORTSERVER_ADDRESS environment variable in your test runner
+ environment to let the portpicker library know to use a port server
+ rather than attempt to find ports on its own.
+
+$ /path/to/portserver.py &
+$ export PORTSERVER_ADDRESS=@unittest-portserver
+$ # ... launch a bunch of unittest runners using portpicker ...
+"""
+
+import argparse
+import asyncio
+import collections
+import logging
+import os
+import signal
+import socket
+import sys
+
+log = None # Initialized to a logging.Logger by _configure_logging().
+
+_PROTOS = [(socket.SOCK_STREAM, socket.IPPROTO_TCP),
+ (socket.SOCK_DGRAM, socket.IPPROTO_UDP)]
+
+
+def _get_process_command_line(pid):
+ try:
+ with open('/proc/{}/cmdline'.format(pid), 'rt') as cmdline_f:
+ return cmdline_f.read()
+ except IOError:
+ return ''
+
+
+def _get_process_start_time(pid):
+ try:
+ with open('/proc/{}/stat'.format(pid), 'rt') as pid_stat_f:
+ return int(pid_stat_f.readline().split()[21])
+ except IOError:
+ return 0
+
+
+# TODO: Consider importing portpicker.bind() instead of duplicating the code.
+def _bind(port, socket_type, socket_proto):
+ """Try to bind to a socket of the specified type, protocol, and port.
+
+ For the port to be considered available, the kernel must support at least
+ one of (IPv6, IPv4), and the port must be available on each supported
+ family.
+
+ Args:
+ port: The port number to bind to, or 0 to have the OS pick a free port.
+ socket_type: The type of the socket (ex: socket.SOCK_STREAM).
+ socket_proto: The protocol of the socket (ex: socket.IPPROTO_TCP).
+
+ Returns:
+ The port number on success or None on failure.
+ """
+ got_socket = False
+ for family in (socket.AF_INET6, socket.AF_INET):
+ try:
+ sock = socket.socket(family, socket_type, socket_proto)
+ got_socket = True
+ except socket.error:
+ continue
+ try:
+ sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+ sock.bind(('', port))
+ if socket_type == socket.SOCK_STREAM:
+ sock.listen(1)
+ port = sock.getsockname()[1]
+ except socket.error:
+ return None
+ finally:
+ sock.close()
+ return port if got_socket else None
+
+
+def _is_port_free(port):
+ """Check if specified port is free.
+
+ Args:
+ port: integer, port to check
+ Returns:
+ boolean, whether it is free to use for both TCP and UDP
+ """
+ return _bind(port, *_PROTOS[0]) and _bind(port, *_PROTOS[1])
+
+
+def _should_allocate_port(pid):
+ """Determine if we should allocate a port for use by the given process id."""
+ if pid <= 0:
+ log.info('Not allocating a port to invalid pid')
+ return False
+ if pid == 1:
+ # The client probably meant to send us its parent pid but
+ # had been reparented to init.
+ log.info('Not allocating a port to init.')
+ return False
+ try:
+ os.kill(pid, 0)
+ except ProcessLookupError:
+ log.info('Not allocating a port to a non-existent process')
+ return False
+ return True
+
+
+class _PortInfo(object):
+ """Container class for information about a given port assignment.
+
+ Attributes:
+ port: integer port number
+ pid: integer process id or 0 if unassigned.
+ start_time: Time in seconds since the epoch that the process started.
+ """
+
+ __slots__ = ('port', 'pid', 'start_time')
+
+ def __init__(self, port):
+ self.port = port
+ self.pid = 0
+ self.start_time = 0
+
+
+class _PortPool(object):
+ """Manage available ports for processes.
+
+ Ports are reclaimed when the reserving process exits and the reserved port
+ is no longer in use. Only ports which are free for both TCP and UDP will be
+ handed out. It is easier to not differentiate between protocols.
+
+ The pool must be pre-seeded with add_port_to_free_pool() calls
+ after which get_port_for_process() will allocate and reclaim ports.
+ The len() of a _PortPool returns the total number of ports being managed.
+
+ Attributes:
+ ports_checked_for_last_request: The number of ports examined in order to
+ return from the most recent get_port_for_process() request. A high
+ number here likely means the number of available ports with no active
+ process using them is getting low.
+ """
+
+ def __init__(self):
+ self._port_queue = collections.deque()
+ self.ports_checked_for_last_request = 0
+
+ def num_ports(self):
+ return len(self._port_queue)
+
+ def get_port_for_process(self, pid):
+ """Allocates and returns port for pid or 0 if none could be allocated."""
+ if not self._port_queue:
+ raise RuntimeError('No ports being managed.')
+
+ # Avoid an infinite loop if all ports are currently assigned.
+ check_count = 0
+ max_ports_to_test = len(self._port_queue)
+ while check_count < max_ports_to_test:
+ # Get the next candidate port and move it to the back of the queue.
+ candidate = self._port_queue.pop()
+ self._port_queue.appendleft(candidate)
+ check_count += 1
+ if (candidate.start_time == 0 or
+ candidate.start_time != _get_process_start_time(candidate.pid)):
+ if _is_port_free(candidate.port):
+ candidate.pid = pid
+ candidate.start_time = _get_process_start_time(pid)
+ if not candidate.start_time:
+ log.info("Can't read start time for pid %d.", pid)
+ self.ports_checked_for_last_request = check_count
+ return candidate.port
+ else:
+ log.info(
+ 'Port %d unexpectedly in use, last owning pid %d.',
+ candidate.port, candidate.pid)
+
+ log.info('All ports in use.')
+ self.ports_checked_for_last_request = check_count
+ return 0
+
+ def add_port_to_free_pool(self, port):
+ """Add a new port to the free pool for allocation."""
+ if port < 1 or port > 65535:
+ raise ValueError(
+ 'Port must be in the [1, 65535] range, not %d.' % port)
+ port_info = _PortInfo(port=port)
+ self._port_queue.append(port_info)
+
+
+class _PortServerRequestHandler(object):
+ """A class to handle port allocation and status requests.
+
+ Allocates ports to process ids via the dead simple port server protocol
+ when the handle_port_request asyncio.coroutine handler has been registered.
+ Statistics can be logged using the dump_stats method.
+ """
+
+ def __init__(self, ports_to_serve):
+ """Initialize a new port server.
+
+ Args:
+ ports_to_serve: A sequence of unique port numbers to test and offer
+ up to clients.
+ """
+ self._port_pool = _PortPool()
+ self._total_allocations = 0
+ self._denied_allocations = 0
+ self._client_request_errors = 0
+ for port in ports_to_serve:
+ self._port_pool.add_port_to_free_pool(port)
+
+ @asyncio.coroutine
+ def handle_port_request(self, reader, writer):
+ client_data = yield from reader.read(100)
+ self._handle_port_request(client_data, writer)
+ writer.close()
+
+ def _handle_port_request(self, client_data, writer):
+ """Given a port request body, parse it and respond appropriately.
+
+ Args:
+ client_data: The request bytes from the client.
+ writer: The asyncio Writer for the response to be written to.
+ """
+ try:
+ pid = int(client_data)
+ except ValueError as error:
+ self._client_request_errors += 1
+ log.warning('Could not parse request: %s', error)
+ return
+
+ log.info('Request on behalf of pid %d.', pid)
+ log.info('cmdline: %s', _get_process_command_line(pid))
+
+ if not _should_allocate_port(pid):
+ self._denied_allocations += 1
+ return
+
+ port = self._port_pool.get_port_for_process(pid)
+ if port > 0:
+ self._total_allocations += 1
+ writer.write('{:d}\n'.format(port).encode('utf-8'))
+ log.debug('Allocated port %d to pid %d', port, pid)
+ else:
+ self._denied_allocations += 1
+
+ def dump_stats(self):
+ """Logs statistics of our operation."""
+ log.info('Dumping statistics:')
+ stats = []
+ stats.append(
+ 'client-request-errors {}'.format(self._client_request_errors))
+ stats.append('denied-allocations {}'.format(self._denied_allocations))
+ stats.append('num-ports-managed {}'.format(self._port_pool.num_ports()))
+ stats.append('num-ports-checked-for-last-request {}'.format(
+ self._port_pool.ports_checked_for_last_request))
+ stats.append('total-allocations {}'.format(self._total_allocations))
+ for stat in stats:
+ log.info(stat)
+
+
+def _parse_command_line():
+ """Configure and parse our command line flags."""
+ parser = argparse.ArgumentParser()
+ parser.add_argument(
+ '--portserver_static_pool',
+ type=str,
+ default='15000-24999',
+ help='Comma separated N-P Range(s) of ports to manage (inclusive).')
+ parser.add_argument(
+ '--portserver_unix_socket_address',
+ type=str,
+ default='@unittest-portserver',
+ help='Address of AF_UNIX socket on which to listen (first @ is a NUL).')
+ parser.add_argument('--verbose',
+ action='store_true',
+ default=False,
+ help='Enable verbose messages.')
+ parser.add_argument('--debug',
+ action='store_true',
+ default=False,
+ help='Enable full debug messages.')
+ return parser.parse_args(sys.argv[1:])
+
+
+def _parse_port_ranges(pool_str):
+ """Given a 'N-P,X-Y' description of port ranges, return a set of ints."""
+ ports = set()
+ for range_str in pool_str.split(','):
+ try:
+ a, b = range_str.split('-', 1)
+ start, end = int(a), int(b)
+ except ValueError:
+ log.error('Ignoring unparsable port range %r.', range_str)
+ continue
+ if start < 1 or end > 65535:
+ log.error('Ignoring out of bounds port range %r.', range_str)
+ continue
+ ports.update(set(range(start, end + 1)))
+ return ports
+
+
+def _configure_logging(verbose=False, debug=False):
+ """Configure the log global, message format, and verbosity settings."""
+ overall_level = logging.DEBUG if debug else logging.INFO
+ logging.basicConfig(
+ format=('{levelname[0]}{asctime}.{msecs:03.0f} {thread} '
+ '{filename}:{lineno}] {message}'),
+ datefmt='%m%d %H:%M:%S',
+ style='{',
+ level=overall_level)
+ global log
+ log = logging.getLogger('portserver')
+ # The verbosity controls our loggers logging level, not the global
+ # one above. This avoids debug messages from libraries such as asyncio.
+ log.setLevel(logging.DEBUG if verbose else overall_level)
+
+
+def main():
+ config = _parse_command_line()
+ if config.debug:
+ # Equivalent of PYTHONASYNCIODEBUG=1 in 3.4; pylint: disable=protected-access
+ asyncio.tasks._DEBUG = True
+ _configure_logging(verbose=config.verbose, debug=config.debug)
+ ports_to_serve = _parse_port_ranges(config.portserver_static_pool)
+ if not ports_to_serve:
+ log.error('No ports. Invalid port ranges in --portserver_static_pool?')
+ sys.exit(1)
+
+ request_handler = _PortServerRequestHandler(ports_to_serve)
+
+ event_loop = asyncio.get_event_loop()
+ event_loop.add_signal_handler(signal.SIGUSR1, request_handler.dump_stats)
+ coro = asyncio.start_unix_server(
+ request_handler.handle_port_request,
+ path=config.portserver_unix_socket_address.replace('@', '\0', 1),
+ loop=event_loop)
+ server_address = config.portserver_unix_socket_address
+
+ server = event_loop.run_until_complete(coro)
+ log.info('Serving on %s', server_address)
+ try:
+ event_loop.run_forever()
+ except KeyboardInterrupt:
+ log.info('Stopping due to ^C.')
+
+ server.close()
+ event_loop.run_until_complete(server.wait_closed())
+ event_loop.remove_signal_handler(signal.SIGUSR1)
+ event_loop.close()
+ request_handler.dump_stats()
+ log.info('Goodbye.')
+
+
+if __name__ == '__main__':
+ main()
--- a/src/portserver.py
+++ /dev/null
@@ -1,374 +0,0 @@
-#!/usr/bin/python3
-#
-# Copyright 2015 Google Inc. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-"""A server to hand out network ports to applications running on one host.
-
-Typical usage:
- 1) Run one instance of this process on each of your unittest farm hosts.
- 2) Set the PORTSERVER_ADDRESS environment variable in your test runner
- environment to let the portpicker library know to use a port server
- rather than attempt to find ports on its own.
-
-$ /path/to/portserver.py &
-$ export PORTSERVER_ADDRESS=@unittest-portserver
-$ # ... launch a bunch of unittest runners using portpicker ...
-"""
-
-import argparse
-import asyncio
-import collections
-import logging
-import os
-import signal
-import socket
-import sys
-
-log = None # Initialized to a logging.Logger by _configure_logging().
-
-_PROTOS = [(socket.SOCK_STREAM, socket.IPPROTO_TCP),
- (socket.SOCK_DGRAM, socket.IPPROTO_UDP)]
-
-
-def _get_process_command_line(pid):
- try:
- with open('/proc/{}/cmdline'.format(pid), 'rt') as cmdline_f:
- return cmdline_f.read()
- except IOError:
- return ''
-
-
-def _get_process_start_time(pid):
- try:
- with open('/proc/{}/stat'.format(pid), 'rt') as pid_stat_f:
- return int(pid_stat_f.readline().split()[21])
- except IOError:
- return 0
-
-
-# TODO: Consider importing portpicker.bind() instead of duplicating the code.
-def _bind(port, socket_type, socket_proto):
- """Try to bind to a socket of the specified type, protocol, and port.
-
- For the port to be considered available, the kernel must support at least
- one of (IPv6, IPv4), and the port must be available on each supported
- family.
-
- Args:
- port: The port number to bind to, or 0 to have the OS pick a free port.
- socket_type: The type of the socket (ex: socket.SOCK_STREAM).
- socket_proto: The protocol of the socket (ex: socket.IPPROTO_TCP).
-
- Returns:
- The port number on success or None on failure.
- """
- got_socket = False
- for family in (socket.AF_INET6, socket.AF_INET):
- try:
- sock = socket.socket(family, socket_type, socket_proto)
- got_socket = True
- except socket.error:
- continue
- try:
- sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
- sock.bind(('', port))
- if socket_type == socket.SOCK_STREAM:
- sock.listen(1)
- port = sock.getsockname()[1]
- except socket.error:
- return None
- finally:
- sock.close()
- return port if got_socket else None
-
-
-def _is_port_free(port):
- """Check if specified port is free.
-
- Args:
- port: integer, port to check
- Returns:
- boolean, whether it is free to use for both TCP and UDP
- """
- return _bind(port, *_PROTOS[0]) and _bind(port, *_PROTOS[1])
-
-
-def _should_allocate_port(pid):
- """Determine if we should allocate a port for use by the given process id."""
- if pid <= 0:
- log.info('Not allocating a port to invalid pid')
- return False
- if pid == 1:
- # The client probably meant to send us its parent pid but
- # had been reparented to init.
- log.info('Not allocating a port to init.')
- return False
- try:
- os.kill(pid, 0)
- except ProcessLookupError:
- log.info('Not allocating a port to a non-existent process')
- return False
- return True
-
-
-class _PortInfo(object):
- """Container class for information about a given port assignment.
-
- Attributes:
- port: integer port number
- pid: integer process id or 0 if unassigned.
- start_time: Time in seconds since the epoch that the process started.
- """
-
- __slots__ = ('port', 'pid', 'start_time')
-
- def __init__(self, port):
- self.port = port
- self.pid = 0
- self.start_time = 0
-
-
-class _PortPool(object):
- """Manage available ports for processes.
-
- Ports are reclaimed when the reserving process exits and the reserved port
- is no longer in use. Only ports which are free for both TCP and UDP will be
- handed out. It is easier to not differentiate between protocols.
-
- The pool must be pre-seeded with add_port_to_free_pool() calls
- after which get_port_for_process() will allocate and reclaim ports.
- The len() of a _PortPool returns the total number of ports being managed.
-
- Attributes:
- ports_checked_for_last_request: The number of ports examined in order to
- return from the most recent get_port_for_process() request. A high
- number here likely means the number of available ports with no active
- process using them is getting low.
- """
-
- def __init__(self):
- self._port_queue = collections.deque()
- self.ports_checked_for_last_request = 0
-
- def num_ports(self):
- return len(self._port_queue)
-
- def get_port_for_process(self, pid):
- """Allocates and returns port for pid or 0 if none could be allocated."""
- if not self._port_queue:
- raise RuntimeError('No ports being managed.')
-
- # Avoid an infinite loop if all ports are currently assigned.
- check_count = 0
- max_ports_to_test = len(self._port_queue)
- while check_count < max_ports_to_test:
- # Get the next candidate port and move it to the back of the queue.
- candidate = self._port_queue.pop()
- self._port_queue.appendleft(candidate)
- check_count += 1
- if (candidate.start_time == 0 or
- candidate.start_time != _get_process_start_time(candidate.pid)):
- if _is_port_free(candidate.port):
- candidate.pid = pid
- candidate.start_time = _get_process_start_time(pid)
- if not candidate.start_time:
- log.info("Can't read start time for pid %d.", pid)
- self.ports_checked_for_last_request = check_count
- return candidate.port
- else:
- log.info(
- 'Port %d unexpectedly in use, last owning pid %d.',
- candidate.port, candidate.pid)
-
- log.info('All ports in use.')
- self.ports_checked_for_last_request = check_count
- return 0
-
- def add_port_to_free_pool(self, port):
- """Add a new port to the free pool for allocation."""
- if port < 1 or port > 65535:
- raise ValueError(
- 'Port must be in the [1, 65535] range, not %d.' % port)
- port_info = _PortInfo(port=port)
- self._port_queue.append(port_info)
-
-
-class _PortServerRequestHandler(object):
- """A class to handle port allocation and status requests.
-
- Allocates ports to process ids via the dead simple port server protocol
- when the handle_port_request asyncio.coroutine handler has been registered.
- Statistics can be logged using the dump_stats method.
- """
-
- def __init__(self, ports_to_serve):
- """Initialize a new port server.
-
- Args:
- ports_to_serve: A sequence of unique port numbers to test and offer
- up to clients.
- """
- self._port_pool = _PortPool()
- self._total_allocations = 0
- self._denied_allocations = 0
- self._client_request_errors = 0
- for port in ports_to_serve:
- self._port_pool.add_port_to_free_pool(port)
-
- @asyncio.coroutine
- def handle_port_request(self, reader, writer):
- client_data = yield from reader.read(100)
- self._handle_port_request(client_data, writer)
- writer.close()
-
- def _handle_port_request(self, client_data, writer):
- """Given a port request body, parse it and respond appropriately.
-
- Args:
- client_data: The request bytes from the client.
- writer: The asyncio Writer for the response to be written to.
- """
- try:
- pid = int(client_data)
- except ValueError as error:
- self._client_request_errors += 1
- log.warning('Could not parse request: %s', error)
- return
-
- log.info('Request on behalf of pid %d.', pid)
- log.info('cmdline: %s', _get_process_command_line(pid))
-
- if not _should_allocate_port(pid):
- self._denied_allocations += 1
- return
-
- port = self._port_pool.get_port_for_process(pid)
- if port > 0:
- self._total_allocations += 1
- writer.write('{:d}\n'.format(port).encode('utf-8'))
- log.debug('Allocated port %d to pid %d', port, pid)
- else:
- self._denied_allocations += 1
-
- def dump_stats(self):
- """Logs statistics of our operation."""
- log.info('Dumping statistics:')
- stats = []
- stats.append(
- 'client-request-errors {}'.format(self._client_request_errors))
- stats.append('denied-allocations {}'.format(self._denied_allocations))
- stats.append('num-ports-managed {}'.format(self._port_pool.num_ports()))
- stats.append('num-ports-checked-for-last-request {}'.format(
- self._port_pool.ports_checked_for_last_request))
- stats.append('total-allocations {}'.format(self._total_allocations))
- for stat in stats:
- log.info(stat)
-
-
-def _parse_command_line():
- """Configure and parse our command line flags."""
- parser = argparse.ArgumentParser()
- parser.add_argument(
- '--portserver_static_pool',
- type=str,
- default='15000-24999',
- help='Comma separated N-P Range(s) of ports to manage (inclusive).')
- parser.add_argument(
- '--portserver_unix_socket_address',
- type=str,
- default='@unittest-portserver',
- help='Address of AF_UNIX socket on which to listen (first @ is a NUL).')
- parser.add_argument('--verbose',
- action='store_true',
- default=False,
- help='Enable verbose messages.')
- parser.add_argument('--debug',
- action='store_true',
- default=False,
- help='Enable full debug messages.')
- return parser.parse_args(sys.argv[1:])
-
-
-def _parse_port_ranges(pool_str):
- """Given a 'N-P,X-Y' description of port ranges, return a set of ints."""
- ports = set()
- for range_str in pool_str.split(','):
- try:
- a, b = range_str.split('-', 1)
- start, end = int(a), int(b)
- except ValueError:
- log.error('Ignoring unparsable port range %r.', range_str)
- continue
- if start < 1 or end > 65535:
- log.error('Ignoring out of bounds port range %r.', range_str)
- continue
- ports.update(set(range(start, end + 1)))
- return ports
-
-
-def _configure_logging(verbose=False, debug=False):
- """Configure the log global, message format, and verbosity settings."""
- overall_level = logging.DEBUG if debug else logging.INFO
- logging.basicConfig(
- format=('{levelname[0]}{asctime}.{msecs:03.0f} {thread} '
- '{filename}:{lineno}] {message}'),
- datefmt='%m%d %H:%M:%S',
- style='{',
- level=overall_level)
- global log
- log = logging.getLogger('portserver')
- # The verbosity controls our loggers logging level, not the global
- # one above. This avoids debug messages from libraries such as asyncio.
- log.setLevel(logging.DEBUG if verbose else overall_level)
-
-
-def main():
- config = _parse_command_line()
- if config.debug:
- # Equivalent of PYTHONASYNCIODEBUG=1 in 3.4; pylint: disable=protected-access
- asyncio.tasks._DEBUG = True
- _configure_logging(verbose=config.verbose, debug=config.debug)
- ports_to_serve = _parse_port_ranges(config.portserver_static_pool)
- if not ports_to_serve:
- log.error('No ports. Invalid port ranges in --portserver_static_pool?')
- sys.exit(1)
-
- request_handler = _PortServerRequestHandler(ports_to_serve)
-
- event_loop = asyncio.get_event_loop()
- event_loop.add_signal_handler(signal.SIGUSR1, request_handler.dump_stats)
- coro = asyncio.start_unix_server(
- request_handler.handle_port_request,
- path=config.portserver_unix_socket_address.replace('@', '\0', 1),
- loop=event_loop)
- server_address = config.portserver_unix_socket_address
-
- server = event_loop.run_until_complete(coro)
- log.info('Serving on %s', server_address)
- try:
- event_loop.run_forever()
- except KeyboardInterrupt:
- log.info('Stopping due to ^C.')
-
- server.close()
- event_loop.run_until_complete(server.wait_closed())
- event_loop.remove_signal_handler(signal.SIGUSR1)
- event_loop.close()
- request_handler.dump_stats()
- log.info('Goodbye.')
-
-
-if __name__ == '__main__':
- main()
|