src/include/gnunet_sq_lib.h

   1 /*
   2   This file is part of GNUnet
   3   Copyright (C) 2017 GNUnet e.V.
   4
   5   GNUnet is free software; you can redistribute it and/or modify it under the
   6   terms of the GNU General Public License as published by the Free Software
   7   Foundation; either version 3, or (at your option) any later version.
   8
   9   GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY
  10   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  11   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  12
  13   You should have received a copy of the GNU General Public License along with
  14   GNUnet; see the file COPYING.  If not, If not, see <http://www.gnu.org/licenses/>
  15 */
  16 /**
  17  * @file include/gnunet_sq_lib.h
  18  * @brief helper functions for Sqlite3 DB interactions
  19  * @author Christian Grothoff
  20  */
  21 #ifndef GNUNET_SQ_LIB_H
  22 #define GNUNET_SQ_LIB_H
  23
  24 #include <sqlite3.h>
  25 #include "gnunet_util_lib.h"
  26
  27
  28 /**
  29  * Function called to convert input argument into SQL parameters.
  30  *
  31  * @param cls closure
  32  * @param data pointer to input argument
  33  * @param data_len number of bytes in @a data (if applicable)
  34  * @param stmt sqlite statement to bind parameters for
  35  * @param off offset of the argument to bind in @a stmt, numbered from 1,
  36  *            so immediately suitable for passing to `sqlite3_bind`-functions.
  37  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
  38  */
  39 typedef int
  40 (*GNUNET_SQ_QueryConverter)(void *cls,
  41                             const void *data,
  42                             size_t data_len,
  43                             sqlite3_stmt *stmt,
  44                             unsigned int off);
  45
  46
  47 /**
  48  * @brief Description of a DB query parameter.
  49  */
  50 struct GNUNET_SQ_QueryParam
  51 {
  52
  53   /**
  54    * Function for how to handle this type of entry.
  55    */
  56   GNUNET_SQ_QueryConverter conv;
  57
  58   /**
  59    * Closure for @e conv.
  60    */
  61   void *conv_cls;
  62
  63   /**
  64    * Data or NULL.
  65    */
  66   const void *data;
  67
  68   /**
  69    * Size of @e data
  70    */
  71   size_t size;
  72
  73   /**
  74    * Number of parameters eaten by this operation.
  75    */
  76   unsigned int num_params;
  77 };
  78
  79
  80 /**
  81  * End of query parameter specification.
  82  */
  83 #define GNUNET_SQ_query_param_end { NULL, NULL, NULL, 0, 0 }
  84
  85
  86 /**
  87  * Generate query parameter for a buffer @a ptr of
  88  * @a ptr_size bytes.
  89  *
  90  * @param ptr pointer to the query parameter to pass
  91  * @oaran ptr_size number of bytes in @a ptr
  92  */
  93 struct GNUNET_SQ_QueryParam
  94 GNUNET_SQ_query_param_fixed_size (const void *ptr,
  95                                   size_t ptr_size);
  96
  97
  98
  99 /**
 100  * Generate query parameter for a string.
 101  *
 102  * @param ptr pointer to the string query parameter to pass
 103  */
 104 struct GNUNET_SQ_QueryParam
 105 GNUNET_SQ_query_param_string (const char *ptr);
 106
 107
 108 /**
 109  * Generate fixed-size query parameter with size determined
 110  * by variable type.
 111  *
 112  * @param x pointer to the query parameter to pass.
 113  */
 114 #define GNUNET_SQ_query_param_auto_from_type(x) GNUNET_SQ_query_param_fixed_size ((x), sizeof (*(x)))
 115
 116
 117 /**
 118  * Generate query parameter for an RSA public key.  The
 119  * database must contain a BLOB type in the respective position.
 120  *
 121  * @param x the query parameter to pass.
 122  */
 123 struct GNUNET_SQ_QueryParam
 124 GNUNET_SQ_query_param_rsa_public_key (const struct GNUNET_CRYPTO_RsaPublicKey *x);
 125
 126
 127 /**
 128  * Generate query parameter for an RSA signature.  The
 129  * database must contain a BLOB type in the respective position.
 130  *
 131  * @param x the query parameter to pass
 132  */
 133 struct GNUNET_SQ_QueryParam
 134 GNUNET_SQ_query_param_rsa_signature (const struct GNUNET_CRYPTO_RsaSignature *x);
 135
 136
 137 /**
 138  * Generate query parameter for an absolute time value.
 139  * The database must store a 64-bit integer.
 140  *
 141  * @param x pointer to the query parameter to pass
 142  */
 143 struct GNUNET_SQ_QueryParam
 144 GNUNET_SQ_query_param_absolute_time (const struct GNUNET_TIME_Absolute *x);
 145
 146
 147 /**
 148  * Generate query parameter for an absolute time value.
 149  * The database must store a 64-bit integer.
 150  *
 151  * @param x pointer to the query parameter to pass
 152  */
 153 struct GNUNET_SQ_QueryParam
 154 GNUNET_SQ_query_param_absolute_time_nbo (const struct GNUNET_TIME_AbsoluteNBO *x);
 155
 156
 157 /**
 158  * Generate query parameter for an uint16_t in host byte order.
 159  *
 160  * @param x pointer to the query parameter to pass
 161  */
 162 struct GNUNET_SQ_QueryParam
 163 GNUNET_SQ_query_param_uint16 (const uint16_t *x);
 164
 165
 166 /**
 167  * Generate query parameter for an uint32_t in host byte order.
 168  *
 169  * @param x pointer to the query parameter to pass
 170  */
 171 struct GNUNET_SQ_QueryParam
 172 GNUNET_SQ_query_param_uint32 (const uint32_t *x);
 173
 174
 175 /**
 176  * Generate query parameter for an uint16_t in host byte order.
 177  *
 178  * @param x pointer to the query parameter to pass
 179  */
 180 struct GNUNET_SQ_QueryParam
 181 GNUNET_SQ_query_param_uint64 (const uint64_t *x);
 182
 183
 184 /**
 185  * Extract data from a Postgres database @a result at row @a row.
 186  *
 187  * @param cls closure
 188  * @param result where to extract data from
 189  * @param column column to extract data from
 190  * @param[in,out] dst_size where to store size of result, may be NULL
 191  * @param[out] dst where to store the result
 192  * @return
 193  *   #GNUNET_YES if all results could be extracted
 194  *   #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
 195  */
 196 typedef int
 197 (*GNUNET_SQ_ResultConverter)(void *cls,
 198                              sqlite3_stmt *result,
 199                              unsigned int column,
 200                              size_t *dst_size,
 201                              void *dst);
 202
 203
 204 /**
 205  * @brief Description of a DB result cell.
 206  */
 207 struct GNUNET_SQ_ResultSpec;
 208
 209
 210 /**
 211  * Function called to clean up memory allocated
 212  * by a #GNUNET_SQ_ResultConverter.
 213  *
 214  * @param cls closure
 215  */
 216 typedef void
 217 (*GNUNET_SQ_ResultCleanup)(void *cls);
 218
 219
 220 /**
 221  * @brief Description of a DB result cell.
 222  */
 223 struct GNUNET_SQ_ResultSpec
 224 {
 225
 226   /**
 227    * What is the format of the result?
 228    */
 229   GNUNET_SQ_ResultConverter conv;
 230
 231   /**
 232    * Function to clean up result data, NULL if cleanup is
 233    * not necessary.
 234    */
 235   GNUNET_SQ_ResultCleanup cleaner;
 236
 237   /**
 238    * Closure for @e conv and @e cleaner.
 239    */
 240   void *cls;
 241
 242   /**
 243    * Destination for the data.
 244    */
 245   void *dst;
 246
 247   /**
 248    * Allowed size for the data, 0 for variable-size
 249    * (in this case, the type of @e dst is a `void **`
 250    * and we need to allocate a buffer of the right size).
 251    */
 252   size_t dst_size;
 253
 254   /**
 255    * Where to store actual size of the result.  If left at
 256    * NULL, will be made to point to @e dst_size before
 257    * @a conv is called.
 258    */
 259   size_t *result_size;
 260
 261   /**
 262    * Number of parameters (columns) eaten by this operation.
 263    */
 264   unsigned int num_params;
 265
 266 };
 267
 268
 269 /**
 270  * End of result parameter specification.
 271  *
 272  * @return array last entry for the result specification to use
 273  */
 274 #define GNUNET_SQ_result_spec_end { NULL, NULL, NULL, NULL, 0, NULL }
 275
 276
 277 /**
 278  * Variable-size result expected.
 279  *
 280  * @param[out] dst where to store the result, allocated
 281  * @param[out] sptr where to store the size of @a dst
 282  * @return array entry for the result specification to use
 283  */
 284 struct GNUNET_SQ_ResultSpec
 285 GNUNET_SQ_result_spec_variable_size (void **dst,
 286                                      size_t *sptr);
 287
 288
 289 /**
 290  * Fixed-size result expected.
 291  *
 292  * @param[out] dst where to store the result
 293  * @param dst_size number of bytes in @a dst
 294  * @return array entry for the result specification to use
 295  */
 296 struct GNUNET_SQ_ResultSpec
 297 GNUNET_SQ_result_spec_fixed_size (void *dst,
 298                                   size_t dst_size);
 299
 300
 301 /**
 302  * We expect a fixed-size result, with size determined by the type of `* dst`
 303  *
 304  * @param dst point to where to store the result, type fits expected result size
 305  * @return array entry for the result specification to use
 306  */
 307 #define GNUNET_SQ_result_spec_auto_from_type(dst) GNUNET_SQ_result_spec_fixed_size ((dst), sizeof (*(dst)))
 308
 309
 310 /**
 311  * Variable-size result expected.
 312  *
 313  * @param[out] dst where to store the result, allocated
 314  * @param[out] sptr where to store the size of @a dst
 315  * @return array entry for the result specification to use
 316  */
 317 struct GNUNET_SQ_ResultSpec
 318 GNUNET_SQ_result_spec_variable_size (void **dst,
 319                                      size_t *sptr);
 320
 321
 322 /**
 323  * 0-terminated string expected.
 324  *
 325  * @param[out] dst where to store the result, allocated
 326  * @return array entry for the result specification to use
 327  */
 328 struct GNUNET_SQ_ResultSpec
 329 GNUNET_SQ_result_spec_string (char **dst);
 330
 331
 332 /**
 333  * RSA public key expected.
 334  *
 335  * @param[out] rsa where to store the result
 336  * @return array entry for the result specification to use
 337  */
 338 struct GNUNET_SQ_ResultSpec
 339 GNUNET_SQ_result_spec_rsa_public_key (struct GNUNET_CRYPTO_RsaPublicKey **rsa);
 340
 341
 342 /**
 343  * RSA signature expected.
 344  *
 345  * @param[out] sig where to store the result;
 346  * @return array entry for the result specification to use
 347  */
 348 struct GNUNET_SQ_ResultSpec
 349 GNUNET_SQ_result_spec_rsa_signature (struct GNUNET_CRYPTO_RsaSignature **sig);
 350
 351
 352 /**
 353  * Absolute time expected.
 354  *
 355  * @param[out] at where to store the result
 356  * @return array entry for the result specification to use
 357  */
 358 struct GNUNET_SQ_ResultSpec
 359 GNUNET_SQ_result_spec_absolute_time (struct GNUNET_TIME_Absolute *at);
 360
 361
 362 /**
 363  * Absolute time expected.
 364  *
 365  * @param[out] at where to store the result
 366  * @return array entry for the result specification to use
 367  */
 368 struct GNUNET_SQ_ResultSpec
 369 GNUNET_SQ_result_spec_absolute_time_nbo (struct GNUNET_TIME_AbsoluteNBO *at);
 370
 371
 372 /**
 373  * uint16_t expected.
 374  *
 375  * @param[out] u16 where to store the result
 376  * @return array entry for the result specification to use
 377  */
 378 struct GNUNET_SQ_ResultSpec
 379 GNUNET_SQ_result_spec_uint16 (uint16_t *u16);
 380
 381
 382 /**
 383  * uint32_t expected.
 384  *
 385  * @param[out] u32 where to store the result
 386  * @return array entry for the result specification to use
 387  */
 388 struct GNUNET_SQ_ResultSpec
 389 GNUNET_SQ_result_spec_uint32 (uint32_t *u32);
 390
 391
 392 /**
 393  * uint64_t expected.
 394  *
 395  * @param[out] u64 where to store the result
 396  * @return array entry for the result specification to use
 397  */
 398 struct GNUNET_SQ_ResultSpec
 399 GNUNET_SQ_result_spec_uint64 (uint64_t *u64);
 400
 401
 402 /**
 403  * Execute a prepared statement.
 404  *
 405  * @param db_conn database connection
 406  * @param params parameters to the statement
 407  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 408  */
 409 int
 410 GNUNET_SQ_bind (sqlite3_stmt *stmt,
 411                 const struct GNUNET_SQ_QueryParam *params);
 412
 413
 414 /**
 415  * Extract results from a query result according to the given specification.
 416  *
 417  * @param result result to process
 418  * @param[in,out] rs result specification to extract for
 419  * @return
 420  *   #GNUNET_OK if all results could be extracted
 421  *   #GNUNET_SYSERR if a result was invalid (non-existing field)
 422  */
 423 int
 424 GNUNET_SQ_extract_result (sqlite3_stmt *result,
 425                           struct GNUNET_SQ_ResultSpec *rs);
 426
 427
 428 /**
 429  * Free all memory that was allocated in @a rs during
 430  * #GNUNET_SQ_extract_result().
 431  *
 432  * @param rs reult specification to clean up
 433  */
 434 void
 435 GNUNET_SQ_cleanup_result (struct GNUNET_SQ_ResultSpec *rs);
 436
 437
 438 #endif  /* GNUNET_SQ_LIB_H_ */
 439
 440 /* end of include/gnunet_sq_lib.h */