Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
content badge
swh:1:cnt:a9365b5f894c64d282e5ab8b3a3ee3322869e41e

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
/*
 * ============================================================================
 *
 *        Authors:  Prashant Pandey <ppandey@cs.stonybrook.edu>
 *                  Rob Johnson <robj@vmware.com>   
 *
 * ============================================================================
 */

#include <stdlib.h>
#if 0
# include <assert.h>
#else
# define assert(x)
#endif
#include <string.h>
#include <inttypes.h>
#include <stdio.h>
#include <unistd.h>
#include <math.h>
#include <time.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <fcntl.h>

#include "gqf/hashutil.h"
#include "gqf/gqf.h"
#include "gqf/gqf_int.h"
#include "gqf/gqf_file.h"

#define NUM_SLOTS_TO_LOCK (1ULL<<16)

bool qf_initfile(QF *qf, uint64_t nslots, uint64_t key_bits, uint64_t
								 value_bits, enum qf_hashmode hash, uint32_t seed, char*
								 filename, int prot)
{
	uint64_t total_num_bytes = qf_init(qf, nslots, key_bits, value_bits, hash,
																		 seed, NULL, 0);

	int ret;
	qf->runtimedata = (qfruntime *)calloc(sizeof(qfruntime), 1);
	if (qf->runtimedata == NULL) {
		perror("Couldn't allocate memory for runtime data.");
		exit(EXIT_FAILURE);
	}
	qf->runtimedata->f_info.fd = open(filename, O_RDWR | O_CREAT | O_TRUNC, S_IRWXU);
	if (qf->runtimedata->f_info.fd < 0) {
		perror("Couldn't open file.");
		exit(EXIT_FAILURE);
	}
	ret = posix_fallocate(qf->runtimedata->f_info.fd, 0, total_num_bytes);
	if (ret < 0) {
		perror("Couldn't fallocate file:\n");
		exit(EXIT_FAILURE);
	}
	qf->metadata = (qfmetadata *)mmap(NULL, total_num_bytes, prot, MAP_SHARED,
																		qf->runtimedata->f_info.fd, 0);
	if (qf->metadata == MAP_FAILED) {
		perror("Couldn't mmap metadata.");
		exit(EXIT_FAILURE);
	}
	ret = madvise(qf->metadata, total_num_bytes, MADV_RANDOM);
	if (ret < 0) {
		perror("Couldn't fallocate file.");
		exit(EXIT_FAILURE);
	}
	qf->blocks = (qfblock *)(qf->metadata + 1);

	uint64_t init_size = qf_init(qf, nslots, key_bits, value_bits, hash, seed,
															 qf->metadata, total_num_bytes);
	qf->runtimedata->f_info.filepath = (char *)malloc(strlen(filename) + 1);
	if (qf->runtimedata->f_info.filepath == NULL) {
		perror("Couldn't allocate memory for runtime f_info filepath.");
		exit(EXIT_FAILURE);
	}
	strcpy(qf->runtimedata->f_info.filepath, filename);

	if (init_size == total_num_bytes)
		return true;
	else
		return false;
}

uint64_t qf_usefile(QF* qf, const char* filename, int prot)
{
	struct stat sb;
	int ret;

	qf->runtimedata = (qfruntime *)calloc(sizeof(qfruntime), 1);
	if (qf->runtimedata == NULL) {
		perror("Couldn't allocate memory for runtime data.");
		exit(EXIT_FAILURE);
	}
	qf->runtimedata->f_info.fd = open(filename, O_RDONLY, S_IRUSR);
	if (qf->runtimedata->f_info.fd < 0) {
		perror("Couldn't open file.");
		exit(EXIT_FAILURE);
	}

	ret = fstat (qf->runtimedata->f_info.fd, &sb);
	if ( ret < 0) {
		perror ("fstat");
		exit(EXIT_FAILURE);
	}

	if (!S_ISREG (sb.st_mode)) {
		fprintf (stderr, "%s is not a file.\n", filename);
		exit(EXIT_FAILURE);
	}

	qf->runtimedata->f_info.filepath = (char *)malloc(strlen(filename) + 1);
	if (qf->runtimedata->f_info.filepath == NULL) {
		perror("Couldn't allocate memory for runtime f_info filepath.");
		exit(EXIT_FAILURE);
	}
	strcpy(qf->runtimedata->f_info.filepath, filename);
	/* initialize all the locks to 0 */
	qf->runtimedata->metadata_lock = 0;
	qf->runtimedata->locks = (volatile int *)calloc(qf->runtimedata->num_locks,
																					sizeof(volatile int));
	if (qf->runtimedata->locks == NULL) {
		perror("Couldn't allocate memory for runtime locks.");
		exit(EXIT_FAILURE);
	}
#ifdef LOG_WAIT_TIME
	qf->runtimedata->wait_times = (wait_time_data* )calloc(qf->runtimedata->num_locks+1,
																								 sizeof(wait_time_data));
	if (qf->runtimedata->wait_times == NULL) {
		perror("Couldn't allocate memory for runtime wait_times.");
		exit(EXIT_FAILURE);
	}
#endif
	qf->metadata = (qfmetadata *)mmap(NULL, sb.st_size, prot, MAP_SHARED,
																		qf->runtimedata->f_info.fd, 0);
	if (qf->metadata == MAP_FAILED) {
		perror("Couldn't mmap metadata.");
		exit(EXIT_FAILURE);
	}
	if (qf->metadata->magic_endian_number != MAGIC_NUMBER) {
		fprintf(stderr, "Can't read the CQF. It was written on a different endian machine.");
		exit(EXIT_FAILURE);
	}
	qf->blocks = (qfblock *)(qf->metadata + 1);

	return sizeof(qfmetadata) + qf->metadata->total_size_in_bytes;
}

