aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/definitions.h
diff options
context:
space:
mode:
authorMartin Willi <martin@strongswan.org>2006-04-05 12:10:50 +0000
committerMartin Willi <martin@strongswan.org>2006-04-05 12:10:50 +0000
commit6862128151fb78f63685a8da5575783c426d64a7 (patch)
tree75920a6688ed5654fb917ecccc1e0e469480fd1f /Source/charon/definitions.h
parent3dbbbf3e16366b0da33b29bbc1a4ba9a976e43a0 (diff)
downloadstrongswan-6862128151fb78f63685a8da5575783c426d64a7.tar.bz2
strongswan-6862128151fb78f63685a8da5575783c426d64a7.tar.xz
../svn-commit.tmp
Diffstat (limited to 'Source/charon/definitions.h')
-rw-r--r--Source/charon/definitions.h292
1 files changed, 0 insertions, 292 deletions
diff --git a/Source/charon/definitions.h b/Source/charon/definitions.h
deleted file mode 100644
index 4ca46063a..000000000
--- a/Source/charon/definitions.h
+++ /dev/null
@@ -1,292 +0,0 @@
-/**
- * @file definitions.h
- *
- * @brief General purpose definitions and macros.
- *
- */
-
-/*
- * Copyright (C) 2005 Jan Hutter, Martin Willi
- * Hochschule fuer Technik Rapperswil
- * Copyright (C) 1998, 1999 D. Hugh Redelmeier. (Endian stuff)
- *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the
- * Free Software Foundation; either version 2 of the License, or (at your
- * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
- * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * for more details.
- */
-
-#ifndef DEFINITIONS_H_
-#define DEFINITIONS_H_
-
-
-
-/* stolen from strongswan */
-#if linux
-# if defined(i386) && !defined(__i386__)
-# define __i386__ 1
-# define MYHACKFORTHIS 1
-# endif
-# include <endian.h>
-# ifdef MYHACKFORTHIS
-# undef __i386__
-# undef MYHACKFORTHIS
-# endif
-#elif !(defined(BIG_ENDIAN) && defined(LITTLE_ENDIAN) && defined(BYTE_ORDER))
- /* we don't know how to do this, so we require the macros to be defined
- * with compiler flags:
- * -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=BIG_ENDIAN
- * or -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=LITTLE_ENDIAN
- * Thse match the GNU definitions
- */
-# include <sys/endian.h>
-#endif
-
-#ifndef BIG_ENDIAN
- #error "BIG_ENDIAN must be defined"
-#endif
-
-#ifndef LITTLE_ENDIAN
- #error "LITTLE_ENDIAN must be defined"
-#endif
-
-#ifndef BYTE_ORDER
- #error "BYTE_ORDER must be defined"
-#endif
-
-/**
- * @mainpage
- *
- * @section Threading Architecture
- *
- * All IKEv2 stuff is handled in charon. It uses a newer and more flexible
- * architecture than pluto. Charon uses a thread-pool, which allows parallel
- * execution SA-management. Beside the thread-pool, there are some special purpose
- * threads which do their job for the common health of the daemon.
- @verbatim
- +------+
- | E Q |
- | v u |---+ +------+ +------+
- | e e | | | | | IKE- |
- | n u | +-----------+ | |--| SA |
- | t e | | | | I M | +------+
- +------------+ | - | | Scheduler | | K a |
- | receiver | +------+ | | | E n | +------+
- +----+-------+ +-----------+ | - a | | IKE- |
- | | +------+ | | S g |--| SA |
- +-------+--+ +-----| J Q |---+ +------------+ | A e | +------+
- -| socket | | o u | | | | - r |
- +-------+--+ | b e | | Thread- | | |
- | | - u | | Pool | | |
- +----+-------+ | e |------| |---| |
- | sender | +------+ +------------+ +------+
- +----+-------+
- | +------+
- | | S Q |
- | | e u |
- | | n e |
- +------------| d u |
- | - e |
- +--+---+
- @endverbatim
- * The thread-pool is the heart of the architecture. It processes jobs from a
- * (fully synchronized) job-queue. Mostly, a job is associated with a specific
- * IKE SA. These IKE SAs are synchronized, only one thread can work one an IKE SA.
- * This makes it unnecesary to use further synchronisation methods once a IKE SA
- * is checked out. The (rather complex) synchronization of IKE SAs is completely
- * done in the IKE SA manager.
- * The sceduler is responsible for event firing. It waits until a event in the
- * (fully synchronized) event-queue is ready for processing and pushes the event
- * down to the job-queue. A thread form the pool will pick it up as quick as
- * possible. Every thread can queue events or jobs. Furter, an event can place a
- * packet in the send-queue. The sender thread waits for those packets and sends
- * them over the wire, via the socket. The receiver does exactly the opposite of
- * the sender. It waits on the socket, reads in packets an places them on the
- * job-queue for further processing by a thread from the pool.
- * There are even more threads, not drawn in the upper scheme. The stroke thread
- * is responsible for reading and processessing commands from another process. The
- * kernel interface thread handles communication from and to the kernel via a
- * netlink socket. It waits for kernel events and processes them appropriately.
- */
-
-/**
- * @defgroup config config
- *
- * Classes implementing configuration related things.
- */
-
-/**
- * @defgroup encoding encoding
- *
- * Classes used to encode and decode IKEv2 messages.
- */
-
-/**
- * @defgroup network network
- *
- * Classes for network relevant stuff.
- */
-
- /**
- * @defgroup payloads payloads
- *
- * Classes representing specific IKEv2 payloads.
- *
- * @ingroup encoding
- */
-
-/**
- * @defgroup sa sa
- *
- * Security association and helper classes.
- */
-
-
-/**
- * @defgroup states states
- *
- * Varius states in which an IKE SA can be.
- *
- * @ingroup sa
- */
-
-/**
- * @defgroup queues queues
- *
- * Different kind of queues.
- */
-
- /**
- * @defgroup jobs jobs
- *
- * Jobs used in job queue and event queue.
- *
- * @ingroup queues
- */
-
-/**
- * @defgroup testcases testcases
- *
- * Testcases used to test the different classes in seperate module tests.
- */
-
-/**
- * @defgroup transforms transforms
- *
- * Transform algorithms of different kind.
- */
-
-/**
- * @defgroup rsa rsa
- *
- * RSA public key algorithm.
- *
- * @ingroup transforms
- */
-
-/**
- * @defgroup prfs prfs
- *
- * Pseudo random functions.
- *
- * @ingroup transforms
- */
-
-/**
- * @defgroup signers signers
- *
- * Symmetric signing algorithms, used to ensure message integrity.
- *
- * @ingroup transforms
- */
-
-/**
- * @defgroup crypters crypters
- *
- * Symmetric encryption algorithms, used to encrypt and decrypt.
- *
- * @ingroup transforms
- */
-
-/**
- * @defgroup hashers hashers
- *
- * Hashing algorithms.
- *
- * @ingroup transforms
- */
-/**
- * @defgroup asn1 asn1
- *
- * ASN1 structure definition, en-/decoder of for DER
- *
- * @todo Implement a der_encoder_t class.
- */
-
-/**
- * @defgroup utils utils
- *
- * Generic helper classes.
- */
-
-/**
- * @defgroup threads threads
- *
- * Threaded classes, which will do their job alone.
- */
-
-/**
- * Macro gives back larger of two values.
- */
-#define max(x,y) (x > y ? x : y)
-
-/**
- * Macro gives back smaller of two values.
- */
-#define min(x,y) (x < y ? x : y)
-
-/**
- * Debug macro to follow control flow
- */
-#define POS printf("%s, line %d\n", __FILE__, __LINE__)
-
-/**
- * Papping entry which defines the end of a mapping_t array.
- */
-#define MAPPING_END (-1)
-
-
-typedef struct mapping_t mapping_t;
-
-/**
- * @brief Mapping entry, where enum-to-string mappings are stored.
- */
-struct mapping_t
-{
- /**
- * Enumeration value.
- */
- int value;
-
- /**
- * Mapped string.
- */
- char *string;
-};
-
-
-/**
- * @brief Find a mapping_string in the mapping[].
- *
- * @param mappings mappings array
- * @param value enum-value to get the string from
- *
- */
-char *mapping_find(mapping_t *mappings, int value);
-
-#endif /*DEFINITIONS_H_*/