Fork from facebookincubator/dynolog branches/release-v0.3.0

.github/workflows/dynolog-ci.yml

@@ -0,0 +1,52 @@
+name: DYNOLOGCI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest] # TODO: What other OSs should we include here?
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Checkout submodules
+      shell: bash
+      run: |
+        auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+        git submodule sync --recursive
+        git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+
+    - name: Get env vars
+      run: |
+        echo GITHUB_WORKFLOW   = $GITHUB_WORKFLOW
+        echo HOME              = $HOME
+        echo GITHUB_ACTION     = $GITHUB_ACTION
+        echo GITHUB_ACTIONS    = $GITHUB_ACTIONS
+        echo GITHUB_REPOSITORY = $GITHUB_REPOSITORY
+        echo GITHUB_EVENT_NAME = $GITHUB_EVENT_NAME
+        echo GITHUB_EVENT_PATH = $GITHUB_EVENT_PATH
+        echo GITHUB_WORKSPACE  = $GITHUB_WORKSPACE
+        echo GITHUB_SHA        = $GITHUB_SHA
+        echo GITHUB_REF        = $GITHUB_REF
+        c++ --verbose
+
+    - name: Download and setup Ninja
+      uses: seanmiddleditch/gha-setup-ninja@master
+
+    - name: Build dynolog binary
+      run: |
+        set -e
+        ./scripts/build.sh
+    - name: Run Unit Tests
+      run: |
+        set -e
+        cd $GITHUB_WORKSPACE/build
+        ctest --output-on-failure

.gitignore

@@ -0,0 +1 @@
+Cargo.lock

.gitmodules

@@ -0,0 +1,24 @@
+[submodule "third_party/glog"]
+	path = third_party/glog
+	url = https://github.com/google/glog.git
+[submodule "third_party/gflags"]
+	path = third_party/gflags
+	url = https://github.com/gflags/gflags.git
+[submodule "third_party/fmt"]
+	path = third_party/fmt
+	url = https://github.com/fmtlib/fmt.git
+[submodule "third_party/json"]
+	path = third_party/json
+	url = https://github.com/nlohmann/json.git
+[submodule "third_party/pfs"]
+	path = third_party/pfs
+	url = https://github.com/dtrugman/pfs.git
+[submodule "third_party/googletest"]
+	path = third_party/googletest
+	url = https://github.com/google/googletest.git
+[submodule "third_party/cpr"]
+	path = third_party/cpr
+	url = https://github.com/libcpr/cpr.git
+[submodule "third_party/DCGM"]
+	path = third_party/DCGM
+	url = https://github.com/NVIDIA/DCGM.git

CHANGELOG.md

@@ -0,0 +1,5 @@
+# July 28, 2022
+* Initial commit
+# Dec 8, 2022 (v0.1.0)
+- Include CPU instructions and cycles performance events
+- GPU trace trigger improvements: support tracing by iteration count.

CMakeLists.txt

