matchy 2.0.1

Fast database for IP address and pattern matching with rich data storage
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
//! MaxMind DB Compatibility Layer
//!
//! This module provides libmaxminddb-compatible C API functions that wrap
//! matchy's native API. This allows applications using libmaxminddb to
//! switch to matchy with minimal code changes.

use super::matchy::{
    matchy_aget_value, matchy_close, matchy_entry_data_list_t, matchy_entry_data_t, matchy_entry_s,
    matchy_get_entry_data_list, matchy_open, matchy_query, matchy_t, MATCHY_SUCCESS,
};
use std::ffi::{CStr, CString};
use std::mem;
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use std::os::raw::{c_char, c_int, c_void};
use std::ptr;

// ============================================================================
// TYPE DEFINITIONS (matching maxminddb.h)
// ============================================================================

/// MaxMind DB handle (compatibility wrapper)
#[repr(C)]
pub struct MMDB_s {
    /// Internal matchy handle
    _matchy_db: *mut matchy_t,
    /// Flags passed to open
    pub flags: u32,
    /// Filename (owned, needs to be freed)
    pub filename: *const c_char,
    /// File size (not used but provided for compatibility)
    pub file_size: isize,
}

/// MaxMind DB entry (compatibility wrapper)
#[repr(C)]
pub struct MMDB_entry_s {
    /// Database handle
    pub mmdb: *const MMDB_s,
    /// Internal matchy entry
    pub _matchy_entry: matchy_entry_s,
}

/// MaxMind DB lookup result
#[repr(C)]
pub struct MMDB_lookup_result_s {
    /// Whether entry was found
    pub found_entry: bool,
    /// Entry data
    pub entry: MMDB_entry_s,
    /// Network prefix length
    pub netmask: u16,
}

/// Entry data (aliases matchy_entry_data_t)
#[allow(non_camel_case_types)]
pub type MMDB_entry_data_s = matchy_entry_data_t;

/// Entry data list node
#[repr(C)]
pub struct MMDB_entry_data_list_s {
    /// The entry data for this node
    pub entry_data: MMDB_entry_data_s,
    /// Pointer to the next node in the list (NULL if last)
    pub next: *mut Self,
    /// Memory pool pointer (not used in this implementation)
    pub pool: *mut c_void,
}

// ============================================================================
// ERROR CODE MAPPING
// ============================================================================

const MMDB_SUCCESS: c_int = 0;
const MMDB_FILE_OPEN_ERROR: c_int = 1;
const MMDB_IO_ERROR: c_int = 4;
const MMDB_OUT_OF_MEMORY_ERROR: c_int = 5;
const MMDB_INVALID_DATA_ERROR: c_int = 7;
const MMDB_INVALID_LOOKUP_PATH_ERROR: c_int = 8;
const MMDB_INVALID_NODE_NUMBER_ERROR: c_int = 10;

/// Map matchy error codes to MMDB error codes
fn map_matchy_error(matchy_error: i32) -> c_int {
    match matchy_error {
        MATCHY_SUCCESS => MMDB_SUCCESS,
        super::matchy::MATCHY_ERROR_FILE_NOT_FOUND => MMDB_FILE_OPEN_ERROR,
        super::matchy::MATCHY_ERROR_IO => MMDB_IO_ERROR,
        super::matchy::MATCHY_ERROR_OUT_OF_MEMORY => MMDB_OUT_OF_MEMORY_ERROR,
        super::matchy::MATCHY_ERROR_LOOKUP_PATH_INVALID => MMDB_INVALID_LOOKUP_PATH_ERROR,
        _ => MMDB_INVALID_DATA_ERROR,
    }
}

// ============================================================================
// CORE API FUNCTIONS
// ============================================================================

