refactor: Move osquery/include files to appropriate places (osquery#6557

)
ccombs-sqsp · Aug 11, 2020 · 8ee7e3a · 8ee7e3a
1 parent 6c98ab3
commit 8ee7e3a
Show file tree

Hide file tree

Showing 627 changed files with 1,644 additions and 1,611 deletions.
diff --git a/docs/wiki/development/config-plugins.md b/docs/wiki/development/config-plugins.md
@@ -8,8 +8,8 @@ The following code is more-or-less the **filesystem** config plugin. This is the
 
 ```cpp
 // Note 1: REQUIRED includes
-#include <osquery/config.h>
-#include <osquery/flags.h>
+#include <osquery/config/config.h>
+#include <osquery/core/flags.h>
 
 namespace osquery {
 

diff --git a/docs/wiki/development/creating-tables.md b/docs/wiki/development/creating-tables.md
@@ -93,7 +93,7 @@ Here is that code for `./osquery/tables/utility/time_example.cpp`:
 // Copyright 2004-present Facebook. All Rights Reserved.
 
 #include <ctime>
-#include <osquery/tables.h>
+#include <osquery/core/tables.h>
 
 namespace osquery {
 namespace tables {
@@ -171,7 +171,7 @@ To make this compile, open `./tests/integration/tables/CMakeLists.txt`, find the
 
 ## Using where clauses
 
-The `QueryContext` data type is osquery's abstraction of the underlying SQL engine's query parsing. It is defined in [osquery/tables.h](/osquery/include/osquery/tables.h).
+The `QueryContext` data type is osquery's abstraction of the underlying SQL engine's query parsing. It is defined in `osquery/core/tables.h`.
 
 The most important use of the context is query predicate constraints (e.g., `WHERE col = 'value'`). Some tables MUST have a predicate constraint, others may optionally use the constraints to increase performance.
 
@@ -201,7 +201,7 @@ Examples:
 
 ## SQL data types
 
-Data types like `TableRows`, `TableRow`, `DiffResults`, etc. are osquery's built-in data result types. They're all defined in [include/osquery/database.h](https://github.com/osquery/osquery/blob/master/include/osquery/database.h).
+Data types like `TableRows`, `TableRow`, `DiffResults`, etc. are osquery's built-in data result types. They're all defined in [osquery/database/database.h](https://github.com/osquery/osquery/blob/master/osquery/database/database.h).
 
 `TableRow` is an interface; each table has a generated implementation with strongly-typed fields for each column in the table. There's also `DynamicTableRow`, which is backed by a `std::map<std::string, std::string>` mapping column names to the string representations of their values. `DynamicTableRow` exists to support tables that were written before the strongly-typed row support was added, and for plugins.
 

diff --git a/docs/wiki/development/options-arguments.md b/docs/wiki/development/options-arguments.md
@@ -1,6 +1,6 @@
 How do I add a command line flag/option/argument to osquery? Well, first familiarize yourself with gflags, then take note of the wrapper below.
 
-[include/osquery/flags.h](https://github.com/osquery/osquery/blob/master/include/osquery/flags.h) contains a single wrapper for `gflags::DEFINE_` type style macros. osquery includes a simple wrapper for defining arguments/options/flags for the osqueryd daemon and shell.
+[osquery/core/flags.h](https://github.com/osquery/osquery/blob/master/osquery/core/flags.h) contains a single wrapper for `gflags::DEFINE_` type style macros. osquery includes a simple wrapper for defining arguments/options/flags for the osqueryd daemon and shell.
 
 Instead of writing the normal gflags macro for defining a new option:
 
@@ -13,7 +13,7 @@ DEFINE_bool(you_are_awesome, true, "Ground truth for awesome.");  // DON'T DO TH
 Use the following wrapper:
 
 ```cpp
-#include <osquery/flags.h>
+#include <osquery/core/flags.h>
 
 FLAG(bool, you_are_awesome, true, "Ground truth for awesome.");
 ```
@@ -22,4 +22,4 @@ If you are declaring a flag before defining it, no change is needed. Use `DECLAR
 
 This will allow osquery callers to show pretty displays when `-h, --help` is used.
 
