<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[11995] CalendarServer/trunk</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/11995">11995</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2013-11-22 12:28:07 -0800 (Fri, 22 Nov 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>New master/child application services.</pre>
<h3>Added Paths</h3>
<ul>
<li>CalendarServer/trunk/twext/application/</li>
<li><a href="#CalendarServertrunktwextapplication__init__py">CalendarServer/trunk/twext/application/__init__.py</a></li>
<li><a href="#CalendarServertrunktwextapplicationmasterchildpy">CalendarServer/trunk/twext/application/masterchild.py</a></li>
<li><a href="#CalendarServertrunktwistedpluginsmasterchildpy">CalendarServer/trunk/twisted/plugins/masterchild.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunktwextapplication__init__py"></a>
<div class="addfile"><h4>Added: CalendarServer/trunk/twext/application/__init__.py (0 => 11995)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/application/__init__.py (rev 0)
+++ CalendarServer/trunk/twext/application/__init__.py 2013-11-22 20:28:07 UTC (rev 11995)
</span><span class="lines">@@ -0,0 +1,19 @@
</span><ins>+##
+# Copyright (c) 2013 Apple 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.
+##
+
+"""
+TAP files
+"""
</ins></span></pre></div>
<a id="CalendarServertrunktwextapplicationmasterchildpy"></a>
<div class="addfile"><h4>Added: CalendarServer/trunk/twext/application/masterchild.py (0 => 11995)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/application/masterchild.py (rev 0)
+++ CalendarServer/trunk/twext/application/masterchild.py 2013-11-22 20:28:07 UTC (rev 11995)
</span><span class="lines">@@ -0,0 +1,285 @@
</span><ins>+##
+# Copyright (c) 2013 Apple 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.
+##
+
+"""
+Application container
+"""
+
+import sys
+from collections import namedtuple
+
+from zope.interface import implementer
+
+from twisted.python.sendmsg import getsockfam
+from twisted.python.usage import Options, UsageError
+from twisted.application.service import MultiService, Service
+from twisted.application.service import IServiceMaker
+from twisted.application.internet import TCPServer
+from twisted.protocols.policies import WrappingFactory, ProtocolWrapper
+
+from twisted.internet.protocol import ProcessProtocol
+from twext.internet.sendfdport import InheritingProtocolFactory
+from twext.internet.sendfdport import InheritedSocketDispatcher
+from twext.internet.sendfdport import IStatusWatcher
+from twext.internet.sendfdport import InheritedPort
+
+
+
+class MasterOptions (Options):
+ optParameters = [[
+ #"config", "f", DEFAULT_CONFIG_FILE, "Path to configuration file."
+ ]]
+
+ # def __init__(self, *args, **kwargs):
+ # super(Options, self).__init__(*args, **kwargs)
+
+
+
+@implementer(IServiceMaker)
+class MasterServiceMaker(object):
+ def makeService(self, options):
+ service = MultiService()
+
+ port = 8000
+
+ # Dispatcher
+ statusWatcher = StatusWatcher()
+ dispatcher = InheritedSocketDispatcher(statusWatcher)
+
+ # Child Processes
+ spawningService = ChildSpawningService(dispatcher)
+ spawningService.setServiceParent(service)
+
+ # TCP Service
+ description = b"" # UserInfo sent to the dispatcher
+ tcpFactory = InheritingProtocolFactory(dispatcher, description)
+ tcpService = TCPServer(port, tcpFactory)
+
+ tcpService.setServiceParent(service)
+
+ return service
+
+
+#########
+# Subclass InheritingProtocolFactory
+# override sendSocket to decide when to spawn a child
+
+
+# @implementer(IServiceMaker)
+# class ChildSpawningServiceMaker(object):
+# def makeService(self, options):
+# service = ChildSpawningService(args)
+# return service
+
+
+
+class ChildSpawningService(Service, object):
+ def __init__(self, dispatcher, maxProcessCount=8):
+ self.dispatcher = dispatcher
+ self.maxProcessCount = maxProcessCount
+
+
+ def startService(self):
+ assert not hasattr(self, "children")
+
+ self.children = set()
+
+
+ def stopService(self):
+ del(self.children)
+
+
+ def spawnChild(self, arguments):
+ from twisted.internet import reactor
+
+ inheritedSocket = self.dispatcher.addSocket()
+ inheritedFD = inheritedSocket.fileno()
+
+ processProtocol = ChildProcessProtocol(self, inheritedSocket)
+
+ reactor.spawnProcess(
+ processProtocol,
+ sys.executable,
+ args=(
+ sys.executable, b"-c",
+ b"from twisted.scripts.twistd import run; run()",
+ b"--inherited-fd", b"3",
+ ) + tuple(arguments),
+ env={},
+ childFDs={0: b"w", 1: b"r", 2: b"r", 3: inheritedFD}
+ )
+
+ self.children.add(processProtocol)
+
+
+ def childDidExit(self, child):
+ self.children.remove(child)
+ self.dispatcher.removeSocket(child.inheritedSocket)
+
+
+
+class ChildProcessProtocol(ProcessProtocol, object):
+ def __init__(self, service, inheritedSocket):
+ self.service = service
+ self.inheritedSocket = inheritedSocket
+
+
+ def outReceived(self, data):
+ super(ChildProcessProtocol, self).outReceived(data)
+ # FIXME: log...
+
+
+ def errReceived(self, data):
+ super(ChildProcessProtocol, self).errReceived(data)
+ # FIXME: log...
+
+
+ def processExited(self, reason):
+ self.service.childDidExit(self)
+
+
+
+class ChildOptions (Options):
+ def opt_inherited_fd(self, value):
+ """
+ Inherited file descriptor
+ """
+ try:
+ try:
+ fd = int(value)
+ except ValueError:
+ raise ValueError("not an integer")
+
+ if fd < 0:
+ raise ValueError("must be >=0")
+ except ValueError as e:
+ raise UsageError(
+ "Invalid file descriptor {0!r}: {1}".format(value, e)
+ )
+
+ self["inherited-fd"] = fd
+
+
+ def postOptions(self):
+ if "inherited-fd" not in self:
+ raise UsageError("inherited-fd paramater is required")
+
+
+
+@implementer(IServiceMaker)
+class ChildServiceMaker(object):
+ def makeService(self, options):
+ service = ChildService(options["inherited-fd"], self.protocolFactory)
+ return service
+
+
+
+class ChildService(Service, object):
+ def __init__(self, fd, protocolFactory):
+ self.fd = fd
+ self.protocolFactory = protocolFactory
+
+
+ def startService(self):
+ self.wrappedProtocolFactory = ReportingWrapperFactory(
+ self.protocolFactory, self.fd, self.createTransport
+ )
+ return super(ChildService, self).startService()
+
+
+ def stopService(self):
+ return super(ChildService, self).stopService()
+
+
+ def createTransport(self, socket, peer, data, protocol):
+ """
+ Create a TCP transport from a socket object passed by the parent.
+ """
+ from twisted.internet import reactor
+
+ self.wrappedFactory.inheritedPort.reportStatus("+")
+
+ socketFD = socket.fileno()
+ return reactor.adoptStreamConnection(
+ socketFD, getsockfam(socketFD), self.wrappedProtocolFactory
+ )
+
+
+
+class ReportingProtocolWrapper(ProtocolWrapper, object):
+ def connectionLost(self, reason):
+ self.factory.inheritedPort.reportStatus("-")
+ return super(ReportingProtocolWrapper, self).connectionLost(reason)
+
+
+
+class ReportingWrapperFactory(WrappingFactory):
+ protocol = ReportingProtocolWrapper
+
+ def __init__(self, wrappedFactory, fd, createTransport):
+ self.inheritedPort = InheritedPort(fd, createTransport, self)
+ super(ReportingWrapperFactory, self).__init__(wrappedFactory)
+
+
+
+@implementer(IStatusWatcher)
+class StatusWatcher(object):
+ """
+ This enabled the dispatcher to keep track of how many connections are in
+ flight for each child.
+ """
+ @staticmethod
+ def initialStatus():
+ return Status(sentCount=0, ackedCount=0)
+
+ @staticmethod
+ def newConnectionStatus(previousStatus):
+ return Status(
+ sentCount=previousStatus.sentCount + 1,
+ ackedCount=previousStatus.ackedCount,
+ )
+
+ @staticmethod
+ def statusFromMessage(previousStatus, message):
+ if message == b"-":
+ return Status(
+ sentCount=previousStatus.sentCount - 1,
+ ackedCount=previousStatus.ackedCount,
+ )
+ elif message == b"+":
+ return Status(
+ sentCount=previousStatus.sentCount,
+ ackedCount=previousStatus.ackedCount + 1,
+ )
+ else:
+ raise AssertionError("Unknown message: {}".format(message))
+
+ @staticmethod
+ def closeCountFromStatus(previousStatus):
+ return (
+ previousStatus.ackedCount,
+ Status(
+ sentCount=previousStatus.sentCount,
+ ackedCount=0,
+ )
+ )
+
+
+
+Status = namedtuple(
+ "Status",
+ ("sentCount", "ackedCount")
+)
</ins></span></pre></div>
<a id="CalendarServertrunktwistedpluginsmasterchildpy"></a>
<div class="addfile"><h4>Added: CalendarServer/trunk/twisted/plugins/masterchild.py (0 => 11995)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twisted/plugins/masterchild.py (rev 0)
+++ CalendarServer/trunk/twisted/plugins/masterchild.py 2013-11-22 20:28:07 UTC (rev 11995)
</span><span class="lines">@@ -0,0 +1,56 @@
</span><ins>+##
+# Copyright (c) 2010-2013 Apple 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.
+##
+
+from zope.interface import implementer
+from twisted.python import reflect
+from twisted.plugin import IPlugin
+from twisted.application.service import IServiceMaker
+from twext.application.masterchild import MasterOptions, ChildOptions
+
+
+@implementer(IPlugin, IServiceMaker)
+class ServiceMaker(object):
+ def __init__(self, name, description, options, serviceMakerClass):
+ self.tapname = name
+ self.description = description
+ self.options = options
+ self.serviceMakerClass = serviceMakerClass
+ self._serviceMaker = None
+
+
+ def makeService(self, options):
+ if self._serviceMaker is None:
+ self._serviceMaker = reflect.namedClass(self.serviceMakerClass)()
+
+ return self._serviceMaker.makeService(options)
+
+
+
+masterServiceMaker = ServiceMaker(
+ "master",
+ "Master process application container",
+ MasterOptions,
+ "twext.application.masterchild.MasterServiceMaker"
+)
+
+
+
+childServiceMaker = ServiceMaker(
+ "child",
+ "Child process application container",
+ ChildOptions,
+ "twext.application.masterchild.ChildServiceMaker"
+)
</ins></span></pre>
</div>
</div>
</body>
</html>