santa/Testing/integration/SNTLoggingBenchmarks.m

/// Copyright 2021 Google Inc. All rights reserved.
///
/// 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.

// clang-format off
/// This benchmarking program pairs well with the hyperfine benchmarking utility:
/// https://github.com/sharkdp/hyperfine
///
/// Some example invocations:
/// - Compare performance of different in-memory buffer sizes by controlling file size threshold
///   hyperfine --warmup 3 -P fssize 50 500 -D 50 'santa_logging_benchmarks_bin -i 20000 -l protobuf -f {fssize} -s 500 -t 5'
///
/// - Compare the file logger vs the protobuf logger
///   hyperfine --warmup 3 --parameter-list logger file,protobuf 'santa_logging_benchmarks_bin -i 100000 -l {logger} -f 100 -s 500 -t 5'
// clang-format on

#import <EndpointSecurity/EndpointSecurity.h>
#import <Foundation/Foundation.h>
#import <getopt.h>
#import <stdlib.h>

#import "Source/common/SNTConfigurator.h"
#import "Source/santad/EventProviders/EndpointSecurityTestUtil.h"
#import "Source/santad/Logs/SNTFileEventLog.h"
#import "Source/santad/Logs/SNTProtobufEventLog.h"
#import "Source/santad/Logs/SNTSyslogEventLog.h"

@interface SNTConfigurator (Testing)
@property NSMutableDictionary *configState;
@end

void usage(void) {
  fprintf(stderr, "Usage: %s [-i <iterations>] [-l (file|syslog|protobuf)]\n", getprogname());
}

void runLogFileModification(santa_message_t *msg, SNTEventLog *eventLog) {
  msg->action = ACTION_NOTIFY_RENAME;
  [eventLog logFileModification:*msg];
}

BOOL createTestDir(NSURL *dir) {
  return [[NSFileManager defaultManager] createDirectoryAtURL:dir
                                  withIntermediateDirectories:YES
                                                   attributes:nil
                                                        error:nil];
}

void setup(int iterations, SNTEventLog *eventLog) {
  // Create and populate necessary values and data structures in advance to
  // minimze the effect on overall run time.
  static const char *commonProcName = "launchd";
  static const char *commonPath = "/sbin/launchd";
  static const char *commonNewPath = "/foo/bar.txt";
  NSArray *execArgs = @[ @"/sbin/launchd", @"--init", @"--testing" ];
  struct timespec ts = {123, 456};

  es_file_t esFile = MakeESFile(commonPath);
  es_process_t esProc = MakeESProcess(&esFile);
  es_message_t esMsg = MakeESMessage(ES_EVENT_TYPE_NOTIFY_RENAME, &esProc, ts);

  santa_message_t santaMsg = {0};

  santaMsg.uid = 242;
  santaMsg.gid = 20;
  santaMsg.pid = 1;
  santaMsg.pidversion = 2;
  santaMsg.ppid = 3;

  strlcpy(santaMsg.path, commonPath, sizeof(santaMsg.path));
  strlcpy(santaMsg.newpath, commonNewPath, sizeof(santaMsg.newpath));
  strlcpy(santaMsg.pname, commonProcName, sizeof(santaMsg.pname));

  santaMsg.args_array = (__bridge void *)execArgs;
  santaMsg.es_message = &esMsg;

  for (int i = 0; i < iterations; i++) {
    [eventLog logFileModification:santaMsg];
  }
}

int main(int argc, char *argv[]) {
  @autoreleasepool {
    static const struct option longopts[] = {
      {"iter", required_argument, NULL, 'i'},
      {"logger", required_argument, NULL, 'l'},
      {NULL, 0, NULL, 0},
    };

    int ch;
    int iterations = 5000;
    Class eventLogClass = [SNTProtobufEventLog class];
    SNTConfigurator *configurator = [SNTConfigurator configurator];
    unsigned int fileSize = 100;
    unsigned int dirSize = 500;
    float flushFrequency = 5.0;

    while ((ch = getopt_long(argc, argv, "f:i:l:s:t:", longopts, NULL)) != -1) {
      switch (ch) {
        case 'f': fileSize = atoi(optarg); break;
        case 'i': iterations = atoi(optarg); break;
        case 'l':
          if (strcmp(optarg, "syslog") == 0) {
            eventLogClass = [SNTSyslogEventLog class];
          } else if (strcmp(optarg, "file") == 0) {
            eventLogClass = [SNTFileEventLog class];
          } else if (strcmp(optarg, "protobuf") == 0) {
            eventLogClass = [SNTProtobufEventLog class];
          } else {
            usage();
            exit(1);
          }
          break;
        case 's': dirSize = atoi(optarg); break;
        case 't': flushFrequency = (float)atoi(optarg); break;
        default: usage(); exit(1);
      }
    }

    NSURL *santaTestDir =
      [NSURL fileURLWithPath:[NSTemporaryDirectory() stringByAppendingPathComponent:@"santa_test"]];
    NSURL *tempDir = [santaTestDir URLByAppendingPathComponent:[[NSUUID UUID] UUIDString]];
    NSURL *mailDir = [tempDir URLByAppendingPathComponent:@"pblogger"];
    NSURL *fileDir = [tempDir URLByAppendingPathComponent:@"filelogger"];
    NSString *eventLogPath = [[fileDir URLByAppendingPathComponent:@"santa.log"] path];

    [[NSFileManager defaultManager] createDirectoryAtURL:mailDir
                             withIntermediateDirectories:YES
                                              attributes:nil
                                                   error:nil];
    [[NSFileManager defaultManager] createDirectoryAtURL:fileDir
                             withIntermediateDirectories:YES
                                              attributes:nil
                                                   error:nil];

    configurator.configState[@"EventLogPath"] = eventLogPath;
    configurator.configState[@"MailDirectory"] = mailDir.path;
    configurator.configState[@"MailDirectoryFileSizeThresholdKB"] = @(fileSize);
    configurator.configState[@"MailDirectorySizeThresholdMB"] = @(dirSize);
    configurator.configState[@"MailDirectoryEventMaxFlushTimeSec"] = @(flushFrequency);

    NSLog(@"Using log path: %@", configurator.eventLogPath);
    NSLog(@"Using mail dir: %@", configurator.mailDirectory);
    NSLog(@"Using logger: %@", eventLogClass);

    SNTEventLog *eventLog = [[eventLogClass alloc] init];
    setup(iterations, eventLog);
    [eventLog forceFlush];
  }
}