@@ -0,0 +1,79 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+cmake_minimum_required(VERSION 3.16)
+
+project(Dynolog VERSION 1.0)
+option(BUILD_TESTS "Build the unit tests" ON)
+option(USE_ODS_GRAPH_API "Enable logger to Meta ODS using public Graph API."
+OFF)
+option(USE_JSON_GENERATED_PERF_EVENTS "Add performance events generated using
+Intel json spec, see hbt/src/perf_event/json_events/intel"
+OFF)
+
+file(READ "version.txt" DYNOLOG_VERSION)
+string(STRIP ${DYNOLOG_VERSION} DYNOLOG_VERSION)
+
+execute_process (
+  COMMAND git rev-parse --short HEAD
+  OUTPUT_VARIABLE DYNOLOG_GIT_REV
+  OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+set(DYNOLOG_VERSION "\"${DYNOLOG_VERSION}\"")
+set(DYNOLOG_GIT_REV "\"${DYNOLOG_GIT_REV}\"")
+message("Dynolog version = ${DYNOLOG_VERSION}")
+message("Dynolog git rev = ${DYNOLOG_GIT_REV}")
+
+set(USE_ODS_GRAPH_API 1)
+
+set(CMAKE_VERBOSE_MAKEFILE ON)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+set(CMAKE_POSITION_INDEPENDENT_CODE True)
+
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread")
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -pthread")
+
+if(BUILD_TESTS)
+  enable_testing()
+  add_subdirectory("third_party/googletest" "third_party/googletest")
+endif()
+
+include_directories(".")
+add_subdirectory(dynolog)
+add_subdirectory(cli)
+# The following dummy depdendency ensures the cli is built
+add_dependencies(dynolog_lib dyno)
+add_subdirectory(hbt)
+
+# Third party deps
+set(BUILD_SHARED_LIBS OFF CACHE INTERNAL "")
+set(BUILD_SAMPLES OFF CACHE BOOL "")
+set(BUILD_TEST OFF CACHE BOOL "")
+set(BUILD_SHARED_LIBS OFF CACHE BOOL "")
+
+set(BUILD_TESTING OFF CACHE BOOL "")
+set(WITH_GFLAGS OFF CACHE BOOL "")
+add_subdirectory(third_party/glog)
+target_link_libraries(dynolog_lib PUBLIC glog::glog)
+
+set(GFLAGS_BUILD_TESTING OFF CACHE BOOL "")
+add_subdirectory(third_party/gflags)
+target_link_libraries(dynolog_lib PUBLIC gflags::gflags)
+
+# https://github.com/nlohmann/json#cmake
+set(JSON_BuildTests OFF CACHE INTERNAL "")
+add_subdirectory(third_party/json)
+target_link_libraries(dynolog_lib PUBLIC nlohmann_json::nlohmann_json)
+
+add_subdirectory(third_party/pfs)
+target_include_directories(dynolog_lib PUBLIC third_party/pfs/include)
+target_link_libraries(dynolog_lib PUBLIC pfs)
+
+add_subdirectory(third_party/fmt)
+target_link_libraries(dynolog_lib PUBLIC fmt::fmt)
+
+if(USE_ODS_GRAPH_API)
+  add_subdirectory(third_party/cpr)
+  target_link_libraries(dynolog_lib PUBLIC cpr::cpr)
+endif()

CODE_OF_CONDUCT.md

@@ -0,0 +1,80 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+This Code of Conduct also applies outside the project spaces when there is a
+reasonable belief that an individual's behavior may have a negative impact on
+the project or its community.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <[email protected]>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to dynolog
+We want to make contributing to this project as easy and transparent as
+possible.
+
+## Our Development Process
+Each pull request is first submitted into Meta's internal repositories by a Meta team member. Once the commit has successfully passed Meta's internal test suite, it will be exported back out from Meta's repository. We endeavour to do this as soon as possible for all commits.
+
+## Pull Requests
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. If you haven't already, complete the Contributor License Agreement ("CLA").
+
+## Contributor License Agreement ("CLA")
+In order to accept your pull request, we need you to submit a CLA. You only need
+to do this once to work on any of Meta's open source projects.
+
+Complete your CLA here: <https://code.facebook.com/cla>
+
+## Issues
+We use GitHub issues to track public bugs. Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue.
+
+Meta has a [bounty program](https://www.facebook.com/whitehat/) for the safe
+disclosure of security bugs. In those cases, please go through the process
+outlined on that page and do not file a public issue.
+
+## Coding Style
+* 2 spaces for indentation rather than tabs
+* 80 character line length
+* ...
+
+## License
+By contributing to dynolog, you agree that your contributions will be licensed
+under the LICENSE file in the root directory of this source tree.

Dockerfile

@@ -0,0 +1,54 @@
+FROM --platform=linux/amd64 amd64/ubuntu:20.04 AS ubuntu_build_x86
+# This required to avoid interactive build for tzdata
+ENV DEBIAN_FRONTEND=noninteractive 
+RUN apt-get update && apt-get install -y --no-install-recommends \
+        build-essential \
+        ca-certificates \
+        cmake \
+        curl \
+        git \
+        libssl-dev \
+        ninja-build \
+        tini \
+        tree \
+        vim \
+    && rm -rf /var/lib/apt/lists/*
+# Use Rust nightly with sparse index, https://github.com/rust-lang/cargo/issues/10781
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly
+ENV PATH /root/.cargo/bin:$PATH
+
+WORKDIR /workspace/dynolog
+COPY . .
+
+# Run the rust build directly
+RUN cd cli && /root/.cargo/bin/cargo +nightly build --release -Z sparse-registry --target-dir build
+
+RUN ./scripts/build.sh 2>&1 | tee build.log
+
+FROM --platform=linux/amd64 rockylinux:9 AS rocky_build_x86
+RUN yum update -y && \
+    yum install -y \
+        make \
+        git \
+        cmake \
+        openssl-devel \
+        libstdc++ \
+        gcc \
+        gcc-c++ \
+        rpmdevtools.noarch \
+        rpmlint.noarch \
+        systemd-rpm-macros \
+        tree \
+        vim
+RUN dnf --enablerepo=crb install -y ninja-build
+# Use Rust nightly with sparse index, https://github.com/rust-lang/cargo/issues/10781
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly
+ENV PATH /root/.cargo/bin:$PATH
+
+WORKDIR /workspace/dynolog
+COPY . .
+
+# Run the rust build directly
+RUN cd cli && /root/.cargo/bin/cargo +nightly build --release -Z sparse-registry --target-dir build
+
+RUN ./scripts/build.sh 2>&1 | tee build.log

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Facebook, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.