ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / include / mysql / server / private

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; version 2 of the License.

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.

You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1335  USA */

#ifndef FILESORT_INCLUDED
#define FILESORT_INCLUDED

#include "my_base.h"                            /* ha_rows */
#include "sql_alloc.h"
#include "filesort_utils.h"

class SQL_SELECT;
class THD;
struct TABLE;
class Filesort_tracker;
struct SORT_FIELD;
struct SORT_FIELD_ATTR;
typedef struct st_order ORDER;
class JOIN;
class Addon_fields;
class Sort_keys;

/**
  Sorting related info.
  To be extended by another WL to include complete filesort implementation.
*/
class Filesort: public Sql_alloc
{
public:
  /** List of expressions to order the table by */
  ORDER *order;
  /** Number of records to return */
  ha_rows limit;
  /** ORDER BY list with some precalculated info for filesort */
  SORT_FIELD *sortorder;
  /* Used with ROWNUM. Contains the number of rows filesort has found so far */
  ha_rows *accepted_rows;
  /** select to use for getting records */
  SQL_SELECT *select;

/** TRUE <=> free select on destruction */
  bool own_select;
  /** TRUE means we are using Priority Queue for order by with limit. */
  bool using_pq;
  /* 
    TRUE means sort operation must produce table rowids. 
    FALSE means that it also has an option of producing {sort_key, addon_fields}
          pairs.

Usually initialized with value of join_tab->keep_current_rowid to allow for
    a call to table->file->position() using these table rowids.
  */
  bool sort_positions;
  /*
    TRUE means all the fields of table of whose bitmap read_set is set
         need to be read while reading records in the sort buffer.
    FALSE otherwise
  */
  bool set_all_read_bits;

Filesort_tracker *tracker;
  Sort_keys *sort_keys;

/* Unpack temp table columns to base table columns*/
  void (*unpack)(TABLE *);

Filesort(ORDER *order_arg, ha_rows limit_arg, bool sort_positions_arg,
           SQL_SELECT *select_arg):
    order(order_arg),
    limit(limit_arg),
    sortorder(NULL),
    accepted_rows(0),
    select(select_arg),
    own_select(false), 
    using_pq(false),
    sort_positions(sort_positions_arg),
    set_all_read_bits(false),
    sort_keys(NULL),
    unpack(NULL)
  {
    DBUG_ASSERT(order);
  };

~Filesort() { cleanup(); }
  /* Prepare ORDER BY list for sorting. */
  Sort_keys* make_sortorder(THD *thd, JOIN *join, table_map first_table_bit);

private:
  void cleanup();
};

class SORT_INFO
{
  /// Buffer for sorting keys.
  Filesort_buffer filesort_buffer;

public:
  SORT_INFO()
    :addon_fields(NULL), record_pointers(0),
     sort_keys(NULL),
     sorted_result_in_fsbuf(FALSE)
  {
    buffpek.str= 0;
    my_b_clear(&io_cache);
  }

~SORT_INFO();

void free_data()
  {
    close_cached_file(&io_cache);
    free_addon_buff();
    my_free(record_pointers);
    my_free(buffpek.str);
    my_free(addon_fields);
    free_sort_buffer();
  }

void reset()
  {
    free_data();
    record_pointers= 0;
    buffpek.str= 0;
    addon_fields= 0;
    sorted_result_in_fsbuf= false;
  }

void free_addon_buff();

IO_CACHE  io_cache;           /* If sorted through filesort */
  LEX_STRING buffpek;           /* Buffer for buffpek structures */
  Addon_fields *addon_fields;   /* Addon field descriptors */
  uchar     *record_pointers;    /* If sorted in memory */
  Sort_keys *sort_keys;         /* Sort key descriptors*/

/**
    If the entire result of filesort fits in memory, we skip the merge phase.
    We may leave the result in filesort_buffer
    (indicated by sorted_result_in_fsbuf), or we may strip away
    the sort keys, and copy the sorted result into a new buffer.
    @see save_index()
   */
  bool      sorted_result_in_fsbuf;

/*
    How many rows in final result.
    Also how many rows in record_pointers, if used
  */
  ha_rows   return_rows;
  ha_rows   examined_rows;	/* How many rows read */
  ha_rows   found_rows;         /* How many rows was accepted */

/** Sort filesort_buffer */
  void sort_buffer(Sort_param *param, uint count)
  { filesort_buffer.sort_buffer(param, count); }

uchar **get_sort_keys()
  { return filesort_buffer.get_sort_keys(); }

uchar *get_sorted_record(uint ix)
  { return filesort_buffer.get_sorted_record(ix); }

uchar *alloc_sort_buffer(uint num_records, uint record_length)
  { return filesort_buffer.alloc_sort_buffer(num_records, record_length); }

void free_sort_buffer()
  { filesort_buffer.free_sort_buffer(); }

bool isfull() const
  { return filesort_buffer.isfull(); }
  void init_record_pointers()
  { filesort_buffer.init_record_pointers(); }
  void init_next_record_pointer()
  { filesort_buffer.init_next_record_pointer(); }
  uchar *get_next_record_pointer()
  { return filesort_buffer.get_next_record_pointer(); }
  void adjust_next_record_pointer(uint val)
  { filesort_buffer.adjust_next_record_pointer(val); }

Bounds_checked_array<uchar> get_raw_buf()
  { return filesort_buffer.get_raw_buf(); }

size_t sort_buffer_size() const
  { return filesort_buffer.sort_buffer_size(); }

bool is_allocated() const
  { return filesort_buffer.is_allocated(); }
  void set_sort_length(uint val)
  { filesort_buffer.set_sort_length(val); }
  uint get_sort_length() const
  { return filesort_buffer.get_sort_length(); }

bool has_filesort_result_in_memory() const
  {
    return record_pointers || sorted_result_in_fsbuf;
  }

/// Are we using "addon fields"?
  bool using_addon_fields() const
  {
    return addon_fields != NULL;
  }

/// Are we using "packed addon fields"?
  bool using_packed_addons();

/**
    Copies (unpacks) values appended to sorted fields from a buffer back to
    their regular positions specified by the Field::ptr pointers.
    @param buff            Buffer which to unpack the value from
  */
  template<bool Packed_addon_fields>
  inline void unpack_addon_fields(uchar *buff);

bool using_packed_sortkeys();

friend SORT_INFO *filesort(THD *thd, TABLE *table, Filesort *filesort,
                             Filesort_tracker* tracker, JOIN *join,
                             table_map first_table_bit);
};

