From Apache OpenOffice Wiki
Revision as of 05:01, 20 May 2006 by Mikeleib (Talk | contribs)

Jump to: navigation, search


In our initial investigations of cold-start performance, we theorized that the impact of having hundreds of small xml files to be crawled had a negative impact on performance. We reasoned that combining the hundreds of files into one or two containers would greatly improve the ability of the buffer-cache to work effectively and reduce the startup time.


We performed several experiments to get an estimate of the performance gains that could be had. We tried three methodologies that all indicated that we could expect roughly a 1 second improvement on a cold-start of writer. Our test machine for these experiments was a 3.2Ghz Pentium 4HT with 1 gigabyte of RAM, a 120GB 7200rpm SATA drive, running NLD9.


In this experiment, we pre-stuffed the buffer-cache with the xcu files before startup. This was accomplished by running cat:

cat xcu_file_list | xargs cat | cat > /dev/null


We created two ramdisks and put the configuration data in them. This was a little coarser, because the contents registry was the ramdisk, which also includes the cache.

Const Char*

We created a header file that had all of the contents of the xcu files as const character strings. A simple search function was crafted that took a URL and found the appropriate string. We changed the implimentation of XLayer.readData to look into the strings instead of the disk. Writes were left going to the disk.


At first, we tried to modify localbe to use one large xml file rather than hundreds of smaller ones. This proved to be quite difficult, because the "canned" parser does not expect multiple components per file. Because of the expat interface, it is difficult to craft a system of querying the xml parser for relavent tags and sorting the data. Thus, it was decided that a database system would yeild the fastest implimentation rate.

BerkelyDB was chosen because it was used elsewhere in the code, and is very simple. A simple schema was implimented, where there the key was the url of the xcu file and the value was a struct with the timestamp and the xml blob. There was also a special key, the list of keys, so that searching for children could be done in a moderately efficient manner.

Prototype Changes to localbe

The changes were to BasicLocalFileLayer::readData and replaceWith. Additionally, the LocalMultiStratum::listLayerId had to be changed. These changes were quick and dirty, and in no way production quality. We left LocalSingleBackend and LocalHierarchyBrowserSvc alone, because they weren't used in simple uses of openoffice, and this was just an experiment. We also introduce Database, a singleton that encapsulates the two databases.


Our performance testing methodology was to use a script that launched openoffice and had it output RTL_LOG data. After a short delay (roughly one minute), the system would be rebooted and the process would repeat. Our comparison is based on a build that is built with ooo-build. The version of ooo-build is ooo-build- and it is compiled with TIMELOG and -g. The tested machine for these tests is a IBM T42 Thinkpad, (1.7 Ghz Centrino) with 1 gigabyte of RAM and 40G 5400rpm drive running NLD9.

For starting writer, the startup gain was again roughly 1 second. Our average start time of the unmodified build is 10.589 seconds, and our modified version's average start time is 9.234 seconds with 5 samples. However, we cannot simply claim a 1.3 second improvement, because we have modified our startup script to prestuff the buffer-cache with the two database files. This takes 440 milliseconds, so our net gain is 915 milliseconds. While this is only 5 samples, a similar test that just started the framework/shell (soffice, with no arguments) of 50 runs showed a net gain of ~750 milliseconds. On a sample set of 20, starting calc is also accelerated by a net gain of 967 milliseconds.

It should be noted, however, that the results vary across machines, in particular the speedup for desktops is less noticeable.


We have crafted a new backend, called dbbe that uses xml files encapsulated in berkeley databases. This backend is similar to localbe in many ways and has some code that is "stolen" from there. It implements the following services:

Additionally, we have a utility that can import and export xcu files into databases for migration.

Basic Design

The berkeley database stores key/data pairs with no relations. These pairs are of arbitrary type and size. We've made an abstraction of the berkeleydb API that can put and get Records by key. Our Single/MultiLayerStratums list/get Layers that deal with individual Records.

Layer/Updatable Layer

