Break up LibC.xs into separate module files.

2025-10-30 23:37:45 +02:00 · 2017-09-17 15:52:19 -04:00
parent 20af8ecf50
commit d36c52271f
5 changed files with 182 additions and 161 deletions
--- a/doc/xml/release.xml
+++ b/doc/xml/release.xml
@@ -26,6 +26,10 @@
                    <release-item>
                        <p>Dynamically generate list of files for C library build.</p>
                    </release-item>
+
+                    <release-item>
+                        <p>Break up <file>LibC.xs</file> into separate module files.</p>
+                    </release-item>
                </release-refactor-list>
            </release-core-list>

--- a/libc/LibC.xs
+++ b/libc/LibC.xs
@@ -16,167 +16,12 @@
 MODULE = pgBackRest::LibC PACKAGE = pgBackRest::LibC
 PROTOTYPES: DISABLE

+# Exported constants
+# ----------------------------------------------------------------------------------------------------------------------------------
 INCLUDE: const-xs.inc

-# Config Rule
+# Exported functions and modules
 # ----------------------------------------------------------------------------------------------------------------------------------
-I32
-cfgCommandId(szCommandName)
-    const char *szCommandName
-
-I32
-cfgOptionId(szOptionName)
-    const char *szOptionName
-
-bool
-cfgRuleOptionAllowList(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-const char *
-cfgRuleOptionAllowListValue(uiCommandId, uiOptionId, uiValueId)
-    U32 uiCommandId
-    U32 uiOptionId
-    U32 uiValueId
-
-I32
-cfgRuleOptionAllowListValueTotal(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-bool
-cfgRuleOptionAllowListValueValid(uiCommandId, uiOptionId, szValue);
-    U32 uiCommandId
-    U32 uiOptionId
-    const char *szValue
-
-bool
-cfgRuleOptionAllowRange(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-double
-cfgRuleOptionAllowRangeMax(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-double
-cfgRuleOptionAllowRangeMin(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-const char *
-cfgRuleOptionDefault(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-bool
-cfgRuleOptionDepend(uiCommandId, uiOptionId);
-    U32 uiCommandId
-    U32 uiOptionId
-
-I32
-cfgRuleOptionDependOption(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-const char *
-cfgRuleOptionDependValue(uiCommandId, uiOptionId, uiValueId)
-    U32 uiCommandId
-    U32 uiOptionId
-    U32 uiValueId
-
-I32
-cfgRuleOptionDependValueTotal(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-bool
-cfgRuleOptionDependValueValid(uiCommandId, uiOptionId, szValue)
-    U32 uiCommandId
-    U32 uiOptionId
-    const char *szValue
-
-const char *
-cfgRuleOptionHint(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-const char *
-cfgRuleOptionNameAlt(uiOptionId)
-    U32 uiOptionId
-
-bool cfgRuleOptionNegate(uiOptionId)
-    U32 uiOptionId
-
-const char *
-cfgRuleOptionPrefix(uiOptionId)
-    U32 uiOptionId
-
-bool
-cfgRuleOptionRequired(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-const char *
-cfgRuleOptionSection(uiOptionId)
-    U32 uiOptionId
-
-bool
-cfgRuleOptionSecure(uiOptionId)
-    U32 uiOptionId
-
-I32
-cfgRuleOptionType(uiOptionId);
-    U32 uiOptionId
-
-bool
-cfgRuleOptionValid(uiCommandId, uiOptionId)
-    U32 uiCommandId
-    U32 uiOptionId
-
-U32
-cfgOptionTotal()
-
-bool
-cfgRuleOptionValueHash(uiOptionId)
-    U32 uiOptionId
-
-# Config
-# ----------------------------------------------------------------------------------------------------------------------------------
-const char *
-cfgCommandName(uiCommandId)
-    U32 uiCommandId
-
-I32
-cfgOptionIndexTotal(uiOptionId)
-    U32 uiOptionId
-
-const char *
-cfgOptionName(uiOptionId)
-    U32 uiOptionId
-
-# Page Checksum
-# ----------------------------------------------------------------------------------------------------------------------------------
-U16
-pageChecksum(page, blkno, pageSize)
-    const char * page
-    U32 blkno
-    U32 pageSize
-
-bool
-pageChecksumTest(szPage, uiBlockNo, uiPageSize, uiIgnoreWalId, uiIgnoreWalOffset)
-    const char *szPage
-    U32 uiBlockNo
-    U32 uiPageSize
-    U32 uiIgnoreWalId
-    U32 uiIgnoreWalOffset
-
-bool
-pageChecksumBufferTest(szPageBuffer, uiBufferSize, uiBlockNoStart, uiPageSize, uiIgnoreWalId, uiIgnoreWalOffset)
-    const char *szPageBuffer
-    U32 uiBufferSize
-    U32 uiBlockNoStart
-    U32 uiPageSize
-    U32 uiIgnoreWalId
-    U32 uiIgnoreWalOffset
+INCLUDE: xs/config/config.xs
+INCLUDE: xs/config/configRule.xs
+INCLUDE: xs/postgres/pageChecksum.xs
--- a/libc/xs/config/config.xs
+++ b/libc/xs/config/config.xs
@@ -0,0 +1,17 @@
+# ----------------------------------------------------------------------------------------------------------------------------------
+# Config Perl Exports
+# ----------------------------------------------------------------------------------------------------------------------------------
+
+MODULE = pgBackRest::LibC PACKAGE = pgBackRest::LibC
+
+const char *
+cfgCommandName(uiCommandId)
+    U32 uiCommandId
+
+I32
+cfgOptionIndexTotal(uiOptionId)
+    U32 uiOptionId
+
+const char *
+cfgOptionName(uiOptionId)
+    U32 uiOptionId
--- a/libc/xs/config/configRule.xs
+++ b/libc/xs/config/configRule.xs
@@ -0,0 +1,127 @@
+# ----------------------------------------------------------------------------------------------------------------------------------
+# Config Rule Perl Exports
+# ----------------------------------------------------------------------------------------------------------------------------------
+
+MODULE = pgBackRest::LibC PACKAGE = pgBackRest::LibC
+
+I32
+cfgCommandId(szCommandName)
+    const char *szCommandName
+
+I32
+cfgOptionId(szOptionName)
+    const char *szOptionName
+
+bool
+cfgRuleOptionAllowList(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+const char *
+cfgRuleOptionAllowListValue(uiCommandId, uiOptionId, uiValueId)
+    U32 uiCommandId
+    U32 uiOptionId
+    U32 uiValueId
+
+I32
+cfgRuleOptionAllowListValueTotal(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+bool
+cfgRuleOptionAllowListValueValid(uiCommandId, uiOptionId, szValue);
+    U32 uiCommandId
+    U32 uiOptionId
+    const char *szValue
+
+bool
+cfgRuleOptionAllowRange(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+double
+cfgRuleOptionAllowRangeMax(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+double
+cfgRuleOptionAllowRangeMin(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+const char *
+cfgRuleOptionDefault(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+bool
+cfgRuleOptionDepend(uiCommandId, uiOptionId);
+    U32 uiCommandId
+    U32 uiOptionId
+
+I32
+cfgRuleOptionDependOption(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+const char *
+cfgRuleOptionDependValue(uiCommandId, uiOptionId, uiValueId)
+    U32 uiCommandId
+    U32 uiOptionId
+    U32 uiValueId
+
+I32
+cfgRuleOptionDependValueTotal(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+bool
+cfgRuleOptionDependValueValid(uiCommandId, uiOptionId, szValue)
+    U32 uiCommandId
+    U32 uiOptionId
+    const char *szValue
+
+const char *
+cfgRuleOptionHint(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+const char *
+cfgRuleOptionNameAlt(uiOptionId)
+    U32 uiOptionId
+
+bool cfgRuleOptionNegate(uiOptionId)
+    U32 uiOptionId
+
+const char *
+cfgRuleOptionPrefix(uiOptionId)
+    U32 uiOptionId
+
+bool
+cfgRuleOptionRequired(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+const char *
+cfgRuleOptionSection(uiOptionId)
+    U32 uiOptionId
+
+bool
+cfgRuleOptionSecure(uiOptionId)
+    U32 uiOptionId
+
+I32
+cfgRuleOptionType(uiOptionId);
+    U32 uiOptionId
+
+bool
+cfgRuleOptionValid(uiCommandId, uiOptionId)
+    U32 uiCommandId
+    U32 uiOptionId
+
+U32
+cfgOptionTotal()
+
+bool
+cfgRuleOptionValueHash(uiOptionId)
+    U32 uiOptionId
--- a/libc/xs/postgres/pageChecksum.xs
+++ b/libc/xs/postgres/pageChecksum.xs
@@ -0,0 +1,28 @@
+# ----------------------------------------------------------------------------------------------------------------------------------
+# Page Checksum Perl Exports
+# ----------------------------------------------------------------------------------------------------------------------------------
+
+MODULE = pgBackRest::LibC PACKAGE = pgBackRest::LibC
+
+U16
+pageChecksum(page, blkno, pageSize)
+    const char *page
+    U32 blkno
+    U32 pageSize
+
+bool
+pageChecksumTest(szPage, uiBlockNo, uiPageSize, uiIgnoreWalId, uiIgnoreWalOffset)
+    const char *szPage
+    U32 uiBlockNo
+    U32 uiPageSize
+    U32 uiIgnoreWalId
+    U32 uiIgnoreWalOffset
+
+bool
+pageChecksumBufferTest(szPageBuffer, uiBufferSize, uiBlockNoStart, uiPageSize, uiIgnoreWalId, uiIgnoreWalOffset)
+    const char *szPageBuffer
+    U32 uiBufferSize
+    U32 uiBlockNoStart
+    U32 uiPageSize
+    U32 uiIgnoreWalId
+    U32 uiIgnoreWalOffset