mmap_cache.h revision 9028706a00da1bc48547e74aa872c825ac15adb2
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard/*
095e49b99a1a9a4604e5750771e062c061cd12bdwrowe SSSD
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard Mmap Cache Common header
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard Copyright (C) Simo Sorce <ssorce@redhat.com> 2011
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard This program is free software; you can redistribute it and/or modify
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard it under the terms of the GNU General Public License as published by
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard the Free Software Foundation; either version 3 of the License, or
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard (at your option) any later version.
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard This program is distributed in the hope that it will be useful,
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard but WITHOUT ANY WARRANTY; without even the implied warranty of
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard GNU General Public License for more details.
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard You should have received a copy of the GNU General Public License
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard along with this program. If not, see <http://www.gnu.org/licenses/>.
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard*/
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#ifndef _MMAP_CACHE_H_
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define _MMAP_CACHE_H_
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
095e49b99a1a9a4604e5750771e062c061cd12bdwrowe#include "util/murmurhash3.h"
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard/* NOTE: all the code here assumes that writing a uint32_t nto mmapped
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard * memory is an atomic operation and can't be split in multiple
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard * non-atomic operations */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddardtypedef uint32_t rel_ptr_t;
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard/* align macros */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_8 sizeof(uint8_t)
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_32 sizeof(uint32_t)
4e06302d1825b2a21dfe3ac998ff14e9a40927d7wrowe#define MC_64 sizeof(uint64_t)
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_ALIGN32(size) ( ((size) + MC_32 -1) & (~(MC_32 -1)) )
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_ALIGN64(size) ( ((size) + MC_64 -1) & (~(MC_64 -1)) )
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_HEADER_SIZE MC_ALIGN64(sizeof(struct sss_mc_header))
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_HT_SIZE(elems) ( (elems) * MC_32 )
4e06302d1825b2a21dfe3ac998ff14e9a40927d7wrowe#define MC_HT_ELEMS(size) ( (size) / MC_32 )
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_DT_SIZE(elems, payload) ( (elems) * (payload) )
4e06302d1825b2a21dfe3ac998ff14e9a40927d7wrowe#define MC_FT_SIZE(elems) ( (elems) / 8 )
f84cab2da5f8958575b1ce99ca2bf4fda34cecb6mturk/* ^^ 8 bits per byte so we need just elems/8 bytes to represent all blocks */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_PTR_ADD(ptr, bytes) (void *)((uint8_t *)(ptr) + (bytes))
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_PTR_DIFF(ptr, base) ((uint8_t *)(ptr) - (uint8_t *)(base))
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_INVALID_VAL64 ((uint64_t)-1)
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_INVALID_VAL32 ((uint32_t)-1)
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_INVALID_VAL8 ((uint8_t)-1)
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_INVALID_VAL MC_INVALID_VAL32
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
4e06302d1825b2a21dfe3ac998ff14e9a40927d7wrowe/*
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard * 32 seem a good compromise for slot size
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard * 4 blocks are enough for the average passwd entry of 42 bytes
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard * passwd records have 84 bytes of overhead, 128 - 82 = 46 bytes
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard * 3 blocks can contain a very minimal entry, 96 - 82 = 14 bytes
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard *
4e06302d1825b2a21dfe3ac998ff14e9a40927d7wrowe * 3 blocks are enough for groups w/o users (private user groups)
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard * group records have 68 bytes of overhead, 96 - 66 = 30 bytes
4e06302d1825b2a21dfe3ac998ff14e9a40927d7wrowe */
fb929740692fe796b467212ec57aa34cebb562cfwrowe#define MC_SLOT_SIZE 32
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_SIZE_TO_SLOTS(len) (((len) + (MC_SLOT_SIZE - 1)) / MC_SLOT_SIZE)
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_PTR_TO_SLOT(base, ptr) (MC_PTR_DIFF(ptr, base) / MC_SLOT_SIZE)
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_SLOT_TO_PTR(base, slot, type) \
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard (type *)((base) + ((slot) * MC_SLOT_SIZE))
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_VALID_BARRIER(val) (((val) & 0xff000000) == 0xf0000000)
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define MC_CHECK_RECORD_LENGTH(mc_ctx, rec) \
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard ((rec)->len >= MC_HEADER_SIZE && (rec)->len != MC_INVALID_VAL32 \
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard && ((rec)->len <= ((mc_ctx)->dt_size \
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard - MC_PTR_DIFF(rec, (mc_ctx)->data_table))))
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define SSS_MC_MAJOR_VNO 0
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define SSS_MC_MINOR_VNO 4
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define SSS_MC_HEADER_UNINIT 0 /* after ftruncate or before reset */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define SSS_MC_HEADER_ALIVE 1 /* current and in use */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#define SSS_MC_HEADER_RECYCLED 2 /* file was recycled, reopen asap */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard#pragma pack(1)
83cb9e783386a18eecdb0749d9d17aa8e3bc012estoddardstruct sss_mc_header {
83cb9e783386a18eecdb0749d9d17aa8e3bc012estoddard uint32_t b1; /* barrier 1 */
83cb9e783386a18eecdb0749d9d17aa8e3bc012estoddard uint32_t major_vno; /* major version number */
83cb9e783386a18eecdb0749d9d17aa8e3bc012estoddard uint32_t minor_vno; /* minor version number */
43681d859fe7d4cd90a33d6be2232192c108de75wrowe uint32_t status; /* database status */
43681d859fe7d4cd90a33d6be2232192c108de75wrowe uint32_t seed; /* random seed used to avoid collision attacks */
43681d859fe7d4cd90a33d6be2232192c108de75wrowe uint32_t dt_size; /* data table size */
43681d859fe7d4cd90a33d6be2232192c108de75wrowe uint32_t ft_size; /* free table size */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard uint32_t ht_size; /* hash table size */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard rel_ptr_t data_table; /* data table pointer relative to mmap base */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard rel_ptr_t free_table; /* free table pointer relative to mmap base */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard rel_ptr_t hash_table; /* hash table pointer relative to mmap base */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard rel_ptr_t reserved; /* reserved for future changes */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard uint32_t b2; /* barrier 2 */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard};
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddardstruct sss_mc_rec {
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard uint32_t b1; /* barrier 1 */
43681d859fe7d4cd90a33d6be2232192c108de75wrowe uint32_t len; /* total record length including record data */
43681d859fe7d4cd90a33d6be2232192c108de75wrowe uint64_t expire; /* record expiration time (cast to time_t) */
43681d859fe7d4cd90a33d6be2232192c108de75wrowe rel_ptr_t next; /* ptr of next record rel to data_table */
43681d859fe7d4cd90a33d6be2232192c108de75wrowe uint32_t hash1; /* val of first hash (usually name of record) */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard uint32_t hash2; /* val of second hash (usually id of record) */
8e117661fd51fd19d6430fca8d7ae87c67d6de20stoddard uint32_t b2; /* barrier 2 - 32 bytes mark, fits a slot */
char data[0];
};
/* FIXME: Function sss_mc_find_record currently relies on fact that
* offset of strs is the same in both sss_mc_pwd_data and sss_mc_grp_data. */
struct sss_mc_pwd_data {
rel_ptr_t name; /* ptr to name string, rel. to struct base addr */
uint32_t uid;
uint32_t gid;
uint32_t strs_len; /* length of strs */
char strs[0]; /* concatenation of all passwd strings, each
* string is zero terminated ordered as follows:
* name, passwd, gecos, dir, shell */
};
struct sss_mc_grp_data {
rel_ptr_t name; /* ptr to name string, rel. to struct base addr */
uint32_t gid;
uint32_t members; /* number of members in strs */
uint32_t strs_len; /* length of strs */
char strs[0]; /* concatenation of all group strings, each
* string is zero terminated ordered as follows:
* name, passwd, member1, member2, ... */
};
#pragma pack()
#endif /* _MMAP_CACHE_H_ */