We define a schema for our Layers and UpdatableLayers that uses a namespace prefix concatinated with the Configuration Item as a key. The namespace convention we will use is the same as localbe for it's three managed stratums: res, data, modules. We use the :: seperator because (as far as I know), this is not valid in a path and it makes a nice convention. Additionally, we will use another :: seperator after the Configuration Item name to signify a sublayer. So for example, we would have the keys:

  • data::org.openoffice.Office.Labels
  • modules::org.openoffice.TypeDetection.Types.fcfg_math_types

For sublayers, the mapping would be as follows:

  • /registry/modules/org/openoffice/Setup/Setup-draw.xcu
  • /registry/modules/org/openoffice/Setup/Setup-writer.xcu
  • /registry/modules/org/openoffice/Setup/Setup-calc.xcu
get mapped to:
  • modules::org.openoffice.Setup::Setup-draw
  • modules::org.openoffice.Setup::Setup-writer
  • modules::org.openoffice.Setup::Setup-calc

Note: localbe uses a strange system for language packs that we will not adopt. So, in localbe, we have: /res/en-US/org/openoffice/Office/UI/BasicIDECommands, where en-US is a sublayer. In our backend, dbbe, we would have: res::org.openoffice.Office.UI.BasicIDECommands::en-US, where en-US is a sublayer.

Note: the use of the word sublayer is somewhat misleading. The Record object does not differntiate sublayer blobs from anonymous configuration "particles" It calls both sublayers.

The data can be though of as a struct defined as so:

struct Record
    sal_Int64  date;          /** Unix Epoch */
    sal_uInt32 blobSize;      /** XML Blob Size */
    sal_uInt32 numSubLayers;
    sal_Char   *pSubLayers;   /** ARGV style vector */
    sal_Char   *pBlob;        /** XML Blob */

Each layer is implemented in a similar way to localbe, with a base class for the simple aspects of XLayer and XTimeStamped and a base class for the common elements of XCompositeLayer and XTimeStamped. The readData method will be implimented like in the experiment, with comphelper creating a stream from a ByteSequence. We use the URL property, but define the "URL" as <dbPath>:Key.


Like in localbe, we will use a base class to impliment XBackendEntities and then have a single MultiStratum class to provide XMultiStratum. However, the approach in localbe for SingleBackend is a now somewhat archaic. To refresh, in localbe:

  • LocalStratumBase
    • LocalSingleStratum Base
      • LocalDataStratum
      • LocalReadOnlyStratum
      • LocalResourceStratum
      • LocalSingleStratum

In our implimentation, we have a simplier class heirchy with only two derivative classes for the BaseStratume that impliment XMultiLayerStratum and XSingleLayerStratum. We use ask the database for a given layer if it has any "SubLayers" to see if getLayer and the like should return a CompositeLayer, Layer, or the updatable version of each. We do this by checking if the Layer has any sublayers and if the database it came from is read-only.

Factory/Database Abstraction

We have a class, Database, that abstracts the berkelyDB API from the rest of dbbe. This is done to consolodate access to database internal settings so that they can all be changed in one place.

Because we have multiple stratum services that are using the same database (just namepsaces within them), we provide a factory that can instantiate databases. This allows the services specified in the configmgrc to specify a database path and namespace prefix to work in. Additionally, this allows for the case of more than the original two envisioned databases to be used. However, making more databases will degrade performance.


Because this is a fundamentally non-human-editable data store, we provide a utility to populate and edit the contents of the database. This utility will be a stand-alone binary suitable for packages to use in their post-install scripts. We will support the following basic operations:

  • import files
  • export files
  • integrity check
  • statistics on database (list keys)

For import and export, we use a "code" to mangle/demangle key names into file paths/names for localbe. The scheme that localbe uses is automatically detected, and a correct code is supplied. However, for other cases, it is possible to supply a code for how names are mapped to keys. The code is very simple; it just specifies what parts of the path are namespaces, layers, and "sublayers." The Mangler class handles this name mangling/demangling and the respository class handles the import/export of keys.

The Code

The code is in CWS: configdbbe Also, you can see a doxygen run of dbbe here

Personal tools