SORT_INFO *filesort(THD *thd, TABLE *table, Filesort *filesort,
                    Filesort_tracker* tracker, JOIN *join=NULL,
                    table_map first_table_bit=0);

bool filesort_use_addons(TABLE *table, uint sortlength,
                         uint *length, uint *fields, uint *null_fields,
                         uint *m_packable_length);

void change_double_for_sort(double nr,uchar *to);
void store_length(uchar *to, uint length, uint pack_length);
void
reverse_key(uchar *to, const SORT_FIELD_ATTR *sort_field);

#endif /* FILESORT_INCLUDED */

[+] ..
[-] sql_manager.h [open]
[-] create_tmp_table.h [open]
[-] lex_ident.h [open]
[-] semisync_slave.h [open]
[-] sql_cache.h [open]
[-] events.h [open]
[-] my_rnd.h [open]
[-] lex_hash.h [open]
[-] discover.h [open]
[-] item_geofunc.h [open]
[-] wsrep_applier.h [open]
[-] my_apc.h [open]
[-] log_event.h [open]
[-] wsrep_thd.h [open]
[-] threadpool_generic.h [open]
[-] my_json_writer.h [open]
[-] mysys_err.h [open]
[-] semisync_master_ack_receiver.h [open]
[-] sql_udf.h [open]
[-] opt_trace_context.h [open]
[-] violite.h [open]
[-] rpl_mi.h [open]
[-] thr_timer.h [open]
[-] bounded_queue.h [open]
[-] item_sum.h [open]
[-] cset_narrowing.h [open]
[-] wsrep_xid.h [open]
[-] my_bitmap.h [open]
[-] table_cache.h [open]
[-] sql_locale.h [open]
[-] sql_plugin.h [open]
[-] handle_connections_win.h [open]
[-] sql_array.h [open]
[-] sql_expression_cache.h [open]
[-] password.h [open]
[-] waiting_threads.h [open]
[-] my_virtual_mem.h [open]
[-] privilege.h [open]
[-] rpl_filter.h [open]
[-] event_db_repository.h [open]
[-] thr_malloc.h [open]
[-] rpl_injector.h [open]
[-] sql_const.h [open]
[-] lex_charset.h [open]
[-] my_cpu.h [open]
[-] sql_rename.h [open]
[-] sp_cache.h [open]
[-] sql_prepare.h [open]
[-] mdl.h [open]
[-] event_scheduler.h [open]
[-] my_md5.h [open]
[-] probes_mysql.h [open]
[-] item_subselect.h [open]
[-] sql_type_geom.h [open]
[-] sql_sequence.h [open]
[-] sql_type_fixedbin.h [open]
[-] wsrep_storage_service.h [open]
[-] item_windowfunc.h [open]
[-] sql_command.h [open]
[-] uniques.h [open]
[-] rpl_record.h [open]
[-] sql_priv.h [open]
[-] sql_digest_stream.h [open]
[-] sql_callback.h [open]
[-] item_row.h [open]
[-] table.h [open]
[-] sql_profile.h [open]
[-] item_create.h [open]
[-] item_jsonfunc.h [open]
[-] sys_vars_shared.h [open]
[-] opt_trace.h [open]
[-] wsrep_types.h [open]
[-] sql_help.h [open]
[-] wsrep_on.h [open]
[-] myisamchk.h [open]
[-] my_compare.h [open]
[-] item_strfunc.h [open]
[-] proxy_protocol.h [open]
[-] wsrep.h [open]
[-] my_stack_alloc.h [open]
[-] my_nosys.h [open]
[-] sql_analyze_stmt.h [open]
[-] datadict.h [open]
[-] wqueue.h [open]
[-] mysqld_suffix.h [open]
[-] protocol.h [open]
[-] wsrep_allowlist_service.h [open]
[-] my_user.h [open]
[-] myisam.h [open]
[-] sql_trigger.h [open]
[-] json_table.h [open]
[-] sql_signal.h [open]
[-] filesort.h [open]
[-] embedded_priv.h [open]
[-] sql_type_json.h [open]
[-] sql_alter.h [open]
[-] heap.h [open]
[-] sql_delete.h [open]
[-] partition_info.h [open]
[-] message.h [open]
[-] sql_sort.h [open]
[-] wsrep_utils.h [open]
[-] rijndael.h [open]
[-] set_var.h [open]
[-] my_minidump.h [open]
[-] compat56.h [open]
[-] client_settings.h [open]
[-] thr_alarm.h [open]
[-] xa.h [open]
[-] assume_aligned.h [open]
[-] my_libwrap.h [open]
[+] atomic
[-] wsrep_status.h [open]
[-] innodb_priv.h [open]
[-] sql_load.h [open]
[-] sql_plugin_compat.h [open]
[-] sp_rcontext.h [open]
[-] wsrep_sst.h [open]
[-] sql_acl.h [open]
[-] procedure.h [open]
[-] pfs_transaction_provider.h [open]
[-] my_atomic.h [open]
[-] item_vers.h [open]
[-] sql_repl.h [open]
[-] sql_do.h [open]
[-] hash_filo.h [open]
[-] pfs_statement_provider.h [open]
[-] service_versions.h [open]
[-] sql_cmd.h [open]
[-] sql_type_string.h [open]
[-] item_timefunc.h [open]
[-] my_handler_errors.h [open]
[-] sql_crypt.h [open]
[-] scheduler.h [open]
[-] pfs_socket_provider.h [open]
[-] tzfile.h [open]
[-] rpl_rli.h [open]
[-] wsrep_mutex.h [open]
[-] keycaches.h [open]
[-] my_time.h [open]
[-] rpl_record_old.h [open]
[-] welcome_copyright_notice.h [open]
[-] item.h [open]
[-] wsrep_server_service.h [open]
[-] t_ctype.h [open]
[-] sql_debug.h [open]
[-] mysqld.h [open]
[-] item_xmlfunc.h [open]
[-] pfs_metadata_provider.h [open]
[-] gstream.h [open]
[-] sql_reload.h [open]
[-] session_tracker.h [open]
[-] config.h [open]
[-] multi_range_read.h [open]
[-] ha_handler_stats.h [open]
[-] my_counter.h [open]
[-] sql_type.h [open]
[-] probes_mysql_nodtrace.h [open]
[-] my_base.h [open]
[-] opt_subselect.h [open]
[-] repl_failsafe.h [open]
[-] handler.h [open]
[-] wsrep_mysqld_c.h [open]
[-] records.h [open]
[-] backup.h [open]
[-] sql_bitmap.h [open]
[-] sql_binlog.h [open]
[-] log_event_data_type.h [open]
[-] wsrep_client_service.h [open]
[-] lex_symbol.h [open]
[-] sql_lex.h [open]
[-] ddl_log.h [open]
[-] create_options.h [open]
[-] group_by_handler.h [open]
[-] strfunc.h [open]
[-] my_service_manager.h [open]
[-] semisync_master.h [open]
[-] sql_db.h [open]
[-] sql_insert.h [open]
[-] my_stacktrace.h [open]
[-] lex.h [open]
[-] item_cmpfunc.h [open]
[-] sql_type_int.h [open]
[-] wsrep_var.h [open]
[-] maria.h [open]
[-] event_data_objects.h [open]
[-] sql_handler.h [open]
[-] source_revision.h [open]
[-] debug.h [open]
[-] rpl_gtid.h [open]
[-] key.h [open]
[-] sql_servers.h [open]
[-] lex_string.h [open]
[-] myisampack.h [open]
[-] rpl_tblmap.h [open]
[-] sql_type_fixedbin_storage.h [open]
[-] my_crypt.h [open]
[-] structs.h [open]
[-] sql_table.h [open]
[-] field.h [open]
[-] sql_plist.h [open]
[-] replication.h [open]
[-] select_handler.h [open]
[-] winservice.h [open]
[-] win_tzname_data.h [open]
[-] slave.h [open]
[-] init.h [open]
[-] sql_get_diagnostics.h [open]
[-] sp_head.h [open]
[-] custom_conf.h [open]
[-] sql_join_cache.h [open]
[-] sql_audit.h [open]
[-] sql_connect.h [open]
[-] wsrep_server_state.h [open]
[+] data
[-] sql_update.h [open]
[-] transaction.h [open]
[-] log_event_old.h [open]
[-] pfs_stage_provider.h [open]
[-] mariadb.h [open]
[-] item_func.h [open]
[-] my_tree.h [open]
[-] sql_tvc.h [open]
[-] rpl_reporting.h [open]
[-] derror.h [open]
[-] sql_schema.h [open]
[-] sql_parse.h [open]
[-] sql_type_real.h [open]
[-] pfs_thread_provider.h [open]
[-] my_check_opt.h [open]
[-] rowid_filter.h [open]
[-] sql_base.h [open]
[-] sql_test.h [open]
[-] sp.h [open]
[-] my_uctype.h [open]
[-] myisammrg.h [open]
[-] sp_pcontext.h [open]
[-] my_bit.h [open]
[-] wsrep_client_state.h [open]
[-] event_queue.h [open]
[-] sql_window.h [open]
[-] sql_limit.h [open]
[-] my_rdtsc.h [open]
[-] sql_list.h [open]
[-] pfs_file_provider.h [open]
[-] rpl_constants.h [open]
[-] sql_explain.h [open]
[-] sql_class.h [open]
[-] sql_i_s.h [open]
[-] sql_lifo_buffer.h [open]
[-] pfs_memory_provider.h [open]
[-] ssl_compat.h [open]
[-] wsrep_mysqld.h [open]
[-] dur_prop.h [open]
[-] sql_union.h [open]
[-] field_comp.h [open]
[-] contributors.h [open]
[-] pfs_table_provider.h [open]
[-] wsrep_condition_variable.h [open]
[-] wsrep_trans_observer.h [open]
[-] rpl_parallel.h [open]
[-] parse_file.h [open]
[-] my_atomic_wrapper.h [open]
[-] sql_alloc.h [open]
[-] threadpool_winsockets.h [open]
[-] sql_show.h [open]
[-] sql_mode.h [open]
[-] gcalc_tools.h [open]
[-] hash.h [open]
[-] sql_partition.h [open]
[-] mysqld_default_groups.h [open]
[-] sql_truncate.h [open]
[-] mem_root_array.h [open]
[-] sql_basic_types.h [open]
[-] socketpair.h [open]
[-] lex_token.h [open]
[-] thr_lock.h [open]
[+] providers
[-] authors.h [open]
[-] sql_error.h [open]
[-] threadpool.h [open]
[-] opt_range.h [open]
[-] log_slow.h [open]
[-] debug_sync.h [open]
[-] ha_partition.h [open]
[-] sql_derived.h [open]
[-] sql_bootstrap.h [open]
[-] gcalc_slicescan.h [open]
[-] queues.h [open]
[-] aria_backup.h [open]
[-] aligned.h [open]
[-] partition_element.h [open]
[-] spatial.h [open]
[-] semisync.h [open]
[-] my_default.h [open]
[-] sql_hset.h [open]
[-] sql_cte.h [open]
[-] opt_histogram_json.h [open]
[-] scope.h [open]
[-] event_parse_data.h [open]
[-] ilist.h [open]
[-] sql_view.h [open]
[-] wsrep_schema.h [open]
[-] lock.h [open]
[-] sql_admin.h [open]
[-] sql_partition_admin.h [open]
[-] vers_string.h [open]
[-] ha_sequence.h [open]
[-] sql_cursor.h [open]
[-] sql_string.h [open]
[-] sql_statistics.h [open]
[-] tztime.h [open]
[-] my_alarm.h [open]
[-] my_decimal.h [open]
[-] sql_analyse.h [open]
[-] sql_digest.h [open]
[-] unireg.h [open]
[-] hostname.h [open]
[-] ft_global.h [open]
[-] grant.h [open]
[-] wsrep_priv.h [open]
[-] log.h [open]
[-] filesort_utils.h [open]
[-] sql_time.h [open]
[-] sql_select.h [open]
[-] wsrep_binlog.h [open]
[-] wsrep_high_priority_service.h [open]
[-] pfs_idle_provider.h [open]
[-] derived_handler.h [open]
[-] thread_cache.h [open]
[-] lf.h [open]
[-] des_key_file.h [open]
[-] span.h [open]
[-] rpl_utility.h [open]