area.h

Go to the documentation of this file.

/*
** area.h for lseos in lseos-lib/libarea
** 
** Copyright (c)2004 Vianney Rancurel, Julien Quintard
** Login   <vianney@epita.fr>
** 
** Started on  Tue Jan 20 16:46:06 2004 Vianney Rancurel
 ** Last update Fri Feb 18 16:44:52 2005 Olivier Dembour
*/
#ifndef __LIBAREA_AREA_H__
#define __LIBAREA_AREA_H__      1
typedef int     (*t_area_printf_fn)(const char *fmt, ...);

typedef unsigned int    t_area_uint;
typedef signed int      t_area_int;

typedef int     (*t_area_data_coalesce_fn)(void *data1,
                                           void *data2);

typedef void    (*t_area_data_print_fn)(void    *data);

typedef void    (*t_area_data_copy_fn)(void     *data_src,
                                       void     *data_dst);
typedef void    (*t_area_xlate_fn)(void *data,
                                    signed int  diff_pgs);

typedef int     (*t_area_match_fn)(void *data, void *val);

typedef int     (*t_area_foreach_fn)(void *data, void *val);
#define AREA_FOREACH_CONT       0
#define AREA_FOREACH_STOP       1

struct s_area;
typedef struct                  s_area
{
  union
  {
    LIST_ENTRY(s_area)          list;
  } u;

  t_area_uint                   blk;
  t_area_uint                   nb_blks;/* number of blocks             */
  void                          *data;  /* specific data                */
}                               t_area;

typedef enum
  {
    AREA_EZERO,                 /* 0 */
    AREA_ECOLLIDE,              /* 1 */
    AREA_ENOROOM,               /* 2 */
    AREA_EINVAL,                /* 3 */
    AREA_ELIMIT,                /* 4 */
    AREA_ENODEV,                /* 5 */
    AREA_ENOMATCH,              /* 6 */
    AREA_ENOFIT,                /* 7 there is room but we dont fit */
  }                             t_area_status;

typedef enum
  {
    AREA_FIRST_FIT,
    AREA_WORST_FIT,
    AREA_ANY_FIT,               
  }                             t_area_fit_method;

#define AREA_FITOPT_NOPAGE0     (1<<0u) 
#define AREA_FITOPT_NOFIRSTMEG  (1<<1u) 
LIST_HEAD(s_area_list, s_area);
typedef struct s_area_list      t_area_list;

struct s_area_set;
#include <llarea.h>
#include <bptarea.h>

typedef struct                  s_area_set
{
#define AREA_LL         0
#define AREA_BPT        1
#define AREA_MAXTYPE    1
  int                           type;
  union
  {
    t_area_list                 area_list;
    t_bpt(area_tree)            area_tree;
  } u;
  t_area_data_coalesce_fn       coalesce;
  t_area_data_print_fn          print;
  t_area_data_copy_fn           copy;
  t_area_xlate_fn               xlate;
  t_area_uint                   blk_size;
  t_area_uint                   first_blk;
  t_area_uint                   last_blk; /* could be the same as first_blk */
  void                          *set_data;
  struct
  {
    u_int                       nb_coal;
  } stats;
  char                          mem[512]; /* used internally            */
}                               t_area_set;

#define AREA_SET_SIZE(Set) \
  ((t_area_uint)(((Set)->last_blk - (Set)->first_blk + 1)))

/*
 * stubs prototypes
 */
typedef void
(*t_area_set_subinit_fn)(t_area_set *set);

typedef t_area_status 
(*t_area_set_add_fn)(t_area_set *set,
                     t_area **io);

typedef t_area_status
(*t_area_set_collide_fn)(t_area_set *set,
                         t_area_uint blk, 
                         int nb_blks);

typedef t_area_status
(*t_area_set_get_area_fn)(t_area_set *set,
                          t_area_uint blk,
                          int nb_blks, 
                          t_area **area);

typedef t_area_status 
(*t_area_set_remove_fn)(t_area_set *set,
                        t_area **io,
                        int no_alloc);

typedef t_area_status
(*t_area_set_modify_fn)(t_area_set *set,
                        t_area **io,
                        int no_alloc);

typedef t_area_status
 (*t_area_set_find_space_fn)(t_area_set *set,
                             int nb_blks,
                             t_area_fit_method fit,
                             u_int32_t fitopts,
                             t_area_uint *addr_returned);

typedef t_area_status
(*t_area_set_find_coalescible_space_fn)(t_area_set *set,
                                        t_area *ref_area,
                                        t_area_fit_method fit,
                                        u_int32_t fitopts,
                                        t_area_uint *blk_returned);

typedef void
(*t_area_set_dump_fn)(t_area_printf_fn printf_fn,
                      t_area_set *set,
                      t_area_match_fn match,
                      void *val);

