Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 52c140ca authored by Mark Salyzyn's avatar Mark Salyzyn
Browse files

liblog: add log/log_time.h 

Move log_time definitions to their own home.

struct log_time

Test: gTest liblog-unit-tests --gtest_filter=liblog.log_time
Bug: 34250038
Change-Id: I400cf4cc865d1c167699a4654ecb69455a18e604
parent dd61659e

liblog/include/log/log.h

+1 −171
Original line number Diff line number Diff line
@@ -32,6 +32,7 @@ 
#include <log/log_main.h>

#include <log/log_radio.h>

#include <log/log_system.h>

#include <log/log_time.h>

#include <log/uio.h> /* helper to define iovec for portability */



#ifdef __cplusplus
@@ -230,177 +231,6 @@ struct logger_entry_v4 { 
};

#endif



/* struct log_time is a wire-format variant of struct timespec */

#define NS_PER_SEC 1000000000ULL



#ifndef __struct_log_time_defined

#define __struct_log_time_defined

#ifdef __cplusplus



/*

 * NB: we did NOT define a copy constructor. This will result in structure

 * no longer being compatible with pass-by-value which is desired

 * efficient behavior. Also, pass-by-reference breaks C/C++ ABI.

 */

struct log_time {

public:

    uint32_t tv_sec; /* good to Feb 5 2106 */

    uint32_t tv_nsec;



    static const uint32_t tv_sec_max = 0xFFFFFFFFUL;

    static const uint32_t tv_nsec_max = 999999999UL;



    log_time(const timespec& T)

    {

        tv_sec = static_cast<uint32_t>(T.tv_sec);

        tv_nsec = static_cast<uint32_t>(T.tv_nsec);

    }

    log_time(uint32_t sec, uint32_t nsec)

    {

        tv_sec = sec;

        tv_nsec = nsec;

    }

#ifdef _SYSTEM_CORE_INCLUDE_PRIVATE_ANDROID_LOGGER_H_

#define __struct_log_time_private_defined

    static const timespec EPOCH;

#endif

    log_time()

    {

    }

#ifdef __linux__

    log_time(clockid_t id)

    {

        timespec T;

        clock_gettime(id, &T);

        tv_sec = static_cast<uint32_t>(T.tv_sec);

        tv_nsec = static_cast<uint32_t>(T.tv_nsec);

    }

#endif

    log_time(const char* T)

    {

        const uint8_t* c = reinterpret_cast<const uint8_t*>(T);

        tv_sec = c[0] |

                 (static_cast<uint32_t>(c[1]) << 8) |

                 (static_cast<uint32_t>(c[2]) << 16) |

                 (static_cast<uint32_t>(c[3]) << 24);

        tv_nsec = c[4] |

                  (static_cast<uint32_t>(c[5]) << 8) |

                  (static_cast<uint32_t>(c[6]) << 16) |

                  (static_cast<uint32_t>(c[7]) << 24);

    }



    /* timespec */

    bool operator== (const timespec& T) const

    {

        return (tv_sec == static_cast<uint32_t>(T.tv_sec))

            && (tv_nsec == static_cast<uint32_t>(T.tv_nsec));

    }

    bool operator!= (const timespec& T) const

    {

        return !(*this == T);

    }

    bool operator< (const timespec& T) const

    {

        return (tv_sec < static_cast<uint32_t>(T.tv_sec))

            || ((tv_sec == static_cast<uint32_t>(T.tv_sec))

                && (tv_nsec < static_cast<uint32_t>(T.tv_nsec)));

    }

    bool operator>= (const timespec& T) const

    {

        return !(*this < T);

    }

    bool operator> (const timespec& T) const

    {

        return (tv_sec > static_cast<uint32_t>(T.tv_sec))

            || ((tv_sec == static_cast<uint32_t>(T.tv_sec))

                && (tv_nsec > static_cast<uint32_t>(T.tv_nsec)));

    }

    bool operator<= (const timespec& T) const

    {

        return !(*this > T);

    }



#ifdef _SYSTEM_CORE_INCLUDE_PRIVATE_ANDROID_LOGGER_H_

    log_time operator-= (const timespec& T);

    log_time operator- (const timespec& T) const

    {

        log_time local(*this);

        return local -= T;

    }

    log_time operator+= (const timespec& T);

    log_time operator+ (const timespec& T) const

    {

        log_time local(*this);

        return local += T;

    }

#endif



    /* log_time */

    bool operator== (const log_time& T) const

