android_frameworks_base/services/common_time/common_clock_service.cpp
John Grossman 354edbc80e Implement new common_time service functionality.
Major re-factor of the common_time (formally aah_timesrv) service in
preparation for up-integration into Android master.  This work
includes bug fixes, new features, and general code cleanup.  High
points are listed below.

+ CommonClock interface has been enhanced to allow querying of many
  more low level synchronization details; mostly for debugging, but in
  theory useful to an application as well.
+ CommonTimeConfig interface has been implemented.  This allows a
  management process to configure a number of different parameters
  (many of them new) to control the behavior of the common_time
  service.  Most importantly, the time service can be bound to a
  specific network interface and should only operate on that interface
  an no others.
+ Enhance log messages to be more useful in determining what the time
  service state machine is doing and why.
+ Enhance information provided by dumpsys to provide many more details
  about the quality of time sync and the network conditions which gave
  rise to the current quality conditions.

Features, features, features....
+ Add a feature which lets the high level choose a different master
  election endpoint so that multiple time synchronization domains can
  co-exist on the same subnet (mostly to support a potential use case
  of multiple home domains in a multiple dwelling environment like a
  hotel, dormitory or apartment complex).
+ Add a feature which lets the high level assign a 64-bit group ID
  which allows partitioning of time synchronization domains even when
  the master election endpoint is shared (as it might be if broadcast
  is being used instead of multicast)
+ Add an auto-disable feature which lets the time service drop into
  network-less mode when there are no active clients of the
  common_time service in the device.  Mostly for phones, this allows
  phones to not consume network/battery resources when they don't need
  to maintain common time.
+ Add a feature which lets the high level choose the priority of the
  common_time service in the master election protocol.  This allows
  high level decisions about things like mobile vs non-mobile, wired
  ethernet vs WiFi to affect who ends up with the job of master on a
  given network.  Priority overrides at the low level also allow
  clients coming in from network-less mode to lower their effective
  priority as they join a new network so as to not disrupt any
  stable long-running timeline which may already be active on the
  network.
+ Add the ability to control some of the core parameters of the time
  sync service which effect network load (like the sync polling
  interval and the master announce interval)

Change-Id: I71af15a83cfa5ef0417b406928967fb9e02f55c6
2012-02-06 18:02:32 -08:00

158 lines
4.9 KiB
C++

/*
* Copyright (C) 2011 The Android Open Source Project
*
* 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.
*/
#include <common_time/local_clock.h>
#include <utils/String8.h>
#include "common_clock_service.h"
#include "common_clock.h"
#include "common_time_server.h"
namespace android {
sp<CommonClockService> CommonClockService::instantiate(
CommonTimeServer& timeServer) {
sp<CommonClockService> tcc = new CommonClockService(timeServer);
if (tcc == NULL)
return NULL;
defaultServiceManager()->addService(ICommonClock::kServiceName, tcc);
return tcc;
}
status_t CommonClockService::dump(int fd, const Vector<String16>& args) {
Mutex::Autolock lock(mRegistrationLock);
return mTimeServer.dumpClockInterface(fd, args, mListeners.size());
}
status_t CommonClockService::isCommonTimeValid(bool* valid,
uint32_t* timelineID) {
return mTimeServer.isCommonTimeValid(valid, timelineID);
}
status_t CommonClockService::commonTimeToLocalTime(int64_t commonTime,
int64_t* localTime) {
return mTimeServer.getCommonClock().commonToLocal(commonTime, localTime);
}
status_t CommonClockService::localTimeToCommonTime(int64_t localTime,
int64_t* commonTime) {
return mTimeServer.getCommonClock().localToCommon(localTime, commonTime);
}
status_t CommonClockService::getCommonTime(int64_t* commonTime) {
return localTimeToCommonTime(mTimeServer.getLocalClock().getLocalTime(), commonTime);
}
status_t CommonClockService::getCommonFreq(uint64_t* freq) {
*freq = mTimeServer.getCommonClock().getCommonFreq();
return OK;
}
status_t CommonClockService::getLocalTime(int64_t* localTime) {
*localTime = mTimeServer.getLocalClock().getLocalTime();
return OK;
}
status_t CommonClockService::getLocalFreq(uint64_t* freq) {
*freq = mTimeServer.getLocalClock().getLocalFreq();
return OK;
}
status_t CommonClockService::getEstimatedError(int32_t* estimate) {
*estimate = mTimeServer.getEstimatedError();
return OK;
}
status_t CommonClockService::getTimelineID(uint64_t* id) {
*id = mTimeServer.getTimelineID();
return OK;
}
status_t CommonClockService::getState(State* state) {
*state = mTimeServer.getState();
return OK;
}
status_t CommonClockService::getMasterAddr(struct sockaddr_storage* addr) {
return mTimeServer.getMasterAddr(addr);
}
status_t CommonClockService::registerListener(
const sp<ICommonClockListener>& listener) {
Mutex::Autolock lock(mRegistrationLock);
{ // scoping for autolock pattern
Mutex::Autolock lock(mCallbackLock);
// check whether this is a duplicate
for (size_t i = 0; i < mListeners.size(); i++) {
if (mListeners[i]->asBinder() == listener->asBinder())
return ALREADY_EXISTS;
}
}
mListeners.add(listener);
mTimeServer.reevaluateAutoDisableState(0 != mListeners.size());
return listener->asBinder()->linkToDeath(this);
}
status_t CommonClockService::unregisterListener(
const sp<ICommonClockListener>& listener) {
Mutex::Autolock lock(mRegistrationLock);
status_t ret_val = NAME_NOT_FOUND;
{ // scoping for autolock pattern
Mutex::Autolock lock(mCallbackLock);
for (size_t i = 0; i < mListeners.size(); i++) {
if (mListeners[i]->asBinder() == listener->asBinder()) {
mListeners[i]->asBinder()->unlinkToDeath(this);
mListeners.removeAt(i);
ret_val = OK;
break;
}
}
}
mTimeServer.reevaluateAutoDisableState(0 != mListeners.size());
return ret_val;
}
void CommonClockService::binderDied(const wp<IBinder>& who) {
Mutex::Autolock lock(mRegistrationLock);
{ // scoping for autolock pattern
Mutex::Autolock lock(mCallbackLock);
for (size_t i = 0; i < mListeners.size(); i++) {
if (mListeners[i]->asBinder() == who) {
mListeners.removeAt(i);
break;
}
}
}
mTimeServer.reevaluateAutoDisableState(0 != mListeners.size());
}
void CommonClockService::notifyOnTimelineChanged(uint64_t timelineID) {
Mutex::Autolock lock(mCallbackLock);
for (size_t i = 0; i < mListeners.size(); i++) {
mListeners[i]->onTimelineChanged(timelineID);
}
}
}; // namespace android