cmd/img_mgmt/port/mynewt/src/mynewt_img_mgmt_log.c

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 "os/mynewt.h"
#include "modlog/modlog.h"
#include "cborattr/cborattr.h"
#include "img_mgmt/img_mgmt.h"

/**
 * Log event types (all events are CBOR-encoded):
 *
 * upstart:
 *     When: upon receiving an upload request with an offset of 0.
 *     Structure:
 *     {
 *         "ev": "upstart",
 *         "rc": <mgmt-error-code (int)>
 *     }
 *
 * updone:
 *     When: upon receiving an upload request containing the final chunk of an
 *           image OR a failed upload request with a non-zero offset.
 *     Structure:
 *     {
 *         "ev": "updone",
 *         "rc": <mgmt-error-code (int)>
 *         "hs": <image-hash (byte-string)> (only present on success)
 *     }
 *
 * pend:
 *     When: upon receiving a non-permanent `set-pending` request.
 *     Structure:
 *     {
 *         "ev": "pend",
 *         "rc": <mgmt-error-code (int)>,
 *         "hs": <image-hash (byte-string)>
 *     }
 *
 * conf:
 *     When: upon receiving a `confirm` request OR a permanent `set-pending`
 *           request.
 *     Structure:
 *     {
 *         "ev": "conf",
 *         "rc": <mgmt-error-code (int)>,
 *         "hs": <image-hash (byte-string)> (only present for `set-pending`)
 *     }
 */

#define IMG_MGMT_LOG_EV_UPSTART   "upstart"
#define IMG_MGMT_LOG_EV_UPDONE    "updone"
#define IMG_MGMT_LOG_EV_PEND      "pend"
#define IMG_MGMT_LOG_EV_CONF      "conf"

static int
img_mgmt_log_gen(const char *ev, int status, const uint8_t *hash)
{
#if MYNEWT_VAL(LOG_VERSION) > 2 && \
    LOG_MOD_LEVEL_IS_ACTIVE(MYNEWT_VAL(IMG_MGMT_LOG_LVL), LOG_LEVEL_INFO)

    struct os_mbuf *om;
    int rc;

    const struct cbor_out_attr_t attrs[] = {
        {
            .attribute = "ev",
            .val = {
                .type = CborAttrTextStringType,
                .string = ev,
            },
        },
        {
            .attribute = "rc",
            .val = {
                .type = CborAttrIntegerType,
                .integer = status,
            },
        },
        {
            .attribute = "hs",
            .val = {
                .type = CborAttrByteStringType,
                .bytestring.data = hash,
                .bytestring.len = IMG_MGMT_HASH_LEN,
            },
            .omit = hash == NULL,    
        },
        { 0 }
    };

    rc = cbor_write_object_msys(attrs, &om);
    if (rc != 0) {
        return rc;
    }

    modlog_append_mbuf(MYNEWT_VAL(IMG_MGMT_LOG_MOD), LOG_LEVEL_INFO,
                       LOG_ETYPE_CBOR, om);
#endif

    return 0;
}

int
img_mgmt_impl_log_upload_start(int status)
{
    return img_mgmt_log_gen(IMG_MGMT_LOG_EV_UPSTART, status, NULL);
}

int
img_mgmt_impl_log_upload_done(int status, const uint8_t *hash)
{
    return img_mgmt_log_gen(IMG_MGMT_LOG_EV_UPDONE, 0, hash);
}

int
img_mgmt_impl_log_pending(int status, const uint8_t *hash)
{
    return img_mgmt_log_gen(IMG_MGMT_LOG_EV_PEND, status, hash);
}

int
img_mgmt_impl_log_confirm(int status, const uint8_t *hash)
{
    return img_mgmt_log_gen(IMG_MGMT_LOG_EV_CONF, status, hash);
}