third_party/WebKit/Source/platform/fonts/FontCache.cpp

/*
 * Copyright (C) 2006, 2008 Apple Inc. All rights reserved.
 * Copyright (C) 2007 Nicholas Shanks <webkit@nickshanks.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "platform/fonts/FontCache.h"

#include "base/trace_event/process_memory_dump.h"
#include "platform/FontFamilyNames.h"
#include "platform/Histogram.h"
#include "platform/RuntimeEnabledFeatures.h"
#include "platform/fonts/AcceptLanguagesResolver.h"
#include "platform/fonts/AlternateFontFamily.h"
#include "platform/fonts/FontCacheClient.h"
#include "platform/fonts/FontCacheKey.h"
#include "platform/fonts/FontDataCache.h"
#include "platform/fonts/FontDescription.h"
#include "platform/fonts/FontPlatformData.h"
#include "platform/fonts/FontSmoothingMode.h"
#include "platform/fonts/SimpleFontData.h"
#include "platform/fonts/TextRenderingMode.h"
#include "platform/fonts/opentype/OpenTypeVerticalData.h"
#include "platform/fonts/shaping/ShapeCache.h"
#include "platform/tracing/web_memory_allocator_dump.h"
#include "platform/tracing/web_process_memory_dump.h"
#include "public/platform/Platform.h"
#include "wtf/HashMap.h"
#include "wtf/ListHashSet.h"
#include "wtf/PtrUtil.h"
#include "wtf/StdLibExtras.h"
#include "wtf/Vector.h"
#include "wtf/text/AtomicStringHash.h"
#include "wtf/text/StringHash.h"
#include <memory>

using namespace WTF;

namespace blink {

#if !OS(WIN) && !OS(LINUX)
FontCache::FontCache() : m_purgePreventCount(0), m_fontManager(nullptr) {}
#endif  // !OS(WIN) && !OS(LINUX)

typedef HashMap<unsigned,
                std::unique_ptr<FontPlatformData>,
                WTF::IntHash<unsigned>,
                WTF::UnsignedWithZeroKeyHashTraits<unsigned>>
    SizedFontPlatformDataSet;
typedef HashMap<FontCacheKey,
                SizedFontPlatformDataSet,
                FontCacheKeyHash,
                FontCacheKeyTraits>
    FontPlatformDataCache;
typedef HashMap<FallbackListCompositeKey,
                std::unique_ptr<ShapeCache>,
                FallbackListCompositeKeyHash,
                FallbackListCompositeKeyTraits>
    FallbackListShaperCache;

static FontPlatformDataCache* gFontPlatformDataCache = nullptr;
static FallbackListShaperCache* gFallbackListShaperCache = nullptr;

SkFontMgr* FontCache::s_staticFontManager = nullptr;

#if OS(WIN)
bool FontCache::s_antialiasedTextEnabled = false;
bool FontCache::s_lcdTextEnabled = false;
float FontCache::s_deviceScaleFactor = 1.0;
bool FontCache::s_useSkiaFontFallback = false;
#endif  // OS(WIN)

FontCache* FontCache::fontCache() {
  DEFINE_STATIC_LOCAL(FontCache, globalFontCache, ());
  return &globalFontCache;
}

#if !OS(MACOSX)
FontPlatformData* FontCache::systemFontPlatformData(
    const FontDescription& fontDescription) {
  const AtomicString& family = FontCache::systemFontFamily();
#if OS(LINUX)
  if (family.isEmpty() || family == FontFamilyNames::system_ui)
    return nullptr;
#else
  DCHECK(!family.isEmpty() && family != FontFamilyNames::system_ui);
#endif
  return getFontPlatformData(fontDescription, FontFaceCreationParams(family),
                             true);
}
#endif

FontPlatformData* FontCache::getFontPlatformData(
    const FontDescription& fontDescription,
    const FontFaceCreationParams& creationParams,
    bool checkingAlternateName) {
  if (!gFontPlatformDataCache) {
    gFontPlatformDataCache = new FontPlatformDataCache;
    platformInit();
  }

#if !OS(MACOSX)
  if (creationParams.creationType() == CreateFontByFamily &&
      creationParams.family() == FontFamilyNames::system_ui) {
    return systemFontPlatformData(fontDescription);
  }
#endif

  float size = fontDescription.effectiveFontSize();
  unsigned roundedSize = size * FontCacheKey::precisionMultiplier();
  FontCacheKey key = fontDescription.cacheKey(creationParams);

  // Remove the font size from the cache key, and handle the font size
  // separately in the inner HashMap. So that different size of FontPlatformData
  // can share underlying SkTypeface.
  if (RuntimeEnabledFeatures::fontCacheScalingEnabled())
    key.clearFontSize();

  FontPlatformData* result;
  bool foundResult;

  {
    // addResult's scope must end before we recurse for alternate family names
    // below, to avoid trigering its dtor hash-changed asserts.
    SizedFontPlatformDataSet* sizedFonts =
        &gFontPlatformDataCache->add(key, SizedFontPlatformDataSet())
             .storedValue->value;
    bool wasEmpty = sizedFonts->isEmpty();

    // Take a different size instance of the same font before adding an entry to
    // |sizedFont|.
    FontPlatformData* anotherSize =
        wasEmpty ? nullptr : sizedFonts->begin()->value.get();
    auto addResult = sizedFonts->add(roundedSize, nullptr);
    std::unique_ptr<FontPlatformData>* found = &addResult.storedValue->value;
    if (addResult.isNewEntry) {
      if (wasEmpty)
        *found = createFontPlatformData(fontDescription, creationParams, size);
      else if (anotherSize)
        *found = scaleFontPlatformData(*anotherSize, fontDescription,
                                       creationParams, size);
    }

    result = found->get();
    foundResult = result || !addResult.isNewEntry;
  }

  if (!foundResult && !checkingAlternateName &&
      creationParams.creationType() == CreateFontByFamily) {
    // We were unable to find a font. We have a small set of fonts that we alias
    // to other names, e.g., Arial/Helvetica, Courier/Courier New, etc. Try
    // looking up the font under the aliased name.
    const AtomicString& alternateName =
        alternateFamilyName(creationParams.family());
    if (!alternateName.isEmpty()) {
      FontFaceCreationParams createByAlternateFamily(alternateName);
      result =
          getFontPlatformData(fontDescription, createByAlternateFamily, true);
    }
    if (result) {
      // Cache the result under the old name.
      auto adding =
          &gFontPlatformDataCache->add(key, SizedFontPlatformDataSet())
               .storedValue->value;
      adding->set(roundedSize, wrapUnique(new FontPlatformData(*result)));
    }
  }

  return result;
}

std::unique_ptr<FontPlatformData> FontCache::scaleFontPlatformData(
    const FontPlatformData& fontPlatformData,
    const FontDescription& fontDescription,
    const FontFaceCreationParams& creationParams,
    float fontSize) {
#if OS(MACOSX)
  return createFontPlatformData(fontDescription, creationParams, fontSize);
#else
  return wrapUnique(new FontPlatformData(fontPlatformData, fontSize));
#endif
}

ShapeCache* FontCache::getShapeCache(const FallbackListCompositeKey& key) {
  if (!gFallbackListShaperCache)
    gFallbackListShaperCache = new FallbackListShaperCache;

  FallbackListShaperCache::iterator it = gFallbackListShaperCache->find(key);
  ShapeCache* result = nullptr;
  if (it == gFallbackListShaperCache->end()) {
    result = new ShapeCache();
    gFallbackListShaperCache->set(key, wrapUnique(result));
  } else {
    result = it->value.get();
  }

  ASSERT(result);
  return result;
}

typedef HashMap<FontCache::FontFileKey,
                RefPtr<OpenTypeVerticalData>,
                IntHash<FontCache::FontFileKey>,
                UnsignedWithZeroKeyHashTraits<FontCache::FontFileKey>>
    FontVerticalDataCache;

FontVerticalDataCache& fontVerticalDataCacheInstance() {
  DEFINE_STATIC_LOCAL(FontVerticalDataCache, fontVerticalDataCache, ());
  return fontVerticalDataCache;
}

void FontCache::setFontManager(const sk_sp<SkFontMgr>& fontManager) {
  DCHECK(!s_staticFontManager);
  s_staticFontManager = fontManager.get();
  // Explicitly AddRef since we're going to hold on to the object for the life
  // of the program.
  s_staticFontManager->ref();
}

PassRefPtr<OpenTypeVerticalData> FontCache::getVerticalData(
    const FontFileKey& key,
    const FontPlatformData& platformData) {
  FontVerticalDataCache& fontVerticalDataCache =
      fontVerticalDataCacheInstance();
  FontVerticalDataCache::iterator result = fontVerticalDataCache.find(key);
  if (result != fontVerticalDataCache.end())
    return result.get()->value;

  RefPtr<OpenTypeVerticalData> verticalData =
      OpenTypeVerticalData::create(platformData);
  if (!verticalData->isOpenType())
    verticalData.clear();
  fontVerticalDataCache.set(key, verticalData);
  return verticalData;
}

void FontCache::acceptLanguagesChanged(const String& acceptLanguages) {
  AcceptLanguagesResolver::acceptLanguagesChanged(acceptLanguages);
}

static FontDataCache* gFontDataCache = 0;

PassRefPtr<SimpleFontData> FontCache::getFontData(
    const FontDescription& fontDescription,
    const AtomicString& family,
    bool checkingAlternateName,
    ShouldRetain shouldRetain) {
  if (FontPlatformData* platformData = getFontPlatformData(
          fontDescription, FontFaceCreationParams(
                               adjustFamilyNameToAvoidUnsupportedFonts(family)),
          checkingAlternateName)) {
    return fontDataFromFontPlatformData(
        platformData, shouldRetain, fontDescription.subpixelAscentDescent());
  }

  return nullptr;
}

PassRefPtr<SimpleFontData> FontCache::fontDataFromFontPlatformData(
    const FontPlatformData* platformData,
    ShouldRetain shouldRetain,
    bool subpixelAscentDescent) {
  if (!gFontDataCache)
    gFontDataCache = new FontDataCache;

#if ENABLE(ASSERT)
  if (shouldRetain == DoNotRetain)
    ASSERT(m_purgePreventCount);
#endif

  return gFontDataCache->get(platformData, shouldRetain, subpixelAscentDescent);
}

bool FontCache::isPlatformFontAvailable(const FontDescription& fontDescription,
                                        const AtomicString& family) {
  bool checkingAlternateName = true;
  return getFontPlatformData(
      fontDescription,
      FontFaceCreationParams(adjustFamilyNameToAvoidUnsupportedFonts(family)),
      checkingAlternateName);
}

SimpleFontData* FontCache::getNonRetainedLastResortFallbackFont(
    const FontDescription& fontDescription) {
  return getLastResortFallbackFont(fontDescription, DoNotRetain).leakRef();
}

void FontCache::releaseFontData(const SimpleFontData* fontData) {
  ASSERT(gFontDataCache);

  gFontDataCache->release(fontData);
}

static inline void purgePlatformFontDataCache() {
  if (!gFontPlatformDataCache)
    return;

  Vector<FontCacheKey> keysToRemove;
  keysToRemove.reserveInitialCapacity(gFontPlatformDataCache->size());
  for (auto& sizedFonts : *gFontPlatformDataCache) {
    Vector<unsigned> sizesToRemove;
    sizesToRemove.reserveInitialCapacity(sizedFonts.value.size());
    for (const auto& platformData : sizedFonts.value) {
      if (platformData.value &&
          !gFontDataCache->contains(platformData.value.get()))
        sizesToRemove.append(platformData.key);
    }
    sizedFonts.value.removeAll(sizesToRemove);
    if (sizedFonts.value.isEmpty())
      keysToRemove.append(sizedFonts.key);
  }
  gFontPlatformDataCache->removeAll(keysToRemove);
}

static inline void purgeFontVerticalDataCache() {
  FontVerticalDataCache& fontVerticalDataCache =
      fontVerticalDataCacheInstance();
  if (!fontVerticalDataCache.isEmpty()) {
    // Mark & sweep unused verticalData
    FontVerticalDataCache::iterator verticalDataEnd =
        fontVerticalDataCache.end();
    for (FontVerticalDataCache::iterator verticalData =
             fontVerticalDataCache.begin();
         verticalData != verticalDataEnd; ++verticalData) {
      if (verticalData->value)
        verticalData->value->setInFontCache(false);
    }

    gFontDataCache->markAllVerticalData();

    Vector<FontCache::FontFileKey> keysToRemove;
    keysToRemove.reserveInitialCapacity(fontVerticalDataCache.size());
    for (FontVerticalDataCache::iterator verticalData =
             fontVerticalDataCache.begin();
         verticalData != verticalDataEnd; ++verticalData) {
      if (!verticalData->value || !verticalData->value->inFontCache())
        keysToRemove.append(verticalData->key);
    }
    fontVerticalDataCache.removeAll(keysToRemove);
  }
}

static inline void purgeFallbackListShaperCache() {
  unsigned items = 0;
  if (gFallbackListShaperCache) {
    FallbackListShaperCache::iterator iter;
    for (iter = gFallbackListShaperCache->begin();
         iter != gFallbackListShaperCache->end(); ++iter) {
      items += iter->value->size();
    }
    gFallbackListShaperCache->clear();
  }
  DEFINE_STATIC_LOCAL(CustomCountHistogram, shapeCacheHistogram,
                      ("Blink.Fonts.ShapeCache", 1, 1000000, 50));
  shapeCacheHistogram.count(items);
}

void FontCache::invalidateShapeCache() {
  purgeFallbackListShaperCache();
}

void FontCache::purge(PurgeSeverity PurgeSeverity) {
  // We should never be forcing the purge while the FontCachePurgePreventer is
  // in scope.
  ASSERT(!m_purgePreventCount || PurgeSeverity == PurgeIfNeeded);
  if (m_purgePreventCount)
    return;

  if (!gFontDataCache || !gFontDataCache->purge(PurgeSeverity))
    return;

  purgePlatformFontDataCache();
  purgeFontVerticalDataCache();
  purgeFallbackListShaperCache();
}

static bool invalidateFontCache = false;

HeapHashSet<WeakMember<FontCacheClient>>& fontCacheClients() {
  DEFINE_STATIC_LOCAL(HeapHashSet<WeakMember<FontCacheClient>>, clients,
                      (new HeapHashSet<WeakMember<FontCacheClient>>));
  invalidateFontCache = true;
  return clients;
}

void FontCache::addClient(FontCacheClient* client) {
  ASSERT(!fontCacheClients().contains(client));
  fontCacheClients().add(client);
}

static unsigned short gGeneration = 0;

unsigned short FontCache::generation() {
  return gGeneration;
}

void FontCache::invalidate() {
  if (!invalidateFontCache) {
    ASSERT(!gFontPlatformDataCache);
    return;
  }

  if (gFontPlatformDataCache) {
    delete gFontPlatformDataCache;
    gFontPlatformDataCache = new FontPlatformDataCache;
  }

  gGeneration++;

  HeapVector<Member<FontCacheClient>> clients;
  size_t numClients = fontCacheClients().size();
  clients.reserveInitialCapacity(numClients);
  HeapHashSet<WeakMember<FontCacheClient>>::iterator end =
      fontCacheClients().end();
  for (HeapHashSet<WeakMember<FontCacheClient>>::iterator it =
           fontCacheClients().begin();
       it != end; ++it)
    clients.append(*it);

  ASSERT(numClients == clients.size());
  for (size_t i = 0; i < numClients; ++i)
    clients[i]->fontCacheInvalidated();

  purge(ForcePurge);
}

void FontCache::dumpFontPlatformDataCache(
    base::trace_event::ProcessMemoryDump* memoryDump) {
  ASSERT(isMainThread());
  if (!gFontPlatformDataCache)
    return;
  base::trace_event::MemoryAllocatorDump* dump =
      memoryDump->CreateAllocatorDump("font_caches/font_platform_data_cache");
  size_t fontPlatformDataObjectsSize =
      gFontPlatformDataCache->size() * sizeof(FontPlatformData);
  dump->AddScalar("size", "bytes", fontPlatformDataObjectsSize);
  memoryDump->AddSuballocation(dump->guid(),
                               WTF::Partitions::kAllocatedObjectPoolName);
}

void FontCache::dumpShapeResultCache(
    base::trace_event::ProcessMemoryDump* memoryDump) {
  ASSERT(isMainThread());
  if (!gFallbackListShaperCache) {
    return;
  }
  base::trace_event::MemoryAllocatorDump* dump =
      memoryDump->CreateAllocatorDump("font_caches/shape_caches");
  size_t shapeResultCacheSize = 0;
  FallbackListShaperCache::iterator iter;
  for (iter = gFallbackListShaperCache->begin();
       iter != gFallbackListShaperCache->end(); ++iter) {
    shapeResultCacheSize += iter->value->byteSize();
  }
  dump->AddScalar("size", "bytes", shapeResultCacheSize);
  memoryDump->AddSuballocation(dump->guid(),
                               WTF::Partitions::kAllocatedObjectPoolName);
}

}  // namespace blink