-> NOTICE: restrict your default values to code literals. It does not help to abstract the default variable into a constant then use it singularly in the macro.
+> NOTICE: restrict your default values to code literals. It does not help to abstract the default variable into a constant then use it singularly in the macro.
diff --git a/docs/wiki/development/pubsub-framework.md b/docs/wiki/development/pubsub-framework.md
@@ -44,8 +44,8 @@ implementation("new_etc_files@NewETCFilesEventSubscriber::genTable")
 Now with the simplest table spec possible, we need to write `NewETCFilesEventSubscriber`!
 
 ```cpp
-#include <osquery/database.h>
-#include "osquery/events/linux/inotify.h"
+#include <osquery/database/database.h>
+#include <osquery/events/linux/inotify.h>
 
 namespace osquery {
 namespace tables {

diff --git a/osquery/CMakeLists.txt b/osquery/CMakeLists.txt
@@ -32,26 +32,9 @@ function(osqueryMain)
   add_subdirectory("system")
   add_subdirectory("worker")
 
-  generateOsqueryHeaders()
   generateOsqueryd()
 endfunction()
 
-function(generateOsqueryHeaders)
-  add_osquery_library(osquery_headers INTERFACE)
-  target_include_directories(osquery_headers INTERFACE "${CMAKE_SOURCE_DIR}/osquery/include")
-
-  target_link_libraries(osquery_headers INTERFACE
-    osquery_cxx_settings
-    osquery_core_plugins
-    osquery_utils_info
-    osquery_utils_macros
-    osquery_utils_system_systemutils
-    thirdparty_gflags
-    thirdparty_sqlite
-    thirdparty_googletest_headers
-  )
-endfunction()
-
 function(generateOsqueryd)
   # Upstream uses an empty executable that links to a library with a
   # a main() entry point; try to emulate this.

diff --git a/osquery/carver/carver.cpp b/osquery/carver/carver.cpp
@@ -15,14 +15,14 @@
 #include <boost/algorithm/string.hpp>
 
 #include <osquery/carver/carver.h>
-#include <osquery/database.h>
-#include <osquery/distributed.h>
+#include <osquery/database/database.h>
+#include <osquery/distributed/distributed.h>
 #include <osquery/filesystem/fileops.h>
-#include <osquery/flags.h>
+#include <osquery/core/flags.h>
 #include <osquery/hashing/hashing.h>
-#include <osquery/logger.h>
+#include <osquery/logger/logger.h>
 #include <osquery/remote/serializers/json.h>
-#include <osquery/system.h>
+#include <osquery/core/system.h>
 #include <osquery/utils/base64.h>
 #include <osquery/utils/json/json.h>
 

diff --git a/osquery/carver/carver.h b/osquery/carver/carver.h
@@ -11,7 +11,7 @@
 #include <set>
 #include <string>
 
-#include <osquery/dispatcher.h>
+#include <osquery/dispatcher/dispatcher.h>
 #include <osquery/filesystem/filesystem.h>
 #include <osquery/utils/status/status.h>
 

diff --git a/osquery/carver/tests/carver_tests.cpp b/osquery/carver/tests/carver_tests.cpp
@@ -15,12 +15,12 @@
 
 #include <osquery/carver/carver.h>
 #include <osquery/config/tests/test_utils.h>
-#include <osquery/database.h>
+#include <osquery/core/system.h>
+#include <osquery/database/database.h>
 #include <osquery/filesystem/fileops.h>
 #include <osquery/hashing/hashing.h>
-#include <osquery/registry.h>
-#include <osquery/sql.h>
-#include <osquery/system.h>
+#include <osquery/registry/registry.h>
+#include <osquery/sql/sql.h>
 #include <osquery/utils/json/json.h>
 
 namespace osquery {

diff --git a/osquery/config/CMakeLists.txt b/osquery/config/CMakeLists.txt
@@ -22,15 +22,17 @@ function(generateOsqueryConfig)
 
   target_link_libraries(osquery_config PUBLIC
     osquery_cxx_settings
-    osquery_headers
+    osquery_events_eventsregistry
     osquery_filesystem
     osquery_hashing
+    osquery_registry
     osquery_utils
     osquery_utils_system_time
   )
 
   set(public_header_files
     config.h
+    packs.h
   )
 
   generateIncludeNamespace(osquery_config "osquery/config" "FILE_ONLY" ${public_header_files})

diff --git a/osquery/config/config.cpp b/osquery/config/config.cpp
@@ -19,17 +19,17 @@
 #include <boost/iterator/filter_iterator.hpp>
 
 #include <osquery/config/config.h>
-#include <osquery/database.h>
-#include <osquery/events.h>
-#include <osquery/flagalias.h>
-#include <osquery/flags.h>
+#include <osquery/config/packs.h>
+#include <osquery/core/flagalias.h>
+#include <osquery/core/flags.h>
+#include <osquery/core/shutdown.h>
+#include <osquery/core/system.h>
+#include <osquery/core/tables.h>
+#include <osquery/database/database.h>
+#include <osquery/events/events.h>
 #include <osquery/hashing/hashing.h>
-#include <osquery/logger.h>
-#include <osquery/packs.h>
-#include <osquery/registry.h>
-#include <osquery/shutdown.h>
-#include <osquery/system.h>
-#include <osquery/tables.h>
+#include <osquery/logger/logger.h>
+#include <osquery/registry/registry.h>
 
 #include <osquery/utils/conversions/split.h>
 #include <osquery/utils/conversions/tryto.h>

diff --git a/osquery/config/config.h b/osquery/config/config.h
@@ -13,9 +13,9 @@
 #include <memory>
 #include <vector>
 
+#include <osquery/core/query.h>
 #include <osquery/core/sql/query_performance.h>
 #include <osquery/plugins/plugin.h>
-#include <osquery/query.h>
 #include <osquery/utils/expected/expected.h>
 #include <osquery/utils/json/json.h>
 

diff --git a/osquery/config/packs.cpp b/osquery/config/packs.cpp
@@ -10,12 +10,12 @@
 #include <mutex>
 #include <random>
 
-#include <osquery/database.h>
+#include <osquery/config/packs.h>
+#include <osquery/core/system.h>
+#include <osquery/database/database.h>
 #include <osquery/hashing/hashing.h>
-#include <osquery/logger.h>
-#include <osquery/packs.h>
-#include <osquery/sql.h>
-#include <osquery/system.h>
+#include <osquery/logger/logger.h>
+#include <osquery/sql/sql.h>
 #include <osquery/utils/conversions/split.h>
 #include <osquery/utils/conversions/tryto.h>
 #include <osquery/utils/info/version.h>

diff --git a/osquery/include/osquery/packs.h → osquery/config/packs.h b/osquery/include/osquery/packs.h → osquery/config/packs.h
@@ -17,7 +17,7 @@
 
 #include <boost/noncopyable.hpp>
 
-#include <osquery/query.h>
+#include <osquery/core/query.h>
 
 #include <gtest/gtest_prod.h>
 
@@ -182,4 +182,4 @@ size_t splayValue(size_t original, size_t splay_percent);
  * @return either the restored previous calculated splay, or a new splay.
  */
 size_t restoreSplayedValue(const std::string& name, size_t interval);
-}
+} // namespace osquery
diff --git a/osquery/config/tests/config_tests.cpp b/osquery/config/tests/config_tests.cpp
@@ -21,13 +21,13 @@
 #include <osquery/filesystem/filesystem.h>
 #include <osquery/filesystem/mock_file_structure.h>
 
-#include <osquery/core.h>
-#include <osquery/database.h>
-#include <osquery/dispatcher.h>
-#include <osquery/flags.h>
-#include <osquery/packs.h>
-#include <osquery/registry.h>
-#include <osquery/system.h>
+#include <osquery/config/packs.h>
+#include <osquery/core/core.h>
+#include <osquery/core/flags.h>
+#include <osquery/core/system.h>
+#include <osquery/database/database.h>
+#include <osquery/dispatcher/dispatcher.h>
+#include <osquery/registry/registry.h>
 #include <osquery/utils/json/json.h>
 
 #include <osquery/utils/info/platform_type.h>

diff --git a/osquery/config/tests/packs.cpp b/osquery/config/tests/packs.cpp
@@ -10,12 +10,12 @@
 
 #include <osquery/config/tests/test_utils.h>
 
-#include <osquery/core.h>
-#include <osquery/database.h>
-#include <osquery/flags.h>
-#include <osquery/packs.h>
-#include <osquery/registry.h>
-#include <osquery/system.h>
+#include <osquery/config/packs.h>
+#include <osquery/core/core.h>
+#include <osquery/core/flags.h>
+#include <osquery/core/system.h>
+#include <osquery/database/database.h>
+#include <osquery/registry/registry.h>
 
 #include <osquery/filesystem/filesystem.h>
 

diff --git a/osquery/core/CMakeLists.txt b/osquery/core/CMakeLists.txt
@@ -27,9 +27,10 @@ function(generateOsqueryCoreInit)
   )
 
   set(dependencies
-    osquery_headers
+    osquery_cxx_settings
     osquery_config
     osquery_core
+    osquery_numericmonitoring
     osquery_extensions
   )
 
@@ -75,11 +76,12 @@ function(generateOsqueryCore)
   )
 
   set(dependencies
-    osquery_headers
+    osquery_cxx_settings
     osquery_core_plugins
     osquery_core_sql
     osquery_filesystem
     osquery_process
+    osquery_registry
     osquery_utils
     osquery_utils_conversions
     osquery_utils_info
@@ -103,17 +105,25 @@ function(generateOsqueryCore)
     ${dependencies}
   )
 
+  set(public_header_files
+    core.h
+    flags.h
+    flagalias.h
+    query.h
+    tables.h
+    shutdown.h
+    system.h
+  )
+
   if(DEFINED PLATFORM_WINDOWS)
-    list(APPEND windows_public_header_files
+    list(APPEND public_header_files
       windows/handle.h
       windows/ntapi.h
       windows/wmi.h
     )
-
-    generateIncludeNamespace(osquery_core "osquery/core" "FULL_PATH" ${windows_public_header_files})
   endif()
 
-  generateIncludeNamespace(osquery_core "osquery/core" "FILE_ONLY" ${public_header_files})
+  generateIncludeNamespace(osquery_core "osquery/core" "FULL_PATH" ${public_header_files})
 
   add_test(NAME osquery_core_tests_flagstests-test COMMAND osquery_core_tests_flagstests-test)
   add_test(NAME osquery_core_tests_systemtests-test COMMAND osquery_core_tests_systemtests-test)

diff --git a/osquery/include/osquery/core.h → osquery/core/core.h b/osquery/include/osquery/core.h → osquery/core/core.h
diff --git a/osquery/core/database/database.h b/osquery/core/database/database.h
@@ -11,7 +11,7 @@
 #include <cstdint>
 
 #include <osquery/debug/debug_only.h>
-#include <osquery/logger.h>
+#include <osquery/logger/logger.h>
 #include <osquery/utils/error/error.h>
 #include <osquery/utils/expected/expected.h>
 

diff --git a/osquery/core/database/in_memory_database.cpp b/osquery/core/database/in_memory_database.cpp
@@ -7,8 +7,8 @@
  */
 
 #include <osquery/core/database/in_memory_database.h>
-#include <osquery/database.h>
-#include <osquery/logger.h>
+#include <osquery/database/database.h>
+#include <osquery/logger/logger.h>
 
 #include <boost/algorithm/string.hpp>
 #include <boost/core/demangle.hpp>

diff --git a/osquery/core/database/rocksdb_database.cpp b/osquery/core/database/rocksdb_database.cpp
@@ -13,7 +13,7 @@
 #endif
 
 #include <osquery/core/database/rocksdb_database.h>
-#include <osquery/logger.h>
+#include <osquery/logger/logger.h>
 
 #include <boost/algorithm/string.hpp>
 

diff --git a/osquery/include/osquery/flagalias.h → osquery/core/flagalias.h b/osquery/include/osquery/flagalias.h → osquery/core/flagalias.h
@@ -10,7 +10,7 @@
 
 #include <boost/lexical_cast.hpp>
 
-#include <osquery/flags.h>
+#include <osquery/core/flags.h>
 
 namespace boost {
 /// We define a lexical_cast template for boolean for Gflags boolean string

diff --git a/osquery/core/flags.cpp b/osquery/core/flags.cpp
@@ -6,9 +6,9 @@
  *  the LICENSE file found in the root directory of this source tree.
  */
 
-#include <osquery/flagalias.h>
-#include <osquery/flags.h>
-#include <osquery/registry.h>
+#include <osquery/core/flagalias.h>
+#include <osquery/core/flags.h>
+#include <osquery/registry/registry.h>
 #include <osquery/utils/conversions/tryto.h>
 
 namespace boost {

diff --git a/osquery/include/osquery/flags.h → osquery/core/flags.h b/osquery/include/osquery/flags.h → osquery/core/flags.h
@@ -20,7 +20,7 @@
 #define STRIP_FLAG_HELP 1
 #include <gflags/gflags.h>
 
-#include <osquery/core.h>
+#include <osquery/core/core.h>
 #include <osquery/utils/status/status.h>
 
 #ifdef FREEBSD