xxdp.h

/* xxdp.h - handles the XXDP filesystem on an image.
 *
 *  Copyright (c) 2017, Joerg Hoppe
 *  j_hoppe@t-online.de, www.retrocmp.com
 *
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *  - Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *  - Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 *  - Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 *  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 *  07-May-2017  JH  passes GCC warning levels -Wall -Wextra
 *  12-Jan-2017  JH  created
 */
#ifndef XXDP_H_
#define XXDP_H_

#include <stdio.h>
#include <stdint.h>
#include <time.h>

#include "boolarray.h"
#include "device_info.h"
#include "utils.h"
#include "xxdp_radi.h"

/* Logical structure of XXDP filesystem.
*  See
 * CHQFSA0 XXDP+ FILE STRUCT DOC
 *
 */
#define XXDP_BLOCKSIZE   512
#define XXDP_MAX_BLOCKCOUNT 0x10000 // block addr only 16 bit

// layout data not in RADI
#define	XXDP_BITMAP_WORDS_PER_MAP 60 // 1 map = 16*60 = 960 block bits
#define	XXDP_UFD_ENTRY_WORDCOUNT	9 // len of UFD entry
#define XXDP_UFD_ENTRIES_PER_BLOCK	28 // 29 file entries per UFD block
// own limits
#define	XXDP_MAX_FILES_PER_IMAGE 1000
#define XXDP_MAX_BLOCKS_PER_LIST       1024  //  own: max filesize: * 510

// pseudo file for volume parameters
#define XXDP_VOLUMEINFO_FILNAM	"$VOLUM" // valid XXDP file name
#define XXDP_VOLUMEINFO_EXT	"INF"
// boot block and monitor blocks are pseudo files
#define XXDP_BOOTBLOCK_FILNAM	"$BOOT" // valid XXDP file names
#define XXDP_BOOTBLOCK_EXT	"BLK"
#define XXDP_MONITOR_FILNAM	"$MONI"// valid XXDP file names
#define XXDP_MONITOR_EXT	"TOR"


typedef uint16_t xxdp_blocknr_t ;


typedef struct {
	int	 track ;
	int	 sector ;
	int	 cylinder ;
	int	blocknr ;
} diskaddr_t ;


typedef struct {
	unsigned count;
	xxdp_blocknr_t blocknr[XXDP_MAX_BLOCKS_PER_LIST]; // later dynamic?
} xxdp_blocklist_t;

// a range of block which is treaed as one byte stream
// - for the bootloader on a xxdp image
// - for the monitor
typedef struct {
	xxdp_blocknr_t	blocknr ; // start
	xxdp_blocknr_t	blockcount ; // count of blocks
	uint8_t *data;  // space for blockcount * BLOCKSIZE data
	uint32_t data_size; // byte count in data[]
} xxdp_multiblock_t;

// boolean marker for block usage
typedef struct {
	xxdp_blocklist_t blocklist ;
	uint8_t used[XXDP_MAX_BLOCKCOUNT];
} xxdp_bitmap_t;

typedef struct {
// these blocks are allocated, but no necessarily all used
	xxdp_blocklist_t blocklist;
	int contiguous; //  1: blocknumbers are numbered start, start+1, start+2, ...
	char filnam[80];  // normally 6 chars, encoded in 2 words RADIX50. Special filenames longer
	char ext[40]; // normally 3 chars, encoded 1 word
	xxdp_blocknr_t block_count ; // saved blockcount from UFD.
	// UFD should not differ from blocklist.count !
	uint32_t data_size; // byte count in data[]
	uint8_t *data; // dynamic array with 'size' entries
	struct tm date; // file date. only y,m,d valid
	uint8_t	changed ; // calc'd from image_changed_blocks
	int	fixed ; // is part of filesystem, can not be deleted
} xxdp_file_t;

// all elements of a populated xxdp disk image
typedef struct {
	// link to image data and size
	 uint8_t *image_data;
	 uint32_t image_size ;
	 boolarray_t *image_changed_blocks ; // blocks marked as "changed". may be NULL

	// the device this filesystem resides on
	device_type_t dec_device ;
	device_info_t  *device_info ;
	xxdp_radi_t radi ;    // Random Access Device Information

	 unsigned blockcount ; // usable blocks in filesystem.
	 xxdp_blocknr_t	preallocated_blockcount ; // fix blocks at start
	 int interleave;
 	 int mfd_variety; // Master File Directory in format 1 or format 2?

 	diskaddr_t bad_sector_file_sd ; // DEC std 144 bad sector file single density
 	diskaddr_t bad_sector_file_dd ; // dto, double density

	xxdp_multiblock_t *bootblock;
	xxdp_multiblock_t *monitor;
	xxdp_bitmap_t *bitmap;

	// Data in  Master File Directory
	// format 1: linked list of 2.  Variant 2: only 1 block
	xxdp_blocklist_t *mfd_blocklist;

	// blocks used by User File Directory
	xxdp_blocklist_t *ufd_blocklist;
	int file_count; // signed, because there are negative file_idx
	xxdp_file_t *file[XXDP_MAX_FILES_PER_IMAGE];
} xxdp_filesystem_t;

#if !defined(_XXDP_C_) && !defined(_XXDP_RADI_C_)
extern char * xxdp_fileorder[] ;
#endif


//int xxdp_init(image_t *img);


// before first use. Link with image data buffer
xxdp_filesystem_t *xxdp_filesystem_create(device_type_t dec_device, uint8_t *image_data, uint32_t image_size,
		boolarray_t *changedblocks) ;

void xxdp_filesystem_destroy(xxdp_filesystem_t *_this) ;

void xxdp_filesystem_init(xxdp_filesystem_t *_this) ;

// analyse an image
int xxdp_filesystem_parse(xxdp_filesystem_t *_this);

int xxdp_filesystem_file_add(xxdp_filesystem_t *_this,char *hostfname, time_t hostfdate,
		uint8_t *data, uint32_t data_size) ;

// write filesystem into image
int xxdp_filesystem_render(xxdp_filesystem_t *_this);

xxdp_file_t *xxdp_filesystem_file_get(xxdp_filesystem_t *_this, int fileidx) ;

void xxdp_filesystem_print_dir(xxdp_filesystem_t *_this, FILE *stream) ;
void xxdp_filesystem_print_diag(xxdp_filesystem_t *_this, FILE *stream) ;

char *xxdp_filename_to_host(char *filnam, char *ext) ;
char *xxdp_filename_from_host(char *hostfname, char *filnam, char *ext) ;


#endif /* XXDP_H_ */