ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / include

#ifdef __cplusplus
extern "C" {
#endif

#ifndef MAXMINDDB_H
#define MAXMINDDB_H

/* Request POSIX.1-2008. However, we want to remain compatible with
 * POSIX.1-2001 (since we have been historically and see no reason to drop
 * compatibility). By requesting POSIX.1-2008, we can conditionally use
 * features provided by that standard if the implementation provides it. We can
 * check for what the implementation provides by checking the _POSIX_VERSION
 * macro after including unistd.h. If a feature is in POSIX.1-2008 but not
 * POSIX.1-2001, check that macro before using the feature (or check for the
 * feature directly if possible). */
#ifndef _POSIX_C_SOURCE
#define _POSIX_C_SOURCE 200809L
#endif

#include "maxminddb_config.h"
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <sys/types.h>

#ifdef _WIN32
#include <winsock2.h>
#include <ws2tcpip.h>
/* libmaxminddb package version from configure */
#define PACKAGE_VERSION "1.5.2"

typedef ADDRESS_FAMILY sa_family_t;

#if defined(_MSC_VER)
/* MSVC doesn't define signed size_t, copy it from configure */
#define ssize_t SSIZE_T

/* MSVC doesn't support restricted pointers */
#define restrict
#endif
#else
#include <netdb.h>
#include <netinet/in.h>
#include <sys/socket.h>
#endif

#define MMDB_DATA_TYPE_EXTENDED (0)
#define MMDB_DATA_TYPE_POINTER (1)
#define MMDB_DATA_TYPE_UTF8_STRING (2)
#define MMDB_DATA_TYPE_DOUBLE (3)
#define MMDB_DATA_TYPE_BYTES (4)
#define MMDB_DATA_TYPE_UINT16 (5)
#define MMDB_DATA_TYPE_UINT32 (6)
#define MMDB_DATA_TYPE_MAP (7)
#define MMDB_DATA_TYPE_INT32 (8)
#define MMDB_DATA_TYPE_UINT64 (9)
#define MMDB_DATA_TYPE_UINT128 (10)
#define MMDB_DATA_TYPE_ARRAY (11)
#define MMDB_DATA_TYPE_CONTAINER (12)
#define MMDB_DATA_TYPE_END_MARKER (13)
#define MMDB_DATA_TYPE_BOOLEAN (14)
#define MMDB_DATA_TYPE_FLOAT (15)

#define MMDB_RECORD_TYPE_SEARCH_NODE (0)
#define MMDB_RECORD_TYPE_EMPTY (1)
#define MMDB_RECORD_TYPE_DATA (2)
#define MMDB_RECORD_TYPE_INVALID (3)

/* flags for open */
#define MMDB_MODE_MMAP (1)
#define MMDB_MODE_MASK (7)

/* error codes */
#define MMDB_SUCCESS (0)
#define MMDB_FILE_OPEN_ERROR (1)
#define MMDB_CORRUPT_SEARCH_TREE_ERROR (2)
#define MMDB_INVALID_METADATA_ERROR (3)
#define MMDB_IO_ERROR (4)
#define MMDB_OUT_OF_MEMORY_ERROR (5)
#define MMDB_UNKNOWN_DATABASE_FORMAT_ERROR (6)
#define MMDB_INVALID_DATA_ERROR (7)
#define MMDB_INVALID_LOOKUP_PATH_ERROR (8)
#define MMDB_LOOKUP_PATH_DOES_NOT_MATCH_DATA_ERROR (9)
#define MMDB_INVALID_NODE_NUMBER_ERROR (10)
#define MMDB_IPV6_LOOKUP_IN_IPV4_DATABASE_ERROR (11)

#if !(MMDB_UINT128_IS_BYTE_ARRAY)
#if MMDB_UINT128_USING_MODE
typedef unsigned int mmdb_uint128_t __attribute__((__mode__(TI)));
#else
typedef unsigned __int128 mmdb_uint128_t;
#endif
#endif

/* This is a pointer into the data section for a given IP address lookup */
typedef struct MMDB_entry_s {
    const struct MMDB_s *mmdb;
    uint32_t offset;
} MMDB_entry_s;

typedef struct MMDB_lookup_result_s {
    bool found_entry;
    MMDB_entry_s entry;
    uint16_t netmask;
} MMDB_lookup_result_s;

typedef struct MMDB_entry_data_s {
    bool has_data;
    union {
        uint32_t pointer;
        const char *utf8_string;
        double double_value;
        const uint8_t *bytes;
        uint16_t uint16;
        uint32_t uint32;
        int32_t int32;
        uint64_t uint64;
#if MMDB_UINT128_IS_BYTE_ARRAY
        uint8_t uint128[16];
#else
        mmdb_uint128_t uint128;
#endif
        bool boolean;
        float float_value;
    };
    /* This is a 0 if a given entry cannot be found. This can only happen
     * when a call to MMDB_(v)get_value() asks for hash keys or array
     * indices that don't exist. */
    uint32_t offset;
    /* This is the next entry in the data section, but it's really only
     * relevant for entries that part of a larger map or array
     * struct. There's no good reason for an end user to look at this
     * directly. */
    uint32_t offset_to_next;
    /* This is only valid for strings, utf8_strings or binary data */
    uint32_t data_size;
    /* This is an MMDB_DATA_TYPE_* constant */
    uint32_t type;
} MMDB_entry_data_s;

/* This is the return type when someone asks for all the entry data in a map or
 * array */
typedef struct MMDB_entry_data_list_s {
    MMDB_entry_data_s entry_data;
    struct MMDB_entry_data_list_s *next;
    void *pool;
} MMDB_entry_data_list_s;

typedef struct MMDB_description_s {
    const char *language;
    const char *description;
} MMDB_description_s;

/* WARNING: do not add new fields to this struct without bumping the SONAME.
 * The struct is allocated by the users of this library and increasing the
 * size will cause existing users to allocate too little space when the shared
 * library is upgraded */
typedef struct MMDB_metadata_s {
    uint32_t node_count;
    uint16_t record_size;
    uint16_t ip_version;
    const char *database_type;
    struct {
        size_t count;
        const char **names;
    } languages;
    uint16_t binary_format_major_version;
    uint16_t binary_format_minor_version;
    uint64_t build_epoch;
    struct {
        size_t count;
        MMDB_description_s **descriptions;
    } description;
    /* See above warning before adding fields */
} MMDB_metadata_s;

/* WARNING: do not add new fields to this struct without bumping the SONAME.
 * The struct is allocated by the users of this library and increasing the
 * size will cause existing users to allocate too little space when the shared
 * library is upgraded */
typedef struct MMDB_s {
    uint32_t flags;
    const char *filename;
    ssize_t file_size;
    const uint8_t *file_content;
    const uint8_t *data_section;
    uint32_t data_section_size;
    const uint8_t *metadata_section;
    uint32_t metadata_section_size;
    uint16_t full_record_byte_size;
    uint16_t depth;
    MMDB_ipv4_start_node_s ipv4_start_node;
    MMDB_metadata_s metadata;
    /* See above warning before adding fields */
} MMDB_s;

typedef struct MMDB_search_node_s {
    uint64_t left_record;
    uint64_t right_record;
    uint8_t left_record_type;
    uint8_t right_record_type;
    MMDB_entry_s left_record_entry;
    MMDB_entry_s right_record_entry;
} MMDB_search_node_s;

extern int
MMDB_open(const char *const filename, uint32_t flags, MMDB_s *const mmdb);
extern MMDB_lookup_result_s MMDB_lookup_string(const MMDB_s *const mmdb,
                                               const char *const ipstr,
                                               int *const gai_error,
                                               int *const mmdb_error);
extern MMDB_lookup_result_s
MMDB_lookup_sockaddr(const MMDB_s *const mmdb,
                     const struct sockaddr *const sockaddr,
                     int *const mmdb_error);
extern int MMDB_read_node(const MMDB_s *const mmdb,
                          uint32_t node_number,
                          MMDB_search_node_s *const node);
extern int MMDB_get_value(MMDB_entry_s *const start,
                          MMDB_entry_data_s *const entry_data,
                          ...);
extern int MMDB_vget_value(MMDB_entry_s *const start,
                           MMDB_entry_data_s *const entry_data,
                           va_list va_path);
extern int MMDB_aget_value(MMDB_entry_s *const start,
                           MMDB_entry_data_s *const entry_data,
                           const char *const *const path);
extern int MMDB_get_metadata_as_entry_data_list(
    const MMDB_s *const mmdb, MMDB_entry_data_list_s **const entry_data_list);
extern int
MMDB_get_entry_data_list(MMDB_entry_s *start,
                         MMDB_entry_data_list_s **const entry_data_list);
extern void
MMDB_free_entry_data_list(MMDB_entry_data_list_s *const entry_data_list);
extern void MMDB_close(MMDB_s *const mmdb);
extern const char *MMDB_lib_version(void);
extern int
MMDB_dump_entry_data_list(FILE *const stream,
                          MMDB_entry_data_list_s *const entry_data_list,
                          int indent);
extern const char *MMDB_strerror(int error_code);

#endif /* MAXMINDDB_H */

#ifdef __cplusplus
}
#endif