/// Open a MaxMind DB file
///
/// # Safety
/// - `filename` must be a valid null-terminated C string
/// - `mmdb` must be a valid pointer to MMDB_s struct
#[no_mangle]
pub unsafe extern "C" fn MMDB_open(
    filename: *const c_char,
    flags: u32,
    mmdb: *mut MMDB_s,
) -> c_int {
    if filename.is_null() || mmdb.is_null() {
        return MMDB_FILE_OPEN_ERROR;
    }

    // Zero the struct first (for safety)
    ptr::write_bytes(mmdb, 0, 1);

    // Convert filename to Rust string
    let filename_str = match CStr::from_ptr(filename).to_str() {
        Ok(s) => s,
        Err(_) => return MMDB_FILE_OPEN_ERROR,
    };

    // Open database using matchy
    let db = matchy_open(filename_str.as_ptr().cast::<c_char>());
    if db.is_null() {
        return MMDB_FILE_OPEN_ERROR;
    }

    // Duplicate filename for storage
    let filename_copy = match CString::new(filename_str) {
        Ok(s) => s.into_raw(),
        Err(_) => {
            matchy_close(db);
            return MMDB_OUT_OF_MEMORY_ERROR;
        }
    };

    // Initialize MMDB_s
    (*mmdb)._matchy_db = db;
    (*mmdb).flags = flags;
    (*mmdb).filename = filename_copy;
    (*mmdb).file_size = 0; // Could query file size if needed

    MMDB_SUCCESS
}

/// Lookup an IP address from string
///
/// # Safety
/// - `mmdb` must be a valid opened database
/// - `ipstr` must be a valid null-terminated C string
#[no_mangle]
pub unsafe extern "C" fn MMDB_lookup_string(
    mmdb: *const MMDB_s,
    ipstr: *const c_char,
    gai_error: *mut c_int,
    mmdb_error: *mut c_int,
) -> MMDB_lookup_result_s {
    let set_error = |gai: c_int, mmdb_err: c_int| {
        if !gai_error.is_null() {
            *gai_error = gai;
        }
        if !mmdb_error.is_null() {
            *mmdb_error = mmdb_err;
        }
        MMDB_lookup_result_s {
            found_entry: false,
            entry: MMDB_entry_s {
                mmdb: ptr::null(),
                _matchy_entry: mem::zeroed(),
            },
            netmask: 0,
        }
    };

    if mmdb.is_null() || ipstr.is_null() {
        return set_error(0, MMDB_INVALID_DATA_ERROR);
    }

    let db = (*mmdb)._matchy_db;
    if db.is_null() {
        return set_error(0, MMDB_INVALID_DATA_ERROR);
    }

    let result = matchy_query(db, ipstr);

    if !result.found {
        return set_error(0, MMDB_SUCCESS);
    }

    let lookup_result = MMDB_lookup_result_s {
        found_entry: true,
        entry: MMDB_entry_s {
            mmdb,
            _matchy_entry: matchy_entry_s {
                db,
                _data_offset: result._data_offset,
            },
        },
        netmask: u16::from(result.prefix_len),
    };

    if !gai_error.is_null() {
        *gai_error = 0;
    }
    if !mmdb_error.is_null() {
        *mmdb_error = MMDB_SUCCESS;
    }

    lookup_result
}

/// Lookup an IP address from sockaddr
///
/// # Safety
/// - `mmdb` must be a valid opened database
/// - `sockaddr` must be a valid socket address
///
/// # Platform Support
/// This function works on Unix-like and Windows platforms.
/// - On Unix (Linux, macOS, FreeBSD, etc.): Uses libc's sockaddr types
/// - On Windows: Uses Windows socket types (winsock2)
#[cfg(unix)]
#[no_mangle]
pub unsafe extern "C" fn MMDB_lookup_sockaddr(
    mmdb: *const MMDB_s,
    sockaddr: *const libc::sockaddr,
    mmdb_error: *mut c_int,
) -> MMDB_lookup_result_s {
    let set_error = |err: c_int| {
        if !mmdb_error.is_null() {
            *mmdb_error = err;
        }
        MMDB_lookup_result_s {
            found_entry: false,
            entry: MMDB_entry_s {
                mmdb: ptr::null(),
                _matchy_entry: mem::zeroed(),
            },
            netmask: 0,
        }
    };

    if mmdb.is_null() || sockaddr.is_null() {
        return set_error(MMDB_INVALID_DATA_ERROR);
    }

    // Convert sockaddr to IP string
    // First, read the address family with a minimal dereference
    let family = i32::from((*sockaddr).sa_family);

    let ip_addr = match family {
        libc::AF_INET => {
            // Safely copy the IPv4 address bytes into a local in_addr
            let sa = sockaddr.cast::<libc::sockaddr_in>();
            let mut in_addr: libc::in_addr = mem::zeroed();
            ptr::copy_nonoverlapping(
                &(*sa).sin_addr as *const libc::in_addr,
                &mut in_addr as *mut libc::in_addr,
                1,
            );
            let addr = u32::from_be(in_addr.s_addr);
            IpAddr::V4(Ipv4Addr::from(addr))
        }
        libc::AF_INET6 => {
            // Safely copy the IPv6 address bytes into a local in6_addr
            let sa = sockaddr.cast::<libc::sockaddr_in6>();
            let mut in6_addr: libc::in6_addr = mem::zeroed();
            ptr::copy_nonoverlapping(
                &(*sa).sin6_addr as *const libc::in6_addr,
                &mut in6_addr as *mut libc::in6_addr,
                1,
            );
            IpAddr::V6(Ipv6Addr::from(in6_addr.s6_addr))
        }
        _ => return set_error(MMDB_INVALID_DATA_ERROR),
    };

    let ip_str = ip_addr.to_string();
    let ip_cstr = match CString::new(ip_str) {
        Ok(s) => s,
        Err(_) => return set_error(MMDB_OUT_OF_MEMORY_ERROR),
    };

    // Use MMDB_lookup_string
    let mut gai_error = 0;
    MMDB_lookup_string(mmdb, ip_cstr.as_ptr(), &mut gai_error, mmdb_error)
}

