MatrixSynapse/synapse/util/caches/__init__.py

100 lines
2.5 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2015, 2016 OpenMarket Ltd
#
# 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.
import synapse.metrics
2016-03-22 19:22:52 +01:00
from lrucache import LruCache
2016-03-23 17:13:05 +01:00
import os
CACHE_SIZE_FACTOR = float(os.environ.get("SYNAPSE_CACHE_FACTOR", 0.1))
DEBUG_CACHES = False
metrics = synapse.metrics.get_metrics_for("synapse.util.caches")
caches_by_name = {}
# cache_counter = metrics.register_cache(
# "cache",
# lambda: {(name,): len(caches_by_name[name]) for name in caches_by_name.keys()},
# labels=["name"],
# )
def register_cache(name, cache):
caches_by_name[name] = cache
return metrics.register_cache(
"cache",
lambda: len(cache),
name,
)
2016-03-22 19:22:52 +01:00
2017-01-17 18:04:46 +01:00
_string_cache = LruCache(int(100000 * CACHE_SIZE_FACTOR))
_stirng_cache_metrics = register_cache("string_cache", _string_cache)
2016-03-22 19:22:52 +01:00
2016-03-23 17:13:05 +01:00
KNOWN_KEYS = {
key: key for key in
(
"auth_events",
"content",
"depth",
"event_id",
"hashes",
"origin",
"origin_server_ts",
"prev_events",
"room_id",
"sender",
"signatures",
"state_key",
"type",
"unsigned",
"user_id",
)
}
2016-03-22 19:22:52 +01:00
def intern_string(string):
2016-03-23 17:13:05 +01:00
"""Takes a (potentially) unicode string and interns using custom cache
"""
2017-01-17 18:04:46 +01:00
new_str = _string_cache.setdefault(string, string)
if new_str is string:
_stirng_cache_metrics.inc_hits()
else:
_stirng_cache_metrics.inc_misses()
return new_str
2016-03-23 17:13:05 +01:00
def intern_dict(dictionary):
"""Takes a dictionary and interns well known keys and their values
"""
2016-03-23 17:34:59 +01:00
return {
KNOWN_KEYS.get(key, key): _intern_known_values(key, value)
for key, value in dictionary.items()
}
2016-03-23 17:13:05 +01:00
2016-03-23 17:34:59 +01:00
def _intern_known_values(key, value):
2016-03-23 17:13:05 +01:00
intern_str_keys = ("event_id", "room_id")
intern_unicode_keys = ("sender", "user_id", "type", "state_key")
2016-03-23 17:34:59 +01:00
if key in intern_str_keys:
return intern(value.encode('ascii'))
2016-03-23 17:13:05 +01:00
2016-03-23 17:34:59 +01:00
if key in intern_unicode_keys:
return intern_string(value)
2016-03-23 17:13:05 +01:00
2016-03-23 17:34:59 +01:00
return value