[+] ..
[-] iconv.h [edit]
[-] evrpc.h [edit]
[+] gnu
[-] expat_config.h [edit]
[-] ctype.h [edit]
[-] limits.h [edit]
[-] tar.h [edit]
[-] evdns.h [edit]
[-] mcheck.h [edit]
[+] libxslt
[-] utmp.h [edit]
[-] printf.h [edit]
[-] term.h [edit]
[+] gssrpc
[-] time.h [edit]
[-] nl_types.h [edit]
[-] gdfontl.h [edit]
[+] netipx
[+] asm-generic
[-] termios.h [edit]
[-] gd.h [edit]
[-] pcre2.h [edit]
[+] fontconfig
[-] gpg-error.h [edit]
[-] ftw.h [edit]
[+] c++
[-] maxminddb_config-64.h [edit]
[-] features-time64.h [edit]
[-] cpuidle.h [edit]
[-] event.h [edit]
[-] gnu-versions.h [edit]
[+] asm
[-] png.h [edit]
[-] krb5.h [edit]
[-] pcre_scanner.h [edit]
[-] fts.h [edit]
[-] threads.h [edit]
[+] gssapi
[-] jpeglib.h [edit]
[-] utmpx.h [edit]
[+] sound
[-] complex.h [edit]
[-] err.h [edit]
[-] strings.h [edit]
[-] pcrecpparg.h [edit]
[-] spawn.h [edit]
[+] finclude
[-] panel.h [edit]
[-] fmtmsg.h [edit]
[+] xcb
[+] brotli
[-] tiffio.hxx [edit]
[-] verto-module.h [edit]
[-] idna.h [edit]
[-] jconfig.h [edit]
[-] tld.h [edit]
[+] rpc
[+] netinet
[-] maxminddb.h [edit]
[+] drm
[-] thread_db.h [edit]
[+] neteconet
[-] autosprintf.h [edit]
[+] google
[-] dlfcn.h [edit]
[-] ncurses_dll.h [edit]
[-] tiff.h [edit]
[+] ext2fs
[-] monetary.h [edit]
[-] gdfontt.h [edit]
[-] wait.h [edit]
[-] keyutils.h [edit]
[+] sepol
[-] sgtty.h [edit]
[-] jerror.h [edit]
[-] form.h [edit]
[-] assert.h [edit]
[-] tic.h [edit]
[-] mntent.h [edit]
[-] cursesm.h [edit]
[-] stdio.h [edit]
[-] error.h [edit]
[-] execinfo.h [edit]
[-] ieee754.h [edit]
[-] menu.h [edit]
[-] cursesp.h [edit]
[+] libmount
[-] ltdl.h [edit]
[-] cursesw.h [edit]
[-] jpegint.h [edit]
[-] entities.h [edit]
[+] rdma
[-] lzma.h [edit]
[-] zlib.h [edit]
[-] pwd.h [edit]
[+] nfs
[+] python3.9
[-] nc_tparm.h [edit]
[-] gdfontg.h [edit]
[-] gconv.h [edit]
[-] termcap.h [edit]
[-] etip.h [edit]
[+] libltdl
[+] et
[+] protobuf-c
[+] bits
[+] net
[-] ttyent.h [edit]
[-] inttypes.h [edit]
[-] nss.h [edit]
[-] semaphore.h [edit]
[-] kdb.h [edit]
[+] arpa
[-] alloca.h [edit]
[-] ucontext.h [edit]
[-] tgmath.h [edit]
[-] tiffvers.h [edit]
[-] fenv.h [edit]
[-] gdfonts.h [edit]
[-] string.h [edit]
[-] ffitarget.h [edit]
[-] lmdb.h [edit]
[-] fpu_control.h [edit]
[+] unicode
[-] byteswap.h [edit]
[-] setjmp.h [edit]
[+] sys
[-] pr29.h [edit]
[-] zconf.h [edit]
[-] stdint.h [edit]
[-] errno.h [edit]
[-] mqueue.h [edit]
[-] evutil.h [edit]
[+] harfbuzz
[-] ffi-x86_64.h [edit]
[-] grp.h [edit]
[-] gdfontmb.h [edit]
[-] stdc-predef.h [edit]
[-] malloc.h [edit]
[-] tiffconf.h [edit]
[-] pnglibconf.h [edit]
[-] tiffconf-64.h [edit]
[-] resolv.h [edit]
[-] FlexLexer.h [edit]
[-] punycode.h [edit]
[+] blkid
[-] glob.h [edit]
[-] unctrl.h [edit]
[-] regex.h [edit]
[+] xen
[-] signal.h [edit]
[+] netrose
[+] openssl
[-] ifaddrs.h [edit]
[-] unistd.h [edit]
[-] gssapi.h [edit]
[+] misc
[-] ffi.h [edit]
[+] kadm5
[+] freetype2
[+] video
[-] tiffio.h [edit]
[-] wchar.h [edit]
[-] elf.h [edit]
[-] ncurses.h [edit]
[-] proc_service.h [edit]
[-] uchar.h [edit]
[-] gdbm.h [edit]
[-] langinfo.h [edit]
[-] pcre.h [edit]
[+] webp
[-] values.h [edit]
[+] libexslt
[-] jconfig-64.h [edit]
[-] netdb.h [edit]
[-] cpio.h [edit]
[-] libaio.h [edit]
[-] powercap.h [edit]
[-] dbm.h [edit]
[-] pngconf.h [edit]
[+] netpacket
[-] cursslk.h [edit]
[-] link.h [edit]
[+] security
[-] lastlog.h [edit]
[-] wordexp.h [edit]
[-] gd_io.h [edit]
[+] X11
[-] verto.h [edit]
[-] curses.h [edit]
[-] wctype.h [edit]
[+] netax25
[-] libintl.h [edit]
[-] gettext-po.h [edit]
[+] netrom
[-] stringprep.h [edit]
[-] argp.h [edit]
[+] lzma
[-] ulimit.h [edit]
[+] fwctl
[-] gnumake.h [edit]
[-] krad.h [edit]
[-] pcre_stringpiece.h [edit]
[-] expat_external.h [edit]
[-] shadow.h [edit]
[-] expat.h [edit]
[+] pcp
[-] ar.h [edit]
[-] endian.h [edit]
[+] gdbm
[-] fstab.h [edit]
[-] envz.h [edit]
[-] pty.h [edit]
[-] eti.h [edit]
[-] paths.h [edit]
[-] argz.h [edit]
[-] math.h [edit]
[-] getopt.h [edit]
[-] gpgrt.h [edit]
[+] ncurses
[-] gdcache.h [edit]
[-] fstrm.h [edit]
[-] obstack.h [edit]
[-] maxminddb_config.h [edit]
[+] fstrm
[-] term_entry.h [edit]
[-] sched.h [edit]
[-] memory.h [edit]
[-] gd_color_map.h [edit]
[-] gdfx.h [edit]
[+] mysql
[+] json-c
[+] graphite2
[-] locale.h [edit]
[+] libxml2
[+] e2p
[-] com_err.h [edit]
[-] pcre2posix.h [edit]
[+] scsi
[+] ncursesw
[+] krb5
[-] gd_errors.h [edit]
[+] event2
[-] search.h [edit]
[-] re_comp.h [edit]
[-] fnmatch.h [edit]
[+] libpng16
[-] ndbm.h [edit]
[-] syslog.h [edit]
[-] sysexits.h [edit]
[+] netash
[-] cursesf.h [edit]
[-] pthread.h [edit]
[+] linux
[-] pcrecpp.h [edit]
[-] fcntl.h [edit]
[-] syscall.h [edit]
[-] libgen.h [edit]
[-] ffitarget-x86_64.h [edit]
[-] features.h [edit]
[-] a.out.h [edit]
[+] glib-2.0
[-] evhttp.h [edit]
[+] gio-unix-2.0
[-] idn-free.h [edit]
[-] gshadow.h [edit]
[-] stdlib.h [edit]
[-] dirent.h [edit]
[-] pcreposix.h [edit]
[-] crypt.h [edit]
[+] selinux
[-] regexp.h [edit]
[-] aliases.h [edit]
[-] stdio_ext.h [edit]
[+] netatalk
[-] utime.h [edit]
[-] termio.h [edit]
[-] poll.h [edit]
[+] GL
[+] sysprof-4
[-] aio.h [edit]
[-] gdpp.h [edit]
[+] mtd
[-] stab.h [edit]
[-] idn-int.h [edit]
[-] cursesapp.h [edit]
[-] profile.h [edit]
[-] jmorecfg.h [edit]
[+] bind9
[+] protocols
[+] netiucv
[-] bzlib.h [edit]