    {

        return (tv_sec == T.tv_sec) && (tv_nsec == T.tv_nsec);

    }

    bool operator!= (const log_time& T) const

    {

        return !(*this == T);

    }

    bool operator< (const log_time& T) const

    {

        return (tv_sec < T.tv_sec)

            || ((tv_sec == T.tv_sec) && (tv_nsec < T.tv_nsec));

    }

    bool operator>= (const log_time& T) const

    {

        return !(*this < T);

    }

    bool operator> (const log_time& T) const

    {

        return (tv_sec > T.tv_sec)

            || ((tv_sec == T.tv_sec) && (tv_nsec > T.tv_nsec));

    }

    bool operator<= (const log_time& T) const

    {

        return !(*this > T);

    }



#ifdef _SYSTEM_CORE_INCLUDE_PRIVATE_ANDROID_LOGGER_H_

    log_time operator-= (const log_time& T);

    log_time operator- (const log_time& T) const

    {

        log_time local(*this);

        return local -= T;

    }

    log_time operator+= (const log_time& T);

    log_time operator+ (const log_time& T) const

    {

        log_time local(*this);

        return local += T;

    }

#endif



    uint64_t nsec() const

    {

        return static_cast<uint64_t>(tv_sec) * NS_PER_SEC + tv_nsec;

    }



#ifdef _SYSTEM_CORE_INCLUDE_PRIVATE_ANDROID_LOGGER_H_

    static const char default_format[];



    /* Add %#q for the fraction of a second to the standard library functions */

    char* strptime(const char* s, const char* format = default_format);

#endif

} __attribute__((__packed__));



#else



typedef struct log_time {

    uint32_t tv_sec;

    uint32_t tv_nsec;

} __attribute__((__packed__)) log_time;



#endif

#endif



/*

 * The maximum size of the log entry payload that can be

 * written to the logger. An attempt to write more than

liblog/include/log/log_time.h

0 → 100644
+196 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2005-2017 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



#ifndef _LIBS_LOG_LOG_TIME_H

#define _LIBS_LOG_LOG_TIME_H



#include <stdint.h>

#include <time.h>



/* struct log_time is a wire-format variant of struct timespec */

#define NS_PER_SEC 1000000000ULL



#ifndef __struct_log_time_defined

#define __struct_log_time_defined



#ifdef __cplusplus



/*

 * NB: we did NOT define a copy constructor. This will result in structure

 * no longer being compatible with pass-by-value which is desired

 * efficient behavior. Also, pass-by-reference breaks C/C++ ABI.

 */

struct log_time {

public:

    uint32_t tv_sec; /* good to Feb 5 2106 */

    uint32_t tv_nsec;



    static const uint32_t tv_sec_max = 0xFFFFFFFFUL;

    static const uint32_t tv_nsec_max = 999999999UL;



    log_time(const timespec& T)

    {

        tv_sec = static_cast<uint32_t>(T.tv_sec);

        tv_nsec = static_cast<uint32_t>(T.tv_nsec);

    }

    log_time(uint32_t sec, uint32_t nsec)

    {

        tv_sec = sec;

        tv_nsec = nsec;

    }

#ifdef _SYSTEM_CORE_INCLUDE_PRIVATE_ANDROID_LOGGER_H_

#define __struct_log_time_private_defined

    static const timespec EPOCH;

#endif

    log_time()

    {

    }

#ifdef __linux__

    log_time(clockid_t id)

    {

        timespec T;

        clock_gettime(id, &T);

        tv_sec = static_cast<uint32_t>(T.tv_sec);

        tv_nsec = static_cast<uint32_t>(T.tv_nsec);

    }

#endif

    log_time(const char* T)

    {

        const uint8_t* c = reinterpret_cast<const uint8_t*>(T);

        tv_sec = c[0] |

                 (static_cast<uint32_t>(c[1]) << 8) |

                 (static_cast<uint32_t>(c[2]) << 16) |

                 (static_cast<uint32_t>(c[3]) << 24);

        tv_nsec = c[4] |

                  (static_cast<uint32_t>(c[5]) << 8) |

                  (static_cast<uint32_t>(c[6]) << 16) |

                  (static_cast<uint32_t>(c[7]) << 24);

    }



    /* timespec */

    bool operator== (const timespec& T) const

    {

        return (tv_sec == static_cast<uint32_t>(T.tv_sec))

            && (tv_nsec == static_cast<uint32_t>(T.tv_nsec));

    }

    bool operator!= (const timespec& T) const

