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 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
|
/*
* $Id: $
* $Version: $
*
* Copyright (c) Priit Jrv 2010,2011,2013
*
* This file is part of WhiteDB
*
* WhiteDB is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* WhiteDB is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WhiteDB. If not, see <http://www.gnu.org/licenses/>.
*
*/
/** @file dbquery.c
* WhiteDB query engine.
*/
/* ====== Includes =============== */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
/* ====== Private headers and defs ======== */
#ifdef __cplusplus
extern "C" {
#endif
#include "dballoc.h"
#include "dbquery.h"
#include "dbcompare.h"
#include "dbmpool.h"
#include "dbschema.h"
/* T-tree based scoring */
#define TTREE_SCORE_EQUAL 5
#define TTREE_SCORE_BOUND 2
#define TTREE_SCORE_NULL -1 /** penalty for null values, which
* are likely to be abundant */
#define TTREE_SCORE_MASK 5 /** matching field in template */
/* Query flags for internal use */
#define QUERY_FLAGS_PREFETCH 0x1000
#define QUERY_RESULTSET_PAGESIZE 63 /* mpool is aligned, so we can align
* the result pages too by selecting an
* appropriate size */
/* Emulate array index when doing a scan of key-value pairs
* in a JSON query.
* If this is not desirable, commenting this out makes
* scans somewhat faster.
*/
#define JSON_SCAN_UNWRAP_ARRAY
struct __query_result_page {
gint rows[QUERY_RESULTSET_PAGESIZE];
struct __query_result_page *next;
};
typedef struct __query_result_page query_result_page;
typedef struct {
query_result_page *page; /** current page of results */
gint pidx; /** current index on page (reading) */
} query_result_cursor;
typedef struct {
void *mpool; /** storage for row offsets */
query_result_page *first_page; /** first page of results, for rewinding */
query_result_cursor wcursor; /** read cursor */
query_result_cursor rcursor; /** write cursor */
gint res_count; /** number of rows in results */
} query_result_set;
/* ======= Private protos ================ */
static gint most_restricting_column(void *db,
wg_query_arg *arglist, gint argc, gint *index_id);
static gint check_arglist(void *db, void *rec, wg_query_arg *arglist,
gint argc);
static gint prepare_params(void *db, void *matchrec, gint reclen,
wg_query_arg *arglist, gint argc,
wg_query_arg **farglist, gint *fargc);
static gint find_ttree_bounds(void *db, gint index_id, gint col,
gint start_bound, gint end_bound, gint start_inclusive, gint end_inclusive,
gint *curr_offset, gint *curr_slot, gint *end_offset, gint *end_slot);
static wg_query *internal_build_query(void *db, void *matchrec, gint reclen,
wg_query_arg *arglist, gint argc, gint flags, wg_uint rowlimit);
static query_result_set *create_resultset(void *db);
static void free_resultset(void *db, query_result_set *set);
static void rewind_resultset(void *db, query_result_set *set);
static gint append_resultset(void *db, query_result_set *set, gint offset);
static gint fetch_resultset(void *db, query_result_set *set);
static query_result_set *intersect_resultset(void *db,
query_result_set *seta, query_result_set *setb);
static gint encode_query_param_unistr(void *db, char *data, gint type,
char *extdata, int length);
static gint show_query_error(void* db, char* errmsg);
/*static gint show_query_error_nr(void* db, char* errmsg, gint nr);*/
/* ====== Functions ============== */
/** Find most restricting column from query argument list
* This is probably a reasonable approach to optimize queries
* based on T-tree indexes, but might be difficult to combine
* with hash indexes.
* XXX: currently only considers the existence of T-tree
* index and nothing else.
*/
static gint most_restricting_column(void *db,
wg_query_arg *arglist, gint argc, gint *index_id) {
struct column_score {
gint column;
int score;
int index_id;
};
struct column_score *sc;
int i, j, mrc_score = -1;
gint mrc = -1;
db_memsegment_header* dbh = dbmemsegh(db);
sc = (struct column_score *) malloc(argc * sizeof(struct column_score));
if(!sc) {
show_query_error(db, "Failed to allocate memory");
return -1;
}
/* Scan through the arguments and calculate accumulated score
* for each column. */
for(i=0; i<argc; i++) {
/* As a side effect, we're initializing the score array
* in the same loop */
sc[i].column = -1;
sc[i].score = 0;
sc[i].index_id = 0;
/* Locate the slot for the column */
for(j=0; j<argc; j++) {
if(sc[j].column == -1) {
sc[j].column = arglist[i].column;
break;
}
if(sc[j].column == arglist[i].column) break;
}
/* Apply our primitive scoring */
switch(arglist[i].cond) {
case WG_COND_EQUAL:
sc[j].score += TTREE_SCORE_EQUAL;
if(arglist[i].value == 0) /* NULL values get a small penalty */
sc[j].score += TTREE_SCORE_NULL;
break;
case WG_COND_LESSTHAN:
case WG_COND_GREATER:
case WG_COND_LTEQUAL:
case WG_COND_GTEQUAL:
/* these all qualify as a bound. So two bounds
* appearing in the argument list on the same column
* score higher than one bound. */
sc[j].score += TTREE_SCORE_BOUND;
break;
default:
/* Note that we consider WG_COND_NOT_EQUAL near useless */
break;
}
}
/* Now loop over the scores to find the best. */
for(i=0; i<argc; i++) {
if(sc[i].column == -1) break;
/* Find the index on the column. The score is modified by the
* estimated quality of the index (0 if no index found).
*/
if(sc[i].column <= MAX_INDEXED_FIELDNR) {
gint *ilist = &dbh->index_control_area_header.index_table[sc[i].column];
while(*ilist) {
gcell *ilistelem = (gcell *) offsettoptr(db, *ilist);
if(ilistelem->car) {
wg_index_header *hdr = \
(wg_index_header *) offsettoptr(db, ilistelem->car);
if(hdr->type == WG_INDEX_TYPE_TTREE) {
#ifdef USE_INDEX_TEMPLATE
/* If index templates are available, we can increase the
* score of the index if the template has any columns matching
* the query parameters. On the other hand, in case of a
* mismatch the index is unusable and has to be skipped.
* The indexes are sorted in the order of fixed columns in
* the template, so if there is a match, the search is
* complete (remaining index are likely to be worse)
*/
if(hdr->template_offset) {
wg_index_template *tmpl = \
(wg_index_template *) offsettoptr(db, hdr->template_offset);
void *matchrec = offsettoptr(db, tmpl->offset_matchrec);
gint reclen = wg_get_record_len(db, matchrec);
for(j=0; j<reclen; j++) {
gint enc = wg_get_field(db, matchrec, j);
if(wg_get_encoded_type(db, enc) != WG_VARTYPE) {
/* defined column in matchrec. The score is increased
* if arglist has a WG_COND_EQUAL column with the same
* value. In any other case the index is not usable.
*/
int match = 0, k;
for(k=0; k<argc; k++) {
if(arglist[k].column == j) {
if(arglist[k].cond == WG_COND_EQUAL &&\
WG_COMPARE(db, enc, arglist[k].value) == WG_EQUAL) {
match = 1;
}
else
goto nextindex;
}
}
if(match) {
sc[i].score += TTREE_SCORE_MASK;
if(!enc)
sc[i].score += TTREE_SCORE_NULL;
}
else
goto nextindex;
}
}
}
#endif
sc[i].index_id = ilistelem->car;
break;
}
}
#ifdef USE_INDEX_TEMPLATE
nextindex:
#endif
ilist = &ilistelem->cdr;
}
}
if(!sc[i].index_id)
sc[i].score = 0; /* no index, score reset */
if(sc[i].score > mrc_score) {
mrc_score = sc[i].score;
mrc = sc[i].column;
*index_id = sc[i].index_id;
}
}
/* TODO: does the best score have no index? In that case,
* try to locate an index that would restrict at least
* some columns.
*/
free(sc);
return mrc;
}
/** Check a record against list of conditions
* returns 1 if the record matches
* returns 0 if the record fails at least one condition
*/
static gint check_arglist(void *db, void *rec, wg_query_arg *arglist,
gint argc) {
int i, reclen;
reclen = wg_get_record_len(db, rec);
for(i=0; i<argc; i++) {
gint encoded;
if(arglist[i].column < reclen)
encoded = wg_get_field(db, rec, arglist[i].column);
else
return 0; /* XXX: should shorter records always fail?
* other possiblities here: compare to WG_ILLEGAL
* or WG_NULLTYPE. Current idea is based on SQL
* concept of comparisons to NULL always failing.
*/
switch(arglist[i].cond) {
case WG_COND_EQUAL:
if(WG_COMPARE(db, encoded, arglist[i].value) != WG_EQUAL)
return 0;
break;
case WG_COND_LESSTHAN:
if(WG_COMPARE(db, encoded, arglist[i].value) != WG_LESSTHAN)
return 0;
break;
case WG_COND_GREATER:
if(WG_COMPARE(db, encoded, arglist[i].value) != WG_GREATER)
return 0;
break;
case WG_COND_LTEQUAL:
if(WG_COMPARE(db, encoded, arglist[i].value) == WG_GREATER)
return 0;
break;
case WG_COND_GTEQUAL:
if(WG_COMPARE(db, encoded, arglist[i].value) == WG_LESSTHAN)
return 0;
break;
case WG_COND_NOT_EQUAL:
if(WG_COMPARE(db, encoded, arglist[i].value) == WG_EQUAL)
return 0;
break;
default:
break;
}
}
return 1;
}
/** Prepare query parameters
*
* - Validates matchrec and arglist
* - Converts external pointers to locally allocated data
* - Builds an unified argument list
*
* Returns 0 on success, non-0 on error.
*
* If the function was successful, *farglist will be set to point
* to a newly allocated unified argument list and *fargc will be set
* to indicate the size of *farglist.
*
* If there was an error, *farglist and *fargc may be in
* an undetermined state.
*/
static gint prepare_params(void *db, void *matchrec, gint reclen,
wg_query_arg *arglist, gint argc,
wg_query_arg **farglist, gint *fargc) {
int i;
if(matchrec) {
/* Get the correct length of matchrec data area and the pointer
* to the beginning of the data. If matchrec is a plain array in
* local memory (indicated by NON-zero reclen) we will skip this step.
*/
if(!reclen) {
reclen = wg_get_record_len(db, matchrec);
matchrec = wg_get_record_dataarray(db, matchrec);
}
#ifdef CHECK
if(!reclen) {
show_query_error(db, "Zero-length match record argument");
return -1;
}
#endif
}
#ifdef CHECK
if(arglist && !argc) {
show_query_error(db, "Zero-length argument list");
return -1;
}
if(!arglist && argc) {
show_query_error(db, "Invalid argument list (NULL)");
return -1;
}
#endif
/* Determine total number of query parameters (number of arguments
* in arglist and non-wildcard fields of matchrec).
*/
*fargc = argc;
if(matchrec) {
for(i=0; i<reclen; i++) {
if(wg_get_encoded_type(db, ((gint *) matchrec)[i]) != WG_VARTYPE)
(*fargc)++;
}
}
if(*fargc) {
wg_query_arg *tmp = NULL;
/* The simplest way to treat matchrec is to convert it to
* arglist. While doing this, we will create a local copy of the
* argument list, which has the side effect of allowing the caller
* to free the original arglist after wg_make_query() returns. The
* local copy will be attached to the query object and needs to
* survive beyond that.
*/
tmp = (wg_query_arg *) malloc(*fargc * sizeof(wg_query_arg));
if(!tmp) {
show_query_error(db, "Failed to allocate memory");
return -2;
}
/* Copy the arglist contents */
for(i=0; i<argc; i++) {
tmp[i].column = arglist[i].column;
tmp[i].cond = arglist[i].cond;
tmp[i].value = arglist[i].value;
}
/* Append the matchrec data */
if(matchrec) {
int j;
for(i=0, j=argc; i<reclen; i++) {
if(wg_get_encoded_type(db, ((gint *) matchrec)[i]) != WG_VARTYPE) {
tmp[j].column = i;
tmp[j].cond = WG_COND_EQUAL;
tmp[j++].value = ((gint *) matchrec)[i];
}
}
}
*farglist = tmp;
}
else {
*farglist = NULL;
}
return 0;
}
/*
* Locate the node offset and slot for start and end bound
* in a T-tree index.
*
* return -1 on error
* return 0 on success
*/
static gint find_ttree_bounds(void *db, gint index_id, gint col,
gint start_bound, gint end_bound, gint start_inclusive, gint end_inclusive,
gint *curr_offset, gint *curr_slot, gint *end_offset, gint *end_slot)
{
/* hold the offsets temporarily */
gint co = *curr_offset;
gint cs = *curr_slot;
gint eo = *end_offset;
gint es = *end_slot;
wg_index_header *hdr = (wg_index_header *) offsettoptr(db, index_id);
struct wg_tnode *node;
if(start_bound==WG_ILLEGAL) {
/* Find leftmost node in index */
#ifdef TTREE_CHAINED_NODES
co = TTREE_MIN_NODE(hdr);
#else
/* LUB node search function has the useful property
* of returning the leftmost node when called directly
* on index root node */
co = wg_ttree_find_lub_node(db, TTREE_ROOT_NODE(hdr));
#endif
cs = 0; /* leftmost slot */
} else {
gint boundtype;
if(start_inclusive) {
/* In case of inclusive range, we get the leftmost
* node for the given value and the first slot that
* is equal or greater than the given value.
*/
co = wg_search_ttree_leftmost(db,
TTREE_ROOT_NODE(hdr), start_bound, &boundtype, NULL);
if(boundtype == REALLY_BOUNDING_NODE) {
cs = wg_search_tnode_first(db, co, start_bound, col);
if(cs == -1) {
show_query_error(db, "Starting index node was bad");
return -1;
}
} else if(boundtype == DEAD_END_RIGHT_NOT_BOUNDING) {
/* No exact match, but the next node should be in
* range. */
node = (struct wg_tnode *) offsettoptr(db, co);
co = TNODE_SUCCESSOR(db, node);
cs = 0;
} else if(boundtype == DEAD_END_LEFT_NOT_BOUNDING) {
/* Simplest case, values that are in range start
* with this node. */
cs = 0;
}
} else {
/* For non-inclusive, we need the rightmost node and
* the last slot+1. The latter may overflow into next node.
*/
co = wg_search_ttree_rightmost(db,
TTREE_ROOT_NODE(hdr), start_bound, &boundtype, NULL);
if(boundtype == REALLY_BOUNDING_NODE) {
cs = wg_search_tnode_last(db, co, start_bound, col);
if(cs == -1) {
show_query_error(db, "Starting index node was bad");
return -1;
}
cs++;
node = (struct wg_tnode *) offsettoptr(db, co);
if(node->number_of_elements <= cs) {
/* Crossed node boundary */
co = TNODE_SUCCESSOR(db, node);
cs = 0;
}
} else if(boundtype == DEAD_END_RIGHT_NOT_BOUNDING) {
/* Since exact value was not found, this case is exactly
* the same as with the inclusive range. */
node = (struct wg_tnode *) offsettoptr(db, co);
co = TNODE_SUCCESSOR(db, node);
cs = 0;
} else if(boundtype == DEAD_END_LEFT_NOT_BOUNDING) {
/* No exact value in tree, same as inclusive range */
cs = 0;
}
}
}
/* Finding of the end of the range is more or less opposite
* of finding the beginning. */
if(end_bound==WG_ILLEGAL) {
/* Rightmost node in index */
#ifdef TTREE_CHAINED_NODES
eo = TTREE_MAX_NODE(hdr);
#else
/* GLB search on root node returns the rightmost node in tree */
eo = wg_ttree_find_glb_node(db, TTREE_ROOT_NODE(hdr));
#endif
if(eo) {
node = (struct wg_tnode *) offsettoptr(db, eo);
es = node->number_of_elements - 1; /* rightmost slot */
}
} else {
gint boundtype;
if(end_inclusive) {
/* Find the rightmost node with a given value and the
* righmost slot that is equal or smaller than that value
*/
eo = wg_search_ttree_rightmost(db,
TTREE_ROOT_NODE(hdr), end_bound, &boundtype, NULL);
if(boundtype == REALLY_BOUNDING_NODE) {
es = wg_search_tnode_last(db, eo, end_bound, col);
if(es == -1) {
show_query_error(db, "Ending index node was bad");
return -1;
}
} else if(boundtype == DEAD_END_RIGHT_NOT_BOUNDING) {
/* Last node containing values in range. */
node = (struct wg_tnode *) offsettoptr(db, eo);
es = node->number_of_elements - 1;
} else if(boundtype == DEAD_END_LEFT_NOT_BOUNDING) {
/* Previous node should be in range. */
node = (struct wg_tnode *) offsettoptr(db, eo);
eo = TNODE_PREDECESSOR(db, node);
if(eo) {
node = (struct wg_tnode *) offsettoptr(db, eo);
es = node->number_of_elements - 1; /* rightmost */
}
}
} else {
/* For non-inclusive, we need the leftmost node and
* the first slot-1.
*/
eo = wg_search_ttree_leftmost(db,
TTREE_ROOT_NODE(hdr), end_bound, &boundtype, NULL);
if(boundtype == REALLY_BOUNDING_NODE) {
es = wg_search_tnode_first(db, eo,
end_bound, col);
if(es == -1) {
show_query_error(db, "Ending index node was bad");
return -1;
}
es--;
if(es < 0) {
/* Crossed node boundary */
node = (struct wg_tnode *) offsettoptr(db, eo);
eo = TNODE_PREDECESSOR(db, node);
if(eo) {
node = (struct wg_tnode *) offsettoptr(db, eo);
es = node->number_of_elements - 1;
}
}
} else if(boundtype == DEAD_END_RIGHT_NOT_BOUNDING) {
/* No exact value in tree, same as inclusive range */
node = (struct wg_tnode *) offsettoptr(db, eo);
es = node->number_of_elements - 1;
} else if(boundtype == DEAD_END_LEFT_NOT_BOUNDING) {
/* No exact value in tree, same as inclusive range */
node = (struct wg_tnode *) offsettoptr(db, eo);
eo = TNODE_PREDECESSOR(db, node);
if(eo) {
node = (struct wg_tnode *) offsettoptr(db, eo);
es = node->number_of_elements - 1; /* rightmost slot */
}
}
}
}
/* Now detect the cases where the above bound search
* has produced a result with an empty range.
*/
if(co) {
/* Value could be bounded inside a node, but actually
* not present. Note that we require the end_slot to be
* >= curr_slot, this implies that query->direction == 1.
*/
if(eo == co && es < cs) {
co = 0; /* query will return no rows */
eo = 0;
} else if(!eo) {
/* If one offset is 0 the other should be forced to 0, so that
* if we want to switch direction we won't run into any surprises.
*/
co = 0;
} else {
/* Another case we have to watch out for is when we have a
* range that fits in the space between two nodes. In that case
* the end offset will end up directly left of the start offset.
*/
node = (struct wg_tnode *) offsettoptr(db, co);
if(eo == TNODE_PREDECESSOR(db, node)) {
co = 0; /* no rows */
eo = 0;
}
}
} else {
eo = 0; /* again, if one offset is 0,
* the other should be, too */
}
*curr_offset = co;
*curr_slot = cs;
*end_offset = eo;
*end_slot = es;
return 0;
}
/** Create a query object.
*
* matchrec - array of encoded integers. Can be a pointer to a database record
* or a user-allocated array. If reclen is 0, it is treated as a native
* database record. If reclen is non-zero, reclen number of gint-sized
* words is read, starting from the pointer.
*
* Fields of type WG_VARTYPE in matchrec are treated as wildcards. Other
* types, including NULL, are used as "equals" conditions.
*
* arglist - array of wg_query_arg objects. The size is must be given
* by argc.
*
* flags - type of query requested and other parameters
*
* rowlimit - maximum number of rows fetched. Only has an effect if
* QUERY_FLAGS_PREFETCH is set.
*
* returns NULL if constructing the query fails. Otherwise returns a pointer
* to a wg_query object.
*/
static wg_query *internal_build_query(void *db, void *matchrec, gint reclen,
wg_query_arg *arglist, gint argc, gint flags, wg_uint rowlimit) {
wg_query *query;
wg_query_arg *full_arglist;
gint fargc = 0;
gint col, index_id = -1;
int i;
#ifdef CHECK
if (!dbcheck(db)) {
/* XXX: currently show_query_error would work too */
#ifdef WG_NO_ERRPRINT
#else
fprintf(stderr, "Invalid database pointer in wg_make_query.\n");
#endif
return NULL;
}
#endif
/* Check and prepare the parameters. If there was an error,
* prepare_params() does it's own cleanup so we can (and should)
* return immediately.
*/
if(prepare_params(db, matchrec, reclen, arglist, argc,
&full_arglist, &fargc)) {
return NULL;
}
query = (wg_query *) malloc(sizeof(wg_query));
if(!query) {
show_query_error(db, "Failed to allocate memory");
return NULL;
}
if(fargc) {
/* Find the best (hopefully) index to base the query on.
* Then initialise the query object to the first row in the
* query result set.
* XXX: only considering T-tree indexes now. */
col = most_restricting_column(db, full_arglist, fargc, &index_id);
}
else {
/* Create a "full scan" query with no arguments. */
index_id = -1;
full_arglist = NULL; /* redundant/paranoia */
}
if(index_id > 0) {
int start_inclusive = 0, end_inclusive = 0;
gint start_bound = WG_ILLEGAL; /* encoded values */
gint end_bound = WG_ILLEGAL;
query->qtype = WG_QTYPE_TTREE;
query->column = col;
query->curr_offset = 0;
query->curr_slot = -1;
query->end_offset = 0;
query->end_slot = -1;
query->direction = 1;
/* Determine the bounds for the given column/index.
*
* Examples of using rightmost and leftmost bounds in T-tree queries:
* val = 5 ==>
* find leftmost (A) and rightmost (B) nodes that contain value 5.
* Follow nodes sequentially from A until B is reached.
* val > 1 & val < 7 ==>
* find rightmost node with value 1 (A). Find leftmost node with
* value 7 (B). Find the rightmost value in A that still equals 1.
* The value immediately to the right is the beginning of the result
* set and the value immediately to the left of the first occurrence
* of 7 in B is the end of the result set.
* val > 1 & val <= 7 ==>
* A is the same as above. Find rightmost node with value 7 (B). The
* beginning of the result set is the same as above, the end is the
* last slot in B with value 7.
* val <= 1 ==>
* find rightmost node with value 1. Find the last (rightmost) slot
* containing 1. The result set begins with that value, scan left
* until the end of chain is reached.
*/
for(i=0; i<fargc; i++) {
if(full_arglist[i].column != col) continue;
switch(full_arglist[i].cond) {
case WG_COND_EQUAL:
/* Set bounds as if we had val >= 1 & val <= 1 */
if(start_bound==WG_ILLEGAL ||\
WG_COMPARE(db, start_bound, full_arglist[i].value)==WG_LESSTHAN) {
start_bound = full_arglist[i].value;
start_inclusive = 1;
}
if(end_bound==WG_ILLEGAL ||\
WG_COMPARE(db, end_bound, full_arglist[i].value)==WG_GREATER) {
end_bound = full_arglist[i].value;
end_inclusive = 1;
}
break;
case WG_COND_LESSTHAN:
/* No earlier right bound or new end bound is a smaller
* value (reducing the result set). The result set is also
* possibly reduced if the value is equal, because this
* condition is non-inclusive. */
if(end_bound==WG_ILLEGAL ||\
WG_COMPARE(db, end_bound, full_arglist[i].value)!=WG_LESSTHAN) {
end_bound = full_arglist[i].value;
end_inclusive = 0;
}
break;
case WG_COND_GREATER:
/* No earlier left bound or new left bound is >= of old value */
if(start_bound==WG_ILLEGAL ||\
WG_COMPARE(db, start_bound, full_arglist[i].value)!=WG_GREATER) {
start_bound = full_arglist[i].value;
start_inclusive = 0;
}
break;
case WG_COND_LTEQUAL:
/* Similar to "less than", but inclusive */
if(end_bound==WG_ILLEGAL ||\
WG_COMPARE(db, end_bound, full_arglist[i].value)==WG_GREATER) {
end_bound = full_arglist[i].value;
end_inclusive = 1;
}
break;
case WG_COND_GTEQUAL:
/* Similar to "greater", but inclusive */
if(start_bound==WG_ILLEGAL ||\
WG_COMPARE(db, start_bound, full_arglist[i].value)==WG_LESSTHAN) {
start_bound = full_arglist[i].value;
start_inclusive = 1;
}
break;
case WG_COND_NOT_EQUAL:
/* Force use of full argument list to check each row in the result
* set since we have a condition we cannot satisfy using
* a continuous range of T-tree values alone
*/
query->column = -1;
break;
default:
show_query_error(db, "Invalid condition (ignoring)");
break;
}
}
/* Simple sanity check. Is start_bound greater than end_bound? */
if(start_bound!=WG_ILLEGAL && end_bound!=WG_ILLEGAL &&\
WG_COMPARE(db, start_bound, end_bound) == WG_GREATER) {
/* return empty query */
query->argc = 0;
query->arglist = NULL;
free(full_arglist);
return query;
}
/* Now find the bounding nodes for the query */
if(find_ttree_bounds(db, index_id, col,
start_bound, end_bound, start_inclusive, end_inclusive,
&query->curr_offset, &query->curr_slot, &query->end_offset,
&query->end_slot)) {
free(query);
free(full_arglist);
return NULL;
}
/* XXX: here we can reverse the direction and switch the start and
* end nodes/slots, if "descending" sort order is needed.
*/
} else {
/* Nothing better than full scan available */
void *rec;
query->qtype = WG_QTYPE_SCAN;
query->column = -1; /* no special column, entire argument list
* should be checked for each row */
rec = wg_get_first_record(db);
if(rec)
query->curr_record = ptrtooffset(db, rec);
else
query->curr_record = 0;
}
/* Now attach the argument list to the query. If the query is based
* on a column index, we will create a slimmer copy that does not contain
* the conditions already satisfied by the index bounds.
*/
if(query->column == -1) {
query->arglist = full_arglist;
query->argc = fargc;
}
else {
int cnt = 0;
for(i=0; i<fargc; i++) {
if(full_arglist[i].column != query->column)
cnt++;
}
/* The argument list is reduced, but still contains columns */
if(cnt) {
int j;
query->arglist = (wg_query_arg *) malloc(cnt * sizeof(wg_query_arg));
if(!query->arglist) {
show_query_error(db, "Failed to allocate memory");
free(query);
free(full_arglist);
return NULL;
}
for(i=0, j=0; i<fargc; i++) {
if(full_arglist[i].column != query->column) {
query->arglist[j].column = full_arglist[i].column;
query->arglist[j].cond = full_arglist[i].cond;
query->arglist[j++].value = full_arglist[i].value;
}
}
} else
query->arglist = NULL;
query->argc = cnt;
free(full_arglist); /* Now we have a reduced argument list, free
* the original one */
}
/* Now handle any post-processing required.
*/
if(flags & QUERY_FLAGS_PREFETCH) {
query_result_page **prevnext;
query_result_page *currpage;
void *rec;
query->curr_page = NULL; /* initialize as empty */
query->curr_pidx = 0;
query->res_count = 0;
/* XXX: could move this inside the loop (speeds up empty
* query, slows down other queries) */
query->mpool = wg_create_mpool(db, sizeof(query_result_page));
if(!query->mpool) {
show_query_error(db, "Failed to allocate result memory pool");
wg_free_query(db, query);
return NULL;
}
i = QUERY_RESULTSET_PAGESIZE;
prevnext = (query_result_page **) &(query->curr_page);
while((rec = wg_fetch(db, query))) {
if(i >= QUERY_RESULTSET_PAGESIZE) {
currpage = (query_result_page *) \
wg_alloc_mpool(db, query->mpool, sizeof(query_result_page));
if(!currpage) {
show_query_error(db, "Failed to allocate a resultset row");
wg_free_query(db, query);
return NULL;
}
memset(currpage->rows, 0, sizeof(gint) * QUERY_RESULTSET_PAGESIZE);
*prevnext = currpage;
prevnext = &(currpage->next);
currpage->next = NULL;
i = 0;
}
currpage->rows[i++] = ptrtooffset(db, rec);
query->res_count++;
if(rowlimit && query->res_count >= rowlimit)
break;
}
/* Finally, convert the query type. */
query->qtype = WG_QTYPE_PREFETCH;
}
return query;
}
/** Create a query object and pre-fetch all data rows.
*
* Allocates enough space to hold all row offsets, fetches them and stores
* them in an array. Isolation is not guaranteed in any way, shape or form,
* but can be implemented on top by the user.
*
* returns NULL if constructing the query fails. Otherwise returns a pointer
* to a wg_query object.
*/
wg_query *wg_make_query(void *db, void *matchrec, gint reclen,
wg_query_arg *arglist, gint argc) {
return internal_build_query(db,
matchrec, reclen, arglist, argc, QUERY_FLAGS_PREFETCH, 0);
}
/** Create a query object and pre-fetch rowlimit number of rows.
*
* returns NULL if constructing the query fails. Otherwise returns a pointer
* to a wg_query object.
*/
wg_query *wg_make_query_rc(void *db, void *matchrec, gint reclen,
wg_query_arg *arglist, gint argc, wg_uint rowlimit) {
return internal_build_query(db,
matchrec, reclen, arglist, argc, QUERY_FLAGS_PREFETCH, rowlimit);
}
/** Return next record from the query object
* returns NULL if no more records
*/
void *wg_fetch(void *db, wg_query *query) {
void *rec;
#ifdef CHECK
if (!dbcheck(db)) {
/* XXX: currently show_query_error would work too */
#ifdef WG_NO_ERRPRINT
#else
fprintf(stderr, "Invalid database pointer in wg_fetch.\n");
#endif
return NULL;
}
if(!query) {
show_query_error(db, "Invalid query object");
return NULL;
}
#endif
if(query->qtype == WG_QTYPE_SCAN) {
for(;;) {
void *next;
if(!query->curr_record) {
/* Query exhausted */
return NULL;
}
rec = offsettoptr(db, query->curr_record);
/* Pre-fetch the next record */
next = wg_get_next_record(db, rec);
if(next)
query->curr_record = ptrtooffset(db, next);
else
query->curr_record = 0;
/* Check the record against all conditions; if it does
* not match, go to next iteration.
*/
if(!query->arglist || \
check_arglist(db, rec, query->arglist, query->argc))
return rec;
}
}
else if(query->qtype == WG_QTYPE_TTREE) {
struct wg_tnode *node;
for(;;) {
if(!query->curr_offset) {
/* No more nodes to examine */
return NULL;
}
node = (struct wg_tnode *) offsettoptr(db, query->curr_offset);
rec = offsettoptr(db, node->array_of_values[query->curr_slot]);
/* Increment the slot/and or node cursors before we
* return. If the current node does not satisfy the
* argument list we may need to do this multiple times.
*/
if(query->curr_offset==query->end_offset && \
query->curr_slot==query->end_slot) {
/* Last slot reached, mark the query as exchausted */
query->curr_offset = 0;
} else {
/* Some rows still left */
query->curr_slot += query->direction;
if(query->curr_slot < 0) {
#ifdef CHECK
if(query->end_offset==query->curr_offset) {
/* This should not happen */
show_query_error(db, "Warning: end slot mismatch, possible bug");
query->curr_offset = 0;
} else {
#endif
query->curr_offset = TNODE_PREDECESSOR(db, node);
if(query->curr_offset) {
node = (struct wg_tnode *) offsettoptr(db, query->curr_offset);
query->curr_slot = node->number_of_elements - 1;
}
#ifdef CHECK
}
#endif
} else if(query->curr_slot >= node->number_of_elements) {
#ifdef CHECK
if(query->end_offset==query->curr_offset) {
/* This should not happen */
show_query_error(db, "Warning: end slot mismatch, possible bug");
query->curr_offset = 0;
} else {
#endif
query->curr_offset = TNODE_SUCCESSOR(db, node);
query->curr_slot = 0;
#ifdef CHECK
}
#endif
}
}
/* If there are no extra conditions or the row satisfies
* all the conditions, we can return.
*/
if(!query->arglist || \
check_arglist(db, rec, query->arglist, query->argc))
return rec;
}
}
if(query->qtype == WG_QTYPE_PREFETCH) {
if(query->curr_page) {
query_result_page *currpage = (query_result_page *) query->curr_page;
gint offset = currpage->rows[query->curr_pidx++];
if(!offset) {
/* page not filled completely */
query->curr_page = NULL;
return NULL;
} else {
if(query->curr_pidx >= QUERY_RESULTSET_PAGESIZE) {
query->curr_page = (void *) (currpage->next);
query->curr_pidx = 0;
}
}
return offsettoptr(db, offset);
}
else
return NULL;
}
else {
show_query_error(db, "Unsupported query type");
return NULL;
}
}
/** Release the memory allocated for the query
*/
void wg_free_query(void *db, wg_query *query) {
if(query->arglist)
free(query->arglist);
if(query->qtype==WG_QTYPE_PREFETCH && query->mpool)
wg_free_mpool(db, query->mpool);
free(query);
}
/* ----------- query parameter preparing functions -------------*/
/* Types that use no storage are encoded
* using standard API functions.
*/
gint wg_encode_query_param_null(void *db, char *data) {
return wg_encode_null(db, data);
}
gint wg_encode_query_param_record(void *db, void *data) {
return wg_encode_record(db, data);
}
gint wg_encode_query_param_char(void *db, char data) {
return wg_encode_char(db, data);
}
gint wg_encode_query_param_fixpoint(void *db, double data) {
return wg_encode_fixpoint(db, data);
}
gint wg_encode_query_param_date(void *db, int data) {
return wg_encode_date(db, data);
}
gint wg_encode_query_param_time(void *db, int data) {
return wg_encode_time(db, data);
}
gint wg_encode_query_param_var(void *db, gint data) {
return wg_encode_var(db, data);
}
/* Types using storage are encoded by emulating the behaviour
* of dbdata.c functions. Some assumptions are made about storage
* size of the data (but similar assumptions exist in dbdata.c)
*/
gint wg_encode_query_param_int(void *db, gint data) {
void *dptr;
if(fits_smallint(data)) {
return encode_smallint(data);
} else {
dptr=malloc(sizeof(gint));
if(!dptr) {
show_query_error(db, "Failed to encode query parameter");
return WG_ILLEGAL;
}
*((gint *) dptr) = data;
return encode_fullint_offset(ptrtooffset(db, dptr));
}
}
gint wg_encode_query_param_double(void *db, double data) {
void *dptr;
dptr=malloc(2*sizeof(gint));
if(!dptr) {
show_query_error(db, "Failed to encode query parameter");
return WG_ILLEGAL;
}
*((double *) dptr) = data;
return encode_fulldouble_offset(ptrtooffset(db, dptr));
}
gint wg_encode_query_param_str(void *db, char *data, char *lang) {
if(data) {
return encode_query_param_unistr(db, data, WG_STRTYPE, lang, strlen(data));
} else {
show_query_error(db, "NULL pointer given as parameter");
return WG_ILLEGAL;
}
}
gint wg_encode_query_param_xmlliteral(void *db, char *data, char *xsdtype) {
if(data) {
return encode_query_param_unistr(db, data, WG_XMLLITERALTYPE,
xsdtype, strlen(data));
} else {
show_query_error(db, "NULL pointer given as parameter");
return WG_ILLEGAL;
}
}
gint wg_encode_query_param_uri(void *db, char *data, char *prefix) {
if(data) {
return encode_query_param_unistr(db, data, WG_URITYPE,
prefix, strlen(data));
} else {
show_query_error(db, "NULL pointer given as parameter");
return WG_ILLEGAL;
}
}
/* Encode shortstr- or longstr-compatible data in local memory.
* string type without lang is handled as "short", ignoring the
* actual length. All other types require longstr storage to
* handle the extdata field.
*/
static gint encode_query_param_unistr(void *db, char *data, gint type,
char *extdata, int length) {
void *dptr;
if(type == WG_STRTYPE && extdata == NULL) {
dptr=malloc(length+1);
if(!dptr) {
show_query_error(db, "Failed to encode query parameter");
return WG_ILLEGAL;
}
memcpy((char *) dptr, data, length);
((char *) dptr)[length] = '\0';
return encode_shortstr_offset(ptrtooffset(db, dptr));
}
else {
size_t i;
int extlen = 0;
int dlen, lengints, lenrest;
gint offset, meta;
if(type != WG_BLOBTYPE)
length++; /* include the terminating 0 */
/* Determine storage size */
lengints = length / sizeof(gint);
lenrest = length % sizeof(gint);
if(lenrest) lengints++;
dlen = sizeof(gint) * (LONGSTR_HEADER_GINTS + lengints);
/* Emulate the behaviour of wg_alloc_gints() */
if(dlen < MIN_VARLENOBJ_SIZE) dlen = MIN_VARLENOBJ_SIZE;
if(dlen % 8) dlen += 4;
if(extdata) {
extlen = strlen(extdata);
}
dptr=malloc(dlen + (extdata ? extlen + 1 : 0));
if(!dptr) {
show_query_error(db, "Failed to encode query parameter");
return WG_ILLEGAL;
}
offset = ptrtooffset(db, dptr);
/* Copy the data, fill the remainder with zeroes */
memcpy((char *) dptr + (LONGSTR_HEADER_GINTS*sizeof(gint)), data, length);
for(i=0; lenrest && i<sizeof(gint)-lenrest; i++) {
*((char *)dptr + length + (LONGSTR_HEADER_GINTS*sizeof(gint)) + i) = '\0';
}
/* Use the rest of the allocated storage to encode extdata in
* shortstr format.
*/
if(extdata) {
gint extenc;
void *extptr = (char *) dptr + dlen;
memcpy(extptr, extdata, extlen);
((char *) extptr)[extlen] = '\0';
extenc = encode_shortstr_offset(ptrtooffset(db, extptr));
dbstore(db, offset+LONGSTR_EXTRASTR_POS*sizeof(gint), extenc);
} else {
dbstore(db, offset+LONGSTR_EXTRASTR_POS*sizeof(gint), 0);
}
/* Metadata */
dbstore(db, offset, dlen); /* Local memory, actual value OK here */
meta = (dlen - length) << LONGSTR_META_LENDIFSHFT;
meta = meta | type;
dbstore(db, offset+LONGSTR_META_POS*sizeof(gint), meta);
dbstore(db, offset+LONGSTR_REFCOUNT_POS*sizeof(gint), 0);
dbstore(db, offset+LONGSTR_BACKLINKS_POS*sizeof(gint), 0);
dbstore(db, offset+LONGSTR_HASHCHAIN_POS*sizeof(gint), 0);
return encode_longstr_offset(offset);
}
}
gint wg_free_query_param(void* db, gint data) {
#ifdef CHECK
if (!dbcheck(db)) {
show_query_error(db,"wrong database pointer given to wg_free_query_param");
return 0;
}
#endif
if (isptr(data)) {
gint offset;
switch(data&NORMALPTRMASK) {
case DATARECBITS:
break;
case SHORTSTRBITS:
offset = decode_shortstr_offset(data);
free(offsettoptr(db, offset));
break;
case LONGSTRBITS:
offset = decode_longstr_offset(data);
free(offsettoptr(db, offset));
break;
case FULLDOUBLEBITS:
offset = decode_fulldouble_offset(data);
free(offsettoptr(db, offset));
break;
case FULLINTBITSV0:
case FULLINTBITSV1:
offset = decode_fullint_offset(data);
free(offsettoptr(db, offset));
break;
default:
show_query_error(db,"Bad encoded value given to wg_free_query_param");
break;
}
}
return 0;
}
/* ------------------ Resultset manipulation -------------------*/
/* XXX: consider converting the main query function to use this as well.
* Currently only used to support the JSON/document query.
*/
/*
* Allocate and initialize a new result set.
*/
static query_result_set *create_resultset(void *db) {
query_result_set *set;
if(!(set = malloc(sizeof(query_result_set)))) {
show_query_error(db, "Failed to allocate result set");
return NULL;
}
set->rcursor.page = NULL; /* initialize as empty */
set->rcursor.pidx = 0;
set->wcursor.page = NULL;
set->wcursor.pidx = QUERY_RESULTSET_PAGESIZE; /* new page needed */
set->first_page = NULL;
set->res_count = 0;
set->mpool = wg_create_mpool(db, sizeof(query_result_page));
if(!set->mpool) {
show_query_error(db, "Failed to allocate result memory pool");
free(set);
return NULL;
}
return set;
}
/*
* Free the resultset and it's memory pool
*/
static void free_resultset(void *db, query_result_set *set) {
if(set->mpool)
wg_free_mpool(db, set->mpool);
free(set);
}
/*
* Set the resultset pointers to the beginning of the
* first results page.
*/
static void rewind_resultset(void *db, query_result_set *set) {
set->rcursor.page = set->first_page;
set->rcursor.pidx = 0;
}
/*
* Append an offset to the result set.
* returns 0 on success.
* returns -1 on error.
*/
static gint append_resultset(void *db, query_result_set *set, gint offset) {
if(set->wcursor.pidx >= QUERY_RESULTSET_PAGESIZE) {
query_result_page *newpage = (query_result_page *) \
wg_alloc_mpool(db, set->mpool, sizeof(query_result_page));
if(!newpage) {
return show_query_error(db, "Failed to allocate a resultset page");
}
memset(newpage->rows, 0, sizeof(gint) * QUERY_RESULTSET_PAGESIZE);
newpage->next = NULL;
if(set->wcursor.page) {
set->wcursor.page->next = newpage;
} else {
/* first_page==NULL implied */
set->first_page = newpage;
set->rcursor.page = newpage;
}
set->wcursor.page = newpage;
set->wcursor.pidx = 0;
}
set->wcursor.page->rows[set->wcursor.pidx++] = offset;
set->res_count++;
return 0;
}
/*
* Fetch the next offset from the result set.
* returns 0 if the set is exhausted.
*/
static gint fetch_resultset(void *db, query_result_set *set) {
if(set->rcursor.page) {
gint offset = set->rcursor.page->rows[set->rcursor.pidx++];
if(!offset) {
/* page not filled completely. Mark set as exhausted. */
set->rcursor.page = NULL;
} else {
if(set->rcursor.pidx >= QUERY_RESULTSET_PAGESIZE) {
set->rcursor.page = set->rcursor.page->next;
set->rcursor.pidx = 0;
}
}
return offset;
}
return 0;
}
/*
* Create an intersection of two result sets.
* Returns a new result set (can be empty).
* Returns NULL on error.
*/
static query_result_set *intersect_resultset(void *db,
query_result_set *seta, query_result_set *setb)
{
gint offseta;
query_result_set *intersection;
if(!(intersection = create_resultset(db))) {
return NULL;
}
rewind_resultset(db, seta);
while((offseta = fetch_resultset(db, seta))) {
gint offsetb;
rewind_resultset(db, setb);
while((offsetb = fetch_resultset(db, setb))) {
if(offseta == offsetb) {
gint err = append_resultset(db, intersection, offseta);
if(err) {
free_resultset(db, intersection);
return NULL;
}
break;
}
}
}
return intersection;
}
/*
* Create a result set that contains only unique rows.
* Returns a new result set (can be empty).
* Returns NULL on error.
*/
static query_result_set *unique_resultset(void *db, query_result_set *set)
{
gint offset;
query_result_set *unique;
if(!(unique = create_resultset(db))) {
return NULL;
}
rewind_resultset(db, set);
while((offset = fetch_resultset(db, set))) {
gint offsetu, found = 0;
rewind_resultset(db, unique);
while((offsetu = fetch_resultset(db, unique))) {
if(offset == offsetu) {
found = 1;
break;
}
}
if(!found) {
/* We're now at the end of the set and may append normally. */
gint err = append_resultset(db, unique, offset);
if(err) {
free_resultset(db, unique);
return NULL;
}
}
}
return unique;
}
/* ------------------- (JSON) document query -------------------*/
#define ADD_DOC_TO_RESULTSET(db, ns, cr, doc, err) \
if(doc) { \
err = append_resultset(db, ns, ptrtooffset(db, doc)); \
} else { \
err = show_query_error(db, "Failed to retrieve the document"); \
} \
if(err) { \
free_resultset(db, ns); \
if(cr) \
free_resultset(db, cr); \
return NULL; \
}
/*
* Find a list of documents that contain the key-value pairs.
* Returns a prefetch query object.
* Returns NULL on error.
*/
wg_query *wg_make_json_query(void *db, wg_json_query_arg *arglist, gint argc) {
wg_query *query = NULL;
query_result_set *curr_res = NULL;
gint index_id = -1;
gint icols[2], i;
#ifdef CHECK
if(!arglist || argc < 1) {
show_query_error(db, "Not enough parameters");
return NULL;
}
if (!dbcheck(db)) {
#ifdef WG_NO_ERRPRINT
#else
fprintf(stderr, "Invalid database pointer in wg_make_json_query.\n");
#endif
return NULL;
}
#endif
/* Get index */
icols[0] = WG_SCHEMA_KEY_OFFSET;
icols[1] = WG_SCHEMA_VALUE_OFFSET;
index_id = wg_multi_column_to_index_id(db, icols, 2,
WG_INDEX_TYPE_HASH_JSON, NULL, 0);
/* Iterate over the argument pairs.
* XXX: it is possible that getting the first set from index and
* doing a scan to check the remaining arguments is faster than
* doing the intersect operation of sets retrieved from index.
* XXX: given that we don't index complex structures, reorder
* arguments so that immediate values come first.
*/
for(i=0; i<argc; i++) {
query_result_set *next_set, *tmp_set;
/* Initialize the set produced by this iteration */
next_set = create_resultset(db);
if(!next_set) {
if(curr_res)
free_resultset(db, curr_res);
return NULL;
}
if(index_id > 0 &&\
wg_get_encoded_type(db, arglist[i].value) != WG_RECORDTYPE) {
/* Fetch the matching rows from the index, then retrieve the
* documents they belong to.
*/
gint values[2];
gint reclist_offset;
values[0] = arglist[i].key;
values[1] = arglist[i].value;
reclist_offset = wg_search_hash(db, index_id, values, 2);
if(reclist_offset > 0) {
gint *nextoffset = &reclist_offset;
while(*nextoffset) {
gcell *rec_cell = (gcell *) offsettoptr(db, *nextoffset);
gint err = -1;
void *document = \
wg_find_document(db, offsettoptr(db, rec_cell->car));
ADD_DOC_TO_RESULTSET(db, next_set, curr_res, document, err)
nextoffset = &(rec_cell->cdr);
}
}
}
else {
/* No index, do a scan. This also happens if the value
* is a complex structure.
* XXX: if i>0 scan curr_res instead! (duh) */
gint *rec = wg_get_first_record(db);
while(rec) {
gint reclen = wg_get_record_len(db, rec);
if(reclen > WG_SCHEMA_VALUE_OFFSET) { /* XXX: assume key
* before value */
#ifndef JSON_SCAN_UNWRAP_ARRAY
if(WG_COMPARE(db, wg_get_field(db, rec, WG_SCHEMA_KEY_OFFSET),
arglist[i].key) == WG_EQUAL &&\
WG_COMPARE(db, wg_get_field(db, rec, WG_SCHEMA_VALUE_OFFSET),
arglist[i].value) == WG_EQUAL)
{
gint err = -1;
void *document = wg_find_document(db, rec);
ADD_DOC_TO_RESULTSET(db, next_set, curr_res, document, err)
}
#else
if(WG_COMPARE(db, wg_get_field(db, rec, WG_SCHEMA_KEY_OFFSET),
arglist[i].key) == WG_EQUAL) {
gint k = wg_get_field(db, rec, WG_SCHEMA_VALUE_OFFSET);
if(WG_COMPARE(db, k, arglist[i].value) == WG_EQUAL) {
/* Direct match. */
gint err = -1;
void *document = wg_find_document(db, rec);
ADD_DOC_TO_RESULTSET(db, next_set, curr_res, document, err)
} else if(wg_get_encoded_type(db, k) == WG_RECORDTYPE) {
/* No direct match, but if it is a record AND an array,
* scan the array contents.
*/
void *arec = wg_decode_record(db, k);
if(is_schema_array(arec)) {
gint areclen = wg_get_record_len(db, arec);
int j;
for(j=0; j<areclen; j++) {
if(WG_COMPARE(db, wg_get_field(db, arec, j),
arglist[i].value) == WG_EQUAL) {
gint err = -1;
void *document = wg_find_document(db, rec);
ADD_DOC_TO_RESULTSET(db, next_set, curr_res, document, err)
break;
}
}
}
}
}
#endif
}
rec = wg_get_next_record(db, rec);
}
}
/* Delete duplicate documents */
tmp_set = unique_resultset(db, next_set);
free_resultset(db, next_set);
if(!tmp_set) {
if(curr_res)
free_resultset(db, curr_res);
return NULL;
} else {
next_set = tmp_set;
}
/* Update the query result */
if(i) {
/* Working resultset exists, create an intersection */
if(curr_res->res_count < next_set->res_count) { /* minor optimization */
tmp_set = intersect_resultset(db, curr_res, next_set);
} else {
tmp_set = intersect_resultset(db, next_set, curr_res);
}
free_resultset(db, curr_res);
free_resultset(db, next_set);
if(!tmp_set) {
return NULL;
} else {
curr_res = tmp_set;
}
} else {
/* This set becomes the working resultset */
curr_res = next_set;
}
}
/* Initialize query object */
query = (wg_query *) malloc(sizeof(wg_query));
if(!query) {
free_resultset(db, curr_res);
show_query_error(db, "Failed to allocate memory");
return NULL;
}
query->qtype = WG_QTYPE_PREFETCH;
query->arglist = NULL;
query->argc = 0;
query->column = -1;
/* Copy the result. */
query->curr_page = curr_res->first_page;
query->curr_pidx = 0;
query->res_count = curr_res->res_count;
query->mpool = curr_res->mpool;
free(curr_res); /* contents were inherited, dispose of the struct */
return query;
}
/* ------------------ simple query functions -------------------*/
void *wg_find_record(void *db, gint fieldnr, gint cond, gint data,
void* lastrecord) {
gint index_id = -1;
/* find index on colum */
if(cond != WG_COND_NOT_EQUAL) {
index_id = wg_multi_column_to_index_id(db, &fieldnr, 1,
WG_INDEX_TYPE_TTREE, NULL, 0);
}
if(index_id > 0) {
int start_inclusive = 1, end_inclusive = 1;
/* WG_ILLEGAL is interpreted as "no bound" */
gint start_bound = WG_ILLEGAL;
gint end_bound = WG_ILLEGAL;
gint curr_offset = 0, curr_slot = -1, end_offset = 0, end_slot = -1;
void *prev = NULL;
switch(cond) {
case WG_COND_EQUAL:
start_bound = end_bound = data;
break;
case WG_COND_LESSTHAN:
end_bound = data;
end_inclusive = 0;
break;
case WG_COND_GREATER:
start_bound = data;
start_inclusive = 0;
break;
case WG_COND_LTEQUAL:
end_bound = data;
break;
case WG_COND_GTEQUAL:
start_bound = data;
break;
default:
show_query_error(db, "Invalid condition (ignoring)");
return NULL;
}
if(find_ttree_bounds(db, index_id, fieldnr,
start_bound, end_bound, start_inclusive, end_inclusive,
&curr_offset, &curr_slot, &end_offset, &end_slot)) {
return NULL;
}
/* We have the bounds, scan to lastrecord */
while(curr_offset) {
struct wg_tnode *node = (struct wg_tnode *) offsettoptr(db, curr_offset);
void *rec = offsettoptr(db, node->array_of_values[curr_slot]);
if(prev == lastrecord) {
/* if lastrecord is NULL, first match returned */
return rec;
}
prev = rec;
if(curr_offset==end_offset && curr_slot==end_slot) {
/* Last slot reached */
break;
} else {
/* Some rows still left */
curr_slot += 1; /* direction implied as 1 */
if(curr_slot >= node->number_of_elements) {
#ifdef CHECK
if(end_offset==curr_offset) {
/* This should not happen */
show_query_error(db, "Warning: end slot mismatch, possible bug");
break;
} else {
#endif
curr_offset = TNODE_SUCCESSOR(db, node);
curr_slot = 0;
#ifdef CHECK
}
#endif
}
}
}
}
else {
/* no index (or cond == WG_COND_NOT_EQUAL), do a scan */
wg_query_arg arg;
void *rec;
if(lastrecord) {
rec = wg_get_next_record(db, lastrecord);
} else {
rec = wg_get_first_record(db);
}
arg.column = fieldnr;
arg.cond = cond;
arg.value = data;
while(rec) {
if(check_arglist(db, rec, &arg, 1)) {
return rec;
}
rec = wg_get_next_record(db, rec);
}
}
/* No records found (this can also happen if matching records were
* found but lastrecord does not match any of them or matches the
* very last one).
*/
return NULL;
}
/*
* Wrapper function for wg_find_record with unencoded data (null)
*/
void *wg_find_record_null(void *db, gint fieldnr, gint cond, char *data,
void* lastrecord) {
gint enc = wg_encode_query_param_null(db, data);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (record)
*/
void *wg_find_record_record(void *db, gint fieldnr, gint cond, void *data,
void* lastrecord) {
gint enc = wg_encode_query_param_record(db, data);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (char)
*/
void *wg_find_record_char(void *db, gint fieldnr, gint cond, char data,
void* lastrecord) {
gint enc = wg_encode_query_param_char(db, data);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (fixpoint)
*/
void *wg_find_record_fixpoint(void *db, gint fieldnr, gint cond, double data,
void* lastrecord) {
gint enc = wg_encode_query_param_fixpoint(db, data);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (date)
*/
void *wg_find_record_date(void *db, gint fieldnr, gint cond, int data,
void* lastrecord) {
gint enc = wg_encode_query_param_date(db, data);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (time)
*/
void *wg_find_record_time(void *db, gint fieldnr, gint cond, int data,
void* lastrecord) {
gint enc = wg_encode_query_param_time(db, data);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (var)
*/
void *wg_find_record_var(void *db, gint fieldnr, gint cond, gint data,
void* lastrecord) {
gint enc = wg_encode_query_param_var(db, data);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (int)
*/
void *wg_find_record_int(void *db, gint fieldnr, gint cond, int data,
void* lastrecord) {
gint enc = wg_encode_query_param_int(db, data);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
wg_free_query_param(db, enc);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (double)
*/
void *wg_find_record_double(void *db, gint fieldnr, gint cond, double data,
void* lastrecord) {
gint enc = wg_encode_query_param_double(db, data);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
wg_free_query_param(db, enc);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (string)
*/
void *wg_find_record_str(void *db, gint fieldnr, gint cond, char *data,
void* lastrecord) {
gint enc = wg_encode_query_param_str(db, data, NULL);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
wg_free_query_param(db, enc);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (xmlliteral)
*/
void *wg_find_record_xmlliteral(void *db, gint fieldnr, gint cond, char *data,
char *xsdtype, void* lastrecord) {
gint enc = wg_encode_query_param_xmlliteral(db, data, xsdtype);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
wg_free_query_param(db, enc);
return rec;
}
/*
* Wrapper function for wg_find_record with unencoded data (uri)
*/
void *wg_find_record_uri(void *db, gint fieldnr, gint cond, char *data,
char *prefix, void* lastrecord) {
gint enc = wg_encode_query_param_uri(db, data, prefix);
void *rec = wg_find_record(db, fieldnr, cond, enc, lastrecord);
wg_free_query_param(db, enc);
return rec;
}
/* --------------- error handling ------------------------------*/
/** called with err msg
*
* may print or log an error
* does not do any jumps etc
*/
static gint show_query_error(void* db, char* errmsg) {
#ifdef WG_NO_ERRPRINT
#else
fprintf(stderr,"query error: %s\n",errmsg);
#endif
return -1;
}
#if 0
/** called with err msg and additional int data
*
* may print or log an error
* does not do any jumps etc
*/
static gint show_query_error_nr(void* db, char* errmsg, gint nr) {
#ifdef WG_NO_ERRPRINT
#else
fprintf(stderr,"query error: %s %d\n",errmsg,nr);
#endif
return -1;
}
#endif
#ifdef __cplusplus
}
#endif
|