bool qf_closefile(QF* qf)
{
	assert(qf->metadata != NULL);
	int fd = qf->runtimedata->f_info.fd;
	uint64_t size = qf->metadata->total_size_in_bytes + sizeof(qfmetadata);
	void *buffer = qf_destroy(qf);
	if (buffer != NULL) {
		munmap(buffer, size);
		close(fd);
		return true;
	}

	return false;
}

bool qf_deletefile(QF* qf)
{
	assert(qf->metadata != NULL);
	char *path = (char *)malloc(strlen(qf->runtimedata->f_info.filepath) + 1);
	if (qf->runtimedata->f_info.filepath == NULL) {
		perror("Couldn't allocate memory for runtime f_info filepath.");
		exit(EXIT_FAILURE);
	}
	strcpy(path, qf->runtimedata->f_info.filepath);
	if (qf_closefile(qf)) {
		remove(path);
		return true;
	}

	return false;
}

uint64_t qf_serialize(const QF *qf, const char *filename)
{
	FILE *fout;
	fout = fopen(filename, "wb+");
	if (fout == NULL) {
		perror("Error opening file for serializing.");
		exit(EXIT_FAILURE);
	}
	fwrite(qf->metadata, sizeof(qfmetadata), 1, fout);
	fwrite(qf->blocks, qf->metadata->total_size_in_bytes, 1, fout);
	fclose(fout);
	
	return sizeof(qfmetadata) + qf->metadata->total_size_in_bytes;
}

uint64_t qf_deserialize(QF *qf, const char *filename)
{
	FILE *fin;
	fin = fopen(filename, "rb");
	if (fin == NULL) {
		perror("Error opening file for deserializing.");
		exit(EXIT_FAILURE);
	}

	qf->runtimedata = (qfruntime *)calloc(sizeof(qfruntime), 1);
	if (qf->runtimedata == NULL) {
		perror("Couldn't allocate memory for runtime data.");
		exit(EXIT_FAILURE);
	}
	qf->metadata = (qfmetadata *)calloc(sizeof(qfmetadata), 1);
	if (qf->metadata == NULL) {
		perror("Couldn't allocate memory for metadata.");
		exit(EXIT_FAILURE);
	}
	int ret = fread(qf->metadata, sizeof(qfmetadata), 1, fin);
	if (ret < 1) {
		perror("Couldn't read metadata from file.");
		exit(EXIT_FAILURE);
	}
	if (qf->metadata->magic_endian_number != MAGIC_NUMBER) {
		fprintf(stderr, "Can't read the CQF. It was written on a different endian machine.");
		exit(EXIT_FAILURE);
	}

	qf->runtimedata->f_info.filepath = (char *)malloc(strlen(filename) + 1);
	if (qf->runtimedata->f_info.filepath == NULL) {
		perror("Couldn't allocate memory for runtime f_info filepath.");
		exit(EXIT_FAILURE);
	}
	strcpy(qf->runtimedata->f_info.filepath, filename);
	/* initlialize the locks in the QF */
	qf->runtimedata->num_locks = (qf->metadata->xnslots/NUM_SLOTS_TO_LOCK)+2;
	qf->runtimedata->metadata_lock = 0;
	/* initialize all the locks to 0 */
	qf->runtimedata->locks = (volatile int *)calloc(qf->runtimedata->num_locks,
																									sizeof(volatile int));
	if (qf->runtimedata->locks == NULL) {
		perror("Couldn't allocate memory for runtime locks.");
		exit(EXIT_FAILURE);
	}
	qf->blocks = (qfblock *)calloc(qf->metadata->total_size_in_bytes, 1);
	if (qf->blocks == NULL) {
		perror("Couldn't allocate memory for blocks.");
		exit(EXIT_FAILURE);
	}
	ret = fread(qf->blocks, qf->metadata->total_size_in_bytes, 1, fin);
	if (ret < 1) {
		perror("Couldn't read metadata from file.");
		exit(EXIT_FAILURE);
	}
	fclose(fin);

	return sizeof(qfmetadata) + qf->metadata->total_size_in_bytes;
}

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API