mirror of
https://github.com/valitydev/osquery-1.git
synced 2024-11-08 10:23:54 +00:00
109 lines
3.1 KiB
C++
109 lines
3.1 KiB
C++
/*
|
|
* Copyright (c) 2014-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <boost/noncopyable.hpp>
|
|
|
|
#include <osquery/tables.h>
|
|
|
|
#include "osquery/core/conversions.h"
|
|
#include "osquery/sql/sqlite_util.h"
|
|
|
|
namespace osquery {
|
|
|
|
/**
|
|
* @brief A protection around concurrent table attach requests.
|
|
*
|
|
* Table attaching is not concurrent. Attaching is the only unprotected SQLite
|
|
* operation from osquery's usage perspective. The extensions API allows for
|
|
* concurrent access of non-thread-safe database resources for attaching table
|
|
* schema and filter routing instructions.
|
|
*/
|
|
extern RecursiveMutex kAttachMutex;
|
|
|
|
/**
|
|
* @brief osquery cursor object.
|
|
*
|
|
* Only used in the SQLite virtual table module methods.
|
|
*/
|
|
struct BaseCursor : private boost::noncopyable {
|
|
public:
|
|
/// SQLite virtual table cursor.
|
|
sqlite3_vtab_cursor base;
|
|
|
|
/// Track cursors for optional planner output.
|
|
size_t id{0};
|
|
|
|
/// Table data generated from last access.
|
|
QueryData data;
|
|
|
|
/// Callable generator.
|
|
std::unique_ptr<RowGenerator::pull_type> generator{nullptr};
|
|
|
|
/// Results of current call.
|
|
Row current;
|
|
|
|
/// Does the backing local table use a generator type.
|
|
bool uses_generator{false};
|
|
|
|
/// Current cursor position.
|
|
size_t row{0};
|
|
|
|
/// Total number of rows.
|
|
size_t n{0};
|
|
};
|
|
|
|
/**
|
|
* @brief osquery virtual table object
|
|
*
|
|
* Only used in the SQLite virtual table module methods.
|
|
* This adds each table plugin class to the state tracking in SQLite.
|
|
*/
|
|
struct VirtualTable : private boost::noncopyable {
|
|
/// The SQLite-provided virtual table structure.
|
|
sqlite3_vtab base;
|
|
|
|
/// Added structure: A content structure with metadata about the table.
|
|
VirtualTableContent* content{nullptr};
|
|
|
|
/// Added structure: The thread-local DB instance associated with the query.
|
|
SQLiteDBInstance* instance{nullptr};
|
|
};
|
|
|
|
/// Attach a table plugin name to an in-memory SQLite database.
|
|
Status attachTableInternal(const std::string& name,
|
|
const std::string& statement,
|
|
const SQLiteDBInstanceRef& instance);
|
|
|
|
/// Detach (drop) a table.
|
|
Status detachTableInternal(const std::string& name, sqlite3* db);
|
|
|
|
Status attachFunctionInternal(
|
|
const std::string& name,
|
|
std::function<
|
|
void(sqlite3_context* context, int argc, sqlite3_value** argv)> func);
|
|
|
|
/// Attach all table plugins to an in-memory SQLite database.
|
|
void attachVirtualTables(const SQLiteDBInstanceRef& instance);
|
|
|
|
#if !defined(OSQUERY_EXTERNAL)
|
|
/**
|
|
* A generated foreign amalgamation file includes schema for all tables.
|
|
*
|
|
* When the build system generates TablePlugin%s from the .table spec files, it
|
|
* reads the foreign-platform tables and generates an associated schema plugin.
|
|
* These plugins are amalgamated into 'foreign_amalgamation' and do not call
|
|
* their filter generation functions.
|
|
*/
|
|
void registerForeignTables();
|
|
#endif
|
|
}
|