fw_release.h

Go to the documentation of this file.

 
#ifndef RCBENCH_FW_RELEASE_H
#define RCBENCH_FW_RELEASE_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "fw_image.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define FW_REL_REPO        "subtilitas/rcbench"
#define FW_REL_LATEST_URL  "https://github.com/" FW_REL_REPO "/releases/latest"
#define FW_REL_TAG_PREFIX  "https://github.com/" FW_REL_REPO "/releases/tag/"
#define FW_REL_DL_PREFIX   "https://github.com/" FW_REL_REPO "/releases/download/"
#define FW_REL_SUMS_NAME   "SHA256SUMS"
#define FW_REL_API_URL     "https://api.github.com/repos/" FW_REL_REPO \
                           "/releases?per_page=10"

#define FW_REL_API_ACCEPT  "application/vnd.github+json"
#define FW_REL_API_VERSION "2022-11-28"

#define FW_REL_LINE_MAJOR  0u    
#define FW_REL_LINE_MINOR  22u   

#ifndef FW_REL_LINE_CAPPED
#define FW_REL_LINE_CAPPED 0
#endif

#define FW_REL_TAG_MAX     18u
#define FW_REL_VER_TEXT    18u
#define FW_REL_NAME_MAX    40u
#define FW_REL_URL_MAX     2048u
#define FW_REL_HOPS_MAX    3u
#define FW_REL_SUMS_MAX    4096u
#define FW_REL_API_RELEASES 10u
#define FW_REL_API_MAX     262144u
#define FW_REL_SCAN_MAX    FW_REL_API_MAX
#define FW_REL_SCAN_DEPTH  32u

typedef enum {
    FW_REL_OK = 0,
    FW_REL_MISSING,     
    FW_REL_LONG,        
    FW_REL_CHAR,        
    FW_REL_PLACE,       
    FW_REL_VERSION,     
    FW_REL_STATUS,      
    FW_REL_HOPS,        
    FW_REL_HOST,        
    FW_REL_NO_LENGTH,   
    FW_REL_EMPTY,       
    FW_REL_TOO_BIG,     
    FW_REL_SHORT,       
    FW_REL_OVERRUN,     
    FW_REL_SUMS_BAD,    
    FW_REL_SUMS_NONE,   
    FW_REL_SUMS_TWICE,  
    FW_REL_TAG_NONE,    
    FW_REL_TAG_LONG,    
    FW_REL_TAG_FORM,    
    FW_REL_SCAN_LONG,   
    FW_REL_COUNT
} fw_rel_err_t;

const char *fw_rel_err_str(fw_rel_err_t e);

bool fw_release_parse_version(const char *s, size_t n, fw_version_t *out);

fw_rel_err_t fw_release_parse_tag(const char *loc, size_t n, bool cut,
                                  fw_version_t *out);

typedef enum {
    FW_REL_BODY = 0,    
    FW_REL_REDIRECT,    
    FW_REL_REFUSED,     
} fw_rel_status_t;
 
fw_rel_status_t fw_release_status(int status);

fw_rel_err_t fw_release_redirect(const char *loc, size_t n, bool cut,
                                 unsigned hops);

extern const char *const FW_REL_HOSTS[];

fw_rel_err_t fw_release_length(int64_t length, bool chunked, uint32_t cap);

fw_rel_err_t fw_release_parse_sums(const char *text, size_t n,
                                   const char *name,
                                   uint8_t out[FW_SHA256_BYTES]);

typedef struct {
    uint32_t     seen;    
    uint32_t     arrays;  
    uint8_t      depth;   
    uint8_t      st;      
    uint8_t      want;    
    uint8_t      kn;      
    char         key[8];  
    bool         klong;   
    bool         ended;   
    uint8_t      tn;      
    char         tag[FW_REL_TAG_MAX]; 
    uint8_t      dn;      
    char         dval[5]; 
    bool         have_tag;   
    bool         have_draft; 
    bool         draft;      
    bool         have_best;  
    uint8_t      releases;   
    fw_version_t cur;     
    fw_version_t best;    
    bool         have_line; 
    fw_version_t line;    
    fw_rel_err_t err;     
    fw_version_t found;   
} fw_rel_scan_t;
 
void fw_release_scan_init(fw_rel_scan_t *s);

bool fw_release_scan_feed(fw_rel_scan_t *s, const uint8_t *d, size_t n);

fw_rel_err_t fw_release_scan_end(const fw_rel_scan_t *s, fw_version_t *out);

bool fw_release_scan_line(const fw_rel_scan_t *s, fw_version_t *out);

bool fw_release_in_line(fw_version_t v);

bool fw_release_line_capped(void);

void fw_release_set_line_capped(bool capped);

bool fw_release_offered(fw_version_t found, fw_version_t running,
                        bool running_ok);

void fw_release_version_text(fw_version_t v, char out[FW_REL_VER_TEXT]);

void fw_release_image_name(fw_version_t v, char out[FW_REL_NAME_MAX]);

bool fw_release_url(fw_version_t v, const char *file, char *out, size_t cap);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_FW_RELEASE_H */