190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/*
2f71323e297a928af368937089d3ed71239786f86Andreas Huber *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber *
4f71323e297a928af368937089d3ed71239786f86Andreas Huber *  Use of this source code is governed by a BSD-style license
5f71323e297a928af368937089d3ed71239786f86Andreas Huber *  that can be found in the LICENSE file in the root of the source
6f71323e297a928af368937089d3ed71239786f86Andreas Huber *  tree. An additional intellectual property rights grant can be found
7f71323e297a928af368937089d3ed71239786f86Andreas Huber *  in the file PATENTS.  All contributing project authors may
8f71323e297a928af368937089d3ed71239786f86Andreas Huber *  be found in the AUTHORS file in the root of the source tree.
990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber */
1090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
11b08e2e23eec181e9951df33cd704ac294c5407b6Vignesh Venkatasubramanian#ifndef VPX_MEM_MEMORY_MANAGER_INCLUDE_HMM_CNFG_H_
12b08e2e23eec181e9951df33cd704ac294c5407b6Vignesh Venkatasubramanian#define VPX_MEM_MEMORY_MANAGER_INCLUDE_HMM_CNFG_H_
1390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
1490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* This code is in the public domain.
1590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** Version: 1.1  Author: Walt Karas
1690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber*/
1790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
1890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Configure Heap Memory Manager for processor architecture, compiler,
1990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** and desired performance characteristics.  This file is included
2090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** by heapmm.h, so these definitions can be used by code external to
2190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** HMM.  You can change the default configuration, and/or create alternate
2290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** configuration(s).
2390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber*/
2490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
2590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* To allow for multiple configurations of HMM to be used in the same
2690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** compilation unit, undefine all preprocessor symbols that will be
2790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** defined below.
2890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber*/
2990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#undef HMM_ADDR_ALIGN_UNIT
3090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#undef HMM_BLOCK_ALIGN_UNIT
3190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#undef HMM_UNIQUE
3290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#undef HMM_DESC_PARAM
3390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#undef HMM_SYM_TO_STRING
3490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#undef HMM_SYM_TO_STRING
3590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#undef HMM_AUDIT_FAIL
3690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
3790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Turn X into a string after one macro expansion pass of X.  This trick
3890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** works with both GCC and Visual C++. */
3990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_SYM_TO_STRING(X) HMM_SYM_TO_STRING(X)
4090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_SYM_TO_STRING(X) #X
4190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
4290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#ifndef HMM_CNFG_NUM
4390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
4490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Default configuration. */
4590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
4690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Use hmm_ prefix to avoid identifier conflicts. */
4790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_UNIQUE(BASE) hmm_ ## BASE
4890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
4990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Number of bytes in an Address Alignment Unit (AAU). */
50ba164dffc5a6795bce97fae02b51ccf3330e15e4hkuang// fwg
51ba164dffc5a6795bce97fae02b51ccf3330e15e4hkuang// #define HMM_ADDR_ALIGN_UNIT sizeof(int)
5290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_ADDR_ALIGN_UNIT 32
5390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
5490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Number of AAUs in a Block Alignment Unit (BAU). */
5590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_BLOCK_ALIGN_UNIT 1
5690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
5790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Type of unsigned integer big enough to hold the size of a Block in AAUs. */
5890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Hubertypedef unsigned long HMM_UNIQUE(size_aau);
5990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
6090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Type of unsigned integer big enough to hold the size of a Block/Chunk
6190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** in BAUs.  The high bit will be robbed. */
6290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Hubertypedef unsigned long HMM_UNIQUE(size_bau);
6390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
6490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Hubervoid hmm_dflt_abort(const char *, const char *);
6590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
6690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Actions upon a self-audit failure.  Must expand to a single complete
6790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** statement.  If you remove the definition of this macro, no self-auditing
6890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** will be performed. */
6990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_AUDIT_FAIL \
70ba164dffc5a6795bce97fae02b51ccf3330e15e4hkuang  hmm_dflt_abort(__FILE__, HMM_SYM_TO_STRING(__LINE__));
7190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
7290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#elif HMM_CNFG_NUM == 0
7390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
7490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Definitions for testing. */
7590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
7690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_UNIQUE(BASE) thmm_ ## BASE
7790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
7890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_ADDR_ALIGN_UNIT sizeof(int)
7990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
8090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_BLOCK_ALIGN_UNIT 3
8190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
8290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Hubertypedef unsigned HMM_UNIQUE(size_aau);
8390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
8490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Hubertypedef unsigned short HMM_UNIQUE(size_bau);
8590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
8690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Under this test setup, a long jump is done if there is a self-audit
8790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber** failure.
8890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber*/
8990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
9090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huberextern jmp_buf HMM_UNIQUE(jmp_buf);
9190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huberextern const char *HMM_UNIQUE(fail_file);
9290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huberextern unsigned HMM_UNIQUE(fail_line);
9390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
9490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#define HMM_AUDIT_FAIL \
95ba164dffc5a6795bce97fae02b51ccf3330e15e4hkuang  { HMM_UNIQUE(fail_file) = __FILE__; HMM_UNIQUE(fail_line) = __LINE__; \
96ba164dffc5a6795bce97fae02b51ccf3330e15e4hkuang    longjmp(HMM_UNIQUE(jmp_buf), 1); }
9790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
9890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#elif HMM_CNFG_NUM == 1
9990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
10090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Put configuration 1 definitions here (if there is a configuration 1). */
10190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
10290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#elif HMM_CNFG_NUM == 2
10390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
10490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Put configuration 2 definitions here. */
10590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
10690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#elif HMM_CNFG_NUM == 3
10790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
10890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Put configuration 3 definitions here. */
10990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
11090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#elif HMM_CNFG_NUM == 4
11190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
11290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Put configuration 4 definitions here. */
11390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
11490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#elif HMM_CNFG_NUM == 5
11590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
11690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber/* Put configuration 5 definitions here. */
11790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber
11890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#endif
119b08e2e23eec181e9951df33cd704ac294c5407b6Vignesh Venkatasubramanian
120b08e2e23eec181e9951df33cd704ac294c5407b6Vignesh Venkatasubramanian#endif  // VPX_MEM_MEMORY_MANAGER_INCLUDE_HMM_CNFG_H_
121