/// Lookup an IP address from sockaddr (Windows implementation)
///
/// # Safety
/// - `mmdb` must be a valid opened database
/// - `sockaddr` must be a valid Windows SOCKADDR structure
#[cfg(windows)]
#[no_mangle]
pub unsafe extern "C" fn MMDB_lookup_sockaddr(
    mmdb: *const MMDB_s,
    sockaddr: *const winapi::shared::ws2def::SOCKADDR,
    mmdb_error: *mut c_int,
) -> MMDB_lookup_result_s {
    let set_error = |err: c_int| {
        if !mmdb_error.is_null() {
            *mmdb_error = err;
        }
        MMDB_lookup_result_s {
            found_entry: false,
            entry: MMDB_entry_s {
                mmdb: ptr::null(),
                _matchy_entry: mem::zeroed(),
            },
            netmask: 0,
        }
    };

    if mmdb.is_null() || sockaddr.is_null() {
        return set_error(MMDB_INVALID_DATA_ERROR);
    }

    use winapi::shared::ws2def::{AF_INET, AF_INET6, SOCKADDR_IN};
    use winapi::shared::ws2ipdef::SOCKADDR_IN6_LH;

    // Convert sockaddr to IP string
    let ip_addr = match (*sockaddr).sa_family as i32 {
        AF_INET => {
            let sa = sockaddr as *const SOCKADDR_IN;
            let addr = u32::from_be(*(*sa).sin_addr.S_un.S_addr());
            IpAddr::V4(Ipv4Addr::from(addr))
        }
        AF_INET6 => {
            let sa = sockaddr as *const SOCKADDR_IN6_LH;
            let addr = *(*sa).sin6_addr.u.Byte();
            IpAddr::V6(Ipv6Addr::from(addr))
        }
        _ => return set_error(MMDB_INVALID_DATA_ERROR),
    };

    let ip_str = ip_addr.to_string();
    let ip_cstr = match CString::new(ip_str) {
        Ok(s) => s,
        Err(_) => return set_error(MMDB_OUT_OF_MEMORY_ERROR),
    };

    // Use MMDB_lookup_string
    let mut gai_error = 0;
    MMDB_lookup_string(mmdb, ip_cstr.as_ptr(), &mut gai_error, mmdb_error)
}

/// Get value from entry using array path
///
/// # Safety
/// - `start` must be a valid entry
/// - `entry_data` must be a valid pointer
/// - `path` must be NULL-terminated array of valid C strings
#[no_mangle]
pub unsafe extern "C" fn MMDB_aget_value(
    start: *mut MMDB_entry_s,
    entry_data: *mut MMDB_entry_data_s,
    path: *const *const c_char,
) -> c_int {
    if start.is_null() || entry_data.is_null() || path.is_null() {
        return MMDB_INVALID_DATA_ERROR;
    }

    // Call matchy's aget_value directly
    let matchy_entry = &(*start)._matchy_entry as *const _;
    let status = matchy_aget_value(matchy_entry, entry_data, path);

    map_matchy_error(status)
}