typedef t_area_uint
(*t_area_set_used_fn)(t_area_set *set, 
                      t_area_match_fn match,
                      void *val,
                      int *nb_areas);

typedef int
(*t_area_set_foreach_fn)(t_area_set *set,
                         t_area_foreach_fn foreach,
                         void *val);

typedef int
(*t_area_set_empty_fn)(t_area_set *set);

typedef int
(*t_area_set_add_alloc_fn)(t_area_set *set);

typedef int
(*t_area_set_add_size_fn)(t_area_set *set);

typedef int
(*t_area_set_modify_alloc_fn)(t_area_set *set);

typedef int
(*t_area_set_modify_size_fn)(t_area_set *set);

typedef int
(*t_area_set_remove_alloc_fn)(t_area_set *set);

typedef int
(*t_area_set_remove_size_fn)(t_area_set *set);

#ifdef __AREA_OLD_CODE__
typedef t_area_status 
(*t_area_set_old_add_fn)(t_area_set *set,
                         t_area **new,
                         t_area **unused1);

typedef t_area_status 
(*t_area_set_old_remove_fn)(t_area_set *set,
                            t_area **todel,
                            t_area **unused1,
                            int no_alloc);

typedef t_area_status
(*t_area_set_old_modify_fn)(t_area_set *set,
                            t_area **new,
                            t_area **new2,
                            t_area **unused1,
                            t_area **unused2,
                            int no_alloc);
#endif

typedef struct                  s_area_fns
{
  t_area_set_subinit_fn         subinit;
  t_area_set_find_space_fn      find_space;
  t_area_set_add_fn             add;
  t_area_set_collide_fn         collide;
  t_area_set_find_coalescible_space_fn find_coalescible_space;
  t_area_set_get_area_fn        get_area;
  t_area_set_remove_fn          remove;
  t_area_set_modify_fn          modify;
  t_area_set_foreach_fn         foreach;
  t_area_set_dump_fn            dump;
  t_area_set_used_fn            used;
  t_area_set_empty_fn           empty;
  t_area_set_add_alloc_fn       add_alloc;
  t_area_set_add_size_fn        add_size;
  t_area_set_modify_alloc_fn    modify_alloc;
  t_area_set_modify_size_fn     modify_size;
  t_area_set_remove_alloc_fn    remove_alloc;
  t_area_set_remove_size_fn     remove_size;
#ifdef __AREA_OLD_CODE__
  t_area_set_old_add_fn         old_add;
  t_area_set_old_remove_fn      old_remove;
  t_area_set_old_modify_fn      old_modify;
#endif
}                               t_area_fns;

/* PROTO area.c */
/* area.c */
char *area_get_err_str(t_area_status status);
int area_collide(t_area *area1, t_area *area2);
t_area_status area_set_init(int type, t_area_set *new, t_area_data_coalesce_fn coalesce, t_area_data_print_fn print, t_area_data_copy_fn copy, t_area_xlate_fn xlate, t_area_uint blk_size, t_area_uint first_blk, t_area_uint last_blk, void *set_data);
void area_set_subinit(t_area_set *set);
t_area_status area_set_find_space(t_area_set *set, int nb_blks, t_area_fit_method fit, u_int32_t fitopts, t_area_uint *addr_returned);
t_area_status area_set_add(t_area_set *set, t_area **io);
t_area_status area_set_collide(t_area_set *set, t_area_uint blk, int nb_blks);
t_area_status area_set_find_coalescible_space(t_area_set *set, t_area *ref_area, t_area_fit_method fit, u_int32_t fitopts, t_area_uint *blk_returned);
t_area_status area_set_get_area(t_area_set *set, t_area_uint blk, int nb_blks, t_area **area);
t_area_status area_set_remove(t_area_set *set, t_area **io, int no_alloc);
t_area_status area_set_modify(t_area_set *set, t_area **io, int no_alloc);
int area_set_foreach(t_area_set *set, t_area_foreach_fn foreach, void *val);
void area_set_dump(t_area_printf_fn printf_fn, t_area_set *set, t_area_match_fn match, void *val);
t_area_uint area_set_used(t_area_set *set, t_area_match_fn match, void *val, int *nb_areas);
int area_set_empty(t_area_set *set);
int area_set_add_alloc(t_area_set *set);
int area_set_add_size(t_area_set *set);
int area_set_modify_alloc(t_area_set *set);
int area_set_modify_size(t_area_set *set);
int area_set_remove_alloc(t_area_set *set);
int area_set_remove_size(t_area_set *set);
t_area_status area_set_old_add(t_area_set *set, t_area **new, t_area **unused1);
t_area_status area_set_old_remove(t_area_set *set, t_area **todel, t_area **unused1, int no_alloc);
t_area_status area_set_old_modify(t_area_set *set, t_area **new, t_area **new2, t_area **unused1, t_area **unused2, int no_alloc);
#endif

---