    {

        return !(*this == T);

    }

    bool operator< (const timespec& T) const

    {

        return (tv_sec < static_cast<uint32_t>(T.tv_sec))

            || ((tv_sec == static_cast<uint32_t>(T.tv_sec))

                && (tv_nsec < static_cast<uint32_t>(T.tv_nsec)));

    }

    bool operator>= (const timespec& T) const

    {

        return !(*this < T);

    }

    bool operator> (const timespec& T) const

    {

        return (tv_sec > static_cast<uint32_t>(T.tv_sec))

            || ((tv_sec == static_cast<uint32_t>(T.tv_sec))

                && (tv_nsec > static_cast<uint32_t>(T.tv_nsec)));

    }

    bool operator<= (const timespec& T) const

    {

        return !(*this > T);

    }



#ifdef _SYSTEM_CORE_INCLUDE_PRIVATE_ANDROID_LOGGER_H_

    log_time operator-= (const timespec& T);

    log_time operator- (const timespec& T) const

    {

        log_time local(*this);

        return local -= T;

    }

    log_time operator+= (const timespec& T);

    log_time operator+ (const timespec& T) const

    {

        log_time local(*this);

        return local += T;

    }

#endif



    /* log_time */

    bool operator== (const log_time& T) const

    {

        return (tv_sec == T.tv_sec) && (tv_nsec == T.tv_nsec);

    }

    bool operator!= (const log_time& T) const

    {

        return !(*this == T);

    }

    bool operator< (const log_time& T) const

    {

        return (tv_sec < T.tv_sec)

            || ((tv_sec == T.tv_sec) && (tv_nsec < T.tv_nsec));

    }

    bool operator>= (const log_time& T) const

    {

        return !(*this < T);

    }

    bool operator> (const log_time& T) const

    {

        return (tv_sec > T.tv_sec)

            || ((tv_sec == T.tv_sec) && (tv_nsec > T.tv_nsec));

    }

    bool operator<= (const log_time& T) const

    {

        return !(*this > T);

    }



#ifdef _SYSTEM_CORE_INCLUDE_PRIVATE_ANDROID_LOGGER_H_

    log_time operator-= (const log_time& T);

    log_time operator- (const log_time& T) const

    {

        log_time local(*this);

        return local -= T;

    }

    log_time operator+= (const log_time& T);

    log_time operator+ (const log_time& T) const

    {

        log_time local(*this);

        return local += T;

    }

#endif



    uint64_t nsec() const

    {

        return static_cast<uint64_t>(tv_sec) * NS_PER_SEC + tv_nsec;

    }



#ifdef _SYSTEM_CORE_INCLUDE_PRIVATE_ANDROID_LOGGER_H_

    static const char default_format[];



    /* Add %#q for the fraction of a second to the standard library functions */

    char* strptime(const char* s, const char* format = default_format);

#endif

} __attribute__((__packed__));



#else



typedef struct log_time {

    uint32_t tv_sec;

    uint32_t tv_nsec;

} __attribute__((__packed__)) log_time;



#endif



#endif



#endif /* _LIBS_LOG_LOG_TIME_H */

liblog/tests/Android.mk

+2 −1
Original line number Diff line number Diff line
@@ -58,7 +58,8 @@ test_src_files := \ 
    liblog_test.cpp \

    log_id_test.cpp \

    log_radio_test.cpp \

    log_system_test.cpp

    log_system_test.cpp \

    log_time_test.cpp



# to prevent breaking the build if bionic not relatively visible to us

ifneq ($(wildcard $(LOCAL_PATH)/../../../../bionic/libc/bionic/libc_logging.cpp),)

liblog/tests/log_time_test.cpp

0 → 100644
+43 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2017 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



#include <time.h>



#include <gtest/gtest.h>

// Test the APIs in this standalone include file

#include <log/log_time.h>



TEST(liblog, log_time) {

#ifdef __ANDROID__



#ifdef _SYSTEM_CORE_INCLUDE_PRIVATE_ANDROID_LOGGER_H_

    log_time(CLOCK_MONOTONIC);



    EXPECT_EQ(log_time, log_time::EPOCH);

#endif



    struct timespec ts;

    clock_gettime(CLOCK_MONOTONIC, &ts);

    log_time tl(ts);



    EXPECT_EQ(tl, ts);

    EXPECT_GE(tl, ts);

    EXPECT_LE(tl, ts);



#else

    GTEST_LOG_(INFO) << "This test does nothing.\n";

#endif

}