/// Get entry data list (tree traversal)
///
/// # Safety
/// - `start` must be a valid entry
/// - `entry_data_list` must be a valid pointer
#[no_mangle]
pub unsafe extern "C" fn MMDB_get_entry_data_list(
    start: *mut MMDB_entry_s,
    entry_data_list: *mut *mut MMDB_entry_data_list_s,
) -> c_int {
    if start.is_null() || entry_data_list.is_null() {
        return MMDB_INVALID_DATA_ERROR;
    }

    // Call matchy's get_entry_data_list
    let matchy_entry = &(*start)._matchy_entry as *const _;
    let matchy_list_ptr = entry_data_list.cast::<*mut matchy_entry_data_list_t>();
    let status = matchy_get_entry_data_list(matchy_entry, matchy_list_ptr);

    map_matchy_error(status)
}

/// Free entry data list
///
/// # Safety
/// - `entry_data_list` must be from MMDB_get_entry_data_list or NULL
#[no_mangle]
pub unsafe extern "C" fn MMDB_free_entry_data_list(entry_data_list: *mut MMDB_entry_data_list_s) {
    if entry_data_list.is_null() {
        return;
    }

    let mut current = entry_data_list;
    while !current.is_null() {
        let next = (*current).next;
        let _ = Box::from_raw(current);
        current = next;
    }
}

/// Close database
///
/// # Safety
/// - `mmdb` must be a valid opened database or NULL
#[no_mangle]
pub unsafe extern "C" fn MMDB_close(mmdb: *mut MMDB_s) {
    if mmdb.is_null() {
        return;
    }

    // Close matchy database
    if !(*mmdb)._matchy_db.is_null() {
        matchy_close((*mmdb)._matchy_db);
        (*mmdb)._matchy_db = ptr::null_mut();
    }

    // Free filename
    if !(*mmdb).filename.is_null() {
        let _ = CString::from_raw((*mmdb).filename as *mut c_char);
        (*mmdb).filename = ptr::null();
    }
}

/// Get library version
#[no_mangle]
pub extern "C" fn MMDB_lib_version() -> *const c_char {
    // Return matchy version with "-compat" suffix
    concat!(env!("CARGO_PKG_VERSION"), "-compat\0")
        .as_ptr()
        .cast::<c_char>()
}

/// Convert error code to string
#[no_mangle]
pub extern "C" fn MMDB_strerror(error_code: c_int) -> *const c_char {
    let msg = match error_code {
        MMDB_SUCCESS => "Success\0",
        MMDB_FILE_OPEN_ERROR => "Error opening database file\0",
        MMDB_IO_ERROR => "IO error\0",
        MMDB_OUT_OF_MEMORY_ERROR => "Out of memory\0",
        MMDB_INVALID_DATA_ERROR => "Invalid or corrupt data\0",
        MMDB_INVALID_LOOKUP_PATH_ERROR => "Invalid lookup path\0",
        MMDB_INVALID_NODE_NUMBER_ERROR => "Invalid node number\0",
        _ => "Unknown error\0",
    };
    msg.as_ptr().cast::<c_char>()
}

// ============================================================================
// STUB FUNCTIONS (Not implemented)
// ============================================================================

/// Read node (not implemented)
///
/// # Safety
/// This function is a stub and is not implemented. Always returns an error.
#[no_mangle]
pub unsafe extern "C" fn MMDB_read_node(
    _mmdb: *const MMDB_s,
    _node_number: u32,
    _node: *mut c_void,
) -> c_int {
    MMDB_INVALID_NODE_NUMBER_ERROR
}

/// Dump entry data list (not implemented)
///
/// # Safety
/// This function is a stub and is not implemented. Always returns an error.
#[no_mangle]
pub unsafe extern "C" fn MMDB_dump_entry_data_list(
    _stream: *mut libc::FILE,
    _entry_data_list: *const MMDB_entry_data_list_s,
    _indent: c_int,
) -> c_int {
    MMDB_INVALID_DATA_ERROR
}

/// Get metadata as entry data list (not implemented)
///
/// # Safety
/// This function is a stub and is not implemented. Always returns an error.
#[no_mangle]
pub unsafe extern "C" fn MMDB_get_metadata_as_entry_data_list(
    _mmdb: *const MMDB_s,
    _entry_data_list: *mut *mut MMDB_entry_data_list_s,
) -> c_int {
    MMDB_INVALID_DATA_ERROR
}