]> git.ipfire.org Git - thirdparty/open-vm-tools.git/commitdiff
Common header file change not applicable to open-vm-tools.
authorJohn Wolfe <jwolfe@vmware.com>
Fri, 11 Sep 2020 19:11:04 +0000 (12:11 -0700)
committerJohn Wolfe <jwolfe@vmware.com>
Fri, 11 Sep 2020 19:11:04 +0000 (12:11 -0700)
open-vm-tools/lib/include/log.h

index 7381ba88357df894ba88db6230caad24b4bc0101..5e4677829b67c5419ded286a353ac44b9674c185 100644 (file)
@@ -94,41 +94,15 @@ typedef enum {
 #define VMW_LOG_LEVEL(routing)  ((routing) & VMW_LOG_LEVEL_MASK)
 #define VMW_LOG_MODULE(routing) (((routing) >> VMW_LOG_LEVEL_BITS))
 
-/*
- * To use the Log Facility module specific filters:
- *
- *  1) Use LogV or Log_Level and use the LOG_ROUTING_BITS macro.
- *
- *  2) Have LOGLEVEL_MODULE defined before the include of "log.h".
- *
- *     For many files, this involves moving the include "log.h" after
- *     the include of "loglevel_user.h".
- */
-
-#if defined(LOGLEVEL_MODULE)
-   #include "loglevel_userVars.h"
-   #include "vm_basic_defs.h"
-
-   #define LOGFACILITY_MODULEVAR(mod) XCONC(_logFacilityModule_, mod)
+void
+LogV(uint32 routing,
+     const char *fmt,
+     va_list args);
 
-   enum LogFacilityModuleValue {
-      LOGLEVEL_USER(LOGFACILITY_MODULEVAR)
-   };
-
-   /* Module bits of zero (0) indicate no module has been specified */
-   #define LOG_ROUTING_BITS(level) \
-      (((LOGFACILITY_MODULEVAR(LOGLEVEL_MODULE) + 1) << VMW_LOG_LEVEL_BITS) | level)
-#else
-   #define LOG_ROUTING_BITS(level) (level)
-#endif
-
-void LogV(uint32 routing,
+void
+Log_Level(uint32 routing,
           const char *fmt,
-          va_list args);
-
-void Log_Level(uint32 routing,
-               const char *fmt,
-               ...) PRINTF_DECL(2, 3);
+          ...) PRINTF_DECL(2, 3);
 
 /*
  * Log     = Log_Info
@@ -249,46 +223,58 @@ typedef struct {
 
 typedef struct LogOutput LogOutput;
 
-struct CfgInterface *Log_CfgInterface(void);
+struct CfgInterface *
+Log_CfgInterface(void);
 
-int32 Log_SetStderrLevel(int32 level);
+int32
+Log_SetStderrLevel(int32 level);
 
-int32 Log_GetStderrLevel(void);
+int32
+Log_GetStderrLevel(void);
 
-LogOutput *Log_NewStdioOutput(const char *appPrefix,
-                              struct Dictionary *params,
-                              struct CfgInterface *cfgIf);
+LogOutput *
+Log_NewStdioOutput(const char *appPrefix,
+                   struct Dictionary *params,
+                   struct CfgInterface *cfgIf);
 
-LogOutput *Log_NewSyslogOutput(const char *appPrefix,
-                               const char *instanceName,
-                               struct Dictionary *params,
-                               struct CfgInterface *cfgIf);
+LogOutput *
+Log_NewSyslogOutput(const char *appPrefix,
+                    const char *instanceName,
+                    struct Dictionary *params,
+                    struct CfgInterface *cfgIf);
 
-LogOutput *Log_NewFileOutput(const char *appPrefix,
-                             const char *instanceName,
-                             struct Dictionary *params,
-                             struct CfgInterface *cfgIf);
+LogOutput *
+Log_NewFileOutput(const char *appPrefix,
+                  const char *instanceName,
+                  struct Dictionary *params,
+                  struct CfgInterface *cfgIf);
 
 typedef void (LogCustomMsgFunc)(int level,
                                 const char *msg);
 
-LogOutput *Log_NewCustomOutput(const char *instanceName,
-                               LogCustomMsgFunc *msgFunc,
-                               int minLogLevel);
+LogOutput *
+Log_NewCustomOutput(const char *instanceName,
+                    LogCustomMsgFunc *msgFunc,
+                    int minLogLevel);
 
-Bool Log_FreeOutput(LogOutput *toOutput);
+Bool
+Log_FreeOutput(LogOutput *toOutput);
 
-Bool Log_AddOutput(LogOutput *output);
+Bool
+Log_AddOutput(LogOutput *output);
 
-Bool Log_ReplaceOutput(LogOutput *fromOutput,
-                       LogOutput *toOutput,
-                       Bool copyOver);
+Bool
+Log_ReplaceOutput(LogOutput *fromOutput,
+                  LogOutput *toOutput,
+                  Bool copyOver);
 
-int32 Log_SetOutputLevel(LogOutput *output,
-                         int32 level);
+int32
+Log_SetOutputLevel(LogOutput *output,
+                   int32 level);
 
-Bool Log_SetVmxStatsData(LogOutput *output,
-                         VmxStatsInfo *vmxStats);
+Bool
+Log_SetVmxStatsData(LogOutput *output,
+                    VmxStatsInfo *vmxStats);
 
 /*
  * The most common Log Facility client usage is via the "InitWith" functions.
@@ -303,10 +289,11 @@ Bool Log_SetVmxStatsData(LogOutput *output,
  * correct.
  */
 
-void Log_SetProductInfo(const char *appName,
-                        const char *appVersion,
-                        const char *buildNumber,
-                        const char *compilationOption);
+void
+Log_SetProductInfo(const char *appName,
+                   const char *appVersion,
+                   const char *buildNumber,
+                   const char *compilationOption);
 
 static INLINE void
 Log_SetProductInfoSimple(void)
@@ -318,9 +305,10 @@ Log_SetProductInfoSimple(void)
 }
 
 
-LogOutput *Log_InitWithCustomInt(struct CfgInterface *cfgIf,
-                                 LogCustomMsgFunc *msgFunc,
-                                 int minLogLevel);
+LogOutput *
+Log_InitWithCustomInt(struct CfgInterface *cfgIf,
+                      LogCustomMsgFunc *msgFunc,
+                      int minLogLevel);
 
 
 static INLINE LogOutput *
@@ -333,10 +321,11 @@ Log_InitWithCustom(struct CfgInterface *cfgIf,
    return Log_InitWithCustomInt(cfgIf, msgFunc, minLogLevel);
 }
 
-LogOutput *Log_InitWithFileInt(const char *appPrefix,
-                               struct Dictionary *dict,
-                               struct CfgInterface *cfgIf,
-                               Bool boundNumFiles);
+LogOutput *
+Log_InitWithFileInt(const char *appPrefix,
+                    struct Dictionary *dict,
+                    struct CfgInterface *cfgIf,
+                    Bool boundNumFiles);
 
 static INLINE LogOutput *
 Log_InitWithFile(const char *appPrefix,
@@ -349,9 +338,10 @@ Log_InitWithFile(const char *appPrefix,
    return Log_InitWithFileInt(appPrefix, dict, cfgIf, boundNumFiles);
 }
 
-LogOutput *Log_InitWithFileSimpleInt(const char *appPrefix,
-                                     struct CfgInterface *cfgIf,
-                                     const char *fileName);
+LogOutput *
+Log_InitWithFileSimpleInt(const char *appPrefix,
+                          struct CfgInterface *cfgIf,
+                          const char *fileName);
 
 static INLINE LogOutput *
 Log_InitWithFileSimple(const char *fileName,
@@ -362,9 +352,10 @@ Log_InitWithFileSimple(const char *fileName,
    return Log_InitWithFileSimpleInt(appPrefix, Log_CfgInterface(), fileName);
 }
 
-LogOutput *Log_InitWithSyslogInt(const char *appPrefix,
-                                 struct Dictionary *dict,
-                                 struct CfgInterface *cfgIf);
+LogOutput *
+Log_InitWithSyslogInt(const char *appPrefix,
+                      struct Dictionary *dict,
+                      struct CfgInterface *cfgIf);
 
 static INLINE LogOutput *
 Log_InitWithSyslog(const char *appPrefix,
@@ -376,9 +367,10 @@ Log_InitWithSyslog(const char *appPrefix,
    return Log_InitWithSyslogInt(appPrefix, dict, cfgIf);
 }
 
-LogOutput *Log_InitWithSyslogSimpleInt(const char *appPrefix,
-                                       struct CfgInterface *cfgIf,
-                                       const char *syslogID);
+LogOutput *
+Log_InitWithSyslogSimpleInt(const char *appPrefix,
+                            struct CfgInterface *cfgIf,
+                            const char *syslogID);
 
 static INLINE LogOutput *
 Log_InitWithSyslogSimple(const char *syslogID,
@@ -389,10 +381,11 @@ Log_InitWithSyslogSimple(const char *syslogID,
    return Log_InitWithSyslogSimpleInt(appPrefix, Log_CfgInterface(), syslogID);
 }
 
-LogOutput *Log_InitWithStdioSimpleInt(const char *appPrefix,
-                                      struct CfgInterface *cfgIf,
-                                      const char *minLevel,
-                                      Bool withLinePrefix);
+LogOutput *
+Log_InitWithStdioSimpleInt(const char *appPrefix,
+                           struct CfgInterface *cfgIf,
+                           const char *minLevel,
+                           Bool withLinePrefix);
 
 static INLINE LogOutput *
 Log_InitWithStdioSimple(const char *appPrefix,
@@ -405,34 +398,45 @@ Log_InitWithStdioSimple(const char *appPrefix,
                                      withLinePrefix);
 }
 
-void Log_Exit(void);
+void
+Log_Exit(void);
 
-Bool Log_Outputting(void);
+Bool
+Log_Outputting(void);
 
-Bool Log_IsLevelOutputting(int level);
+Bool
+Log_IsLevelOutputting(int level);
 
-const char *Log_GetFileName(void);
+const char *
+Log_GetFileName(void);
 
-const char *Log_GetOutputFileName(LogOutput *output);
+const char *
+Log_GetOutputFileName(LogOutput *output);
 
-void Log_SkipLocking(Bool skipLocking);
+void
+Log_SkipLocking(Bool skipLocking);
 
-void Log_DisableThrottling(void);
+void
+Log_DisableThrottling(void);
 
-void Log_DisableVmxStats(void);
+void
+Log_DisableVmxStats(void);
 
-uint32 Log_MaxLineLength(void);
+uint32
+Log_MaxLineLength(void);
 
-size_t Log_MakeTimeString(Bool millisec,
-                          char *buf,
-                          size_t max);
+size_t
+Log_MakeTimeString(Bool millisec,
+                   char *buf,
+                   size_t max);
 
 typedef Bool (LogOwnerFunc)(void *userData,
                             const char *fileName);
 
-Bool Log_BoundNumFiles(struct LogOutput *output,
-                       LogOwnerFunc *func,
-                       void *userData);
+Bool
+Log_BoundNumFiles(struct LogOutput *output,
+                LogOwnerFunc *func,
+                void *userData);
 
 #if defined(VMX86_SERVER)
 #define LOG_KEEPOLD 6  // Old log files to keep around; ESX value
@@ -450,44 +454,52 @@ Bool Log_BoundNumFiles(struct LogOutput *output,
  * Assemble a line.
  */
 
-void *Log_BufBegin(void);
+void *
+Log_BufBegin(void);
 
-void Log_BufAppend(void *acc,
-                   const char *fmt,
-                   ...) PRINTF_DECL(2, 3);
+void
+Log_BufAppend(void *acc,
+              const char *fmt,
+              ...) PRINTF_DECL(2, 3);
 
-void Log_BufEndLevel(void *acc,
-                     uint32 routing);
+void
+Log_BufEndLevel(void *acc,
+                uint32 routing);
 
 
 /*
  * Debugging
  */
 
-void Log_HexDump(const char *prefix,
+void
+Log_HexDump(const char *prefix,
+            const void *data,
+            size_t size);
+
+void
+Log_HexDumpLevel(uint32 routing,
+                 const char *prefix,
                  const void *data,
                  size_t size);
 
-void Log_HexDumpLevel(uint32 routing,
-                      const char *prefix,
-                      const void *data,
-                      size_t size);
-
-void Log_Time(VmTimeType *time,
-              int count,
-              const char *message);
+void
+Log_Time(VmTimeType *time,
+         int count,
+         const char *message);
 
-void Log_Histogram(uint32 n,
-                   uint32 histo[],
-                   int nbuckets,
-                   const char *message,
-                   int *count,
-                   int limit);
+void
+Log_Histogram(uint32 n,
+              uint32 histo[],
+              int nbuckets,
+              const char *message,
+              int *count,
+              int limit);
 
 typedef Bool (GetOpId)(size_t maxStringLen,
                        char *opId);
 
-void Log_RegisterOpIdFunction(GetOpId *getOpIdFunc);
+void
+Log_RegisterOpIdFunction(GetOpId *getOpIdFunc);
 
 #endif /* !VMM */
 
@@ -496,3 +508,41 @@ void Log_RegisterOpIdFunction(GetOpId *getOpIdFunc);
 #endif
 
 #endif /* VMWARE_LOG_H */
+
+/*
+ * To use the Log Facility module specific filters:
+ *
+ *  1) Use LogV or Log_Level and use the LOG_ROUTING_BITS macro.
+ *
+ *  2) Have LOGLEVEL_MODULE defined before the include of "log.h".
+ *
+ *     For many files, this involves moving the include "log.h" after
+ *     the include of "loglevel_user.h".
+ */
+
+#if !defined(VMW_LOG_MODULE_LEVELS)
+   #include "vm_basic_defs.h"
+   #include "loglevel_userVars.h"
+
+   #define LOGFACILITY_MODULEVAR(mod) XCONC(_logFacilityModule_, mod)
+
+   enum LogFacilityModuleValue {
+      LOGLEVEL_USER(LOGFACILITY_MODULEVAR)
+   };
+
+   #define VMW_LOG_MODULE_LEVELS
+#endif
+
+#if defined(LOG_ROUTING_BITS)
+   #undef LOG_ROUTING_BITS
+#endif
+
+#if defined(LOGLEVEL_MODULE)
+   /* Module bits of zero (0) indicate no module has been specified */
+   #define LOG_ROUTING_BITS(level) \
+      (((LOGFACILITY_MODULEVAR(LOGLEVEL_MODULE) + 1) << VMW_LOG_LEVEL_BITS) | level)
+#else
+   #define LOG_ROUTING_BITS(level) (level)
+#endif
+
+